# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
from twilio.base import values
from twilio.base.instance_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.page import Page
[docs]class StepContextList(ListResource):
def __init__(self, version, flow_sid, engagement_sid, step_sid):
"""
Initialize the StepContextList
:param Version version: Version that contains the resource
:param flow_sid: The SID of the Flow
:param engagement_sid: The SID of the Engagement
:param step_sid: Step SID
:returns: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextList
:rtype: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextList
"""
super(StepContextList, self).__init__(version)
# Path Solution
self._solution = {'flow_sid': flow_sid, 'engagement_sid': engagement_sid, 'step_sid': step_sid, }
[docs] def get(self):
"""
Constructs a StepContextContext
:returns: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextContext
:rtype: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextContext
"""
return StepContextContext(
self._version,
flow_sid=self._solution['flow_sid'],
engagement_sid=self._solution['engagement_sid'],
step_sid=self._solution['step_sid'],
)
def __call__(self):
"""
Constructs a StepContextContext
:returns: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextContext
:rtype: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextContext
"""
return StepContextContext(
self._version,
flow_sid=self._solution['flow_sid'],
engagement_sid=self._solution['engagement_sid'],
step_sid=self._solution['step_sid'],
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Studio.V1.StepContextList>'
[docs]class StepContextPage(Page):
def __init__(self, version, response, solution):
"""
Initialize the StepContextPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:param flow_sid: The SID of the Flow
:param engagement_sid: The SID of the Engagement
:param step_sid: Step SID
:returns: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextPage
:rtype: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextPage
"""
super(StepContextPage, self).__init__(version, response)
# Path Solution
self._solution = solution
[docs] def get_instance(self, payload):
"""
Build an instance of StepContextInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextInstance
:rtype: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextInstance
"""
return StepContextInstance(
self._version,
payload,
flow_sid=self._solution['flow_sid'],
engagement_sid=self._solution['engagement_sid'],
step_sid=self._solution['step_sid'],
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Studio.V1.StepContextPage>'
[docs]class StepContextContext(InstanceContext):
def __init__(self, version, flow_sid, engagement_sid, step_sid):
"""
Initialize the StepContextContext
:param Version version: Version that contains the resource
:param flow_sid: The SID of the Flow
:param engagement_sid: The SID of the Engagement
:param step_sid: Step SID
:returns: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextContext
:rtype: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextContext
"""
super(StepContextContext, self).__init__(version)
# Path Solution
self._solution = {'flow_sid': flow_sid, 'engagement_sid': engagement_sid, 'step_sid': step_sid, }
self._uri = '/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context'.format(**self._solution)
[docs] def fetch(self):
"""
Fetch the StepContextInstance
:returns: The fetched StepContextInstance
:rtype: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return StepContextInstance(
self._version,
payload,
flow_sid=self._solution['flow_sid'],
engagement_sid=self._solution['engagement_sid'],
step_sid=self._solution['step_sid'],
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Studio.V1.StepContextContext {}>'.format(context)
[docs]class StepContextInstance(InstanceResource):
def __init__(self, version, payload, flow_sid, engagement_sid, step_sid):
"""
Initialize the StepContextInstance
:returns: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextInstance
:rtype: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextInstance
"""
super(StepContextInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'account_sid': payload.get('account_sid'),
'context': payload.get('context'),
'engagement_sid': payload.get('engagement_sid'),
'flow_sid': payload.get('flow_sid'),
'step_sid': payload.get('step_sid'),
'url': payload.get('url'),
}
# Context
self._context = None
self._solution = {'flow_sid': flow_sid, 'engagement_sid': engagement_sid, 'step_sid': step_sid, }
@property
def _proxy(self):
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: StepContextContext for this StepContextInstance
:rtype: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextContext
"""
if self._context is None:
self._context = StepContextContext(
self._version,
flow_sid=self._solution['flow_sid'],
engagement_sid=self._solution['engagement_sid'],
step_sid=self._solution['step_sid'],
)
return self._context
@property
def account_sid(self):
"""
:returns: The SID of the Account that created the resource
:rtype: unicode
"""
return self._properties['account_sid']
@property
def context(self):
"""
:returns: The current state of the flow
:rtype: dict
"""
return self._properties['context']
@property
def engagement_sid(self):
"""
:returns: The SID of the Engagement
:rtype: unicode
"""
return self._properties['engagement_sid']
@property
def flow_sid(self):
"""
:returns: The SID of the Flow
:rtype: unicode
"""
return self._properties['flow_sid']
@property
def step_sid(self):
"""
:returns: Step SID
:rtype: unicode
"""
return self._properties['step_sid']
@property
def url(self):
"""
:returns: The absolute URL of the resource
:rtype: unicode
"""
return self._properties['url']
[docs] def fetch(self):
"""
Fetch the StepContextInstance
:returns: The fetched StepContextInstance
:rtype: twilio.rest.studio.v1.flow.engagement.step.step_context.StepContextInstance
"""
return self._proxy.fetch()
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Studio.V1.StepContextInstance {}>'.format(context)