twilio.rest.studio.v1.flow package

Module contents

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

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

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/studio/v1/flow/__init__.py:docstring of twilio.rest.studio.v1.flow, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.studio.v1.flow.FlowContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the FlowInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
engagements

Access the engagements

Returns:twilio.rest.studio.v1.flow.engagement.EngagementList
Return type:twilio.rest.studio.v1.flow.engagement.EngagementList
executions

Access the executions

Returns:twilio.rest.studio.v1.flow.execution.ExecutionList
Return type:twilio.rest.studio.v1.flow.execution.ExecutionList
fetch()[source]

Fetch the FlowInstance

Returns:The fetched FlowInstance
Return type:twilio.rest.studio.v1.flow.FlowInstance
class twilio.rest.studio.v1.flow.FlowInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Status[source]

Bases: object

DRAFT = 'draft'
PUBLISHED = 'published'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
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 FlowInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
engagements

Access the engagements

Returns:twilio.rest.studio.v1.flow.engagement.EngagementList
Return type:twilio.rest.studio.v1.flow.engagement.EngagementList
executions

Access the executions

Returns:twilio.rest.studio.v1.flow.execution.ExecutionList
Return type:twilio.rest.studio.v1.flow.execution.ExecutionList
fetch()[source]

Fetch the FlowInstance

Returns:The fetched FlowInstance
Return type:twilio.rest.studio.v1.flow.FlowInstance
friendly_name
Returns:The string that you assigned to describe the Flow
Return type:unicode
Returns:Nested resource URLs
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
status
Returns:The status of the Flow
Return type:FlowInstance.Status
url
Returns:The absolute URL of the resource
Return type:unicode
version
Returns:The latest version number of the Flow’s definition
Return type:unicode
class twilio.rest.studio.v1.flow.FlowList(version)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a FlowContext

Parameters:sid – The SID that identifies the resource to fetch
Returns:twilio.rest.studio.v1.flow.FlowContext
Return type:twilio.rest.studio.v1.flow.FlowContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of FlowInstance
Return type:twilio.rest.studio.v1.flow.FlowPage
list(limit=None, page_size=None)[source]

Lists FlowInstance 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.studio.v1.flow.FlowInstance]

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

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

Return type:

twilio.rest.studio.v1.flow.FlowPage

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

Streams FlowInstance 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.studio.v1.flow.FlowInstance]

class twilio.rest.studio.v1.flow.FlowPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of FlowInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.studio.v1.flow.FlowInstance
Return type:twilio.rest.studio.v1.flow.FlowInstance