# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
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
from twilio.rest.preview.marketplace.available_add_on.available_add_on_extension import AvailableAddOnExtensionList
[docs]class AvailableAddOnList(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):
"""
Initialize the AvailableAddOnList
:param Version version: Version that contains the resource
:returns: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnList
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnList
"""
super(AvailableAddOnList, self).__init__(version)
# Path Solution
self._solution = {}
self._uri = '/AvailableAddOns'.format(**self._solution)
[docs] def stream(self, limit=None, page_size=None):
"""
Streams AvailableAddOnInstance 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.preview.marketplace.available_add_on.AvailableAddOnInstance]
"""
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 AvailableAddOnInstance 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.preview.marketplace.available_add_on.AvailableAddOnInstance]
"""
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 AvailableAddOnInstance 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 AvailableAddOnInstance
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnPage
"""
data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, })
response = self._version.page(method='GET', uri=self._uri, params=data, )
return AvailableAddOnPage(self._version, response, self._solution)
[docs] def get_page(self, target_url):
"""
Retrieve a specific page of AvailableAddOnInstance records from the API.
Request is executed immediately
:param str target_url: API-generated URL for the requested results page
:returns: Page of AvailableAddOnInstance
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnPage
"""
response = self._version.domain.twilio.request(
'GET',
target_url,
)
return AvailableAddOnPage(self._version, response, self._solution)
[docs] def get(self, sid):
"""
Constructs a AvailableAddOnContext
:param sid: The SID of the AvailableAddOn resource to fetch
:returns: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnContext
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnContext
"""
return AvailableAddOnContext(self._version, sid=sid, )
def __call__(self, sid):
"""
Constructs a AvailableAddOnContext
:param sid: The SID of the AvailableAddOn resource to fetch
:returns: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnContext
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnContext
"""
return AvailableAddOnContext(self._version, sid=sid, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Preview.Marketplace.AvailableAddOnList>'
[docs]class AvailableAddOnPage(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 AvailableAddOnPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:returns: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnPage
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnPage
"""
super(AvailableAddOnPage, self).__init__(version, response)
# Path Solution
self._solution = solution
[docs] def get_instance(self, payload):
"""
Build an instance of AvailableAddOnInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance
"""
return AvailableAddOnInstance(self._version, payload, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Preview.Marketplace.AvailableAddOnPage>'
[docs]class AvailableAddOnContext(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, sid):
"""
Initialize the AvailableAddOnContext
:param Version version: Version that contains the resource
:param sid: The SID of the AvailableAddOn resource to fetch
:returns: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnContext
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnContext
"""
super(AvailableAddOnContext, self).__init__(version)
# Path Solution
self._solution = {'sid': sid, }
self._uri = '/AvailableAddOns/{sid}'.format(**self._solution)
# Dependents
self._extensions = None
[docs] def fetch(self):
"""
Fetch the AvailableAddOnInstance
:returns: The fetched AvailableAddOnInstance
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return AvailableAddOnInstance(self._version, payload, sid=self._solution['sid'], )
@property
def extensions(self):
"""
Access the extensions
:returns: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionList
:rtype: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionList
"""
if self._extensions is None:
self._extensions = AvailableAddOnExtensionList(
self._version,
available_add_on_sid=self._solution['sid'],
)
return self._extensions
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.Marketplace.AvailableAddOnContext {}>'.format(context)
[docs]class AvailableAddOnInstance(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. """
def __init__(self, version, payload, sid=None):
"""
Initialize the AvailableAddOnInstance
:returns: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance
"""
super(AvailableAddOnInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'sid': payload.get('sid'),
'friendly_name': payload.get('friendly_name'),
'description': payload.get('description'),
'pricing_type': payload.get('pricing_type'),
'configuration_schema': payload.get('configuration_schema'),
'url': payload.get('url'),
'links': payload.get('links'),
}
# Context
self._context = None
self._solution = {'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: AvailableAddOnContext for this AvailableAddOnInstance
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnContext
"""
if self._context is None:
self._context = AvailableAddOnContext(self._version, 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 friendly_name(self):
"""
:returns: The string that you assigned to describe the resource
:rtype: unicode
"""
return self._properties['friendly_name']
@property
def description(self):
"""
:returns: A short description of the Add-on's functionality
:rtype: unicode
"""
return self._properties['description']
@property
def pricing_type(self):
"""
:returns: How customers are charged for using this Add-on
:rtype: unicode
"""
return self._properties['pricing_type']
@property
def configuration_schema(self):
"""
:returns: The JSON object with the configuration that must be provided when installing a given Add-on
:rtype: dict
"""
return self._properties['configuration_schema']
@property
def url(self):
"""
:returns: The absolute URL of the resource
:rtype: unicode
"""
return self._properties['url']
@property
def links(self):
"""
:returns: The URLs of related resources
:rtype: unicode
"""
return self._properties['links']
[docs] def fetch(self):
"""
Fetch the AvailableAddOnInstance
:returns: The fetched AvailableAddOnInstance
:rtype: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance
"""
return self._proxy.fetch()
@property
def extensions(self):
"""
Access the extensions
:returns: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionList
:rtype: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionList
"""
return self._proxy.extensions
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.Marketplace.AvailableAddOnInstance {}>'.format(context)