r""" This code was generated by ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ Twilio - Studio This is the public Twilio REST API. NOTE: This class is auto generated by OpenAPI Generator. https://openapi-generator.tech Do not edit the class manually. """ from datetime import datetime from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator from twilio.base import deserialize, 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.version import Version from twilio.base.page import Page from twilio.rest.studio.v1.flow.engagement.step.step_context import StepContextList class StepInstance(InstanceResource): """ :ivar sid: The unique string that we created to identify the Step resource. :ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Step resource. :ivar flow_sid: The SID of the Flow. :ivar engagement_sid: The SID of the Engagement. :ivar name: The event that caused the Flow to transition to the Step. :ivar context: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. :ivar transitioned_from: The Widget that preceded the Widget for the Step. :ivar transitioned_to: The Widget that will follow the Widget for the Step. :ivar date_created: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. :ivar date_updated: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. :ivar url: The absolute URL of the resource. :ivar links: The URLs of related resources. """ def __init__( self, version: Version, payload: Dict[str, Any], flow_sid: str, engagement_sid: str, sid: Optional[str] = None, ): super().__init__(version) self.sid: Optional[str] = payload.get("sid") self.account_sid: Optional[str] = payload.get("account_sid") self.flow_sid: Optional[str] = payload.get("flow_sid") self.engagement_sid: Optional[str] = payload.get("engagement_sid") self.name: Optional[str] = payload.get("name") self.context: Optional[Dict[str, object]] = payload.get("context") self.transitioned_from: Optional[str] = payload.get("transitioned_from") self.transitioned_to: Optional[str] = payload.get("transitioned_to") self.date_created: Optional[datetime] = deserialize.iso8601_datetime( payload.get("date_created") ) self.date_updated: Optional[datetime] = deserialize.iso8601_datetime( payload.get("date_updated") ) self.url: Optional[str] = payload.get("url") self.links: Optional[Dict[str, object]] = payload.get("links") self._solution = { "flow_sid": flow_sid, "engagement_sid": engagement_sid, "sid": sid or self.sid, } self._context: Optional[StepContext] = None @property def _proxy(self) -> "StepContext": """ Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context :returns: StepContext for this StepInstance """ if self._context is None: self._context = StepContext( self._version, flow_sid=self._solution["flow_sid"], engagement_sid=self._solution["engagement_sid"], sid=self._solution["sid"], ) return self._context def fetch(self) -> "StepInstance": """ Fetch the StepInstance :returns: The fetched StepInstance """ return self._proxy.fetch() async def fetch_async(self) -> "StepInstance": """ Asynchronous coroutine to fetch the StepInstance :returns: The fetched StepInstance """ return await self._proxy.fetch_async() @property def step_context(self) -> StepContextList: """ Access the step_context """ return self._proxy.step_context def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ context = " ".join("{}={}".format(k, v) for k, v in self._solution.items()) return "".format(context) class StepContext(InstanceContext): def __init__(self, version: Version, flow_sid: str, engagement_sid: str, sid: str): """ Initialize the StepContext :param version: Version that contains the resource :param flow_sid: The SID of the Flow with the Step to fetch. :param engagement_sid: The SID of the Engagement with the Step to fetch. :param sid: The SID of the Step resource to fetch. """ super().__init__(version) # Path Solution self._solution = { "flow_sid": flow_sid, "engagement_sid": engagement_sid, "sid": sid, } self._uri = "/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{sid}".format( **self._solution ) self._step_context: Optional[StepContextList] = None def fetch(self) -> StepInstance: """ Fetch the StepInstance :returns: The fetched StepInstance """ payload = self._version.fetch( method="GET", uri=self._uri, ) return StepInstance( self._version, payload, flow_sid=self._solution["flow_sid"], engagement_sid=self._solution["engagement_sid"], sid=self._solution["sid"], ) async def fetch_async(self) -> StepInstance: """ Asynchronous coroutine to fetch the StepInstance :returns: The fetched StepInstance """ payload = await self._version.fetch_async( method="GET", uri=self._uri, ) return StepInstance( self._version, payload, flow_sid=self._solution["flow_sid"], engagement_sid=self._solution["engagement_sid"], sid=self._solution["sid"], ) @property def step_context(self) -> StepContextList: """ Access the step_context """ if self._step_context is None: self._step_context = StepContextList( self._version, self._solution["flow_sid"], self._solution["engagement_sid"], self._solution["sid"], ) return self._step_context def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ context = " ".join("{}={}".format(k, v) for k, v in self._solution.items()) return "".format(context) class StepPage(Page): def get_instance(self, payload: Dict[str, Any]) -> StepInstance: """ Build an instance of StepInstance :param payload: Payload response from the API """ return StepInstance( self._version, payload, flow_sid=self._solution["flow_sid"], engagement_sid=self._solution["engagement_sid"], ) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return "" class StepList(ListResource): def __init__(self, version: Version, flow_sid: str, engagement_sid: str): """ Initialize the StepList :param version: Version that contains the resource :param flow_sid: The SID of the Flow with the Step to read. :param engagement_sid: The SID of the Engagement with the Step to read. """ super().__init__(version) # Path Solution self._solution = { "flow_sid": flow_sid, "engagement_sid": engagement_sid, } self._uri = "/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps".format( **self._solution ) def stream( self, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> Iterator[StepInstance]: """ 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. :param limit: Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit :param page_size: 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 """ limits = self._version.read_limits(limit, page_size) page = self.page(page_size=limits["page_size"]) return self._version.stream(page, limits["limit"]) async def stream_async( self, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> AsyncIterator[StepInstance]: """ Asynchronously 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. :param limit: Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit :param page_size: 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 """ limits = self._version.read_limits(limit, page_size) page = await self.page_async(page_size=limits["page_size"]) return self._version.stream_async(page, limits["limit"]) def list( self, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[StepInstance]: """ Lists StepInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param limit: Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit :param page_size: 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: list that will contain up to limit results """ return list( self.stream( limit=limit, page_size=page_size, ) ) async def list_async( self, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[StepInstance]: """ Asynchronously lists StepInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param limit: Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit :param page_size: 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: list that will contain up to limit results """ return [ record async for record in await self.stream_async( limit=limit, page_size=page_size, ) ] def page( self, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> StepPage: """ Retrieve a single page of StepInstance records from the API. Request is executed immediately :param page_token: PageToken provided by the API :param page_number: Page Number, this value is simply for client state :param page_size: Number of records to return, defaults to 50 :returns: Page of StepInstance """ data = values.of( { "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = self._version.page(method="GET", uri=self._uri, params=data) return StepPage(self._version, response, self._solution) async def page_async( self, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> StepPage: """ Asynchronously retrieve a single page of StepInstance records from the API. Request is executed immediately :param page_token: PageToken provided by the API :param page_number: Page Number, this value is simply for client state :param page_size: Number of records to return, defaults to 50 :returns: Page of StepInstance """ data = values.of( { "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = await self._version.page_async( method="GET", uri=self._uri, params=data ) return StepPage(self._version, response, self._solution) def get_page(self, target_url: str) -> StepPage: """ Retrieve a specific page of StepInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of StepInstance """ response = self._version.domain.twilio.request("GET", target_url) return StepPage(self._version, response, self._solution) async def get_page_async(self, target_url: str) -> StepPage: """ Asynchronously retrieve a specific page of StepInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of StepInstance """ response = await self._version.domain.twilio.request_async("GET", target_url) return StepPage(self._version, response, self._solution) def get(self, sid: str) -> StepContext: """ Constructs a StepContext :param sid: The SID of the Step resource to fetch. """ return StepContext( self._version, flow_sid=self._solution["flow_sid"], engagement_sid=self._solution["engagement_sid"], sid=sid, ) def __call__(self, sid: str) -> StepContext: """ Constructs a StepContext :param sid: The SID of the Step resource to fetch. """ return StepContext( self._version, flow_sid=self._solution["flow_sid"], engagement_sid=self._solution["engagement_sid"], sid=sid, ) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""