twilio-ruby 4.6.1 → 6.9.0

data/lib/twilio-ruby/rest/studio/v1/flow/engagement.rb

@@ -0,0 +1,429 @@
+##
+#    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.
+#
+
+
+module Twilio
+    module REST
+        class Studio < StudioBase
+            class V1 < Version
+                class FlowContext < InstanceContext
+
+                     class EngagementList < ListResource
+                    ##
+                    # Initialize the EngagementList
+                    # @param [Version] version Version that contains the resource
+                    # @return [EngagementList] EngagementList
+                    def initialize(version, flow_sid: nil)
+                        super(version)
+                        # Path Solution
+                        @solution = { flow_sid: flow_sid }
+                        @uri = "/Flows/#{@solution[:flow_sid]}/Engagements"
+                        
+                    end
+                    ##
+                    # Create the EngagementInstance
+                    # @param [String] to The Contact phone number to start a Studio Flow Engagement, available as variable `{{contact.channel.address}}`.
+                    # @param [String] from The Twilio phone number to send messages or initiate calls from during the Flow Engagement. Available as variable `{{flow.channel.address}}`
+                    # @param [Object] parameters A JSON string we will add to your flow's context and that you can access as variables inside your flow. For example, if you pass in `Parameters={'name':'Zeke'}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string 'Zeke'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.
+                    # @return [EngagementInstance] Created EngagementInstance
+                    def create(
+                        to: nil, 
+                        from: nil, 
+                        parameters: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'To' => to,
+                            'From' => from,
+                            'Parameters' => Twilio.serialize_object(parameters),
+                        })
+
+                        payload = @version.create('POST', @uri, data: data)
+                        EngagementInstance.new(
+                            @version,
+                            payload,
+                            flow_sid: @solution[:flow_sid],
+                        )
+                    end
+
+                
+                    ##
+                    # Lists EngagementInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] 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)
+                    # @return [Array] Array of up to limit results
+                    def list(limit: nil, page_size: nil)
+                        self.stream(
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] 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)
+                    # @return [Enumerable] Enumerable that will yield up to limit results
+                    def stream(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # When passed a block, yields EngagementInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of EngagementInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] page_token PageToken provided by the API
+                    # @param [Integer] page_number Page Number, this value is simply for client state
+                    # @param [Integer] page_size Number of records to return, defaults to 50
+                    # @return [Page] Page of EngagementInstance
+                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+
+                        response = @version.page('GET', @uri, params: params)
+
+                        EngagementPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of EngagementInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of EngagementInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    EngagementPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Studio.V1.EngagementList>'
+                    end
+                end
+
+
+                class EngagementContext < InstanceContext
+                    ##
+                    # Initialize the EngagementContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] flow_sid The SID of the Flow.
+                    # @param [String] sid The SID of the Engagement resource to fetch.
+                    # @return [EngagementContext] EngagementContext
+                    def initialize(version, flow_sid, sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { flow_sid: flow_sid, sid: sid,  }
+                        @uri = "/Flows/#{@solution[:flow_sid]}/Engagements/#{@solution[:sid]}"
+
+                        # Dependents
+                        @steps = nil
+                        @engagement_context = nil
+                    end
+                    ##
+                    # Delete the EngagementInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        @version.delete('DELETE', @uri)
+                    end
+
+                    ##
+                    # Fetch the EngagementInstance
+                    # @return [EngagementInstance] Fetched EngagementInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        EngagementInstance.new(
+                            @version,
+                            payload,
+                            flow_sid: @solution[:flow_sid],
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Access the steps
+                    # @return [StepList]
+                    # @return [StepContext] if sid was passed.
+                    def steps(sid=:unset)
+
+                        raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+                        if sid != :unset
+                            return StepContext.new(@version, @solution[:flow_sid], @solution[:sid],sid )
+                        end
+
+                        unless @steps
+                            @steps = StepList.new(
+                                @version, flow_sid: @solution[:flow_sid], engagement_sid: @solution[:sid], )
+                        end
+
+                     @steps
+                    end
+                    ##
+                    # Access the engagement_context
+                    # @return [EngagementContextList]
+                    # @return [EngagementContextContext]
+                    def engagement_context
+                        EngagementContextContext.new(
+                                @version,
+                                @solution[:flow_sid],
+                                @solution[:sid]
+                                )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Studio.V1.EngagementContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Studio.V1.EngagementContext #{context}>"
+                    end
+                end
+
+                class EngagementPage < Page
+                    ##
+                    # Initialize the EngagementPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [EngagementPage] EngagementPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of EngagementInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [EngagementInstance] EngagementInstance
+                    def get_instance(payload)
+                        EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Studio.V1.EngagementPage>'
+                    end
+                end
+                class EngagementInstance < InstanceResource
+                    ##
+                    # Initialize the EngagementInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Engagement
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [EngagementInstance] EngagementInstance
+                    def initialize(version, payload , flow_sid: nil, sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'account_sid' => payload['account_sid'],
+                            'flow_sid' => payload['flow_sid'],
+                            'contact_sid' => payload['contact_sid'],
+                            'contact_channel_address' => payload['contact_channel_address'],
+                            'context' => payload['context'],
+                            'status' => payload['status'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                            'url' => payload['url'],
+                            'links' => payload['links'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'flow_sid' => flow_sid  || @properties['flow_sid']  ,'sid' => sid  || @properties['sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [EngagementContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = EngagementContext.new(@version , @params['flow_sid'], @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the Engagement resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Engagement resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the Flow.
+                    def flow_sid
+                        @properties['flow_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the Contact.
+                    def contact_sid
+                        @properties['contact_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The phone number, SIP address or Client identifier that triggered this Engagement. Phone numbers are in E.164 format (+16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.
+                    def contact_channel_address
+                        @properties['contact_channel_address']
+                    end
+                    
+                    ##
+                    # @return [Hash] The current state of the execution flow. As your flow executes, we save the state in a flow context. Your widgets can access the data in the flow context as variables, either in configuration fields or in text areas as variable substitution.
+                    def context
+                        @properties['context']
+                    end
+                    
+                    ##
+                    # @return [Status] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the Engagement was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the Engagement was updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [Hash] The URLs of the Engagement's nested resources.
+                    def links
+                        @properties['links']
+                    end
+                    
+                    ##
+                    # Delete the EngagementInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the EngagementInstance
+                    # @return [EngagementInstance] Fetched EngagementInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Access the steps
+                    # @return [steps] steps
+                    def steps
+                        context.steps
+                    end
+
+                    ##
+                    # Access the engagement_context
+                    # @return [engagement_context] engagement_context
+                    def engagement_context
+                        context.engagement_context
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Studio.V1.EngagementInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Studio.V1.EngagementInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+

data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_context.rb

@@ -0,0 +1,217 @@
+##
+#    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.
+#
+
+
+module Twilio
+    module REST
+        class Studio < StudioBase
+            class V1 < Version
+                class FlowContext < InstanceContext
+                class ExecutionContext < InstanceContext
+
+                     class ExecutionContextList < ListResource
+                    ##
+                    # Initialize the ExecutionContextList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ExecutionContextList] ExecutionContextList
+                    def initialize(version, flow_sid: nil, execution_sid: nil)
+                        super(version)
+                        # Path Solution
+                        @solution = { flow_sid: flow_sid, execution_sid: execution_sid }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Studio.V1.ExecutionContextList>'
+                    end
+                end
+
+
+                class ExecutionContextContext < InstanceContext
+                    ##
+                    # Initialize the ExecutionContextContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] flow_sid The SID of the Flow with the Execution context to fetch.
+                    # @param [String] execution_sid The SID of the Execution context to fetch.
+                    # @return [ExecutionContextContext] ExecutionContextContext
+                    def initialize(version, flow_sid, execution_sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { flow_sid: flow_sid, execution_sid: execution_sid,  }
+                        @uri = "/Flows/#{@solution[:flow_sid]}/Executions/#{@solution[:execution_sid]}/Context"
+
+                        
+                    end
+                    ##
+                    # Fetch the ExecutionContextInstance
+                    # @return [ExecutionContextInstance] Fetched ExecutionContextInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        ExecutionContextInstance.new(
+                            @version,
+                            payload,
+                            flow_sid: @solution[:flow_sid],
+                            execution_sid: @solution[:execution_sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Studio.V1.ExecutionContextContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Studio.V1.ExecutionContextContext #{context}>"
+                    end
+                end
+
+                class ExecutionContextPage < Page
+                    ##
+                    # Initialize the ExecutionContextPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ExecutionContextPage] ExecutionContextPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ExecutionContextInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ExecutionContextInstance] ExecutionContextInstance
+                    def get_instance(payload)
+                        ExecutionContextInstance.new(@version, payload, flow_sid: @solution[:flow_sid], execution_sid: @solution[:execution_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Studio.V1.ExecutionContextPage>'
+                    end
+                end
+                class ExecutionContextInstance < InstanceResource
+                    ##
+                    # Initialize the ExecutionContextInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this ExecutionContext
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ExecutionContextInstance] ExecutionContextInstance
+                    def initialize(version, payload , flow_sid: nil, execution_sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'context' => payload['context'],
+                            'flow_sid' => payload['flow_sid'],
+                            'execution_sid' => payload['execution_sid'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'flow_sid' => flow_sid  || @properties['flow_sid']  ,'execution_sid' => execution_sid  || @properties['execution_sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [ExecutionContextContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ExecutionContextContext.new(@version , @params['flow_sid'], @params['execution_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ExecutionContext resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [Hash] 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.
+                    def context
+                        @properties['context']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the Flow.
+                    def flow_sid
+                        @properties['flow_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the context's Execution resource.
+                    def execution_sid
+                        @properties['execution_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the ExecutionContextInstance
+                    # @return [ExecutionContextInstance] Fetched ExecutionContextInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Studio.V1.ExecutionContextInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Studio.V1.ExecutionContextInstance #{values}>"
+                    end
+                end
+
+             end
+             end
+            end
+        end
+    end
+end
+
+