File: C:/Users/fred/anaconda3/Lib/site-packages/twilio/rest/sync/v1/service/document/__init__.py
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Sync
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.sync.v1.service.document.document_permission import (
DocumentPermissionList,
)
class DocumentInstance(InstanceResource):
"""
:ivar sid: The unique string that we created to identify the Document resource.
:ivar unique_name: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long.
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource.
:ivar service_sid: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
:ivar url: The absolute URL of the Document resource.
:ivar links: The URLs of resources related to the Sync Document.
:ivar revision: The current revision of the Sync Document, represented as a string. The `revision` property is used with conditional updates to ensure data consistency.
:ivar data: An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
:ivar date_expires: The date and time in GMT when the Sync Document expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync Document does not expire, this value is `null`. The Document resource might not be deleted immediately after it expires.
: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 created_by: The identity of the Sync Document's creator. If the Sync Document is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
service_sid: str,
sid: Optional[str] = None,
):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.unique_name: Optional[str] = payload.get("unique_name")
self.account_sid: Optional[str] = payload.get("account_sid")
self.service_sid: Optional[str] = payload.get("service_sid")
self.url: Optional[str] = payload.get("url")
self.links: Optional[Dict[str, object]] = payload.get("links")
self.revision: Optional[str] = payload.get("revision")
self.data: Optional[Dict[str, object]] = payload.get("data")
self.date_expires: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_expires")
)
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.created_by: Optional[str] = payload.get("created_by")
self._solution = {
"service_sid": service_sid,
"sid": sid or self.sid,
}
self._context: Optional[DocumentContext] = None
@property
def _proxy(self) -> "DocumentContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: DocumentContext for this DocumentInstance
"""
if self._context is None:
self._context = DocumentContext(
self._version,
service_sid=self._solution["service_sid"],
sid=self._solution["sid"],
)
return self._context
def delete(self) -> bool:
"""
Deletes the DocumentInstance
:returns: True if delete succeeds, False otherwise
"""
return self._proxy.delete()
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the DocumentInstance
:returns: True if delete succeeds, False otherwise
"""
return await self._proxy.delete_async()
def fetch(self) -> "DocumentInstance":
"""
Fetch the DocumentInstance
:returns: The fetched DocumentInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "DocumentInstance":
"""
Asynchronous coroutine to fetch the DocumentInstance
:returns: The fetched DocumentInstance
"""
return await self._proxy.fetch_async()
def update(
self,
if_match: Union[str, object] = values.unset,
data: Union[object, object] = values.unset,
ttl: Union[int, object] = values.unset,
) -> "DocumentInstance":
"""
Update the DocumentInstance
:param if_match: The If-Match HTTP request header
:param data: A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
:param ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live).
:returns: The updated DocumentInstance
"""
return self._proxy.update(
if_match=if_match,
data=data,
ttl=ttl,
)
async def update_async(
self,
if_match: Union[str, object] = values.unset,
data: Union[object, object] = values.unset,
ttl: Union[int, object] = values.unset,
) -> "DocumentInstance":
"""
Asynchronous coroutine to update the DocumentInstance
:param if_match: The If-Match HTTP request header
:param data: A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
:param ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live).
:returns: The updated DocumentInstance
"""
return await self._proxy.update_async(
if_match=if_match,
data=data,
ttl=ttl,
)
@property
def document_permissions(self) -> DocumentPermissionList:
"""
Access the document_permissions
"""
return self._proxy.document_permissions
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.Sync.V1.DocumentInstance {}>".format(context)
class DocumentContext(InstanceContext):
def __init__(self, version: Version, service_sid: str, sid: str):
"""
Initialize the DocumentContext
:param version: Version that contains the resource
:param service_sid: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document resource to update.
:param sid: The SID of the Document resource to update. Can be the Document resource's `sid` or its `unique_name`.
"""
super().__init__(version)
# Path Solution
self._solution = {
"service_sid": service_sid,
"sid": sid,
}
self._uri = "/Services/{service_sid}/Documents/{sid}".format(**self._solution)
self._document_permissions: Optional[DocumentPermissionList] = None
def delete(self) -> bool:
"""
Deletes the DocumentInstance
: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 DocumentInstance
: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) -> DocumentInstance:
"""
Fetch the DocumentInstance
:returns: The fetched DocumentInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return DocumentInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
sid=self._solution["sid"],
)
async def fetch_async(self) -> DocumentInstance:
"""
Asynchronous coroutine to fetch the DocumentInstance
:returns: The fetched DocumentInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return DocumentInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
sid=self._solution["sid"],
)
def update(
self,
if_match: Union[str, object] = values.unset,
data: Union[object, object] = values.unset,
ttl: Union[int, object] = values.unset,
) -> DocumentInstance:
"""
Update the DocumentInstance
:param if_match: The If-Match HTTP request header
:param data: A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
:param ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live).
:returns: The updated DocumentInstance
"""
data = values.of(
{
"Data": serialize.object(data),
"Ttl": ttl,
}
)
headers = values.of({})
if not (
if_match is values.unset or (isinstance(if_match, str) and not if_match)
):
headers["If-Match"] = if_match
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 DocumentInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
sid=self._solution["sid"],
)
async def update_async(
self,
if_match: Union[str, object] = values.unset,
data: Union[object, object] = values.unset,
ttl: Union[int, object] = values.unset,
) -> DocumentInstance:
"""
Asynchronous coroutine to update the DocumentInstance
:param if_match: The If-Match HTTP request header
:param data: A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
:param ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live).
:returns: The updated DocumentInstance
"""
data = values.of(
{
"Data": serialize.object(data),
"Ttl": ttl,
}
)
headers = values.of({})
if not (
if_match is values.unset or (isinstance(if_match, str) and not if_match)
):
headers["If-Match"] = if_match
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 DocumentInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
sid=self._solution["sid"],
)
@property
def document_permissions(self) -> DocumentPermissionList:
"""
Access the document_permissions
"""
if self._document_permissions is None:
self._document_permissions = DocumentPermissionList(
self._version,
self._solution["service_sid"],
self._solution["sid"],
)
return self._document_permissions
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.Sync.V1.DocumentContext {}>".format(context)
class DocumentPage(Page):
def get_instance(self, payload: Dict[str, Any]) -> DocumentInstance:
"""
Build an instance of DocumentInstance
:param payload: Payload response from the API
"""
return DocumentInstance(
self._version, payload, service_sid=self._solution["service_sid"]
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Sync.V1.DocumentPage>"
class DocumentList(ListResource):
def __init__(self, version: Version, service_sid: str):
"""
Initialize the DocumentList
:param version: Version that contains the resource
:param service_sid: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document resources to read.
"""
super().__init__(version)
# Path Solution
self._solution = {
"service_sid": service_sid,
}
self._uri = "/Services/{service_sid}/Documents".format(**self._solution)
def create(
self,
unique_name: Union[str, object] = values.unset,
data: Union[object, object] = values.unset,
ttl: Union[int, object] = values.unset,
) -> DocumentInstance:
"""
Create the DocumentInstance
:param unique_name: An application-defined string that uniquely identifies the Sync Document
:param data: A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
:param ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (the Sync Document's time-to-live).
:returns: The created DocumentInstance
"""
data = values.of(
{
"UniqueName": unique_name,
"Data": serialize.object(data),
"Ttl": ttl,
}
)
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 DocumentInstance(
self._version, payload, service_sid=self._solution["service_sid"]
)
async def create_async(
self,
unique_name: Union[str, object] = values.unset,
data: Union[object, object] = values.unset,
ttl: Union[int, object] = values.unset,
) -> DocumentInstance:
"""
Asynchronously create the DocumentInstance
:param unique_name: An application-defined string that uniquely identifies the Sync Document
:param data: A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
:param ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (the Sync Document's time-to-live).
:returns: The created DocumentInstance
"""
data = values.of(
{
"UniqueName": unique_name,
"Data": serialize.object(data),
"Ttl": ttl,
}
)
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 DocumentInstance(
self._version, payload, service_sid=self._solution["service_sid"]
)
def stream(
self,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> Iterator[DocumentInstance]:
"""
Streams DocumentInstance 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[DocumentInstance]:
"""
Asynchronously streams DocumentInstance 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[DocumentInstance]:
"""
Lists DocumentInstance 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[DocumentInstance]:
"""
Asynchronously lists DocumentInstance 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,
) -> DocumentPage:
"""
Retrieve a single page of DocumentInstance 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 DocumentInstance
"""
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 DocumentPage(self._version, response, self._solution)
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,
) -> DocumentPage:
"""
Asynchronously retrieve a single page of DocumentInstance 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 DocumentInstance
"""
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 DocumentPage(self._version, response, self._solution)
def get_page(self, target_url: str) -> DocumentPage:
"""
Retrieve a specific page of DocumentInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of DocumentInstance
"""
response = self._version.domain.twilio.request("GET", target_url)
return DocumentPage(self._version, response, self._solution)
async def get_page_async(self, target_url: str) -> DocumentPage:
"""
Asynchronously retrieve a specific page of DocumentInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of DocumentInstance
"""
response = await self._version.domain.twilio.request_async("GET", target_url)
return DocumentPage(self._version, response, self._solution)
def get(self, sid: str) -> DocumentContext:
"""
Constructs a DocumentContext
:param sid: The SID of the Document resource to update. Can be the Document resource's `sid` or its `unique_name`.
"""
return DocumentContext(
self._version, service_sid=self._solution["service_sid"], sid=sid
)
def __call__(self, sid: str) -> DocumentContext:
"""
Constructs a DocumentContext
:param sid: The SID of the Document resource to update. Can be the Document resource's `sid` or its `unique_name`.
"""
return DocumentContext(
self._version, service_sid=self._solution["service_sid"], sid=sid
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Sync.V1.DocumentList>"