twilio-ruby 5.74.0 → 7.10.1

data/lib/twilio-ruby/rest/flex_api/v1/interaction.rb

@@ -1,233 +1,537 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Flex
+#    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.
 #
-# frozen_string_literal: true
-
-module Twilio
-  module REST
-    class FlexApi < Domain
-      class V1 < Version
-        class InteractionList < ListResource
-          ##
-          # Initialize the InteractionList
-          # @param [Version] version Version that contains the resource
-          # @return [InteractionList] InteractionList
-          def initialize(version)
-            super(version)
-
-            # Path Solution
-            @solution = {}
-            @uri = "/Interactions"
-          end
-
-          ##
-          # Create the InteractionInstance
-          # @param [Hash] channel The Interaction's channel.
-          # @param [Hash] routing The Interaction's routing logic.
-          # @return [InteractionInstance] Created InteractionInstance
-          def create(channel: nil, routing: nil)
-            data = Twilio::Values.of({
-                'Channel' => Twilio.serialize_object(channel),
-                'Routing' => Twilio.serialize_object(routing),
-            })
-
-            payload = @version.create('POST', @uri, data: data)
-
-            InteractionInstance.new(@version, payload, )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '#<Twilio.FlexApi.V1.InteractionList>'
-          end
-        end
-
-        class InteractionPage < Page
-          ##
-          # Initialize the InteractionPage
-          # @param [Version] version Version that contains the resource
-          # @param [Response] response Response from the API
-          # @param [Hash] solution Path solution for the resource
-          # @return [InteractionPage] InteractionPage
-          def initialize(version, response, solution)
-            super(version, response)
-
-            # Path Solution
-            @solution = solution
-          end
-
-          ##
-          # Build an instance of InteractionInstance
-          # @param [Hash] payload Payload response from the API
-          # @return [InteractionInstance] InteractionInstance
-          def get_instance(payload)
-            InteractionInstance.new(@version, payload, )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '<Twilio.FlexApi.V1.InteractionPage>'
-          end
-        end
-
-        class InteractionContext < InstanceContext
-          ##
-          # Initialize the InteractionContext
-          # @param [Version] version Version that contains the resource
-          # @param [String] sid The SID of the Interaction resource to fetch.
-          # @return [InteractionContext] InteractionContext
-          def initialize(version, sid)
-            super(version)
-
-            # Path Solution
-            @solution = {sid: sid, }
-            @uri = "/Interactions/#{@solution[:sid]}"
-
-            # Dependents
-            @channels = nil
-          end
-
-          ##
-          # Fetch the InteractionInstance
-          # @return [InteractionInstance] Fetched InteractionInstance
-          def fetch
-            payload = @version.fetch('GET', @uri)
-
-            InteractionInstance.new(@version, payload, sid: @solution[:sid], )
-          end
-
-          ##
-          # Access the channels
-          # @return [InteractionChannelList]
-          # @return [InteractionChannelContext] if sid was passed.
-          def channels(sid=:unset)
-            raise ArgumentError, 'sid cannot be nil' if sid.nil?
-
-            if sid != :unset
-              return InteractionChannelContext.new(@version, @solution[:sid], sid, )
-            end
 
-            unless @channels
-              @channels = InteractionChannelList.new(@version, interaction_sid: @solution[:sid], )
-            end
 
