twilio.rest.preview.marketplace.installed_add_on package¶
Submodules¶
twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionContext(version, installed_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 InstalledAddOnExtensionInstance
Returns: The fetched InstalledAddOnExtensionInstance Return type: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionInstance
-
update(enabled)[source]¶ Update the InstalledAddOnExtensionInstance
Parameters: enabled (bool) – Whether the Extension should be invoked Returns: The updated InstalledAddOnExtensionInstance Return type: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionInstance
-
-
class
twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionInstance(version, payload, installed_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.
-
fetch()[source]¶ Fetch the InstalledAddOnExtensionInstance
Returns: The fetched InstalledAddOnExtensionInstance Return type: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionInstance
-
friendly_name¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
installed_add_on_sid¶ Returns: The SID of the InstalledAddOn resource to which this extension applies 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
-
update(enabled)[source]¶ Update the InstalledAddOnExtensionInstance
Parameters: enabled (bool) – Whether the Extension should be invoked Returns: The updated InstalledAddOnExtensionInstance Return type: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionInstance
-
url¶ Returns: The absolute URL of the resource Return type: unicode
-
-
class
twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionList(version, installed_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 InstalledAddOnExtensionContext
Parameters: sid – The SID of the InstalledAddOn Extension resource to fetch Returns: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionContext Return type: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionContext
-
get_page(target_url)[source]¶ Retrieve a specific page of InstalledAddOnExtensionInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of InstalledAddOnExtensionInstance Return type: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionPage
-
list(limit=None, page_size=None)[source]¶ Lists InstalledAddOnExtensionInstance 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.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionInstance]
-
page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of InstalledAddOnExtensionInstance records from the API. Request is executed immediately
Parameters: Returns: Page of InstalledAddOnExtensionInstance
Return type:
-
stream(limit=None, page_size=None)[source]¶ Streams InstalledAddOnExtensionInstance 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.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionInstance]
-
-
class
twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionPage(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 InstalledAddOnExtensionInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionInstance Return type: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnContext(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.
-
delete()[source]¶ Deletes the InstalledAddOnInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
extensions¶ Access the extensions
Returns: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionList Return type: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionList
-
fetch()[source]¶ Fetch the InstalledAddOnInstance
Returns: The fetched InstalledAddOnInstance Return type: twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnInstance
-
update(configuration=<object object>, unique_name=<object object>)[source]¶ Update the InstalledAddOnInstance
Parameters: - configuration (dict) – The JSON object representing the configuration
- unique_name (unicode) – An application-defined string that uniquely identifies the resource
Returns: The updated InstalledAddOnInstance
Return type: twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnInstance
-
-
class
twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnInstance(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.
-
account_sid¶ Returns: The SID of the Account that created the resource Return type: unicode
-
configuration¶ Returns: The JSON object that represents the current configuration of installed Add-on Return type: dict
-
date_created¶ Returns: The ISO 8601 date and time in GMT when the resource was created Return type: datetime
-
date_updated¶ Returns: The ISO 8601 date and time in GMT when the resource was last updated Return type: datetime
-
delete()[source]¶ Deletes the InstalledAddOnInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
description¶ Returns: A short description of the Add-on’s functionality Return type: unicode
-
extensions¶ Access the extensions
Returns: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionList Return type: twilio.rest.preview.marketplace.installed_add_on.installed_add_on_extension.InstalledAddOnExtensionList
-
fetch()[source]¶ Fetch the InstalledAddOnInstance
Returns: The fetched InstalledAddOnInstance Return type: twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnInstance
-
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
-
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
-
update(configuration=<object object>, unique_name=<object object>)[source]¶ Update the InstalledAddOnInstance
Parameters: - configuration (dict) – The JSON object representing the configuration
- unique_name (unicode) – An application-defined string that uniquely identifies the resource
Returns: The updated InstalledAddOnInstance
Return type: twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnInstance
-
url¶ Returns: The absolute URL of the resource Return type: unicode
-
-
class
twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnList(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.
-
create(available_add_on_sid, accept_terms_of_service, configuration=<object object>, unique_name=<object object>)[source]¶ Create the InstalledAddOnInstance
Parameters: - available_add_on_sid (unicode) – The SID of the AvaliableAddOn to install
- accept_terms_of_service (bool) – Whether the Terms of Service were accepted
- configuration (dict) – The JSON object representing the configuration
- unique_name (unicode) – An application-defined string that uniquely identifies the resource
Returns: The created InstalledAddOnInstance
Return type: twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnInstance
-
get(sid)[source]¶ Constructs a InstalledAddOnContext
Parameters: sid – The SID of the InstalledAddOn resource to fetch Returns: twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnContext Return type: twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnContext
-
get_page(target_url)[source]¶ Retrieve a specific page of InstalledAddOnInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of InstalledAddOnInstance Return type: twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnPage
-
list(limit=None, page_size=None)[source]¶ Lists InstalledAddOnInstance 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.installed_add_on.InstalledAddOnInstance]
-
page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of InstalledAddOnInstance records from the API. Request is executed immediately
Parameters: Returns: Page of InstalledAddOnInstance
Return type: twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnPage
-
stream(limit=None, page_size=None)[source]¶ Streams InstalledAddOnInstance 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.installed_add_on.InstalledAddOnInstance]
-
-
class
twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnPage(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 InstalledAddOnInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnInstance Return type: twilio.rest.preview.marketplace.installed_add_on.InstalledAddOnInstance
-