twilio.rest.studio.v2.flow package

Submodules

twilio.rest.studio.v2.flow.flow_revision module

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

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

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

Inline substitution_reference start-string without end-string.
class twilio.rest.studio.v2.flow.flow_revision.FlowRevisionContext(version, sid, revision)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the FlowRevisionInstance

Returns:The fetched FlowRevisionInstance
Return type:twilio.rest.studio.v2.flow.flow_revision.FlowRevisionInstance
class twilio.rest.studio.v2.flow.flow_revision.FlowRevisionInstance(version, payload, sid, revision=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
commit_message
Returns:Description of change made in the revision
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
definition
Returns:JSON representation of flow definition
Return type:dict
errors
Returns:List of error in the flow definition
Return type:list[dict]
fetch()[source]

Fetch the FlowRevisionInstance

Returns:The fetched FlowRevisionInstance
Return type:twilio.rest.studio.v2.flow.flow_revision.FlowRevisionInstance
friendly_name
Returns:The string that you assigned to describe the Flow
Return type:unicode
revision
Returns:The latest revision number of the Flow’s definition
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
status
Returns:The status of the Flow
Return type:FlowRevisionInstance.Status
url
Returns:The absolute URL of the resource
Return type:unicode
valid
Returns:Boolean if the flow definition is valid
Return type:bool
class twilio.rest.studio.v2.flow.flow_revision.FlowRevisionList(version, sid)[source]

Bases: twilio.base.list_resource.ListResource

get(revision)[source]

Constructs a FlowRevisionContext

Parameters:revision – Specific Revision number or can be LatestPublished and LatestRevision
Returns:twilio.rest.studio.v2.flow.flow_revision.FlowRevisionContext
Return type:twilio.rest.studio.v2.flow.flow_revision.FlowRevisionContext
get_page(target_url)[source]

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

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

Lists FlowRevisionInstance 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.v2.flow.flow_revision.FlowRevisionInstance]

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

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

Return type:

twilio.rest.studio.v2.flow.flow_revision.FlowRevisionPage

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

Streams FlowRevisionInstance 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.v2.flow.flow_revision.FlowRevisionInstance]

class twilio.rest.studio.v2.flow.flow_revision.FlowRevisionPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of FlowRevisionInstance

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

twilio.rest.studio.v2.flow.test_user module

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

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

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

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

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the FlowTestUserInstance

Returns:The fetched FlowTestUserInstance
Return type:twilio.rest.studio.v2.flow.test_user.FlowTestUserInstance
update(test_users)[source]

Update the FlowTestUserInstance

