# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
from twilio.base import deserialize
from twilio.base import serialize
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.page import Page
[docs]class SyncListItemList(ListResource):
""" PLEASE NOTE that this class contains preview products that are subject
to change. Use them with caution. If you currently do not have developer
preview access, please contact help@twilio.com. """
def __init__(self, version, service_sid, list_sid):
"""
Initialize the SyncListItemList
:param Version version: Version that contains the resource
:param service_sid: The service_sid
:param list_sid: The list_sid
:returns: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemList
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemList
"""
super(SyncListItemList, self).__init__(version)
# Path Solution
self._solution = {'service_sid': service_sid, 'list_sid': list_sid, }
self._uri = '/Services/{service_sid}/Lists/{list_sid}/Items'.format(**self._solution)
[docs] def create(self, data):
"""
Create the SyncListItemInstance
:param dict data: The data
:returns: The created SyncListItemInstance
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemInstance
"""
data = values.of({'Data': serialize.object(data), })
payload = self._version.create(method='POST', uri=self._uri, data=data, )
return SyncListItemInstance(
self._version,
payload,
service_sid=self._solution['service_sid'],
list_sid=self._solution['list_sid'],
)
[docs] def stream(self, order=values.unset, from_=values.unset, bounds=values.unset,
limit=None, page_size=None):
"""
Streams SyncListItemInstance 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 SyncListItemInstance.QueryResultOrder order: The order
:param unicode from_: The from
:param SyncListItemInstance.QueryFromBoundType bounds: The bounds
:param int limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param int 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
:rtype: list[twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemInstance]
"""
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'])
[docs] def list(self, order=values.unset, from_=values.unset, bounds=values.unset,
limit=None, page_size=None):
"""
Lists SyncListItemInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param SyncListItemInstance.QueryResultOrder order: The order
:param unicode from_: The from
:param SyncListItemInstance.QueryFromBoundType bounds: The bounds
:param int limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param int 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: Generator that will yield up to limit results
:rtype: list[twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemInstance]
"""
return list(self.stream(order=order, from_=from_, bounds=bounds, limit=limit, page_size=page_size, ))
[docs] def page(self, order=values.unset, from_=values.unset, bounds=values.unset,
page_token=values.unset, page_number=values.unset,
page_size=values.unset):
"""
Retrieve a single page of SyncListItemInstance records from the API.
Request is executed immediately
:param SyncListItemInstance.QueryResultOrder order: The order
:param unicode from_: The from
:param SyncListItemInstance.QueryFromBoundType bounds: The bounds
:param str page_token: PageToken provided by the API
:param int page_number: Page Number, this value is simply for client state
:param int page_size: Number of records to return, defaults to 50
:returns: Page of SyncListItemInstance
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemPage
"""
data = values.of({
'Order': order,
'From': from_,
'Bounds': bounds,
'PageToken': page_token,
'Page': page_number,
'PageSize': page_size,
})
response = self._version.page(method='GET', uri=self._uri, params=data, )
return SyncListItemPage(self._version, response, self._solution)
[docs] def get_page(self, target_url):
"""
Retrieve a specific page of SyncListItemInstance records from the API.
Request is executed immediately
:param str target_url: API-generated URL for the requested results page
:returns: Page of SyncListItemInstance
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemPage
"""
response = self._version.domain.twilio.request(
'GET',
target_url,
)
return SyncListItemPage(self._version, response, self._solution)
[docs] def get(self, index):
"""
Constructs a SyncListItemContext
:param index: The index
:returns: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemContext
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemContext
"""
return SyncListItemContext(
self._version,
service_sid=self._solution['service_sid'],
list_sid=self._solution['list_sid'],
index=index,
)
def __call__(self, index):
"""
Constructs a SyncListItemContext
:param index: The index
:returns: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemContext
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemContext
"""
return SyncListItemContext(
self._version,
service_sid=self._solution['service_sid'],
list_sid=self._solution['list_sid'],
index=index,
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Preview.Sync.SyncListItemList>'
[docs]class SyncListItemPage(Page):
""" PLEASE NOTE that this class contains preview products that are subject
to change. Use them with caution. If you currently do not have developer
preview access, please contact help@twilio.com. """
def __init__(self, version, response, solution):
"""
Initialize the SyncListItemPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:param service_sid: The service_sid
:param list_sid: The list_sid
:returns: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemPage
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemPage
"""
super(SyncListItemPage, self).__init__(version, response)
# Path Solution
self._solution = solution
[docs] def get_instance(self, payload):
"""
Build an instance of SyncListItemInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemInstance
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemInstance
"""
return SyncListItemInstance(
self._version,
payload,
service_sid=self._solution['service_sid'],
list_sid=self._solution['list_sid'],
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Preview.Sync.SyncListItemPage>'
[docs]class SyncListItemContext(InstanceContext):
""" PLEASE NOTE that this class contains preview products that are subject
to change. Use them with caution. If you currently do not have developer
preview access, please contact help@twilio.com. """
def __init__(self, version, service_sid, list_sid, index):
"""
Initialize the SyncListItemContext
:param Version version: Version that contains the resource
:param service_sid: The service_sid
:param list_sid: The list_sid
:param index: The index
:returns: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemContext
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemContext
"""
super(SyncListItemContext, self).__init__(version)
# Path Solution
self._solution = {'service_sid': service_sid, 'list_sid': list_sid, 'index': index, }
self._uri = '/Services/{service_sid}/Lists/{list_sid}/Items/{index}'.format(**self._solution)
[docs] def fetch(self):
"""
Fetch the SyncListItemInstance
:returns: The fetched SyncListItemInstance
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return SyncListItemInstance(
self._version,
payload,
service_sid=self._solution['service_sid'],
list_sid=self._solution['list_sid'],
index=self._solution['index'],
)
[docs] def delete(self, if_match=values.unset):
"""
Deletes the SyncListItemInstance
:param unicode if_match: The If-Match HTTP request header
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
headers = values.of({'If-Match': if_match, })
return self._version.delete(method='DELETE', uri=self._uri, headers=headers, )
[docs] def update(self, data, if_match=values.unset):
"""
Update the SyncListItemInstance
:param dict data: The data
:param unicode if_match: The If-Match HTTP request header
:returns: The updated SyncListItemInstance
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemInstance
"""
data = values.of({'Data': serialize.object(data), })
headers = values.of({'If-Match': if_match, })
payload = self._version.update(method='POST', uri=self._uri, data=data, headers=headers, )
return SyncListItemInstance(
self._version,
payload,
service_sid=self._solution['service_sid'],
list_sid=self._solution['list_sid'],
index=self._solution['index'],
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Preview.Sync.SyncListItemContext {}>'.format(context)
[docs]class SyncListItemInstance(InstanceResource):
""" PLEASE NOTE that this class contains preview products that are subject
to change. Use them with caution. If you currently do not have developer
preview access, please contact help@twilio.com. """
[docs] class QueryResultOrder(object):
ASC = "asc"
DESC = "desc"
[docs] class QueryFromBoundType(object):
INCLUSIVE = "inclusive"
EXCLUSIVE = "exclusive"
def __init__(self, version, payload, service_sid, list_sid, index=None):
"""
Initialize the SyncListItemInstance
:returns: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemInstance
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemInstance
"""
super(SyncListItemInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'index': deserialize.integer(payload.get('index')),
'account_sid': payload.get('account_sid'),
'service_sid': payload.get('service_sid'),
'list_sid': payload.get('list_sid'),
'url': payload.get('url'),
'revision': payload.get('revision'),
'data': payload.get('data'),
'date_created': deserialize.iso8601_datetime(payload.get('date_created')),
'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')),
'created_by': payload.get('created_by'),
}
# Context
self._context = None
self._solution = {
'service_sid': service_sid,
'list_sid': list_sid,
'index': index or self._properties['index'],
}
@property
def _proxy(self):
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: SyncListItemContext for this SyncListItemInstance
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemContext
"""
if self._context is None:
self._context = SyncListItemContext(
self._version,
service_sid=self._solution['service_sid'],
list_sid=self._solution['list_sid'],
index=self._solution['index'],
)
return self._context
@property
def index(self):
"""
:returns: The index
:rtype: unicode
"""
return self._properties['index']
@property
def account_sid(self):
"""
:returns: The account_sid
:rtype: unicode
"""
return self._properties['account_sid']
@property
def service_sid(self):
"""
:returns: The service_sid
:rtype: unicode
"""
return self._properties['service_sid']
@property
def list_sid(self):
"""
:returns: The list_sid
:rtype: unicode
"""
return self._properties['list_sid']
@property
def url(self):
"""
:returns: The url
:rtype: unicode
"""
return self._properties['url']
@property
def revision(self):
"""
:returns: The revision
:rtype: unicode
"""
return self._properties['revision']
@property
def data(self):
"""
:returns: The data
:rtype: dict
"""
return self._properties['data']
@property
def date_created(self):
"""
:returns: The date_created
:rtype: datetime
"""
return self._properties['date_created']
@property
def date_updated(self):
"""
:returns: The date_updated
:rtype: datetime
"""
return self._properties['date_updated']
@property
def created_by(self):
"""
:returns: The created_by
:rtype: unicode
"""
return self._properties['created_by']
[docs] def fetch(self):
"""
Fetch the SyncListItemInstance
:returns: The fetched SyncListItemInstance
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemInstance
"""
return self._proxy.fetch()
[docs] def delete(self, if_match=values.unset):
"""
Deletes the SyncListItemInstance
:param unicode if_match: The If-Match HTTP request header
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._proxy.delete(if_match=if_match, )
[docs] def update(self, data, if_match=values.unset):
"""
Update the SyncListItemInstance
:param dict data: The data
:param unicode if_match: The If-Match HTTP request header
:returns: The updated SyncListItemInstance
:rtype: twilio.rest.preview.sync.service.sync_list.sync_list_item.SyncListItemInstance
"""
return self._proxy.update(data, if_match=if_match, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Preview.Sync.SyncListItemInstance {}>'.format(context)