File: C:/Users/fred/anaconda3/Lib/site-packages/twilio/rest/sync/v1/service/sync_map/sync_map_item.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
class SyncMapItemInstance(InstanceResource):
class QueryFromBoundType(object):
INCLUSIVE = "inclusive"
EXCLUSIVE = "exclusive"
class QueryResultOrder(object):
ASC = "asc"
DESC = "desc"
"""
:ivar key: The unique, user-defined key for the Map Item.
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Map Item resource.
:ivar service_sid: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
:ivar map_sid: The SID of the Sync Map that contains the Map Item.
:ivar url: The absolute URL of the Map Item resource.
:ivar revision: The current revision of the Map Item, represented as a string.
:ivar data: An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
:ivar date_expires: The date and time in GMT when the Map Item expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Map Item does not expire, this value is `null`. The Map Item 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 Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
service_sid: str,
map_sid: str,
key: Optional[str] = None,
):
super().__init__(version)
self.key: Optional[str] = payload.get("key")
self.account_sid: Optional[str] = payload.get("account_sid")
self.service_sid: Optional[str] = payload.get("service_sid")
self.map_sid: Optional[str] = payload.get("map_sid")
self.url: Optional[str] = payload.get("url")
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,
"map_sid": map_sid,
"key": key or self.key,
}
self._context: Optional[SyncMapItemContext] = None
@property
def _proxy(self) -> "SyncMapItemContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: SyncMapItemContext for this SyncMapItemInstance
"""
if self._context is None:
self._context = SyncMapItemContext(
self._version,
service_sid=self._solution["service_sid"],
map_sid=self._solution["map_sid"],
key=self._solution["key"],
)
return self._context
def delete(self, if_match: Union[str, object] = values.unset) -> bool:
"""
Deletes the SyncMapItemInstance
:param if_match: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:returns: True if delete succeeds, False otherwise
"""
return self._proxy.delete(
if_match=if_match,
)
async def delete_async(self, if_match: Union[str, object] = values.unset) -> bool:
"""
Asynchronous coroutine that deletes the SyncMapItemInstance
:param if_match: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:returns: True if delete succeeds, False otherwise
"""
return await self._proxy.delete_async(
if_match=if_match,
)
def fetch(self) -> "SyncMapItemInstance":
"""
Fetch the SyncMapItemInstance
:returns: The fetched SyncMapItemInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "SyncMapItemInstance":
"""
Asynchronous coroutine to fetch the SyncMapItemInstance
:returns: The fetched SyncMapItemInstance
"""
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,
item_ttl: Union[int, object] = values.unset,
collection_ttl: Union[int, object] = values.unset,
) -> "SyncMapItemInstance":
"""
Update the SyncMapItemInstance
:param if_match: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:param data: A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
:param ttl: An alias for `item_ttl`. If both parameters are provided, this value is ignored.
:param item_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
:param collection_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request.
:returns: The updated SyncMapItemInstance
"""
return self._proxy.update(
if_match=if_match,
data=data,
ttl=ttl,
item_ttl=item_ttl,
collection_ttl=collection_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,
item_ttl: Union[int, object] = values.unset,
collection_ttl: Union[int, object] = values.unset,
) -> "SyncMapItemInstance":
"""
Asynchronous coroutine to update the SyncMapItemInstance
:param if_match: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:param data: A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
:param ttl: An alias for `item_ttl`. If both parameters are provided, this value is ignored.
:param item_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
:param collection_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request.
:returns: The updated SyncMapItemInstance
"""
return await self._proxy.update_async(
if_match=if_match,
data=data,
ttl=ttl,
item_ttl=item_ttl,
collection_ttl=collection_ttl,
)
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.SyncMapItemInstance {}>".format(context)
class SyncMapItemContext(InstanceContext):
def __init__(self, version: Version, service_sid: str, map_sid: str, key: str):
"""
Initialize the SyncMapItemContext
: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 Sync Map Item resource to update.
:param map_sid: The SID of the Sync Map with the Sync Map Item resource to update. Can be the Sync Map resource's `sid` or its `unique_name`.
:param key: The `key` value of the Sync Map Item resource to update.
"""
super().__init__(version)
# Path Solution
self._solution = {
"service_sid": service_sid,
"map_sid": map_sid,
"key": key,
}
self._uri = "/Services/{service_sid}/Maps/{map_sid}/Items/{key}".format(
**self._solution
)
def delete(self, if_match: Union[str, object] = values.unset) -> bool:
"""
Deletes the SyncMapItemInstance
:param if_match: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:returns: True if delete succeeds, False otherwise
"""
headers = values.of(
{
"If-Match": if_match,
}
)
headers = values.of({})
return self._version.delete(method="DELETE", uri=self._uri, headers=headers)
async def delete_async(self, if_match: Union[str, object] = values.unset) -> bool:
"""
Asynchronous coroutine that deletes the SyncMapItemInstance
:param if_match: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:returns: True if delete succeeds, False otherwise
"""
headers = values.of(
{
"If-Match": if_match,
}
)
headers = values.of({})
return await self._version.delete_async(
method="DELETE", uri=self._uri, headers=headers
)
def fetch(self) -> SyncMapItemInstance:
"""
Fetch the SyncMapItemInstance
:returns: The fetched SyncMapItemInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return SyncMapItemInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
map_sid=self._solution["map_sid"],
key=self._solution["key"],
)
async def fetch_async(self) -> SyncMapItemInstance:
"""
Asynchronous coroutine to fetch the SyncMapItemInstance
:returns: The fetched SyncMapItemInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return SyncMapItemInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
map_sid=self._solution["map_sid"],
key=self._solution["key"],
)
def update(
self,
if_match: Union[str, object] = values.unset,
data: Union[object, object] = values.unset,
ttl: Union[int, object] = values.unset,
item_ttl: Union[int, object] = values.unset,
collection_ttl: Union[int, object] = values.unset,
) -> SyncMapItemInstance:
"""
Update the SyncMapItemInstance
:param if_match: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:param data: A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
:param ttl: An alias for `item_ttl`. If both parameters are provided, this value is ignored.
:param item_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
:param collection_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request.
:returns: The updated SyncMapItemInstance
"""
data = values.of(
{
"Data": serialize.object(data),
"Ttl": ttl,
"ItemTtl": item_ttl,
"CollectionTtl": collection_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 SyncMapItemInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
map_sid=self._solution["map_sid"],
key=self._solution["key"],
)
async def update_async(
self,
if_match: Union[str, object] = values.unset,
data: Union[object, object] = values.unset,
ttl: Union[int, object] = values.unset,
item_ttl: Union[int, object] = values.unset,
collection_ttl: Union[int, object] = values.unset,
) -> SyncMapItemInstance:
"""
Asynchronous coroutine to update the SyncMapItemInstance
:param if_match: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
:param data: A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
:param ttl: An alias for `item_ttl`. If both parameters are provided, this value is ignored.
:param item_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
:param collection_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request.
:returns: The updated SyncMapItemInstance
"""
data = values.of(
{
"Data": serialize.object(data),
"Ttl": ttl,
"ItemTtl": item_ttl,
"CollectionTtl": collection_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 SyncMapItemInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
map_sid=self._solution["map_sid"],
key=self._solution["key"],
)
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.SyncMapItemContext {}>".format(context)
class SyncMapItemPage(Page):
def get_instance(self, payload: Dict[str, Any]) -> SyncMapItemInstance:
"""
Build an instance of SyncMapItemInstance
:param payload: Payload response from the API
"""
return SyncMapItemInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
map_sid=self._solution["map_sid"],
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Sync.V1.SyncMapItemPage>"
class SyncMapItemList(ListResource):
def __init__(self, version: Version, service_sid: str, map_sid: str):
"""
Initialize the SyncMapItemList
: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 Map Item resources to read.
:param map_sid: The SID of the Sync Map with the Sync Map Item resource to fetch. Can be the Sync Map resource's `sid` or its `unique_name`.
"""
super().__init__(version)
# Path Solution
self._solution = {
"service_sid": service_sid,
"map_sid": map_sid,
}
self._uri = "/Services/{service_sid}/Maps/{map_sid}/Items".format(
**self._solution
)
def create(
self,
key: str,
data: object,
ttl: Union[int, object] = values.unset,
item_ttl: Union[int, object] = values.unset,
collection_ttl: Union[int, object] = values.unset,
) -> SyncMapItemInstance:
"""
Create the SyncMapItemInstance
:param key: The unique, user-defined key for the Map Item. Can be up to 320 characters long.
:param data: A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
:param ttl: An alias for `item_ttl`. If both parameters are provided, this value is ignored.
:param item_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
:param collection_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted.
:returns: The created SyncMapItemInstance
"""
data = values.of(
{
"Key": key,
"Data": serialize.object(data),
"Ttl": ttl,
"ItemTtl": item_ttl,
"CollectionTtl": collection_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 SyncMapItemInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
map_sid=self._solution["map_sid"],
)
async def create_async(
self,
key: str,
data: object,
ttl: Union[int, object] = values.unset,
item_ttl: Union[int, object] = values.unset,
collection_ttl: Union[int, object] = values.unset,
) -> SyncMapItemInstance:
"""
Asynchronously create the SyncMapItemInstance
:param key: The unique, user-defined key for the Map Item. Can be up to 320 characters long.
:param data: A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
:param ttl: An alias for `item_ttl`. If both parameters are provided, this value is ignored.
:param item_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
:param collection_ttl: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted.
:returns: The created SyncMapItemInstance
"""
data = values.of(
{
"Key": key,
"Data": serialize.object(data),
"Ttl": ttl,
"ItemTtl": item_ttl,
"CollectionTtl": collection_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 SyncMapItemInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
map_sid=self._solution["map_sid"],
)
def stream(
self,
order: Union["SyncMapItemInstance.QueryResultOrder", object] = values.unset,
from_: Union[str, object] = values.unset,
bounds: Union["SyncMapItemInstance.QueryFromBoundType", object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> Iterator[SyncMapItemInstance]:
"""
Streams SyncMapItemInstance 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 "SyncMapItemInstance.QueryResultOrder" order: How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
:param str from_: The `key` of the first Sync Map Item resource to read. See also `bounds`.
:param "SyncMapItemInstance.QueryFromBoundType" bounds: Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
: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(
order=order, from_=from_, bounds=bounds, page_size=limits["page_size"]
)
return self._version.stream(page, limits["limit"])
async def stream_async(
self,
order: Union["SyncMapItemInstance.QueryResultOrder", object] = values.unset,
from_: Union[str, object] = values.unset,
bounds: Union["SyncMapItemInstance.QueryFromBoundType", object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> AsyncIterator[SyncMapItemInstance]:
"""
Asynchronously streams SyncMapItemInstance 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 "SyncMapItemInstance.QueryResultOrder" order: How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
:param str from_: The `key` of the first Sync Map Item resource to read. See also `bounds`.
:param "SyncMapItemInstance.QueryFromBoundType" bounds: Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
: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(
order=order, from_=from_, bounds=bounds, page_size=limits["page_size"]
)
return self._version.stream_async(page, limits["limit"])
def list(
self,
order: Union["SyncMapItemInstance.QueryResultOrder", object] = values.unset,
from_: Union[str, object] = values.unset,
bounds: Union["SyncMapItemInstance.QueryFromBoundType", object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[SyncMapItemInstance]:
"""
Lists SyncMapItemInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param "SyncMapItemInstance.QueryResultOrder" order: How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
:param str from_: The `key` of the first Sync Map Item resource to read. See also `bounds`.
:param "SyncMapItemInstance.QueryFromBoundType" bounds: Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
: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(
order=order,
from_=from_,
bounds=bounds,
limit=limit,
page_size=page_size,
)
)
async def list_async(
self,
order: Union["SyncMapItemInstance.QueryResultOrder", object] = values.unset,
from_: Union[str, object] = values.unset,
bounds: Union["SyncMapItemInstance.QueryFromBoundType", object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[SyncMapItemInstance]:
"""
Asynchronously lists SyncMapItemInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param "SyncMapItemInstance.QueryResultOrder" order: How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
:param str from_: The `key` of the first Sync Map Item resource to read. See also `bounds`.
:param "SyncMapItemInstance.QueryFromBoundType" bounds: Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
: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(
order=order,
from_=from_,
bounds=bounds,
limit=limit,
page_size=page_size,
)
]
def page(
self,
order: Union["SyncMapItemInstance.QueryResultOrder", object] = values.unset,
from_: Union[str, object] = values.unset,
bounds: Union["SyncMapItemInstance.QueryFromBoundType", object] = values.unset,
page_token: Union[str, object] = values.unset,
page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
) -> SyncMapItemPage:
"""
Retrieve a single page of SyncMapItemInstance records from the API.
Request is executed immediately
:param order: How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
:param from_: The `key` of the first Sync Map Item resource to read. See also `bounds`.
:param bounds: Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
: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 SyncMapItemInstance
"""
data = values.of(
{
"Order": order,
"From": from_,
"Bounds": bounds,
"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 SyncMapItemPage(self._version, response, self._solution)
async def page_async(
self,
order: Union["SyncMapItemInstance.QueryResultOrder", object] = values.unset,
from_: Union[str, object] = values.unset,
bounds: Union["SyncMapItemInstance.QueryFromBoundType", object] = values.unset,
page_token: Union[str, object] = values.unset,
page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
) -> SyncMapItemPage:
"""
Asynchronously retrieve a single page of SyncMapItemInstance records from the API.
Request is executed immediately
:param order: How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
:param from_: The `key` of the first Sync Map Item resource to read. See also `bounds`.
:param bounds: Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
: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 SyncMapItemInstance
"""
data = values.of(
{
"Order": order,
"From": from_,
"Bounds": bounds,
"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 SyncMapItemPage(self._version, response, self._solution)
def get_page(self, target_url: str) -> SyncMapItemPage:
"""
Retrieve a specific page of SyncMapItemInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of SyncMapItemInstance
"""
response = self._version.domain.twilio.request("GET", target_url)
return SyncMapItemPage(self._version, response, self._solution)
async def get_page_async(self, target_url: str) -> SyncMapItemPage:
"""
Asynchronously retrieve a specific page of SyncMapItemInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of SyncMapItemInstance
"""
response = await self._version.domain.twilio.request_async("GET", target_url)
return SyncMapItemPage(self._version, response, self._solution)
def get(self, key: str) -> SyncMapItemContext:
"""
Constructs a SyncMapItemContext
:param key: The `key` value of the Sync Map Item resource to update.
"""
return SyncMapItemContext(
self._version,
service_sid=self._solution["service_sid"],
map_sid=self._solution["map_sid"],
key=key,
)
def __call__(self, key: str) -> SyncMapItemContext:
"""
Constructs a SyncMapItemContext
:param key: The `key` value of the Sync Map Item resource to update.
"""
return SyncMapItemContext(
self._version,
service_sid=self._solution["service_sid"],
map_sid=self._solution["map_sid"],
key=key,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Sync.V1.SyncMapItemList>"