File: C:/Users/fred/anaconda3/Lib/site-packages/twilio/rest/trusthub/v1/supporting_document.py
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Trusthub
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
class SupportingDocumentInstance(InstanceResource):
class Status(object):
DRAFT = "DRAFT"
PENDING_REVIEW = "PENDING_REVIEW"
REJECTED = "REJECTED"
APPROVED = "APPROVED"
EXPIRED = "EXPIRED"
PROVISIONALLY_APPROVED = "PROVISIONALLY_APPROVED"
"""
:ivar sid: The unique string created by Twilio to identify the Supporting Document resource.
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource.
:ivar friendly_name: The string that you assigned to describe the resource.
:ivar mime_type: The image type uploaded in the Supporting Document container.
:ivar status:
:ivar type: The type of the Supporting Document.
:ivar attributes: The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.
:ivar date_created: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar date_updated: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar url: The absolute URL of the Supporting Document resource.
"""
def __init__(
self, version: Version, payload: Dict[str, Any], sid: Optional[str] = None
):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.account_sid: Optional[str] = payload.get("account_sid")
self.friendly_name: Optional[str] = payload.get("friendly_name")
self.mime_type: Optional[str] = payload.get("mime_type")
self.status: Optional["SupportingDocumentInstance.Status"] = payload.get(
"status"
)
self.type: Optional[str] = payload.get("type")
self.attributes: Optional[Dict[str, object]] = payload.get("attributes")
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.url: Optional[str] = payload.get("url")
self._solution = {
"sid": sid or self.sid,
}
self._context: Optional[SupportingDocumentContext] = None
@property
def _proxy(self) -> "SupportingDocumentContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: SupportingDocumentContext for this SupportingDocumentInstance
"""
if self._context is None:
self._context = SupportingDocumentContext(
self._version,
sid=self._solution["sid"],
)
return self._context
def delete(self) -> bool:
"""
Deletes the SupportingDocumentInstance
:returns: True if delete succeeds, False otherwise
"""
return self._proxy.delete()
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the SupportingDocumentInstance
:returns: True if delete succeeds, False otherwise
"""
return await self._proxy.delete_async()
def fetch(self) -> "SupportingDocumentInstance":
"""
Fetch the SupportingDocumentInstance
:returns: The fetched SupportingDocumentInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "SupportingDocumentInstance":
"""
Asynchronous coroutine to fetch the SupportingDocumentInstance
:returns: The fetched SupportingDocumentInstance
"""
return await self._proxy.fetch_async()
def update(
self,
friendly_name: Union[str, object] = values.unset,
attributes: Union[object, object] = values.unset,
) -> "SupportingDocumentInstance":
"""
Update the SupportingDocumentInstance
:param friendly_name: The string that you assigned to describe the resource.
:param attributes: The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.
:returns: The updated SupportingDocumentInstance
"""
return self._proxy.update(
friendly_name=friendly_name,
attributes=attributes,
)
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
attributes: Union[object, object] = values.unset,
) -> "SupportingDocumentInstance":
"""
Asynchronous coroutine to update the SupportingDocumentInstance
:param friendly_name: The string that you assigned to describe the resource.
:param attributes: The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.
:returns: The updated SupportingDocumentInstance
"""
return await self._proxy.update_async(
friendly_name=friendly_name,
attributes=attributes,
)
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.Trusthub.V1.SupportingDocumentInstance {}>".format(context)
class SupportingDocumentContext(InstanceContext):
def __init__(self, version: Version, sid: str):
"""
Initialize the SupportingDocumentContext
:param version: Version that contains the resource
:param sid: The unique string created by Twilio to identify the Supporting Document resource.
"""
super().__init__(version)
# Path Solution
self._solution = {
"sid": sid,
}
self._uri = "/SupportingDocuments/{sid}".format(**self._solution)
def delete(self) -> bool:
"""
Deletes the SupportingDocumentInstance
:returns: True if delete succeeds, False otherwise
"""
headers = values.of({})
return self._version.delete(method="DELETE", uri=self._uri, headers=headers)
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the SupportingDocumentInstance
:returns: True if delete succeeds, False otherwise
"""
headers = values.of({})
return await self._version.delete_async(
method="DELETE", uri=self._uri, headers=headers
)
def fetch(self) -> SupportingDocumentInstance:
"""
Fetch the SupportingDocumentInstance
:returns: The fetched SupportingDocumentInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return SupportingDocumentInstance(
self._version,
payload,
sid=self._solution["sid"],
)
async def fetch_async(self) -> SupportingDocumentInstance:
"""
Asynchronous coroutine to fetch the SupportingDocumentInstance
:returns: The fetched SupportingDocumentInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return SupportingDocumentInstance(
self._version,
payload,
sid=self._solution["sid"],
)
def update(
self,
friendly_name: Union[str, object] = values.unset,
attributes: Union[object, object] = values.unset,
) -> SupportingDocumentInstance:
"""
Update the SupportingDocumentInstance
:param friendly_name: The string that you assigned to describe the resource.
:param attributes: The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.
:returns: The updated SupportingDocumentInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"Attributes": serialize.object(attributes),
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.update(
method="POST", uri=self._uri, data=data, headers=headers
)
return SupportingDocumentInstance(
self._version, payload, sid=self._solution["sid"]
)
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
attributes: Union[object, object] = values.unset,
) -> SupportingDocumentInstance:
"""
Asynchronous coroutine to update the SupportingDocumentInstance
:param friendly_name: The string that you assigned to describe the resource.
:param attributes: The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.
:returns: The updated SupportingDocumentInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"Attributes": serialize.object(attributes),
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.update_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return SupportingDocumentInstance(
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.Trusthub.V1.SupportingDocumentContext {}>".format(context)
class SupportingDocumentPage(Page):
def get_instance(self, payload: Dict[str, Any]) -> SupportingDocumentInstance:
"""
Build an instance of SupportingDocumentInstance
:param payload: Payload response from the API
"""
return SupportingDocumentInstance(self._version, payload)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Trusthub.V1.SupportingDocumentPage>"
class SupportingDocumentList(ListResource):
def __init__(self, version: Version):
"""
Initialize the SupportingDocumentList
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/SupportingDocuments"
def create(
self,
friendly_name: str,
type: str,
attributes: Union[object, object] = values.unset,
) -> SupportingDocumentInstance:
"""
Create the SupportingDocumentInstance
:param friendly_name: The string that you assigned to describe the resource.
:param type: The type of the Supporting Document.
:param attributes: The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.
:returns: The created SupportingDocumentInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"Type": type,
"Attributes": serialize.object(attributes),
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.create(
method="POST", uri=self._uri, data=data, headers=headers
)
return SupportingDocumentInstance(self._version, payload)
async def create_async(
self,
friendly_name: str,
type: str,
attributes: Union[object, object] = values.unset,
) -> SupportingDocumentInstance:
"""
Asynchronously create the SupportingDocumentInstance
:param friendly_name: The string that you assigned to describe the resource.
:param type: The type of the Supporting Document.
:param attributes: The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.
:returns: The created SupportingDocumentInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"Type": type,
"Attributes": serialize.object(attributes),
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.create_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return SupportingDocumentInstance(self._version, payload)
def stream(
self,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> Iterator[SupportingDocumentInstance]:
"""
Streams SupportingDocumentInstance 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[SupportingDocumentInstance]:
"""
Asynchronously streams SupportingDocumentInstance 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[SupportingDocumentInstance]:
"""
Lists SupportingDocumentInstance 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[SupportingDocumentInstance]:
"""
Asynchronously lists SupportingDocumentInstance 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,
) -> SupportingDocumentPage:
"""
Retrieve a single page of SupportingDocumentInstance 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 SupportingDocumentInstance
"""
data = values.of(
{
"PageToken": page_token,
"Page": page_number,
"PageSize": page_size,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Accept"] = "application/json"
response = self._version.page(
method="GET", uri=self._uri, params=data, headers=headers
)
return SupportingDocumentPage(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,
) -> SupportingDocumentPage:
"""
Asynchronously retrieve a single page of SupportingDocumentInstance 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 SupportingDocumentInstance
"""
data = values.of(
{
"PageToken": page_token,
"Page": page_number,
"PageSize": page_size,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Accept"] = "application/json"
response = await self._version.page_async(
method="GET", uri=self._uri, params=data, headers=headers
)
return SupportingDocumentPage(self._version, response)
def get_page(self, target_url: str) -> SupportingDocumentPage:
"""
Retrieve a specific page of SupportingDocumentInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of SupportingDocumentInstance
"""
response = self._version.domain.twilio.request("GET", target_url)
return SupportingDocumentPage(self._version, response)
async def get_page_async(self, target_url: str) -> SupportingDocumentPage:
"""
Asynchronously retrieve a specific page of SupportingDocumentInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of SupportingDocumentInstance
"""
response = await self._version.domain.twilio.request_async("GET", target_url)
return SupportingDocumentPage(self._version, response)
def get(self, sid: str) -> SupportingDocumentContext:
"""
Constructs a SupportingDocumentContext
:param sid: The unique string created by Twilio to identify the Supporting Document resource.
"""
return SupportingDocumentContext(self._version, sid=sid)
def __call__(self, sid: str) -> SupportingDocumentContext:
"""
Constructs a SupportingDocumentContext
:param sid: The unique string created by Twilio to identify the Supporting Document resource.
"""
return SupportingDocumentContext(self._version, sid=sid)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Trusthub.V1.SupportingDocumentList>"