twilio.rest.api.v2010.account.recording.add_on_result 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/__init__.py:docstring of twilio.rest.api.v2010.account.recording.add_on_result, line 3); backlink

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

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the AddOnResultInstance

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

Fetch the AddOnResultInstance

Returns:The fetched AddOnResultInstance
Return type:twilio.rest.api.v2010.account.recording.add_on_result.AddOnResultInstance
payloads

Access the payloads

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

Bases: twilio.base.instance_resource.InstanceResource

class Status[source]

Bases: object

CANCELED = 'canceled'
COMPLETED = 'completed'
DELETED = 'deleted'
FAILED = 'failed'
INIT = 'init'
IN_PROGRESS = 'in-progress'
PROCESSING = 'processing'
QUEUED = 'queued'
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_sid
Returns:The SID of the Add-on to which the result belongs
Return type:unicode
date_completed
Returns:The date and time in GMT that the result was completed
Return type:datetime
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 AddOnResultInstance

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

Fetch the AddOnResultInstance

Returns:The fetched AddOnResultInstance
Return type:twilio.rest.api.v2010.account.recording.add_on_result.AddOnResultInstance
payloads

Access the payloads

Returns:twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadList
Return type:twilio.rest.api.v2010.account.recording.add_on_result.payload.PayloadList
reference_sid
Returns:The SID of the recording to which the AddOnResult resource belongs
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
status
Returns:The status of the result
Return type:AddOnResultInstance.Status
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.AddOnResultList(version, account_sid, reference_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a AddOnResultContext

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

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

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

Lists AddOnResultInstance 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.AddOnResultInstance]

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

Retrieve a single page of AddOnResultInstance 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 AddOnResultInstance

Return type:

twilio.rest.api.v2010.account.recording.add_on_result.AddOnResultPage

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

Streams AddOnResultInstance 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.AddOnResultInstance]

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

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of AddOnResultInstance

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