Parameters:test_users (list[unicode]) – List of test user identities that can test draft versions of the flow.
Returns:The updated FlowTestUserInstance
Return type:twilio.rest.studio.v2.flow.test_user.FlowTestUserInstance
class twilio.rest.studio.v2.flow.test_user.FlowTestUserInstance(version, payload, sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

fetch()[source]

Fetch the FlowTestUserInstance

Returns:The fetched FlowTestUserInstance
Return type:twilio.rest.studio.v2.flow.test_user.FlowTestUserInstance
sid
Returns:Unique identifier of the flow.
Return type:unicode
test_users
Returns:List of test user identities that can test draft versions of the flow.
Return type:list[unicode]
update(test_users)[source]

Update the FlowTestUserInstance

Parameters:test_users (list[unicode]) – List of test user identities that can test draft versions of the flow.
Returns:The updated FlowTestUserInstance
Return type:twilio.rest.studio.v2.flow.test_user.FlowTestUserInstance
url
Returns:The URL of this resource.
Return type:unicode
class twilio.rest.studio.v2.flow.test_user.FlowTestUserList(version, sid)[source]

Bases: twilio.base.list_resource.ListResource

get()[source]

Constructs a FlowTestUserContext

Returns:twilio.rest.studio.v2.flow.test_user.FlowTestUserContext
Return type:twilio.rest.studio.v2.flow.test_user.FlowTestUserContext
class twilio.rest.studio.v2.flow.test_user.FlowTestUserPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of FlowTestUserInstance

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

Module contents

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

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

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

Inline substitution_reference start-string without end-string.
class twilio.rest.studio.v2.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
executions

Access the executions

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

Fetch the FlowInstance

Returns:The fetched FlowInstance
Return type:twilio.rest.studio.v2.flow.FlowInstance
revisions

Access the revisions

Returns:twilio.rest.studio.v2.flow.flow_revision.FlowRevisionList
Return type:twilio.rest.studio.v2.flow.flow_revision.FlowRevisionList
test_users

Access the test_users

Returns:twilio.rest.studio.v2.flow.test_user.FlowTestUserList
Return type:twilio.rest.studio.v2.flow.test_user.FlowTestUserList
update(status, friendly_name=<object object>, definition=<object object>, commit_message=<object object>)[source]

Update the FlowInstance

Parameters:
  • status (FlowInstance.Status) – The status of the Flow
  • friendly_name (unicode) – The string that you assigned to describe the Flow
  • definition (dict) – JSON representation of flow definition
  • commit_message (unicode) – Description of change made in the revision
Returns:

The updated FlowInstance

Return type:

twilio.rest.studio.v2.flow.FlowInstance

class twilio.rest.studio.v2.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
commit_message
Returns:Description of change made in the revision
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
definition
Returns:JSON representation of flow definition
Return type:dict
delete()[source]

Deletes the FlowInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
errors
Returns:List of error in the flow definition
Return type:list[dict]
executions

Access the executions

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

Fetch the FlowInstance

Returns:The fetched FlowInstance
Return type:twilio.rest.studio.v2.flow.FlowInstance
friendly_name
Returns:The string that you assigned to describe the Flow
Return type:unicode
Returns:Nested resource URLs
Return type:unicode
revision
Returns:The latest revision number of the Flow’s definition
Return type:unicode
revisions

Access the revisions

Returns:twilio.rest.studio.v2.flow.flow_revision.FlowRevisionList
Return type:twilio.rest.studio.v2.flow.flow_revision.FlowRevisionList
sid
Returns:The unique string that identifies the resource
Return type:unicode
status
Returns:The status of the Flow
Return type:FlowInstance.Status
test_users

Access the test_users

Returns:twilio.rest.studio.v2.flow.test_user.FlowTestUserList
Return type:twilio.rest.studio.v2.flow.test_user.FlowTestUserList
update(status, friendly_name=<object object>, definition=<object object>, commit_message=<object object>)[source]

Update the FlowInstance

Parameters:
  • status (FlowInstance.Status) – The status of the Flow
  • friendly_name (unicode) – The string that you assigned to describe the Flow
  • definition (dict) – JSON representation of flow definition
  • commit_message (unicode) – Description of change made in the revision
Returns:

The updated FlowInstance

Return type:

twilio.rest.studio.v2.flow.FlowInstance

url
Returns:The absolute URL of the resource
Return type:unicode
valid
Returns:Boolean if the flow definition is valid
Return type:bool
warnings
Returns:List of warnings in the flow definition
Return type:list[dict]
webhook_url
Returns:The webhook_url
Return type:unicode
class twilio.rest.studio.v2.flow.FlowList(version)[source]

Bases: twilio.base.list_resource.ListResource

create(friendly_name, status, definition, commit_message=<object object>)[source]

Create the FlowInstance

Parameters:
  • friendly_name (unicode) – The string that you assigned to describe the Flow
  • status (FlowInstance.Status) – The status of the Flow
  • definition (dict) – JSON representation of flow definition
  • commit_message (unicode) – Description of change made in the revision
Returns:

The created FlowInstance

Return type:

twilio.rest.studio.v2.flow.FlowInstance

get(sid)[source]

Constructs a FlowContext

Parameters:sid – The SID that identifies the resource to fetch
Returns:twilio.rest.studio.v2.flow.FlowContext
Return type:twilio.rest.studio.v2.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.v2.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.v2.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.v2.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.v2.flow.FlowInstance]

class twilio.rest.studio.v2.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.v2.flow.FlowInstance
Return type:twilio.rest.studio.v2.flow.FlowInstance