twilio.rest.studio.v1.flow.engagement.step package

Submodules

twilio.rest.studio.v1.flow.engagement.step.step_context module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextContext(version, flow_sid, engagement_sid, step_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the StepContextInstance

Returns:The fetched StepContextInstance
Return type:twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextInstance
class twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextInstance(version, payload, flow_sid, engagement_sid, step_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
context
Returns:The current state of the flow
Return type:dict
engagement_sid
Returns:The SID of the Engagement
Return type:unicode
fetch()[source]

Fetch the StepContextInstance

Returns:The fetched StepContextInstance
Return type:twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextInstance
flow_sid
Returns:The SID of the Flow
Return type:unicode
step_sid
Returns:Step SID
Return type:unicode
url
Returns:The absolute URL of the resource
Return type:unicode
class twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextList(version, flow_sid, engagement_sid, step_sid)[source]

Bases: twilio.base.list_resource.ListResource

get()[source]

Constructs a StepContextContext

Returns:twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextContext
Return type:twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextContext
class twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of StepContextInstance

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

Module contents

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.studio.v1.flow.engagement.step.StepContext(version, flow_sid, engagement_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the StepInstance

Returns:The fetched StepInstance
Return type:twilio.rest.studio.v1.flow.engagement.step.StepInstance
step_context

Access the step_context

Returns:twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextList
Return type:twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextList
class twilio.rest.studio.v1.flow.engagement.step.StepInstance(version, payload, flow_sid, engagement_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
context
Returns:The current state of the flow
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
engagement_sid
Returns:The SID of the Engagement
Return type:unicode
fetch()[source]

Fetch the StepInstance

Returns:The fetched StepInstance
Return type:twilio.rest.studio.v1.flow.engagement.step.StepInstance
flow_sid
Returns:The SID of the Flow
Return type:unicode
Returns:The URLs of related resources
Return type:unicode
name
Returns:The event that caused the Flow to transition to the Step
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
step_context

Access the step_context

Returns:twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextList
Return type:twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextList
transitioned_from
Returns:The Widget that preceded the Widget for the Step
Return type:unicode
transitioned_to
Returns:The Widget that will follow the Widget for the Step
Return type:unicode
url
Returns:The absolute URL of the resource
Return type:unicode
class twilio.rest.studio.v1.flow.engagement.step.StepList(version, flow_sid, engagement_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a StepContext

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

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

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

Lists StepInstance 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.engagement.step.StepInstance]

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

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

Return type:

twilio.rest.studio.v1.flow.engagement.step.StepPage

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

Streams StepInstance 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.engagement.step.StepInstance]

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

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of StepInstance

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