-            @channels
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.FlexApi.V1.InteractionContext #{context}>"
-          end
-
-          ##
-          # Provide a detailed, user friendly representation
-          def inspect
-            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.FlexApi.V1.InteractionContext #{context}>"
-          end
-        end
+module Twilio
+    module REST
+        class FlexApi < FlexApiBase
+            class V1 < Version
+                class InteractionList < ListResource
+                
+                    ##
+                    # Initialize the InteractionList
+                    # @param [Version] version Version that contains the resource
+                    # @return [InteractionList] InteractionList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Interactions"
+                        
+                    end
+                    ##
+                    # Create the InteractionInstance
+                    # @param [Object] channel The Interaction's channel.
+                    # @param [Object] routing The Interaction's routing logic.
+                    # @param [String] interaction_context_sid The Interaction context sid is used for adding a context lookup sid
+                    # @param [String] webhook_ttid The unique identifier for Interaction level webhook
+                    # @return [InteractionInstance] Created InteractionInstance
+                    def create(
+                        channel: nil, 
+                        routing: :unset, 
+                        interaction_context_sid: :unset, 
+                        webhook_ttid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Channel' => Twilio.serialize_object(channel),
+                            'Routing' => Twilio.serialize_object(routing),
+                            'InteractionContextSid' => interaction_context_sid,
+                            'WebhookTtid' => webhook_ttid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        InteractionInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the InteractionInstanceMetadata
+                    # @param [Object] channel The Interaction's channel.
+                    # @param [Object] routing The Interaction's routing logic.
+                    # @param [String] interaction_context_sid The Interaction context sid is used for adding a context lookup sid
+                    # @param [String] webhook_ttid The unique identifier for Interaction level webhook
+                    # @return [InteractionInstance] Created InteractionInstance
+                    def create_with_metadata(
+                      channel: nil, 
+                      routing: :unset, 
+                      interaction_context_sid: :unset, 
+                      webhook_ttid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Channel' => Twilio.serialize_object(channel),
+                            'Routing' => Twilio.serialize_object(routing),
+                            'InteractionContextSid' => interaction_context_sid,
+                            'WebhookTtid' => webhook_ttid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        interaction_instance = InteractionInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        InteractionInstanceMetadata.new(
+                            @version,
+                            interaction_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.FlexApi.V1.InteractionList>'
+                    end
+                end
+
+
+                class InteractionContext < InstanceContext
+                    ##
+                    # Initialize the InteractionContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] sid The SID of the Interaction resource to fetch.
+                    # @return [InteractionContext] InteractionContext
+                    def initialize(version, sid)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { sid: sid,  }
+                        @uri = "/Interactions/#{@solution[:sid]}"
+
+                        # Dependents
+                        @channels = nil
+                    end
+                    ##
+                    # Fetch the InteractionInstance
+                    # @return [InteractionInstance] Fetched InteractionInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        InteractionInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Fetch the InteractionInstanceMetadata
+                    # @return [InteractionInstance] Fetched InteractionInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        interaction_instance = InteractionInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        InteractionInstanceMetadata.new(
+                            @version,
+                            interaction_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Update the InteractionInstance
+                    # @param [String] webhook_ttid The unique identifier for Interaction level webhook
+                    # @return [InteractionInstance] Updated InteractionInstance
+                    def update(
+                        webhook_ttid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'WebhookTtid' => webhook_ttid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
+                        InteractionInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Update the InteractionInstanceMetadata
+                    # @param [String] webhook_ttid The unique identifier for Interaction level webhook
+                    # @return [InteractionInstance] Updated InteractionInstance
+                    def update_with_metadata(
+                      webhook_ttid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'WebhookTtid' => webhook_ttid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        interaction_instance = InteractionInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        InteractionInstanceMetadata.new(
+                            @version,
+                            interaction_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Access the channels
+                    # @return [InteractionChannelList]
+                    # @return [InteractionChannelContext] if sid was passed.
+                    def channels(sid=:unset)
+
+                        raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+                        if sid != :unset
+                            return InteractionChannelContext.new(@version, @solution[:sid],sid )
+                        end
+
+                        unless @channels
+                            @channels = InteractionChannelList.new(
+                                @version, interaction_sid: @solution[:sid], )
+                        end
+
+                     @channels
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.FlexApi.V1.InteractionContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.FlexApi.V1.InteractionContext #{context}>"
+                    end
+                end
+
+                class InteractionInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new InteractionInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}InteractionInstance] interaction_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [InteractionInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, interaction_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @interaction_instance = interaction_instance
+                    end
+
+                    def interaction
+                        @interaction_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.InteractionInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class InteractionListResponse < InstanceListResource
+                    # @param [Array<InteractionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @interaction_instance = payload.body[key].map do |data|
+                        InteractionInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def interaction_instance
+                          @instance
+                      end
+                  end
+
+                class InteractionPage < Page
+                    ##
+                    # Initialize the InteractionPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [InteractionPage] InteractionPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of InteractionInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [InteractionInstance] InteractionInstance
+                    def get_instance(payload)
+                        InteractionInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.FlexApi.V1.InteractionPage>'
+                    end
+                end
+
+                class InteractionPageMetadata < PageMetadata
+                    attr_reader :interaction_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @interaction_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @interaction_page << InteractionListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @interaction_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FlexApi::V1PageMetadata>';
+                    end
+                end
+                class InteractionListResponse < InstanceListResource
+
+                    # @param [Array<InteractionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @interaction = data_list.map do |data|
+                        InteractionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def interaction
+                        @interaction
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class InteractionInstance < InstanceResource
+                    ##
+                    # Initialize the InteractionInstance
+                    # @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 Interaction
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [InteractionInstance] InteractionInstance
+                    def initialize(version, payload , sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'channel' => payload['channel'],
+                            'routing' => payload['routing'],
+                            'url' => payload['url'],
+                            'links' => payload['links'],
+                            'interaction_context_sid' => payload['interaction_context_sid'],
+                            'webhook_ttid' => payload['webhook_ttid'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { '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 [InteractionContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = InteractionContext.new(@version , @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [Hash] A JSON object that defines the Interaction’s communication channel and includes details about the channel. See the [Outbound SMS](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) and [inbound (API-initiated)](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#api-initiated-contact) Channel object examples.
+                    def channel
+                        @properties['channel']
+                    end
+                    
+                    ##
+                    # @return [Hash] A JSON Object representing the routing rules for the Interaction Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality.   All attributes in the Routing object on your Interaction request body are added “as is” to the task. For a list of known attributes consumed by the Flex UI and/or Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes).
+                    def routing
+                        @properties['routing']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def links
+                        @properties['links']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def interaction_context_sid
+                        @properties['interaction_context_sid']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def webhook_ttid
+                        @properties['webhook_ttid']
+                    end
+                    
+                    ##
+                    # Fetch the InteractionInstance
+                    # @return [InteractionInstance] Fetched InteractionInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the InteractionInstance
+                    # @param [String] webhook_ttid The unique identifier for Interaction level webhook
+                    # @return [InteractionInstance] Updated InteractionInstance
+                    def update(
+                        webhook_ttid: :unset
+                    )
+
+                        context.update(
+                            webhook_ttid: webhook_ttid, 
+                        )
+                    end
+
+                    ##
+                    # Access the channels
+                    # @return [channels] channels
+                    def channels
+                        context.channels
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.FlexApi.V1.InteractionInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.FlexApi.V1.InteractionInstance #{values}>"
+                    end
+                end
 
-        class InteractionInstance < InstanceResource
-          ##
-          # Initialize the InteractionInstance
-          # @param [Version] version Version that contains the resource
-          # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The SID of the Interaction resource to fetch.
-          # @return [InteractionInstance] InteractionInstance
-          def initialize(version, payload, sid: nil)
-            super(version)
-
-            # Marshaled Properties
-            @properties = {
-                'sid' => payload['sid'],
-                'channel' => payload['channel'],
-                'routing' => payload['routing'],
-                'url' => payload['url'],
-                'links' => payload['links'],
-            }
-
-            # Context
-            @instance_context = nil
-            @params = {'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 [InteractionContext] InteractionContext for this InteractionInstance
-          def context
-            unless @instance_context
-              @instance_context = InteractionContext.new(@version, @params['sid'], )
             end
-            @instance_context
-          end
-
-          ##
-          # @return [String] The unique string that identifies the resource
-          def sid
-            @properties['sid']
-          end
-
-          ##
-          # @return [Hash] The Interaction's channel
-          def channel
-            @properties['channel']
-          end
-
-          ##
-          # @return [Hash] A JSON Object representing the routing rules for the Interaction Channel
-          def routing
-            @properties['routing']
-          end
-
-          ##
-          # @return [String] The url
-          def url
-            @properties['url']
-          end
-
-          ##
-          # @return [String] The links
-          def links
-            @properties['links']
-          end
-
-          ##
-          # Fetch the InteractionInstance
-          # @return [InteractionInstance] Fetched InteractionInstance
-          def fetch
-            context.fetch
-          end
-
-          ##
-          # Access the channels
-          # @return [channels] channels
-          def channels
-            context.channels
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.FlexApi.V1.InteractionInstance #{values}>"
-          end
-
-          ##
-          # Provide a detailed, user friendly representation
-          def inspect
-            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.FlexApi.V1.InteractionInstance #{values}>"
-          end
         end
-      end
     end
-  end
-end
+end