Initial commit: Email alerts application
This commit is contained in:
Iyeoluwa Akinrinola
@@ -0,0 +1,50 @@
|
||||
r"""
|
||||
This code was generated by
|
||||
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
|
||||
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
|
||||
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
|
||||
|
||||
Twilio - Intelligence
|
||||
This is the public Twilio REST API.
|
||||
|
||||
NOTE: This class is auto generated by OpenAPI Generator.
|
||||
https://openapi-generator.tech
|
||||
Do not edit the class manually.
|
||||
"""
|
||||
|
||||
from typing import Optional
|
||||
from twilio.base.version import Version
|
||||
from twilio.base.domain import Domain
|
||||
from twilio.rest.intelligence.v2.service import ServiceList
|
||||
from twilio.rest.intelligence.v2.transcript import TranscriptList
|
||||
|
||||
|
||||
class V2(Version):
|
||||
def __init__(self, domain: Domain):
|
||||
"""
|
||||
Initialize the V2 version of Intelligence
|
||||
|
||||
:param domain: The Twilio.intelligence domain
|
||||
"""
|
||||
super().__init__(domain, "v2")
|
||||
self._services: Optional[ServiceList] = None
|
||||
self._transcripts: Optional[TranscriptList] = None
|
||||
|
||||
@property
|
||||
def services(self) -> ServiceList:
|
||||
if self._services is None:
|
||||
self._services = ServiceList(self)
|
||||
return self._services
|
||||
|
||||
@property
|
||||
def transcripts(self) -> TranscriptList:
|
||||
if self._transcripts is None:
|
||||
self._transcripts = TranscriptList(self)
|
||||
return self._transcripts
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
return "<Twilio.Intelligence.V2>"
|
||||
BIN
Binary file not shown.
BIN
Binary file not shown.
@@ -0,0 +1,756 @@
|
||||
r"""
|
||||
This code was generated by
|
||||
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
|
||||
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
|
||||
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
|
||||
|
||||
Twilio - Intelligence
|
||||
This is the public Twilio REST API.
|
||||
|
||||
NOTE: This class is auto generated by OpenAPI Generator.
|
||||
https://openapi-generator.tech
|
||||
Do not edit the class manually.
|
||||
"""
|
||||
|
||||
|
||||
from datetime import datetime
|
||||
from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator
|
||||
from twilio.base import deserialize, values
|
||||
from twilio.base.instance_context import InstanceContext
|
||||
from twilio.base.instance_resource import InstanceResource
|
||||
from twilio.base.list_resource import ListResource
|
||||
from twilio.base.version import Version
|
||||
from twilio.base.page import Page
|
||||
|
||||
|
||||
class ServiceInstance(InstanceResource):
|
||||
class HttpMethod(object):
|
||||
GET = "GET"
|
||||
POST = "POST"
|
||||
NULL = "NULL"
|
||||
|
||||
"""
|
||||
:ivar account_sid: The unique SID identifier of the Account the Service belongs to.
|
||||
:ivar auto_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
|
||||
:ivar media_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
|
||||
:ivar auto_transcribe: Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
|
||||
:ivar data_logging: Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models.
|
||||
:ivar date_created: The date that this Service was created, given in ISO 8601 format.
|
||||
:ivar date_updated: The date that this Service was updated, given in ISO 8601 format.
|
||||
:ivar friendly_name: A human readable description of this resource, up to 64 characters.
|
||||
:ivar language_code: The default language code of the audio.
|
||||
:ivar sid: A 34 character string that uniquely identifies this Service.
|
||||
:ivar unique_name: Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
|
||||
:ivar url: The URL of this resource.
|
||||
:ivar webhook_url: The URL Twilio will request when executing the Webhook.
|
||||
:ivar webhook_http_method:
|
||||
:ivar version: The version number of this Service.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self, version: Version, payload: Dict[str, Any], sid: Optional[str] = None
|
||||
):
|
||||
super().__init__(version)
|
||||
|
||||
self.account_sid: Optional[str] = payload.get("account_sid")
|
||||
self.auto_redaction: Optional[bool] = payload.get("auto_redaction")
|
||||
self.media_redaction: Optional[bool] = payload.get("media_redaction")
|
||||
self.auto_transcribe: Optional[bool] = payload.get("auto_transcribe")
|
||||
self.data_logging: Optional[bool] = payload.get("data_logging")
|
||||
self.date_created: Optional[datetime] = deserialize.iso8601_datetime(
|
||||
payload.get("date_created")
|
||||
)
|
||||
self.date_updated: Optional[datetime] = deserialize.iso8601_datetime(
|
||||
payload.get("date_updated")
|
||||
)
|
||||
self.friendly_name: Optional[str] = payload.get("friendly_name")
|
||||
self.language_code: Optional[str] = payload.get("language_code")
|
||||
self.sid: Optional[str] = payload.get("sid")
|
||||
self.unique_name: Optional[str] = payload.get("unique_name")
|
||||
self.url: Optional[str] = payload.get("url")
|
||||
self.webhook_url: Optional[str] = payload.get("webhook_url")
|
||||
self.webhook_http_method: Optional["ServiceInstance.HttpMethod"] = payload.get(
|
||||
"webhook_http_method"
|
||||
)
|
||||
self.version: Optional[int] = deserialize.integer(payload.get("version"))
|
||||
|
||||
self._solution = {
|
||||
"sid": sid or self.sid,
|
||||
}
|
||||
self._context: Optional[ServiceContext] = None
|
||||
|
||||
@property
|
||||
def _proxy(self) -> "ServiceContext":
|
||||
"""
|
||||
Generate an instance context for the instance, the context is capable of
|
||||
performing various actions. All instance actions are proxied to the context
|
||||
|
||||
:returns: ServiceContext for this ServiceInstance
|
||||
"""
|
||||
if self._context is None:
|
||||
self._context = ServiceContext(
|
||||
self._version,
|
||||
sid=self._solution["sid"],
|
||||
)
|
||||
return self._context
|
||||
|
||||
def delete(self) -> bool:
|
||||
"""
|
||||
Deletes the ServiceInstance
|
||||
|
||||
|
||||
:returns: True if delete succeeds, False otherwise
|
||||
"""
|
||||
return self._proxy.delete()
|
||||
|
||||
async def delete_async(self) -> bool:
|
||||
"""
|
||||
Asynchronous coroutine that deletes the ServiceInstance
|
||||
|
||||
|
||||
:returns: True if delete succeeds, False otherwise
|
||||
"""
|
||||
return await self._proxy.delete_async()
|
||||
|
||||
def fetch(self) -> "ServiceInstance":
|
||||
"""
|
||||
Fetch the ServiceInstance
|
||||
|
||||
|
||||
:returns: The fetched ServiceInstance
|
||||
"""
|
||||
return self._proxy.fetch()
|
||||
|
||||
async def fetch_async(self) -> "ServiceInstance":
|
||||
"""
|
||||
Asynchronous coroutine to fetch the ServiceInstance
|
||||
|
||||
|
||||
:returns: The fetched ServiceInstance
|
||||
"""
|
||||
return await self._proxy.fetch_async()
|
||||
|
||||
def update(
|
||||
self,
|
||||
if_match: Union[str, object] = values.unset,
|
||||
auto_transcribe: Union[bool, object] = values.unset,
|
||||
data_logging: Union[bool, object] = values.unset,
|
||||
friendly_name: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
unique_name: Union[str, object] = values.unset,
|
||||
auto_redaction: Union[bool, object] = values.unset,
|
||||
media_redaction: Union[bool, object] = values.unset,
|
||||
webhook_url: Union[str, object] = values.unset,
|
||||
webhook_http_method: Union["ServiceInstance.HttpMethod", object] = values.unset,
|
||||
) -> "ServiceInstance":
|
||||
"""
|
||||
Update the ServiceInstance
|
||||
|
||||
:param if_match: The If-Match HTTP request header
|
||||
:param auto_transcribe: Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
|
||||
:param data_logging: Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models.
|
||||
:param friendly_name: A human readable description of this resource, up to 64 characters.
|
||||
:param language_code: The default language code of the audio.
|
||||
:param unique_name: Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
|
||||
:param auto_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
|
||||
:param media_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
|
||||
:param webhook_url: The URL Twilio will request when executing the Webhook.
|
||||
:param webhook_http_method:
|
||||
|
||||
:returns: The updated ServiceInstance
|
||||
"""
|
||||
return self._proxy.update(
|
||||
if_match=if_match,
|
||||
auto_transcribe=auto_transcribe,
|
||||
data_logging=data_logging,
|
||||
friendly_name=friendly_name,
|
||||
language_code=language_code,
|
||||
unique_name=unique_name,
|
||||
auto_redaction=auto_redaction,
|
||||
media_redaction=media_redaction,
|
||||
webhook_url=webhook_url,
|
||||
webhook_http_method=webhook_http_method,
|
||||
)
|
||||
|
||||
async def update_async(
|
||||
self,
|
||||
if_match: Union[str, object] = values.unset,
|
||||
auto_transcribe: Union[bool, object] = values.unset,
|
||||
data_logging: Union[bool, object] = values.unset,
|
||||
friendly_name: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
unique_name: Union[str, object] = values.unset,
|
||||
auto_redaction: Union[bool, object] = values.unset,
|
||||
media_redaction: Union[bool, object] = values.unset,
|
||||
webhook_url: Union[str, object] = values.unset,
|
||||
webhook_http_method: Union["ServiceInstance.HttpMethod", object] = values.unset,
|
||||
) -> "ServiceInstance":
|
||||
"""
|
||||
Asynchronous coroutine to update the ServiceInstance
|
||||
|
||||
:param if_match: The If-Match HTTP request header
|
||||
:param auto_transcribe: Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
|
||||
:param data_logging: Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models.
|
||||
:param friendly_name: A human readable description of this resource, up to 64 characters.
|
||||
:param language_code: The default language code of the audio.
|
||||
:param unique_name: Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
|
||||
:param auto_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
|
||||
:param media_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
|
||||
:param webhook_url: The URL Twilio will request when executing the Webhook.
|
||||
:param webhook_http_method:
|
||||
|
||||
:returns: The updated ServiceInstance
|
||||
"""
|
||||
return await self._proxy.update_async(
|
||||
if_match=if_match,
|
||||
auto_transcribe=auto_transcribe,
|
||||
data_logging=data_logging,
|
||||
friendly_name=friendly_name,
|
||||
language_code=language_code,
|
||||
unique_name=unique_name,
|
||||
auto_redaction=auto_redaction,
|
||||
media_redaction=media_redaction,
|
||||
webhook_url=webhook_url,
|
||||
webhook_http_method=webhook_http_method,
|
||||
)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
|
||||
return "<Twilio.Intelligence.V2.ServiceInstance {}>".format(context)
|
||||
|
||||
|
||||
class ServiceContext(InstanceContext):
|
||||
def __init__(self, version: Version, sid: str):
|
||||
"""
|
||||
Initialize the ServiceContext
|
||||
|
||||
:param version: Version that contains the resource
|
||||
:param sid: A 34 character string that uniquely identifies this Service.
|
||||
"""
|
||||
super().__init__(version)
|
||||
|
||||
# Path Solution
|
||||
self._solution = {
|
||||
"sid": sid,
|
||||
}
|
||||
self._uri = "/Services/{sid}".format(**self._solution)
|
||||
|
||||
def delete(self) -> bool:
|
||||
"""
|
||||
Deletes the ServiceInstance
|
||||
|
||||
|
||||
:returns: True if delete succeeds, False otherwise
|
||||
"""
|
||||
return self._version.delete(
|
||||
method="DELETE",
|
||||
uri=self._uri,
|
||||
)
|
||||
|
||||
async def delete_async(self) -> bool:
|
||||
"""
|
||||
Asynchronous coroutine that deletes the ServiceInstance
|
||||
|
||||
|
||||
:returns: True if delete succeeds, False otherwise
|
||||
"""
|
||||
return await self._version.delete_async(
|
||||
method="DELETE",
|
||||
uri=self._uri,
|
||||
)
|
||||
|
||||
def fetch(self) -> ServiceInstance:
|
||||
"""
|
||||
Fetch the ServiceInstance
|
||||
|
||||
|
||||
:returns: The fetched ServiceInstance
|
||||
"""
|
||||
|
||||
payload = self._version.fetch(
|
||||
method="GET",
|
||||
uri=self._uri,
|
||||
)
|
||||
|
||||
return ServiceInstance(
|
||||
self._version,
|
||||
payload,
|
||||
sid=self._solution["sid"],
|
||||
)
|
||||
|
||||
async def fetch_async(self) -> ServiceInstance:
|
||||
"""
|
||||
Asynchronous coroutine to fetch the ServiceInstance
|
||||
|
||||
|
||||
:returns: The fetched ServiceInstance
|
||||
"""
|
||||
|
||||
payload = await self._version.fetch_async(
|
||||
method="GET",
|
||||
uri=self._uri,
|
||||
)
|
||||
|
||||
return ServiceInstance(
|
||||
self._version,
|
||||
payload,
|
||||
sid=self._solution["sid"],
|
||||
)
|
||||
|
||||
def update(
|
||||
self,
|
||||
if_match: Union[str, object] = values.unset,
|
||||
auto_transcribe: Union[bool, object] = values.unset,
|
||||
data_logging: Union[bool, object] = values.unset,
|
||||
friendly_name: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
unique_name: Union[str, object] = values.unset,
|
||||
auto_redaction: Union[bool, object] = values.unset,
|
||||
media_redaction: Union[bool, object] = values.unset,
|
||||
webhook_url: Union[str, object] = values.unset,
|
||||
webhook_http_method: Union["ServiceInstance.HttpMethod", object] = values.unset,
|
||||
) -> ServiceInstance:
|
||||
"""
|
||||
Update the ServiceInstance
|
||||
|
||||
:param if_match: The If-Match HTTP request header
|
||||
:param auto_transcribe: Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
|
||||
:param data_logging: Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models.
|
||||
:param friendly_name: A human readable description of this resource, up to 64 characters.
|
||||
:param language_code: The default language code of the audio.
|
||||
:param unique_name: Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
|
||||
:param auto_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
|
||||
:param media_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
|
||||
:param webhook_url: The URL Twilio will request when executing the Webhook.
|
||||
:param webhook_http_method:
|
||||
|
||||
:returns: The updated ServiceInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"AutoTranscribe": auto_transcribe,
|
||||
"DataLogging": data_logging,
|
||||
"FriendlyName": friendly_name,
|
||||
"LanguageCode": language_code,
|
||||
"UniqueName": unique_name,
|
||||
"AutoRedaction": auto_redaction,
|
||||
"MediaRedaction": media_redaction,
|
||||
"WebhookUrl": webhook_url,
|
||||
"WebhookHttpMethod": webhook_http_method,
|
||||
}
|
||||
)
|
||||
headers = values.of(
|
||||
{
|
||||
"If-Match": if_match,
|
||||
}
|
||||
)
|
||||
|
||||
payload = self._version.update(
|
||||
method="POST", uri=self._uri, data=data, headers=headers
|
||||
)
|
||||
|
||||
return ServiceInstance(self._version, payload, sid=self._solution["sid"])
|
||||
|
||||
async def update_async(
|
||||
self,
|
||||
if_match: Union[str, object] = values.unset,
|
||||
auto_transcribe: Union[bool, object] = values.unset,
|
||||
data_logging: Union[bool, object] = values.unset,
|
||||
friendly_name: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
unique_name: Union[str, object] = values.unset,
|
||||
auto_redaction: Union[bool, object] = values.unset,
|
||||
media_redaction: Union[bool, object] = values.unset,
|
||||
webhook_url: Union[str, object] = values.unset,
|
||||
webhook_http_method: Union["ServiceInstance.HttpMethod", object] = values.unset,
|
||||
) -> ServiceInstance:
|
||||
"""
|
||||
Asynchronous coroutine to update the ServiceInstance
|
||||
|
||||
:param if_match: The If-Match HTTP request header
|
||||
:param auto_transcribe: Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
|
||||
:param data_logging: Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models.
|
||||
:param friendly_name: A human readable description of this resource, up to 64 characters.
|
||||
:param language_code: The default language code of the audio.
|
||||
:param unique_name: Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
|
||||
:param auto_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
|
||||
:param media_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
|
||||
:param webhook_url: The URL Twilio will request when executing the Webhook.
|
||||
:param webhook_http_method:
|
||||
|
||||
:returns: The updated ServiceInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"AutoTranscribe": auto_transcribe,
|
||||
"DataLogging": data_logging,
|
||||
"FriendlyName": friendly_name,
|
||||
"LanguageCode": language_code,
|
||||
"UniqueName": unique_name,
|
||||
"AutoRedaction": auto_redaction,
|
||||
"MediaRedaction": media_redaction,
|
||||
"WebhookUrl": webhook_url,
|
||||
"WebhookHttpMethod": webhook_http_method,
|
||||
}
|
||||
)
|
||||
headers = values.of(
|
||||
{
|
||||
"If-Match": if_match,
|
||||
}
|
||||
)
|
||||
|
||||
payload = await self._version.update_async(
|
||||
method="POST", uri=self._uri, data=data, headers=headers
|
||||
)
|
||||
|
||||
return ServiceInstance(self._version, payload, sid=self._solution["sid"])
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
|
||||
return "<Twilio.Intelligence.V2.ServiceContext {}>".format(context)
|
||||
|
||||
|
||||
class ServicePage(Page):
|
||||
def get_instance(self, payload: Dict[str, Any]) -> ServiceInstance:
|
||||
"""
|
||||
Build an instance of ServiceInstance
|
||||
|
||||
:param payload: Payload response from the API
|
||||
"""
|
||||
return ServiceInstance(self._version, payload)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
return "<Twilio.Intelligence.V2.ServicePage>"
|
||||
|
||||
|
||||
class ServiceList(ListResource):
|
||||
def __init__(self, version: Version):
|
||||
"""
|
||||
Initialize the ServiceList
|
||||
|
||||
:param version: Version that contains the resource
|
||||
|
||||
"""
|
||||
super().__init__(version)
|
||||
|
||||
self._uri = "/Services"
|
||||
|
||||
def create(
|
||||
self,
|
||||
unique_name: str,
|
||||
auto_transcribe: Union[bool, object] = values.unset,
|
||||
data_logging: Union[bool, object] = values.unset,
|
||||
friendly_name: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
auto_redaction: Union[bool, object] = values.unset,
|
||||
media_redaction: Union[bool, object] = values.unset,
|
||||
webhook_url: Union[str, object] = values.unset,
|
||||
webhook_http_method: Union["ServiceInstance.HttpMethod", object] = values.unset,
|
||||
) -> ServiceInstance:
|
||||
"""
|
||||
Create the ServiceInstance
|
||||
|
||||
:param unique_name: Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
|
||||
:param auto_transcribe: Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
|
||||
:param data_logging: Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models.
|
||||
:param friendly_name: A human readable description of this resource, up to 64 characters.
|
||||
:param language_code: The default language code of the audio.
|
||||
:param auto_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
|
||||
:param media_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
|
||||
:param webhook_url: The URL Twilio will request when executing the Webhook.
|
||||
:param webhook_http_method:
|
||||
|
||||
:returns: The created ServiceInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"UniqueName": unique_name,
|
||||
"AutoTranscribe": auto_transcribe,
|
||||
"DataLogging": data_logging,
|
||||
"FriendlyName": friendly_name,
|
||||
"LanguageCode": language_code,
|
||||
"AutoRedaction": auto_redaction,
|
||||
"MediaRedaction": media_redaction,
|
||||
"WebhookUrl": webhook_url,
|
||||
"WebhookHttpMethod": webhook_http_method,
|
||||
}
|
||||
)
|
||||
|
||||
payload = self._version.create(
|
||||
method="POST",
|
||||
uri=self._uri,
|
||||
data=data,
|
||||
)
|
||||
|
||||
return ServiceInstance(self._version, payload)
|
||||
|
||||
async def create_async(
|
||||
self,
|
||||
unique_name: str,
|
||||
auto_transcribe: Union[bool, object] = values.unset,
|
||||
data_logging: Union[bool, object] = values.unset,
|
||||
friendly_name: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
auto_redaction: Union[bool, object] = values.unset,
|
||||
media_redaction: Union[bool, object] = values.unset,
|
||||
webhook_url: Union[str, object] = values.unset,
|
||||
webhook_http_method: Union["ServiceInstance.HttpMethod", object] = values.unset,
|
||||
) -> ServiceInstance:
|
||||
"""
|
||||
Asynchronously create the ServiceInstance
|
||||
|
||||
:param unique_name: Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
|
||||
:param auto_transcribe: Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
|
||||
:param data_logging: Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models.
|
||||
:param friendly_name: A human readable description of this resource, up to 64 characters.
|
||||
:param language_code: The default language code of the audio.
|
||||
:param auto_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
|
||||
:param media_redaction: Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
|
||||
:param webhook_url: The URL Twilio will request when executing the Webhook.
|
||||
:param webhook_http_method:
|
||||
|
||||
:returns: The created ServiceInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"UniqueName": unique_name,
|
||||
"AutoTranscribe": auto_transcribe,
|
||||
"DataLogging": data_logging,
|
||||
"FriendlyName": friendly_name,
|
||||
"LanguageCode": language_code,
|
||||
"AutoRedaction": auto_redaction,
|
||||
"MediaRedaction": media_redaction,
|
||||
"WebhookUrl": webhook_url,
|
||||
"WebhookHttpMethod": webhook_http_method,
|
||||
}
|
||||
)
|
||||
|
||||
payload = await self._version.create_async(
|
||||
method="POST",
|
||||
uri=self._uri,
|
||||
data=data,
|
||||
)
|
||||
|
||||
return ServiceInstance(self._version, payload)
|
||||
|
||||
def stream(
|
||||
self,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> Iterator[ServiceInstance]:
|
||||
"""
|
||||
Streams ServiceInstance records from the API as a generator stream.
|
||||
This operation lazily loads records as efficiently as possible until the limit
|
||||
is reached.
|
||||
The results are returned as a generator, so this operation is memory efficient.
|
||||
|
||||
:param limit: Upper limit for the number of records to return. stream()
|
||||
guarantees to never return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, stream() will attempt to read the
|
||||
limit with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: Generator that will yield up to limit results
|
||||
"""
|
||||
limits = self._version.read_limits(limit, page_size)
|
||||
page = self.page(page_size=limits["page_size"])
|
||||
|
||||
return self._version.stream(page, limits["limit"])
|
||||
|
||||
async def stream_async(
|
||||
self,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> AsyncIterator[ServiceInstance]:
|
||||
"""
|
||||
Asynchronously streams ServiceInstance records from the API as a generator stream.
|
||||
This operation lazily loads records as efficiently as possible until the limit
|
||||
is reached.
|
||||
The results are returned as a generator, so this operation is memory efficient.
|
||||
|
||||
:param limit: Upper limit for the number of records to return. stream()
|
||||
guarantees to never return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, stream() will attempt to read the
|
||||
limit with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: Generator that will yield up to limit results
|
||||
"""
|
||||
limits = self._version.read_limits(limit, page_size)
|
||||
page = await self.page_async(page_size=limits["page_size"])
|
||||
|
||||
return self._version.stream_async(page, limits["limit"])
|
||||
|
||||
def list(
|
||||
self,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> List[ServiceInstance]:
|
||||
"""
|
||||
Lists ServiceInstance records from the API as a list.
|
||||
Unlike stream(), this operation is eager and will load `limit` records into
|
||||
memory before returning.
|
||||
|
||||
:param limit: Upper limit for the number of records to return. list() guarantees
|
||||
never to return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, list() will attempt to read the limit
|
||||
with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: list that will contain up to limit results
|
||||
"""
|
||||
return list(
|
||||
self.stream(
|
||||
limit=limit,
|
||||
page_size=page_size,
|
||||
)
|
||||
)
|
||||
|
||||
async def list_async(
|
||||
self,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> List[ServiceInstance]:
|
||||
"""
|
||||
Asynchronously lists ServiceInstance records from the API as a list.
|
||||
Unlike stream(), this operation is eager and will load `limit` records into
|
||||
memory before returning.
|
||||
|
||||
:param limit: Upper limit for the number of records to return. list() guarantees
|
||||
never to return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, list() will attempt to read the limit
|
||||
with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: list that will contain up to limit results
|
||||
"""
|
||||
return [
|
||||
record
|
||||
async for record in await self.stream_async(
|
||||
limit=limit,
|
||||
page_size=page_size,
|
||||
)
|
||||
]
|
||||
|
||||
def page(
|
||||
self,
|
||||
page_token: Union[str, object] = values.unset,
|
||||
page_number: Union[int, object] = values.unset,
|
||||
page_size: Union[int, object] = values.unset,
|
||||
) -> ServicePage:
|
||||
"""
|
||||
Retrieve a single page of ServiceInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param page_token: PageToken provided by the API
|
||||
:param page_number: Page Number, this value is simply for client state
|
||||
:param page_size: Number of records to return, defaults to 50
|
||||
|
||||
:returns: Page of ServiceInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"PageToken": page_token,
|
||||
"Page": page_number,
|
||||
"PageSize": page_size,
|
||||
}
|
||||
)
|
||||
|
||||
response = self._version.page(method="GET", uri=self._uri, params=data)
|
||||
return ServicePage(self._version, response)
|
||||
|
||||
async def page_async(
|
||||
self,
|
||||
page_token: Union[str, object] = values.unset,
|
||||
page_number: Union[int, object] = values.unset,
|
||||
page_size: Union[int, object] = values.unset,
|
||||
) -> ServicePage:
|
||||
"""
|
||||
Asynchronously retrieve a single page of ServiceInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param page_token: PageToken provided by the API
|
||||
:param page_number: Page Number, this value is simply for client state
|
||||
:param page_size: Number of records to return, defaults to 50
|
||||
|
||||
:returns: Page of ServiceInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"PageToken": page_token,
|
||||
"Page": page_number,
|
||||
"PageSize": page_size,
|
||||
}
|
||||
)
|
||||
|
||||
response = await self._version.page_async(
|
||||
method="GET", uri=self._uri, params=data
|
||||
)
|
||||
return ServicePage(self._version, response)
|
||||
|
||||
def get_page(self, target_url: str) -> ServicePage:
|
||||
"""
|
||||
Retrieve a specific page of ServiceInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param target_url: API-generated URL for the requested results page
|
||||
|
||||
:returns: Page of ServiceInstance
|
||||
"""
|
||||
response = self._version.domain.twilio.request("GET", target_url)
|
||||
return ServicePage(self._version, response)
|
||||
|
||||
async def get_page_async(self, target_url: str) -> ServicePage:
|
||||
"""
|
||||
Asynchronously retrieve a specific page of ServiceInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param target_url: API-generated URL for the requested results page
|
||||
|
||||
:returns: Page of ServiceInstance
|
||||
"""
|
||||
response = await self._version.domain.twilio.request_async("GET", target_url)
|
||||
return ServicePage(self._version, response)
|
||||
|
||||
def get(self, sid: str) -> ServiceContext:
|
||||
"""
|
||||
Constructs a ServiceContext
|
||||
|
||||
:param sid: A 34 character string that uniquely identifies this Service.
|
||||
"""
|
||||
return ServiceContext(self._version, sid=sid)
|
||||
|
||||
def __call__(self, sid: str) -> ServiceContext:
|
||||
"""
|
||||
Constructs a ServiceContext
|
||||
|
||||
:param sid: A 34 character string that uniquely identifies this Service.
|
||||
"""
|
||||
return ServiceContext(self._version, sid=sid)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
return "<Twilio.Intelligence.V2.ServiceList>"
|
||||
@@ -0,0 +1,748 @@
|
||||
r"""
|
||||
This code was generated by
|
||||
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
|
||||
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
|
||||
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
|
||||
|
||||
Twilio - Intelligence
|
||||
This is the public Twilio REST API.
|
||||
|
||||
NOTE: This class is auto generated by OpenAPI Generator.
|
||||
https://openapi-generator.tech
|
||||
Do not edit the class manually.
|
||||
"""
|
||||
|
||||
|
||||
from datetime import datetime
|
||||
from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator
|
||||
from twilio.base import deserialize, serialize, values
|
||||
from twilio.base.instance_context import InstanceContext
|
||||
from twilio.base.instance_resource import InstanceResource
|
||||
from twilio.base.list_resource import ListResource
|
||||
from twilio.base.version import Version
|
||||
from twilio.base.page import Page
|
||||
from twilio.rest.intelligence.v2.transcript.media import MediaList
|
||||
from twilio.rest.intelligence.v2.transcript.operator_result import OperatorResultList
|
||||
from twilio.rest.intelligence.v2.transcript.sentence import SentenceList
|
||||
|
||||
|
||||
class TranscriptInstance(InstanceResource):
|
||||
class Status(object):
|
||||
QUEUED = "queued"
|
||||
IN_PROGRESS = "in-progress"
|
||||
COMPLETED = "completed"
|
||||
FAILED = "failed"
|
||||
CANCELED = "canceled"
|
||||
|
||||
"""
|
||||
:ivar account_sid: The unique SID identifier of the Account.
|
||||
:ivar service_sid: The unique SID identifier of the Service.
|
||||
:ivar sid: A 34 character string that uniquely identifies this Transcript.
|
||||
:ivar date_created: The date that this Transcript was created, given in ISO 8601 format.
|
||||
:ivar date_updated: The date that this Transcript was updated, given in ISO 8601 format.
|
||||
:ivar status:
|
||||
:ivar channel: Media Channel describing Transcript Source and Participant Mapping
|
||||
:ivar data_logging: Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models.
|
||||
:ivar language_code: The default language code of the audio.
|
||||
:ivar customer_key:
|
||||
:ivar media_start_time: The date that this Transcript's media was started, given in ISO 8601 format.
|
||||
:ivar duration: The duration of this Transcript's source
|
||||
:ivar url: The URL of this resource.
|
||||
:ivar redaction: If the transcript has been redacted, a redacted alternative of the transcript will be available.
|
||||
:ivar links:
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self, version: Version, payload: Dict[str, Any], sid: Optional[str] = None
|
||||
):
|
||||
super().__init__(version)
|
||||
|
||||
self.account_sid: Optional[str] = payload.get("account_sid")
|
||||
self.service_sid: Optional[str] = payload.get("service_sid")
|
||||
self.sid: Optional[str] = payload.get("sid")
|
||||
self.date_created: Optional[datetime] = deserialize.iso8601_datetime(
|
||||
payload.get("date_created")
|
||||
)
|
||||
self.date_updated: Optional[datetime] = deserialize.iso8601_datetime(
|
||||
payload.get("date_updated")
|
||||
)
|
||||
self.status: Optional["TranscriptInstance.Status"] = payload.get("status")
|
||||
self.channel: Optional[Dict[str, object]] = payload.get("channel")
|
||||
self.data_logging: Optional[bool] = payload.get("data_logging")
|
||||
self.language_code: Optional[str] = payload.get("language_code")
|
||||
self.customer_key: Optional[str] = payload.get("customer_key")
|
||||
self.media_start_time: Optional[datetime] = deserialize.iso8601_datetime(
|
||||
payload.get("media_start_time")
|
||||
)
|
||||
self.duration: Optional[int] = deserialize.integer(payload.get("duration"))
|
||||
self.url: Optional[str] = payload.get("url")
|
||||
self.redaction: Optional[bool] = payload.get("redaction")
|
||||
self.links: Optional[Dict[str, object]] = payload.get("links")
|
||||
|
||||
self._solution = {
|
||||
"sid": sid or self.sid,
|
||||
}
|
||||
self._context: Optional[TranscriptContext] = None
|
||||
|
||||
@property
|
||||
def _proxy(self) -> "TranscriptContext":
|
||||
"""
|
||||
Generate an instance context for the instance, the context is capable of
|
||||
performing various actions. All instance actions are proxied to the context
|
||||
|
||||
:returns: TranscriptContext for this TranscriptInstance
|
||||
"""
|
||||
if self._context is None:
|
||||
self._context = TranscriptContext(
|
||||
self._version,
|
||||
sid=self._solution["sid"],
|
||||
)
|
||||
return self._context
|
||||
|
||||
def delete(self) -> bool:
|
||||
"""
|
||||
Deletes the TranscriptInstance
|
||||
|
||||
|
||||
:returns: True if delete succeeds, False otherwise
|
||||
"""
|
||||
return self._proxy.delete()
|
||||
|
||||
async def delete_async(self) -> bool:
|
||||
"""
|
||||
Asynchronous coroutine that deletes the TranscriptInstance
|
||||
|
||||
|
||||
:returns: True if delete succeeds, False otherwise
|
||||
"""
|
||||
return await self._proxy.delete_async()
|
||||
|
||||
def fetch(self) -> "TranscriptInstance":
|
||||
"""
|
||||
Fetch the TranscriptInstance
|
||||
|
||||
|
||||
:returns: The fetched TranscriptInstance
|
||||
"""
|
||||
return self._proxy.fetch()
|
||||
|
||||
async def fetch_async(self) -> "TranscriptInstance":
|
||||
"""
|
||||
Asynchronous coroutine to fetch the TranscriptInstance
|
||||
|
||||
|
||||
:returns: The fetched TranscriptInstance
|
||||
"""
|
||||
return await self._proxy.fetch_async()
|
||||
|
||||
@property
|
||||
def media(self) -> MediaList:
|
||||
"""
|
||||
Access the media
|
||||
"""
|
||||
return self._proxy.media
|
||||
|
||||
@property
|
||||
def operator_results(self) -> OperatorResultList:
|
||||
"""
|
||||
Access the operator_results
|
||||
"""
|
||||
return self._proxy.operator_results
|
||||
|
||||
@property
|
||||
def sentences(self) -> SentenceList:
|
||||
"""
|
||||
Access the sentences
|
||||
"""
|
||||
return self._proxy.sentences
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
|
||||
return "<Twilio.Intelligence.V2.TranscriptInstance {}>".format(context)
|
||||
|
||||
|
||||
class TranscriptContext(InstanceContext):
|
||||
def __init__(self, version: Version, sid: str):
|
||||
"""
|
||||
Initialize the TranscriptContext
|
||||
|
||||
:param version: Version that contains the resource
|
||||
:param sid: A 34 character string that uniquely identifies this Transcript.
|
||||
"""
|
||||
super().__init__(version)
|
||||
|
||||
# Path Solution
|
||||
self._solution = {
|
||||
"sid": sid,
|
||||
}
|
||||
self._uri = "/Transcripts/{sid}".format(**self._solution)
|
||||
|
||||
self._media: Optional[MediaList] = None
|
||||
self._operator_results: Optional[OperatorResultList] = None
|
||||
self._sentences: Optional[SentenceList] = None
|
||||
|
||||
def delete(self) -> bool:
|
||||
"""
|
||||
Deletes the TranscriptInstance
|
||||
|
||||
|
||||
:returns: True if delete succeeds, False otherwise
|
||||
"""
|
||||
return self._version.delete(
|
||||
method="DELETE",
|
||||
uri=self._uri,
|
||||
)
|
||||
|
||||
async def delete_async(self) -> bool:
|
||||
"""
|
||||
Asynchronous coroutine that deletes the TranscriptInstance
|
||||
|
||||
|
||||
:returns: True if delete succeeds, False otherwise
|
||||
"""
|
||||
return await self._version.delete_async(
|
||||
method="DELETE",
|
||||
uri=self._uri,
|
||||
)
|
||||
|
||||
def fetch(self) -> TranscriptInstance:
|
||||
"""
|
||||
Fetch the TranscriptInstance
|
||||
|
||||
|
||||
:returns: The fetched TranscriptInstance
|
||||
"""
|
||||
|
||||
payload = self._version.fetch(
|
||||
method="GET",
|
||||
uri=self._uri,
|
||||
)
|
||||
|
||||
return TranscriptInstance(
|
||||
self._version,
|
||||
payload,
|
||||
sid=self._solution["sid"],
|
||||
)
|
||||
|
||||
async def fetch_async(self) -> TranscriptInstance:
|
||||
"""
|
||||
Asynchronous coroutine to fetch the TranscriptInstance
|
||||
|
||||
|
||||
:returns: The fetched TranscriptInstance
|
||||
"""
|
||||
|
||||
payload = await self._version.fetch_async(
|
||||
method="GET",
|
||||
uri=self._uri,
|
||||
)
|
||||
|
||||
return TranscriptInstance(
|
||||
self._version,
|
||||
payload,
|
||||
sid=self._solution["sid"],
|
||||
)
|
||||
|
||||
@property
|
||||
def media(self) -> MediaList:
|
||||
"""
|
||||
Access the media
|
||||
"""
|
||||
if self._media is None:
|
||||
self._media = MediaList(
|
||||
self._version,
|
||||
self._solution["sid"],
|
||||
)
|
||||
return self._media
|
||||
|
||||
@property
|
||||
def operator_results(self) -> OperatorResultList:
|
||||
"""
|
||||
Access the operator_results
|
||||
"""
|
||||
if self._operator_results is None:
|
||||
self._operator_results = OperatorResultList(
|
||||
self._version,
|
||||
self._solution["sid"],
|
||||
)
|
||||
return self._operator_results
|
||||
|
||||
@property
|
||||
def sentences(self) -> SentenceList:
|
||||
"""
|
||||
Access the sentences
|
||||
"""
|
||||
if self._sentences is None:
|
||||
self._sentences = SentenceList(
|
||||
self._version,
|
||||
self._solution["sid"],
|
||||
)
|
||||
return self._sentences
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
|
||||
return "<Twilio.Intelligence.V2.TranscriptContext {}>".format(context)
|
||||
|
||||
|
||||
class TranscriptPage(Page):
|
||||
def get_instance(self, payload: Dict[str, Any]) -> TranscriptInstance:
|
||||
"""
|
||||
Build an instance of TranscriptInstance
|
||||
|
||||
:param payload: Payload response from the API
|
||||
"""
|
||||
return TranscriptInstance(self._version, payload)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
return "<Twilio.Intelligence.V2.TranscriptPage>"
|
||||
|
||||
|
||||
class TranscriptList(ListResource):
|
||||
def __init__(self, version: Version):
|
||||
"""
|
||||
Initialize the TranscriptList
|
||||
|
||||
:param version: Version that contains the resource
|
||||
|
||||
"""
|
||||
super().__init__(version)
|
||||
|
||||
self._uri = "/Transcripts"
|
||||
|
||||
def create(
|
||||
self,
|
||||
service_sid: str,
|
||||
channel: object,
|
||||
customer_key: Union[str, object] = values.unset,
|
||||
media_start_time: Union[datetime, object] = values.unset,
|
||||
) -> TranscriptInstance:
|
||||
"""
|
||||
Create the TranscriptInstance
|
||||
|
||||
:param service_sid: The unique SID identifier of the Service.
|
||||
:param channel: JSON object describing Media Channel including Source and Participants
|
||||
:param customer_key: Used to store client provided metadata. Maximum of 64 double-byte UTF8 characters.
|
||||
:param media_start_time: The date that this Transcript's media was started, given in ISO 8601 format.
|
||||
|
||||
:returns: The created TranscriptInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"ServiceSid": service_sid,
|
||||
"Channel": serialize.object(channel),
|
||||
"CustomerKey": customer_key,
|
||||
"MediaStartTime": serialize.iso8601_datetime(media_start_time),
|
||||
}
|
||||
)
|
||||
|
||||
payload = self._version.create(
|
||||
method="POST",
|
||||
uri=self._uri,
|
||||
data=data,
|
||||
)
|
||||
|
||||
return TranscriptInstance(self._version, payload)
|
||||
|
||||
async def create_async(
|
||||
self,
|
||||
service_sid: str,
|
||||
channel: object,
|
||||
customer_key: Union[str, object] = values.unset,
|
||||
media_start_time: Union[datetime, object] = values.unset,
|
||||
) -> TranscriptInstance:
|
||||
"""
|
||||
Asynchronously create the TranscriptInstance
|
||||
|
||||
:param service_sid: The unique SID identifier of the Service.
|
||||
:param channel: JSON object describing Media Channel including Source and Participants
|
||||
:param customer_key: Used to store client provided metadata. Maximum of 64 double-byte UTF8 characters.
|
||||
:param media_start_time: The date that this Transcript's media was started, given in ISO 8601 format.
|
||||
|
||||
:returns: The created TranscriptInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"ServiceSid": service_sid,
|
||||
"Channel": serialize.object(channel),
|
||||
"CustomerKey": customer_key,
|
||||
"MediaStartTime": serialize.iso8601_datetime(media_start_time),
|
||||
}
|
||||
)
|
||||
|
||||
payload = await self._version.create_async(
|
||||
method="POST",
|
||||
uri=self._uri,
|
||||
data=data,
|
||||
)
|
||||
|
||||
return TranscriptInstance(self._version, payload)
|
||||
|
||||
def stream(
|
||||
self,
|
||||
service_sid: Union[str, object] = values.unset,
|
||||
before_start_time: Union[str, object] = values.unset,
|
||||
after_start_time: Union[str, object] = values.unset,
|
||||
before_date_created: Union[str, object] = values.unset,
|
||||
after_date_created: Union[str, object] = values.unset,
|
||||
status: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
source_sid: Union[str, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> Iterator[TranscriptInstance]:
|
||||
"""
|
||||
Streams TranscriptInstance records from the API as a generator stream.
|
||||
This operation lazily loads records as efficiently as possible until the limit
|
||||
is reached.
|
||||
The results are returned as a generator, so this operation is memory efficient.
|
||||
|
||||
:param str service_sid: The unique SID identifier of the Service.
|
||||
:param str before_start_time: Filter by before StartTime.
|
||||
:param str after_start_time: Filter by after StartTime.
|
||||
:param str before_date_created: Filter by before DateCreated.
|
||||
:param str after_date_created: Filter by after DateCreated.
|
||||
:param str status: Filter by status.
|
||||
:param str language_code: Filter by Language Code.
|
||||
:param str source_sid: Filter by SourceSid.
|
||||
:param limit: Upper limit for the number of records to return. stream()
|
||||
guarantees to never return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, stream() will attempt to read the
|
||||
limit with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: Generator that will yield up to limit results
|
||||
"""
|
||||
limits = self._version.read_limits(limit, page_size)
|
||||
page = self.page(
|
||||
service_sid=service_sid,
|
||||
before_start_time=before_start_time,
|
||||
after_start_time=after_start_time,
|
||||
before_date_created=before_date_created,
|
||||
after_date_created=after_date_created,
|
||||
status=status,
|
||||
language_code=language_code,
|
||||
source_sid=source_sid,
|
||||
page_size=limits["page_size"],
|
||||
)
|
||||
|
||||
return self._version.stream(page, limits["limit"])
|
||||
|
||||
async def stream_async(
|
||||
self,
|
||||
service_sid: Union[str, object] = values.unset,
|
||||
before_start_time: Union[str, object] = values.unset,
|
||||
after_start_time: Union[str, object] = values.unset,
|
||||
before_date_created: Union[str, object] = values.unset,
|
||||
after_date_created: Union[str, object] = values.unset,
|
||||
status: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
source_sid: Union[str, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> AsyncIterator[TranscriptInstance]:
|
||||
"""
|
||||
Asynchronously streams TranscriptInstance records from the API as a generator stream.
|
||||
This operation lazily loads records as efficiently as possible until the limit
|
||||
is reached.
|
||||
The results are returned as a generator, so this operation is memory efficient.
|
||||
|
||||
:param str service_sid: The unique SID identifier of the Service.
|
||||
:param str before_start_time: Filter by before StartTime.
|
||||
:param str after_start_time: Filter by after StartTime.
|
||||
:param str before_date_created: Filter by before DateCreated.
|
||||
:param str after_date_created: Filter by after DateCreated.
|
||||
:param str status: Filter by status.
|
||||
:param str language_code: Filter by Language Code.
|
||||
:param str source_sid: Filter by SourceSid.
|
||||
:param limit: Upper limit for the number of records to return. stream()
|
||||
guarantees to never return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, stream() will attempt to read the
|
||||
limit with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: Generator that will yield up to limit results
|
||||
"""
|
||||
limits = self._version.read_limits(limit, page_size)
|
||||
page = await self.page_async(
|
||||
service_sid=service_sid,
|
||||
before_start_time=before_start_time,
|
||||
after_start_time=after_start_time,
|
||||
before_date_created=before_date_created,
|
||||
after_date_created=after_date_created,
|
||||
status=status,
|
||||
language_code=language_code,
|
||||
source_sid=source_sid,
|
||||
page_size=limits["page_size"],
|
||||
)
|
||||
|
||||
return self._version.stream_async(page, limits["limit"])
|
||||
|
||||
def list(
|
||||
self,
|
||||
service_sid: Union[str, object] = values.unset,
|
||||
before_start_time: Union[str, object] = values.unset,
|
||||
after_start_time: Union[str, object] = values.unset,
|
||||
before_date_created: Union[str, object] = values.unset,
|
||||
after_date_created: Union[str, object] = values.unset,
|
||||
status: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
source_sid: Union[str, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> List[TranscriptInstance]:
|
||||
"""
|
||||
Lists TranscriptInstance records from the API as a list.
|
||||
Unlike stream(), this operation is eager and will load `limit` records into
|
||||
memory before returning.
|
||||
|
||||
:param str service_sid: The unique SID identifier of the Service.
|
||||
:param str before_start_time: Filter by before StartTime.
|
||||
:param str after_start_time: Filter by after StartTime.
|
||||
:param str before_date_created: Filter by before DateCreated.
|
||||
:param str after_date_created: Filter by after DateCreated.
|
||||
:param str status: Filter by status.
|
||||
:param str language_code: Filter by Language Code.
|
||||
:param str source_sid: Filter by SourceSid.
|
||||
:param limit: Upper limit for the number of records to return. list() guarantees
|
||||
never to return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, list() will attempt to read the limit
|
||||
with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: list that will contain up to limit results
|
||||
"""
|
||||
return list(
|
||||
self.stream(
|
||||
service_sid=service_sid,
|
||||
before_start_time=before_start_time,
|
||||
after_start_time=after_start_time,
|
||||
before_date_created=before_date_created,
|
||||
after_date_created=after_date_created,
|
||||
status=status,
|
||||
language_code=language_code,
|
||||
source_sid=source_sid,
|
||||
limit=limit,
|
||||
page_size=page_size,
|
||||
)
|
||||
)
|
||||
|
||||
async def list_async(
|
||||
self,
|
||||
service_sid: Union[str, object] = values.unset,
|
||||
before_start_time: Union[str, object] = values.unset,
|
||||
after_start_time: Union[str, object] = values.unset,
|
||||
before_date_created: Union[str, object] = values.unset,
|
||||
after_date_created: Union[str, object] = values.unset,
|
||||
status: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
source_sid: Union[str, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> List[TranscriptInstance]:
|
||||
"""
|
||||
Asynchronously lists TranscriptInstance records from the API as a list.
|
||||
Unlike stream(), this operation is eager and will load `limit` records into
|
||||
memory before returning.
|
||||
|
||||
:param str service_sid: The unique SID identifier of the Service.
|
||||
:param str before_start_time: Filter by before StartTime.
|
||||
:param str after_start_time: Filter by after StartTime.
|
||||
:param str before_date_created: Filter by before DateCreated.
|
||||
:param str after_date_created: Filter by after DateCreated.
|
||||
:param str status: Filter by status.
|
||||
:param str language_code: Filter by Language Code.
|
||||
:param str source_sid: Filter by SourceSid.
|
||||
:param limit: Upper limit for the number of records to return. list() guarantees
|
||||
never to return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, list() will attempt to read the limit
|
||||
with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: list that will contain up to limit results
|
||||
"""
|
||||
return [
|
||||
record
|
||||
async for record in await self.stream_async(
|
||||
service_sid=service_sid,
|
||||
before_start_time=before_start_time,
|
||||
after_start_time=after_start_time,
|
||||
before_date_created=before_date_created,
|
||||
after_date_created=after_date_created,
|
||||
status=status,
|
||||
language_code=language_code,
|
||||
source_sid=source_sid,
|
||||
limit=limit,
|
||||
page_size=page_size,
|
||||
)
|
||||
]
|
||||
|
||||
def page(
|
||||
self,
|
||||
service_sid: Union[str, object] = values.unset,
|
||||
before_start_time: Union[str, object] = values.unset,
|
||||
after_start_time: Union[str, object] = values.unset,
|
||||
before_date_created: Union[str, object] = values.unset,
|
||||
after_date_created: Union[str, object] = values.unset,
|
||||
status: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
source_sid: Union[str, object] = values.unset,
|
||||
page_token: Union[str, object] = values.unset,
|
||||
page_number: Union[int, object] = values.unset,
|
||||
page_size: Union[int, object] = values.unset,
|
||||
) -> TranscriptPage:
|
||||
"""
|
||||
Retrieve a single page of TranscriptInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param service_sid: The unique SID identifier of the Service.
|
||||
:param before_start_time: Filter by before StartTime.
|
||||
:param after_start_time: Filter by after StartTime.
|
||||
:param before_date_created: Filter by before DateCreated.
|
||||
:param after_date_created: Filter by after DateCreated.
|
||||
:param status: Filter by status.
|
||||
:param language_code: Filter by Language Code.
|
||||
:param source_sid: Filter by SourceSid.
|
||||
:param page_token: PageToken provided by the API
|
||||
:param page_number: Page Number, this value is simply for client state
|
||||
:param page_size: Number of records to return, defaults to 50
|
||||
|
||||
:returns: Page of TranscriptInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"ServiceSid": service_sid,
|
||||
"BeforeStartTime": before_start_time,
|
||||
"AfterStartTime": after_start_time,
|
||||
"BeforeDateCreated": before_date_created,
|
||||
"AfterDateCreated": after_date_created,
|
||||
"Status": status,
|
||||
"LanguageCode": language_code,
|
||||
"SourceSid": source_sid,
|
||||
"PageToken": page_token,
|
||||
"Page": page_number,
|
||||
"PageSize": page_size,
|
||||
}
|
||||
)
|
||||
|
||||
response = self._version.page(method="GET", uri=self._uri, params=data)
|
||||
return TranscriptPage(self._version, response)
|
||||
|
||||
async def page_async(
|
||||
self,
|
||||
service_sid: Union[str, object] = values.unset,
|
||||
before_start_time: Union[str, object] = values.unset,
|
||||
after_start_time: Union[str, object] = values.unset,
|
||||
before_date_created: Union[str, object] = values.unset,
|
||||
after_date_created: Union[str, object] = values.unset,
|
||||
status: Union[str, object] = values.unset,
|
||||
language_code: Union[str, object] = values.unset,
|
||||
source_sid: Union[str, object] = values.unset,
|
||||
page_token: Union[str, object] = values.unset,
|
||||
page_number: Union[int, object] = values.unset,
|
||||
page_size: Union[int, object] = values.unset,
|
||||
) -> TranscriptPage:
|
||||
"""
|
||||
Asynchronously retrieve a single page of TranscriptInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param service_sid: The unique SID identifier of the Service.
|
||||
:param before_start_time: Filter by before StartTime.
|
||||
:param after_start_time: Filter by after StartTime.
|
||||
:param before_date_created: Filter by before DateCreated.
|
||||
:param after_date_created: Filter by after DateCreated.
|
||||
:param status: Filter by status.
|
||||
:param language_code: Filter by Language Code.
|
||||
:param source_sid: Filter by SourceSid.
|
||||
:param page_token: PageToken provided by the API
|
||||
:param page_number: Page Number, this value is simply for client state
|
||||
:param page_size: Number of records to return, defaults to 50
|
||||
|
||||
:returns: Page of TranscriptInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"ServiceSid": service_sid,
|
||||
"BeforeStartTime": before_start_time,
|
||||
"AfterStartTime": after_start_time,
|
||||
"BeforeDateCreated": before_date_created,
|
||||
"AfterDateCreated": after_date_created,
|
||||
"Status": status,
|
||||
"LanguageCode": language_code,
|
||||
"SourceSid": source_sid,
|
||||
"PageToken": page_token,
|
||||
"Page": page_number,
|
||||
"PageSize": page_size,
|
||||
}
|
||||
)
|
||||
|
||||
response = await self._version.page_async(
|
||||
method="GET", uri=self._uri, params=data
|
||||
)
|
||||
return TranscriptPage(self._version, response)
|
||||
|
||||
def get_page(self, target_url: str) -> TranscriptPage:
|
||||
"""
|
||||
Retrieve a specific page of TranscriptInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param target_url: API-generated URL for the requested results page
|
||||
|
||||
:returns: Page of TranscriptInstance
|
||||
"""
|
||||
response = self._version.domain.twilio.request("GET", target_url)
|
||||
return TranscriptPage(self._version, response)
|
||||
|
||||
async def get_page_async(self, target_url: str) -> TranscriptPage:
|
||||
"""
|
||||
Asynchronously retrieve a specific page of TranscriptInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param target_url: API-generated URL for the requested results page
|
||||
|
||||
:returns: Page of TranscriptInstance
|
||||
"""
|
||||
response = await self._version.domain.twilio.request_async("GET", target_url)
|
||||
return TranscriptPage(self._version, response)
|
||||
|
||||
def get(self, sid: str) -> TranscriptContext:
|
||||
"""
|
||||
Constructs a TranscriptContext
|
||||
|
||||
:param sid: A 34 character string that uniquely identifies this Transcript.
|
||||
"""
|
||||
return TranscriptContext(self._version, sid=sid)
|
||||
|
||||
def __call__(self, sid: str) -> TranscriptContext:
|
||||
"""
|
||||
Constructs a TranscriptContext
|
||||
|
||||
:param sid: A 34 character string that uniquely identifies this Transcript.
|
||||
"""
|
||||
return TranscriptContext(self._version, sid=sid)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
return "<Twilio.Intelligence.V2.TranscriptList>"
|
||||
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
@@ -0,0 +1,211 @@
|
||||
r"""
|
||||
This code was generated by
|
||||
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
|
||||
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
|
||||
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
|
||||
|
||||
Twilio - Intelligence
|
||||
This is the public Twilio REST API.
|
||||
|
||||
NOTE: This class is auto generated by OpenAPI Generator.
|
||||
https://openapi-generator.tech
|
||||
Do not edit the class manually.
|
||||
"""
|
||||
|
||||
|
||||
from typing import Any, Dict, Optional, Union
|
||||
from twilio.base import values
|
||||
from twilio.base.instance_context import InstanceContext
|
||||
from twilio.base.instance_resource import InstanceResource
|
||||
from twilio.base.list_resource import ListResource
|
||||
from twilio.base.version import Version
|
||||
|
||||
|
||||
class MediaInstance(InstanceResource):
|
||||
|
||||
"""
|
||||
:ivar account_sid: The unique SID identifier of the Account.
|
||||
:ivar media_url: Downloadable URL for media, if stored in Twilio AI.
|
||||
:ivar service_sid: The unique SID identifier of the Service.
|
||||
:ivar sid: The unique SID identifier of the Transcript.
|
||||
:ivar url: The URL of this resource.
|
||||
"""
|
||||
|
||||
def __init__(self, version: Version, payload: Dict[str, Any], sid: str):
|
||||
super().__init__(version)
|
||||
|
||||
self.account_sid: Optional[str] = payload.get("account_sid")
|
||||
self.media_url: Optional[str] = payload.get("media_url")
|
||||
self.service_sid: Optional[str] = payload.get("service_sid")
|
||||
self.sid: Optional[str] = payload.get("sid")
|
||||
self.url: Optional[str] = payload.get("url")
|
||||
|
||||
self._solution = {
|
||||
"sid": sid,
|
||||
}
|
||||
self._context: Optional[MediaContext] = None
|
||||
|
||||
@property
|
||||
def _proxy(self) -> "MediaContext":
|
||||
"""
|
||||
Generate an instance context for the instance, the context is capable of
|
||||
performing various actions. All instance actions are proxied to the context
|
||||
|
||||
:returns: MediaContext for this MediaInstance
|
||||
"""
|
||||
if self._context is None:
|
||||
self._context = MediaContext(
|
||||
self._version,
|
||||
sid=self._solution["sid"],
|
||||
)
|
||||
return self._context
|
||||
|
||||
def fetch(self, redacted: Union[bool, object] = values.unset) -> "MediaInstance":
|
||||
"""
|
||||
Fetch the MediaInstance
|
||||
|
||||
:param redacted: Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.
|
||||
|
||||
:returns: The fetched MediaInstance
|
||||
"""
|
||||
return self._proxy.fetch(
|
||||
redacted=redacted,
|
||||
)
|
||||
|
||||
async def fetch_async(
|
||||
self, redacted: Union[bool, object] = values.unset
|
||||
) -> "MediaInstance":
|
||||
"""
|
||||
Asynchronous coroutine to fetch the MediaInstance
|
||||
|
||||
:param redacted: Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.
|
||||
|
||||
:returns: The fetched MediaInstance
|
||||
"""
|
||||
return await self._proxy.fetch_async(
|
||||
redacted=redacted,
|
||||
)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
|
||||
return "<Twilio.Intelligence.V2.MediaInstance {}>".format(context)
|
||||
|
||||
|
||||
class MediaContext(InstanceContext):
|
||||
def __init__(self, version: Version, sid: str):
|
||||
"""
|
||||
Initialize the MediaContext
|
||||
|
||||
:param version: Version that contains the resource
|
||||
:param sid: The unique SID identifier of the Transcript.
|
||||
"""
|
||||
super().__init__(version)
|
||||
|
||||
# Path Solution
|
||||
self._solution = {
|
||||
"sid": sid,
|
||||
}
|
||||
self._uri = "/Transcripts/{sid}/Media".format(**self._solution)
|
||||
|
||||
def fetch(self, redacted: Union[bool, object] = values.unset) -> MediaInstance:
|
||||
"""
|
||||
Fetch the MediaInstance
|
||||
|
||||
:param redacted: Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.
|
||||
|
||||
:returns: The fetched MediaInstance
|
||||
"""
|
||||
|
||||
data = values.of(
|
||||
{
|
||||
"Redacted": redacted,
|
||||
}
|
||||
)
|
||||
|
||||
payload = self._version.fetch(method="GET", uri=self._uri, params=data)
|
||||
|
||||
return MediaInstance(
|
||||
self._version,
|
||||
payload,
|
||||
sid=self._solution["sid"],
|
||||
)
|
||||
|
||||
async def fetch_async(
|
||||
self, redacted: Union[bool, object] = values.unset
|
||||
) -> MediaInstance:
|
||||
"""
|
||||
Asynchronous coroutine to fetch the MediaInstance
|
||||
|
||||
:param redacted: Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.
|
||||
|
||||
:returns: The fetched MediaInstance
|
||||
"""
|
||||
|
||||
data = values.of(
|
||||
{
|
||||
"Redacted": redacted,
|
||||
}
|
||||
)
|
||||
|
||||
payload = await self._version.fetch_async(
|
||||
method="GET", uri=self._uri, params=data
|
||||
)
|
||||
|
||||
return MediaInstance(
|
||||
self._version,
|
||||
payload,
|
||||
sid=self._solution["sid"],
|
||||
)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
|
||||
return "<Twilio.Intelligence.V2.MediaContext {}>".format(context)
|
||||
|
||||
|
||||
class MediaList(ListResource):
|
||||
def __init__(self, version: Version, sid: str):
|
||||
"""
|
||||
Initialize the MediaList
|
||||
|
||||
:param version: Version that contains the resource
|
||||
:param sid: The unique SID identifier of the Transcript.
|
||||
|
||||
"""
|
||||
super().__init__(version)
|
||||
|
||||
# Path Solution
|
||||
self._solution = {
|
||||
"sid": sid,
|
||||
}
|
||||
|
||||
def get(self) -> MediaContext:
|
||||
"""
|
||||
Constructs a MediaContext
|
||||
|
||||
"""
|
||||
return MediaContext(self._version, sid=self._solution["sid"])
|
||||
|
||||
def __call__(self) -> MediaContext:
|
||||
"""
|
||||
Constructs a MediaContext
|
||||
|
||||
"""
|
||||
return MediaContext(self._version, sid=self._solution["sid"])
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
return "<Twilio.Intelligence.V2.MediaList>"
|
||||
+500
@@ -0,0 +1,500 @@
|
||||
r"""
|
||||
This code was generated by
|
||||
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
|
||||
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
|
||||
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
|
||||
|
||||
Twilio - Intelligence
|
||||
This is the public Twilio REST API.
|
||||
|
||||
NOTE: This class is auto generated by OpenAPI Generator.
|
||||
https://openapi-generator.tech
|
||||
Do not edit the class manually.
|
||||
"""
|
||||
|
||||
|
||||
from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator
|
||||
from twilio.base import deserialize, values
|
||||
from twilio.base.instance_context import InstanceContext
|
||||
from twilio.base.instance_resource import InstanceResource
|
||||
from twilio.base.list_resource import ListResource
|
||||
from twilio.base.version import Version
|
||||
from twilio.base.page import Page
|
||||
|
||||
|
||||
class OperatorResultInstance(InstanceResource):
|
||||
class OperatorType(object):
|
||||
CONVERSATION_CLASSIFY = "conversation_classify"
|
||||
UTTERANCE_CLASSIFY = "utterance_classify"
|
||||
EXTRACT = "extract"
|
||||
EXTRACT_NORMALIZE = "extract_normalize"
|
||||
PII_EXTRACT = "pii_extract"
|
||||
|
||||
"""
|
||||
:ivar operator_type:
|
||||
:ivar name: The name of the applied Language Understanding.
|
||||
:ivar operator_sid: A 34 character string that identifies this Language Understanding operator sid.
|
||||
:ivar extract_match: Boolean to tell if extract Language Understanding Processing model matches results.
|
||||
:ivar match_probability: Percentage of 'matching' class needed to consider a sentence matches
|
||||
:ivar normalized_result: Normalized output of extraction stage which matches Label.
|
||||
:ivar utterance_results: List of mapped utterance object which matches sentences.
|
||||
:ivar utterance_match: Boolean to tell if Utterance matches results.
|
||||
:ivar predicted_label: The 'matching' class. This might be available on conversation classify model outputs.
|
||||
:ivar predicted_probability: Percentage of 'matching' class needed to consider a sentence matches.
|
||||
:ivar label_probabilities: The labels probabilities. This might be available on conversation classify model outputs.
|
||||
:ivar extract_results: List of text extraction results. This might be available on classify-extract model outputs.
|
||||
:ivar transcript_sid: A 34 character string that uniquely identifies this Transcript.
|
||||
:ivar url: The URL of this resource.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
version: Version,
|
||||
payload: Dict[str, Any],
|
||||
transcript_sid: str,
|
||||
operator_sid: Optional[str] = None,
|
||||
):
|
||||
super().__init__(version)
|
||||
|
||||
self.operator_type: Optional[
|
||||
"OperatorResultInstance.OperatorType"
|
||||
] = payload.get("operator_type")
|
||||
self.name: Optional[str] = payload.get("name")
|
||||
self.operator_sid: Optional[str] = payload.get("operator_sid")
|
||||
self.extract_match: Optional[bool] = payload.get("extract_match")
|
||||
self.match_probability: Optional[float] = deserialize.decimal(
|
||||
payload.get("match_probability")
|
||||
)
|
||||
self.normalized_result: Optional[str] = payload.get("normalized_result")
|
||||
self.utterance_results: Optional[List[object]] = payload.get(
|
||||
"utterance_results"
|
||||
)
|
||||
self.utterance_match: Optional[bool] = payload.get("utterance_match")
|
||||
self.predicted_label: Optional[str] = payload.get("predicted_label")
|
||||
self.predicted_probability: Optional[float] = deserialize.decimal(
|
||||
payload.get("predicted_probability")
|
||||
)
|
||||
self.label_probabilities: Optional[Dict[str, object]] = payload.get(
|
||||
"label_probabilities"
|
||||
)
|
||||
self.extract_results: Optional[Dict[str, object]] = payload.get(
|
||||
"extract_results"
|
||||
)
|
||||
self.transcript_sid: Optional[str] = payload.get("transcript_sid")
|
||||
self.url: Optional[str] = payload.get("url")
|
||||
|
||||
self._solution = {
|
||||
"transcript_sid": transcript_sid,
|
||||
"operator_sid": operator_sid or self.operator_sid,
|
||||
}
|
||||
self._context: Optional[OperatorResultContext] = None
|
||||
|
||||
@property
|
||||
def _proxy(self) -> "OperatorResultContext":
|
||||
"""
|
||||
Generate an instance context for the instance, the context is capable of
|
||||
performing various actions. All instance actions are proxied to the context
|
||||
|
||||
:returns: OperatorResultContext for this OperatorResultInstance
|
||||
"""
|
||||
if self._context is None:
|
||||
self._context = OperatorResultContext(
|
||||
self._version,
|
||||
transcript_sid=self._solution["transcript_sid"],
|
||||
operator_sid=self._solution["operator_sid"],
|
||||
)
|
||||
return self._context
|
||||
|
||||
def fetch(
|
||||
self, redacted: Union[bool, object] = values.unset
|
||||
) -> "OperatorResultInstance":
|
||||
"""
|
||||
Fetch the OperatorResultInstance
|
||||
|
||||
:param redacted: Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
||||
|
||||
:returns: The fetched OperatorResultInstance
|
||||
"""
|
||||
return self._proxy.fetch(
|
||||
redacted=redacted,
|
||||
)
|
||||
|
||||
async def fetch_async(
|
||||
self, redacted: Union[bool, object] = values.unset
|
||||
) -> "OperatorResultInstance":
|
||||
"""
|
||||
Asynchronous coroutine to fetch the OperatorResultInstance
|
||||
|
||||
:param redacted: Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
||||
|
||||
:returns: The fetched OperatorResultInstance
|
||||
"""
|
||||
return await self._proxy.fetch_async(
|
||||
redacted=redacted,
|
||||
)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
|
||||
return "<Twilio.Intelligence.V2.OperatorResultInstance {}>".format(context)
|
||||
|
||||
|
||||
class OperatorResultContext(InstanceContext):
|
||||
def __init__(self, version: Version, transcript_sid: str, operator_sid: str):
|
||||
"""
|
||||
Initialize the OperatorResultContext
|
||||
|
||||
:param version: Version that contains the resource
|
||||
:param transcript_sid: A 34 character string that uniquely identifies this Transcript.
|
||||
:param operator_sid: A 34 character string that identifies this Language Understanding operator sid.
|
||||
"""
|
||||
super().__init__(version)
|
||||
|
||||
# Path Solution
|
||||
self._solution = {
|
||||
"transcript_sid": transcript_sid,
|
||||
"operator_sid": operator_sid,
|
||||
}
|
||||
self._uri = (
|
||||
"/Transcripts/{transcript_sid}/OperatorResults/{operator_sid}".format(
|
||||
**self._solution
|
||||
)
|
||||
)
|
||||
|
||||
def fetch(
|
||||
self, redacted: Union[bool, object] = values.unset
|
||||
) -> OperatorResultInstance:
|
||||
"""
|
||||
Fetch the OperatorResultInstance
|
||||
|
||||
:param redacted: Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
||||
|
||||
:returns: The fetched OperatorResultInstance
|
||||
"""
|
||||
|
||||
data = values.of(
|
||||
{
|
||||
"Redacted": redacted,
|
||||
}
|
||||
)
|
||||
|
||||
payload = self._version.fetch(method="GET", uri=self._uri, params=data)
|
||||
|
||||
return OperatorResultInstance(
|
||||
self._version,
|
||||
payload,
|
||||
transcript_sid=self._solution["transcript_sid"],
|
||||
operator_sid=self._solution["operator_sid"],
|
||||
)
|
||||
|
||||
async def fetch_async(
|
||||
self, redacted: Union[bool, object] = values.unset
|
||||
) -> OperatorResultInstance:
|
||||
"""
|
||||
Asynchronous coroutine to fetch the OperatorResultInstance
|
||||
|
||||
:param redacted: Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
||||
|
||||
:returns: The fetched OperatorResultInstance
|
||||
"""
|
||||
|
||||
data = values.of(
|
||||
{
|
||||
"Redacted": redacted,
|
||||
}
|
||||
)
|
||||
|
||||
payload = await self._version.fetch_async(
|
||||
method="GET", uri=self._uri, params=data
|
||||
)
|
||||
|
||||
return OperatorResultInstance(
|
||||
self._version,
|
||||
payload,
|
||||
transcript_sid=self._solution["transcript_sid"],
|
||||
operator_sid=self._solution["operator_sid"],
|
||||
)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
|
||||
return "<Twilio.Intelligence.V2.OperatorResultContext {}>".format(context)
|
||||
|
||||
|
||||
class OperatorResultPage(Page):
|
||||
def get_instance(self, payload: Dict[str, Any]) -> OperatorResultInstance:
|
||||
"""
|
||||
Build an instance of OperatorResultInstance
|
||||
|
||||
:param payload: Payload response from the API
|
||||
"""
|
||||
return OperatorResultInstance(
|
||||
self._version, payload, transcript_sid=self._solution["transcript_sid"]
|
||||
)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
return "<Twilio.Intelligence.V2.OperatorResultPage>"
|
||||
|
||||
|
||||
class OperatorResultList(ListResource):
|
||||
def __init__(self, version: Version, transcript_sid: str):
|
||||
"""
|
||||
Initialize the OperatorResultList
|
||||
|
||||
:param version: Version that contains the resource
|
||||
:param transcript_sid: A 34 character string that uniquely identifies this Transcript.
|
||||
|
||||
"""
|
||||
super().__init__(version)
|
||||
|
||||
# Path Solution
|
||||
self._solution = {
|
||||
"transcript_sid": transcript_sid,
|
||||
}
|
||||
self._uri = "/Transcripts/{transcript_sid}/OperatorResults".format(
|
||||
**self._solution
|
||||
)
|
||||
|
||||
def stream(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> Iterator[OperatorResultInstance]:
|
||||
"""
|
||||
Streams OperatorResultInstance records from the API as a generator stream.
|
||||
This operation lazily loads records as efficiently as possible until the limit
|
||||
is reached.
|
||||
The results are returned as a generator, so this operation is memory efficient.
|
||||
|
||||
:param bool redacted: Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
||||
:param limit: Upper limit for the number of records to return. stream()
|
||||
guarantees to never return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, stream() will attempt to read the
|
||||
limit with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: Generator that will yield up to limit results
|
||||
"""
|
||||
limits = self._version.read_limits(limit, page_size)
|
||||
page = self.page(redacted=redacted, page_size=limits["page_size"])
|
||||
|
||||
return self._version.stream(page, limits["limit"])
|
||||
|
||||
async def stream_async(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> AsyncIterator[OperatorResultInstance]:
|
||||
"""
|
||||
Asynchronously streams OperatorResultInstance records from the API as a generator stream.
|
||||
This operation lazily loads records as efficiently as possible until the limit
|
||||
is reached.
|
||||
The results are returned as a generator, so this operation is memory efficient.
|
||||
|
||||
:param bool redacted: Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
||||
:param limit: Upper limit for the number of records to return. stream()
|
||||
guarantees to never return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, stream() will attempt to read the
|
||||
limit with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: Generator that will yield up to limit results
|
||||
"""
|
||||
limits = self._version.read_limits(limit, page_size)
|
||||
page = await self.page_async(redacted=redacted, page_size=limits["page_size"])
|
||||
|
||||
return self._version.stream_async(page, limits["limit"])
|
||||
|
||||
def list(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> List[OperatorResultInstance]:
|
||||
"""
|
||||
Lists OperatorResultInstance records from the API as a list.
|
||||
Unlike stream(), this operation is eager and will load `limit` records into
|
||||
memory before returning.
|
||||
|
||||
:param bool redacted: Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
||||
:param limit: Upper limit for the number of records to return. list() guarantees
|
||||
never to return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, list() will attempt to read the limit
|
||||
with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: list that will contain up to limit results
|
||||
"""
|
||||
return list(
|
||||
self.stream(
|
||||
redacted=redacted,
|
||||
limit=limit,
|
||||
page_size=page_size,
|
||||
)
|
||||
)
|
||||
|
||||
async def list_async(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> List[OperatorResultInstance]:
|
||||
"""
|
||||
Asynchronously lists OperatorResultInstance records from the API as a list.
|
||||
Unlike stream(), this operation is eager and will load `limit` records into
|
||||
memory before returning.
|
||||
|
||||
:param bool redacted: Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
||||
:param limit: Upper limit for the number of records to return. list() guarantees
|
||||
never to return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, list() will attempt to read the limit
|
||||
with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: list that will contain up to limit results
|
||||
"""
|
||||
return [
|
||||
record
|
||||
async for record in await self.stream_async(
|
||||
redacted=redacted,
|
||||
limit=limit,
|
||||
page_size=page_size,
|
||||
)
|
||||
]
|
||||
|
||||
def page(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
page_token: Union[str, object] = values.unset,
|
||||
page_number: Union[int, object] = values.unset,
|
||||
page_size: Union[int, object] = values.unset,
|
||||
) -> OperatorResultPage:
|
||||
"""
|
||||
Retrieve a single page of OperatorResultInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param redacted: Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
||||
:param page_token: PageToken provided by the API
|
||||
:param page_number: Page Number, this value is simply for client state
|
||||
:param page_size: Number of records to return, defaults to 50
|
||||
|
||||
:returns: Page of OperatorResultInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"Redacted": redacted,
|
||||
"PageToken": page_token,
|
||||
"Page": page_number,
|
||||
"PageSize": page_size,
|
||||
}
|
||||
)
|
||||
|
||||
response = self._version.page(method="GET", uri=self._uri, params=data)
|
||||
return OperatorResultPage(self._version, response, self._solution)
|
||||
|
||||
async def page_async(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
page_token: Union[str, object] = values.unset,
|
||||
page_number: Union[int, object] = values.unset,
|
||||
page_size: Union[int, object] = values.unset,
|
||||
) -> OperatorResultPage:
|
||||
"""
|
||||
Asynchronously retrieve a single page of OperatorResultInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param redacted: Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
|
||||
:param page_token: PageToken provided by the API
|
||||
:param page_number: Page Number, this value is simply for client state
|
||||
:param page_size: Number of records to return, defaults to 50
|
||||
|
||||
:returns: Page of OperatorResultInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"Redacted": redacted,
|
||||
"PageToken": page_token,
|
||||
"Page": page_number,
|
||||
"PageSize": page_size,
|
||||
}
|
||||
)
|
||||
|
||||
response = await self._version.page_async(
|
||||
method="GET", uri=self._uri, params=data
|
||||
)
|
||||
return OperatorResultPage(self._version, response, self._solution)
|
||||
|
||||
def get_page(self, target_url: str) -> OperatorResultPage:
|
||||
"""
|
||||
Retrieve a specific page of OperatorResultInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param target_url: API-generated URL for the requested results page
|
||||
|
||||
:returns: Page of OperatorResultInstance
|
||||
"""
|
||||
response = self._version.domain.twilio.request("GET", target_url)
|
||||
return OperatorResultPage(self._version, response, self._solution)
|
||||
|
||||
async def get_page_async(self, target_url: str) -> OperatorResultPage:
|
||||
"""
|
||||
Asynchronously retrieve a specific page of OperatorResultInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param target_url: API-generated URL for the requested results page
|
||||
|
||||
:returns: Page of OperatorResultInstance
|
||||
"""
|
||||
response = await self._version.domain.twilio.request_async("GET", target_url)
|
||||
return OperatorResultPage(self._version, response, self._solution)
|
||||
|
||||
def get(self, operator_sid: str) -> OperatorResultContext:
|
||||
"""
|
||||
Constructs a OperatorResultContext
|
||||
|
||||
:param operator_sid: A 34 character string that identifies this Language Understanding operator sid.
|
||||
"""
|
||||
return OperatorResultContext(
|
||||
self._version,
|
||||
transcript_sid=self._solution["transcript_sid"],
|
||||
operator_sid=operator_sid,
|
||||
)
|
||||
|
||||
def __call__(self, operator_sid: str) -> OperatorResultContext:
|
||||
"""
|
||||
Constructs a OperatorResultContext
|
||||
|
||||
:param operator_sid: A 34 character string that identifies this Language Understanding operator sid.
|
||||
"""
|
||||
return OperatorResultContext(
|
||||
self._version,
|
||||
transcript_sid=self._solution["transcript_sid"],
|
||||
operator_sid=operator_sid,
|
||||
)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
return "<Twilio.Intelligence.V2.OperatorResultList>"
|
||||
@@ -0,0 +1,312 @@
|
||||
r"""
|
||||
This code was generated by
|
||||
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
|
||||
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
|
||||
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
|
||||
|
||||
Twilio - Intelligence
|
||||
This is the public Twilio REST API.
|
||||
|
||||
NOTE: This class is auto generated by OpenAPI Generator.
|
||||
https://openapi-generator.tech
|
||||
Do not edit the class manually.
|
||||
"""
|
||||
|
||||
|
||||
from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator
|
||||
from twilio.base import deserialize, values
|
||||
|
||||
from twilio.base.instance_resource import InstanceResource
|
||||
from twilio.base.list_resource import ListResource
|
||||
from twilio.base.version import Version
|
||||
from twilio.base.page import Page
|
||||
|
||||
|
||||
class SentenceInstance(InstanceResource):
|
||||
|
||||
"""
|
||||
:ivar media_channel: The channel number.
|
||||
:ivar sentence_index: The index of the sentence in the transcript.
|
||||
:ivar start_time: Offset from the beginning of the transcript when this sentence starts.
|
||||
:ivar end_time: Offset from the beginning of the transcript when this sentence ends.
|
||||
:ivar transcript: Transcript text.
|
||||
:ivar sid: A 34 character string that uniquely identifies this Sentence.
|
||||
:ivar confidence:
|
||||
"""
|
||||
|
||||
def __init__(self, version: Version, payload: Dict[str, Any], transcript_sid: str):
|
||||
super().__init__(version)
|
||||
|
||||
self.media_channel: Optional[int] = deserialize.integer(
|
||||
payload.get("media_channel")
|
||||
)
|
||||
self.sentence_index: Optional[int] = deserialize.integer(
|
||||
payload.get("sentence_index")
|
||||
)
|
||||
self.start_time: Optional[float] = deserialize.decimal(
|
||||
payload.get("start_time")
|
||||
)
|
||||
self.end_time: Optional[float] = deserialize.decimal(payload.get("end_time"))
|
||||
self.transcript: Optional[str] = payload.get("transcript")
|
||||
self.sid: Optional[str] = payload.get("sid")
|
||||
self.confidence: Optional[float] = deserialize.decimal(
|
||||
payload.get("confidence")
|
||||
)
|
||||
|
||||
self._solution = {
|
||||
"transcript_sid": transcript_sid,
|
||||
}
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
|
||||
return "<Twilio.Intelligence.V2.SentenceInstance {}>".format(context)
|
||||
|
||||
|
||||
class SentencePage(Page):
|
||||
def get_instance(self, payload: Dict[str, Any]) -> SentenceInstance:
|
||||
"""
|
||||
Build an instance of SentenceInstance
|
||||
|
||||
:param payload: Payload response from the API
|
||||
"""
|
||||
return SentenceInstance(
|
||||
self._version, payload, transcript_sid=self._solution["transcript_sid"]
|
||||
)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
return "<Twilio.Intelligence.V2.SentencePage>"
|
||||
|
||||
|
||||
class SentenceList(ListResource):
|
||||
def __init__(self, version: Version, transcript_sid: str):
|
||||
"""
|
||||
Initialize the SentenceList
|
||||
|
||||
:param version: Version that contains the resource
|
||||
:param transcript_sid: The unique SID identifier of the Transcript.
|
||||
|
||||
"""
|
||||
super().__init__(version)
|
||||
|
||||
# Path Solution
|
||||
self._solution = {
|
||||
"transcript_sid": transcript_sid,
|
||||
}
|
||||
self._uri = "/Transcripts/{transcript_sid}/Sentences".format(**self._solution)
|
||||
|
||||
def stream(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> Iterator[SentenceInstance]:
|
||||
"""
|
||||
Streams SentenceInstance records from the API as a generator stream.
|
||||
This operation lazily loads records as efficiently as possible until the limit
|
||||
is reached.
|
||||
The results are returned as a generator, so this operation is memory efficient.
|
||||
|
||||
:param bool redacted: Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
|
||||
:param limit: Upper limit for the number of records to return. stream()
|
||||
guarantees to never return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, stream() will attempt to read the
|
||||
limit with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: Generator that will yield up to limit results
|
||||
"""
|
||||
limits = self._version.read_limits(limit, page_size)
|
||||
page = self.page(redacted=redacted, page_size=limits["page_size"])
|
||||
|
||||
return self._version.stream(page, limits["limit"])
|
||||
|
||||
async def stream_async(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> AsyncIterator[SentenceInstance]:
|
||||
"""
|
||||
Asynchronously streams SentenceInstance records from the API as a generator stream.
|
||||
This operation lazily loads records as efficiently as possible until the limit
|
||||
is reached.
|
||||
The results are returned as a generator, so this operation is memory efficient.
|
||||
|
||||
:param bool redacted: Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
|
||||
:param limit: Upper limit for the number of records to return. stream()
|
||||
guarantees to never return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, stream() will attempt to read the
|
||||
limit with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: Generator that will yield up to limit results
|
||||
"""
|
||||
limits = self._version.read_limits(limit, page_size)
|
||||
page = await self.page_async(redacted=redacted, page_size=limits["page_size"])
|
||||
|
||||
return self._version.stream_async(page, limits["limit"])
|
||||
|
||||
def list(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> List[SentenceInstance]:
|
||||
"""
|
||||
Lists SentenceInstance records from the API as a list.
|
||||
Unlike stream(), this operation is eager and will load `limit` records into
|
||||
memory before returning.
|
||||
|
||||
:param bool redacted: Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
|
||||
:param limit: Upper limit for the number of records to return. list() guarantees
|
||||
never to return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, list() will attempt to read the limit
|
||||
with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: list that will contain up to limit results
|
||||
"""
|
||||
return list(
|
||||
self.stream(
|
||||
redacted=redacted,
|
||||
limit=limit,
|
||||
page_size=page_size,
|
||||
)
|
||||
)
|
||||
|
||||
async def list_async(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
limit: Optional[int] = None,
|
||||
page_size: Optional[int] = None,
|
||||
) -> List[SentenceInstance]:
|
||||
"""
|
||||
Asynchronously lists SentenceInstance records from the API as a list.
|
||||
Unlike stream(), this operation is eager and will load `limit` records into
|
||||
memory before returning.
|
||||
|
||||
:param bool redacted: Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
|
||||
:param limit: Upper limit for the number of records to return. list() guarantees
|
||||
never to return more than limit. Default is no limit
|
||||
:param page_size: Number of records to fetch per request, when not set will use
|
||||
the default value of 50 records. If no page_size is defined
|
||||
but a limit is defined, list() will attempt to read the limit
|
||||
with the most efficient page size, i.e. min(limit, 1000)
|
||||
|
||||
:returns: list that will contain up to limit results
|
||||
"""
|
||||
return [
|
||||
record
|
||||
async for record in await self.stream_async(
|
||||
redacted=redacted,
|
||||
limit=limit,
|
||||
page_size=page_size,
|
||||
)
|
||||
]
|
||||
|
||||
def page(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
page_token: Union[str, object] = values.unset,
|
||||
page_number: Union[int, object] = values.unset,
|
||||
page_size: Union[int, object] = values.unset,
|
||||
) -> SentencePage:
|
||||
"""
|
||||
Retrieve a single page of SentenceInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param redacted: Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
|
||||
:param page_token: PageToken provided by the API
|
||||
:param page_number: Page Number, this value is simply for client state
|
||||
:param page_size: Number of records to return, defaults to 50
|
||||
|
||||
:returns: Page of SentenceInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"Redacted": redacted,
|
||||
"PageToken": page_token,
|
||||
"Page": page_number,
|
||||
"PageSize": page_size,
|
||||
}
|
||||
)
|
||||
|
||||
response = self._version.page(method="GET", uri=self._uri, params=data)
|
||||
return SentencePage(self._version, response, self._solution)
|
||||
|
||||
async def page_async(
|
||||
self,
|
||||
redacted: Union[bool, object] = values.unset,
|
||||
page_token: Union[str, object] = values.unset,
|
||||
page_number: Union[int, object] = values.unset,
|
||||
page_size: Union[int, object] = values.unset,
|
||||
) -> SentencePage:
|
||||
"""
|
||||
Asynchronously retrieve a single page of SentenceInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param redacted: Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
|
||||
:param page_token: PageToken provided by the API
|
||||
:param page_number: Page Number, this value is simply for client state
|
||||
:param page_size: Number of records to return, defaults to 50
|
||||
|
||||
:returns: Page of SentenceInstance
|
||||
"""
|
||||
data = values.of(
|
||||
{
|
||||
"Redacted": redacted,
|
||||
"PageToken": page_token,
|
||||
"Page": page_number,
|
||||
"PageSize": page_size,
|
||||
}
|
||||
)
|
||||
|
||||
response = await self._version.page_async(
|
||||
method="GET", uri=self._uri, params=data
|
||||
)
|
||||
return SentencePage(self._version, response, self._solution)
|
||||
|
||||
def get_page(self, target_url: str) -> SentencePage:
|
||||
"""
|
||||
Retrieve a specific page of SentenceInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param target_url: API-generated URL for the requested results page
|
||||
|
||||
:returns: Page of SentenceInstance
|
||||
"""
|
||||
response = self._version.domain.twilio.request("GET", target_url)
|
||||
return SentencePage(self._version, response, self._solution)
|
||||
|
||||
async def get_page_async(self, target_url: str) -> SentencePage:
|
||||
"""
|
||||
Asynchronously retrieve a specific page of SentenceInstance records from the API.
|
||||
Request is executed immediately
|
||||
|
||||
:param target_url: API-generated URL for the requested results page
|
||||
|
||||
:returns: Page of SentenceInstance
|
||||
"""
|
||||
response = await self._version.domain.twilio.request_async("GET", target_url)
|
||||
return SentencePage(self._version, response, self._solution)
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""
|
||||
Provide a friendly representation
|
||||
|
||||
:returns: Machine friendly representation
|
||||
"""
|
||||
return "<Twilio.Intelligence.V2.SentenceList>"
|
||||
Reference in New Issue
Block a user