# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
from twilio.base import deserialize
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 PayloadList(ListResource):
def __init__(self, version, account_sid, reference_sid, add_on_result_sid):
"""
Initialize the PayloadList
:param Version version: Version that contains the resource
:param account_sid: The SID of the Account that created the resource
:param reference_sid: The SID of the recording to which the AddOnResult resource that contains the payload belongs
:param add_on_result_sid: The SID of the AddOnResult to which the payload belongs
:returns: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadList
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadList
"""
super(PayloadList, self).__init__(version)
# Path Solution
self._solution = {
'account_sid': account_sid,
'reference_sid': reference_sid,
'add_on_result_sid': add_on_result_sid,
}
self._uri = '/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads.json'.format(**self._solution)
[docs] def stream(self, limit=None, page_size=None):
"""
Streams PayloadInstance 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 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.api.v2010.account.recording.add_on_result.payload.PayloadInstance]
"""
limits = self._version.read_limits(limit, page_size)
page = self.page(page_size=limits['page_size'], )
return self._version.stream(page, limits['limit'])
[docs] def list(self, limit=None, page_size=None):
"""
Lists PayloadInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
: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.api.v2010.account.recording.add_on_result.payload.PayloadInstance]
"""
return list(self.stream(limit=limit, page_size=page_size, ))
[docs] def page(self, page_token=values.unset, page_number=values.unset,
page_size=values.unset):
"""
Retrieve a single page of PayloadInstance records from the API.
Request is executed immediately
: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 PayloadInstance
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadPage
"""
data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, })
response = self._version.page(method='GET', uri=self._uri, params=data, )
return PayloadPage(self._version, response, self._solution)
[docs] def get_page(self, target_url):
"""
Retrieve a specific page of PayloadInstance records from the API.
Request is executed immediately
:param str target_url: API-generated URL for the requested results page
:returns: Page of PayloadInstance
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadPage
"""
response = self._version.domain.twilio.request(
'GET',
target_url,
)
return PayloadPage(self._version, response, self._solution)
[docs] def get(self, sid):
"""
Constructs a PayloadContext
:param sid: The unique string that identifies the resource to fetch
:returns: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadContext
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadContext
"""
return PayloadContext(
self._version,
account_sid=self._solution['account_sid'],
reference_sid=self._solution['reference_sid'],
add_on_result_sid=self._solution['add_on_result_sid'],
sid=sid,
)
def __call__(self, sid):
"""
Constructs a PayloadContext
:param sid: The unique string that identifies the resource to fetch
:returns: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadContext
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadContext
"""
return PayloadContext(
self._version,
account_sid=self._solution['account_sid'],
reference_sid=self._solution['reference_sid'],
add_on_result_sid=self._solution['add_on_result_sid'],
sid=sid,
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Api.V2010.PayloadList>'
[docs]class PayloadPage(Page):
def __init__(self, version, response, solution):
"""
Initialize the PayloadPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:param account_sid: The SID of the Account that created the resource
:param reference_sid: The SID of the recording to which the AddOnResult resource that contains the payload belongs
:param add_on_result_sid: The SID of the AddOnResult to which the payload belongs
:returns: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadPage
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadPage
"""
super(PayloadPage, self).__init__(version, response)
# Path Solution
self._solution = solution
[docs] def get_instance(self, payload):
"""
Build an instance of PayloadInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadInstance
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadInstance
"""
return PayloadInstance(
self._version,
payload,
account_sid=self._solution['account_sid'],
reference_sid=self._solution['reference_sid'],
add_on_result_sid=self._solution['add_on_result_sid'],
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Api.V2010.PayloadPage>'
[docs]class PayloadContext(InstanceContext):
def __init__(self, version, account_sid, reference_sid, add_on_result_sid, sid):
"""
Initialize the PayloadContext
:param Version version: Version that contains the resource
:param account_sid: The SID of the Account that created the resource to fetch
:param reference_sid: The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs
:param add_on_result_sid: The SID of the AddOnResult to which the payload to fetch belongs
:param sid: The unique string that identifies the resource to fetch
:returns: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadContext
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadContext
"""
super(PayloadContext, self).__init__(version)
# Path Solution
self._solution = {
'account_sid': account_sid,
'reference_sid': reference_sid,
'add_on_result_sid': add_on_result_sid,
'sid': sid,
}
self._uri = '/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{sid}.json'.format(**self._solution)
[docs] def fetch(self):
"""
Fetch the PayloadInstance
:returns: The fetched PayloadInstance
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return PayloadInstance(
self._version,
payload,
account_sid=self._solution['account_sid'],
reference_sid=self._solution['reference_sid'],
add_on_result_sid=self._solution['add_on_result_sid'],
sid=self._solution['sid'],
)
[docs] def delete(self):
"""
Deletes the PayloadInstance
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._version.delete(method='DELETE', uri=self._uri, )
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.Api.V2010.PayloadContext {}>'.format(context)
[docs]class PayloadInstance(InstanceResource):
def __init__(self, version, payload, account_sid, reference_sid,
add_on_result_sid, sid=None):
"""
Initialize the PayloadInstance
:returns: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadInstance
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadInstance
"""
super(PayloadInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'sid': payload.get('sid'),
'add_on_result_sid': payload.get('add_on_result_sid'),
'account_sid': payload.get('account_sid'),
'label': payload.get('label'),
'add_on_sid': payload.get('add_on_sid'),
'add_on_configuration_sid': payload.get('add_on_configuration_sid'),
'content_type': payload.get('content_type'),
'date_created': deserialize.rfc2822_datetime(payload.get('date_created')),
'date_updated': deserialize.rfc2822_datetime(payload.get('date_updated')),
'reference_sid': payload.get('reference_sid'),
'subresource_uris': payload.get('subresource_uris'),
}
# Context
self._context = None
self._solution = {
'account_sid': account_sid,
'reference_sid': reference_sid,
'add_on_result_sid': add_on_result_sid,
'sid': sid or self._properties['sid'],
}
@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: PayloadContext for this PayloadInstance
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadContext
"""
if self._context is None:
self._context = PayloadContext(
self._version,
account_sid=self._solution['account_sid'],
reference_sid=self._solution['reference_sid'],
add_on_result_sid=self._solution['add_on_result_sid'],
sid=self._solution['sid'],
)
return self._context
@property
def sid(self):
"""
:returns: The unique string that identifies the resource
:rtype: unicode
"""
return self._properties['sid']
@property
def add_on_result_sid(self):
"""
:returns: The SID of the AddOnResult to which the payload belongs
:rtype: unicode
"""
return self._properties['add_on_result_sid']
@property
def account_sid(self):
"""
:returns: The SID of the Account that created the resource
:rtype: unicode
"""
return self._properties['account_sid']
@property
def label(self):
"""
:returns: The string that describes the payload
:rtype: unicode
"""
return self._properties['label']
@property
def add_on_sid(self):
"""
:returns: The SID of the Add-on to which the result belongs
:rtype: unicode
"""
return self._properties['add_on_sid']
@property
def add_on_configuration_sid(self):
"""
:returns: The SID of the Add-on configuration
:rtype: unicode
"""
return self._properties['add_on_configuration_sid']
@property
def content_type(self):
"""
:returns: The MIME type of the payload
:rtype: unicode
"""
return self._properties['content_type']
@property
def date_created(self):
"""
:returns: The RFC 2822 date and time in GMT that the resource was created
:rtype: datetime
"""
return self._properties['date_created']
@property
def date_updated(self):
"""
:returns: The RFC 2822 date and time in GMT that the resource was last updated
:rtype: datetime
"""
return self._properties['date_updated']
@property
def reference_sid(self):
"""
:returns: The SID of the recording to which the AddOnResult resource that contains the payload belongs
:rtype: unicode
"""
return self._properties['reference_sid']
@property
def subresource_uris(self):
"""
:returns: A list of related resources identified by their relative URIs
:rtype: unicode
"""
return self._properties['subresource_uris']
[docs] def fetch(self):
"""
Fetch the PayloadInstance
:returns: The fetched PayloadInstance
:rtype: twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadInstance
"""
return self._proxy.fetch()
[docs] def delete(self):
"""
Deletes the PayloadInstance
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._proxy.delete()
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.Api.V2010.PayloadInstance {}>'.format(context)