twilio.rest.preview.marketplace.available_add_on package¶
Submodules¶
twilio.rest.preview.marketplace.available_add_on.available_add_on_extension module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionContext(version, available_add_on_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContextPLEASE 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.
-
fetch()[source]¶ Fetch the AvailableAddOnExtensionInstance
Returns: The fetched AvailableAddOnExtensionInstance Return type: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionInstance
-
-
class
twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionInstance(version, payload, available_add_on_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResourcePLEASE 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.
-
available_add_on_sid¶ Returns: The SID of the AvailableAddOn resource to which this extension applies Return type: unicode
-
fetch()[source]¶ Fetch the AvailableAddOnExtensionInstance
Returns: The fetched AvailableAddOnExtensionInstance Return type: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionInstance
-
friendly_name¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
product_name¶ Returns: The name of the Extension’s Product Return type: unicode
-
sid¶ Returns: The unique string that identifies the resource Return type: unicode
-
unique_name¶ Returns: An application-defined string that uniquely identifies the resource Return type: unicode
-
url¶ Returns: The absolute URL of the resource Return type: unicode
-
-
class
twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionList(version, available_add_on_sid)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE 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.
-
get(sid)[source]¶ Constructs a AvailableAddOnExtensionContext
Parameters: sid – The SID of the AvailableAddOn Extension resource to fetch Returns: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionContext Return type: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionContext
-
get_page(target_url)[source]¶ Retrieve a specific page of AvailableAddOnExtensionInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of AvailableAddOnExtensionInstance Return type: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionPage
-
list(limit=None, page_size=None)[source]¶ Lists AvailableAddOnExtensionInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – 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
Return type: list[twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionInstance]
-
page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of AvailableAddOnExtensionInstance records from the API. Request is executed immediately
Parameters: Returns: Page of AvailableAddOnExtensionInstance
Return type:
-
stream(limit=None, page_size=None)[source]¶ Streams AvailableAddOnExtensionInstance 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.
Parameters: - limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – 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
Return type: list[twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionInstance]
-
-
class
twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionPage(version, response, solution)[source]¶ Bases:
twilio.base.page.PagePLEASE 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.
-
get_instance(payload)[source]¶ Build an instance of AvailableAddOnExtensionInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionInstance Return type: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.marketplace.available_add_on.AvailableAddOnContext(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContextPLEASE 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.
-
extensions¶ Access the extensions
Returns: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionList Return type: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionList
-
fetch()[source]¶ Fetch the AvailableAddOnInstance
Returns: The fetched AvailableAddOnInstance Return type: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance
-
-
class
twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResourcePLEASE 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.
-
configuration_schema¶ Returns: The JSON object with the configuration that must be provided when installing a given Add-on Return type: dict
-
description¶ Returns: A short description of the Add-on’s functionality Return type: unicode
-
extensions¶ Access the extensions
Returns: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionList Return type: twilio.rest.preview.marketplace.available_add_on.available_add_on_extension.AvailableAddOnExtensionList
-
fetch()[source]¶ Fetch the AvailableAddOnInstance
Returns: The fetched AvailableAddOnInstance Return type: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance
-
friendly_name¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
links¶ Returns: The URLs of related resources Return type: unicode
-
pricing_type¶ Returns: How customers are charged for using this Add-on Return type: unicode
-
sid¶ Returns: The unique string that identifies the resource Return type: unicode
-
url¶ Returns: The absolute URL of the resource Return type: unicode
-
-
class
twilio.rest.preview.marketplace.available_add_on.AvailableAddOnList(version)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE 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.
-
get(sid)[source]¶ Constructs a AvailableAddOnContext
Parameters: sid – The SID of the AvailableAddOn resource to fetch Returns: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnContext Return type: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnContext
-
get_page(target_url)[source]¶ Retrieve a specific page of AvailableAddOnInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of AvailableAddOnInstance Return type: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnPage
-
list(limit=None, page_size=None)[source]¶ Lists AvailableAddOnInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – 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
Return type: list[twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance]
-
page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of AvailableAddOnInstance records from the API. Request is executed immediately
Parameters: Returns: Page of AvailableAddOnInstance
Return type: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnPage
-
stream(limit=None, page_size=None)[source]¶ 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.
Parameters: - limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – 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
Return type: list[twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance]
-
-
class
twilio.rest.preview.marketplace.available_add_on.AvailableAddOnPage(version, response, solution)[source]¶ Bases:
twilio.base.page.PagePLEASE 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.
-
get_instance(payload)[source]¶ Build an instance of AvailableAddOnInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance Return type: twilio.rest.preview.marketplace.available_add_on.AvailableAddOnInstance
-