twilio.rest.api.v2010.account.recording.add_on_result.payload package

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/recording/add_on_result/payload/__init__.py:docstring of twilio.rest.api.v2010.account.recording.add_on_result.payload, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadContext(version, account_sid, reference_sid, add_on_result_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the PayloadInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the PayloadInstance

Returns:The fetched PayloadInstance
Return type:twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadInstance
class twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadInstance(version, payload, account_sid, reference_sid, add_on_result_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
add_on_configuration_sid
Returns:The SID of the Add-on configuration
Return type:unicode
add_on_result_sid
Returns:The SID of the AddOnResult to which the payload belongs
Return type:unicode
add_on_sid
Returns:The SID of the Add-on to which the result belongs
Return type:unicode
content_type
Returns:The MIME type of the payload
Return type:unicode
date_created
Returns:The RFC 2822 date and time in GMT that the resource was created
Return type:datetime
date_updated
Returns:The RFC 2822 date and time in GMT that the resource was last updated
Return type:datetime
delete()[source]

Deletes the PayloadInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the PayloadInstance

Returns:The fetched PayloadInstance
Return type:twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadInstance
label
Returns:The string that describes the payload
Return type:unicode
reference_sid
Returns:The SID of the recording to which the AddOnResult resource that contains the payload belongs
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
subresource_uris
Returns:A list of related resources identified by their relative URIs
Return type:unicode
class twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadList(version, account_sid, reference_sid, add_on_result_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a PayloadContext

Parameters:sid – The unique string that identifies the resource to fetch
Returns:twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadContext
Return type:twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadContext
get_page(target_url)[source]

Retrieve a specific page of PayloadInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of PayloadInstance
Return type:twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadPage
list(limit=None, page_size=None)[source]

Lists PayloadInstance 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.api.v2010.account.recording.add_on_result.payload.PayloadInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of PayloadInstance records from the API. Request is executed immediately

Parameters:
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of PayloadInstance

Return type:

twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadPage

stream(limit=None, page_size=None)[source]

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.

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.api.v2010.account.recording.add_on_result.payload.PayloadInstance]

class twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of PayloadInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadInstance
Return type:twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadInstance