twilio-ruby 7.4.4 → 7.10.4

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [InteractionChannelList] InteractionChannelList
                     def initialize(version, interaction_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { interaction_sid: interaction_sid }
                         @uri = "/Interactions/#{@solution[:interaction_sid]}/Channels"
@@ -71,6 +72,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists InteractionChannelPageMetadata records from the API as a list.
+                    # @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_with_metadata(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        InteractionChannelPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields InteractionChannelInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -92,7 +115,7 @@ module Twilio
                     # @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 InteractionChannelInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
@@ -138,6 +161,7 @@ module Twilio
                     # @return [InteractionChannelContext] InteractionChannelContext
                     def initialize(version, interaction_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { interaction_sid: interaction_sid, sid: sid,  }
@@ -145,6 +169,7 @@ module Twilio
 
                         # Dependents
                         @invites = nil
+                        @transfers = nil
                         @participants = nil
                     end
                     ##
@@ -167,6 +192,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the InteractionChannelInstanceMetadata
+                    # @return [InteractionChannelInstance] Fetched InteractionChannelInstance
+                    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_channel_instance = InteractionChannelInstance.new(
+                            @version,
+                            response.body,
+                            interaction_sid: @solution[:interaction_sid],
+                            sid: @solution[:sid],
+                        )
+                        InteractionChannelInstanceMetadata.new(
+                            @version,
+                            interaction_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the InteractionChannelInstance
                     # @param [UpdateChannelStatus] status 
@@ -197,6 +248,42 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the InteractionChannelInstanceMetadata
+                    # @param [UpdateChannelStatus] status 
+                    # @param [Object] routing It changes the state of associated tasks. Routing status is required, When the channel status is set to `inactive`. Allowed Value for routing status is `closed`. Otherwise Optional, if not specified, all tasks will be set to `wrapping`.
+                    # @return [InteractionChannelInstance] Updated InteractionChannelInstance
+                    def update_with_metadata(
+                      status: nil, 
+                      routing: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Status' => status,
+                            'Routing' => Twilio.serialize_object(routing),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        interaction_channel_instance = InteractionChannelInstance.new(
+                            @version,
+                            response.body,
+                            interaction_sid: @solution[:interaction_sid],
+                            sid: @solution[:sid],
+                        )
+                        InteractionChannelInstanceMetadata.new(
+                            @version,
+                            interaction_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the invites
                     # @return [InteractionChannelInviteList]
@@ -209,6 +296,25 @@ module Twilio
                       @invites
                     end
                     ##
+                    # Access the transfers
+                    # @return [InteractionTransferList]
+                    # @return [InteractionTransferContext] if sid was passed.
+                    def transfers(sid=:unset)
+
+                        raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+                        if sid != :unset
+                            return InteractionTransferContext.new(@version, @solution[:interaction_sid], @solution[:sid],sid )
+                        end
+
+                        unless @transfers
+                            @transfers = InteractionTransferList.new(
+                                @version, interaction_sid: @solution[:interaction_sid], channel_sid: @solution[:sid], )
+                        end
+
+                     @transfers
+                    end
+                    ##
                     # Access the participants
                     # @return [InteractionChannelParticipantList]
                     # @return [InteractionChannelParticipantContext] if sid was passed.
@@ -243,6 +349,53 @@ module Twilio
                     end
                 end
 
+                class InteractionChannelInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new InteractionChannelInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}InteractionChannelInstance] interaction_channel_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 [InteractionChannelInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, interaction_channel_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @interaction_channel_instance = interaction_channel_instance
+                    end
+
+                    def interaction_channel
+                        @interaction_channel_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.InteractionChannelInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class InteractionChannelListResponse < InstanceListResource
+                    # @param [Array<InteractionChannelInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @interaction_channel_instance = payload.body[key].map do |data|
+                        InteractionChannelInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def interaction_channel_instance
+                          @instance
+                      end
+                  end
+
                 class InteractionChannelPage < Page
                     ##
                     # Initialize the InteractionChannelPage
@@ -252,6 +405,7 @@ module Twilio
                     # @return [InteractionChannelPage] InteractionChannelPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -271,6 +425,66 @@ module Twilio
                         '<Twilio.FlexApi.V1.InteractionChannelPage>'
                     end
                 end
+
+                class InteractionChannelPageMetadata < PageMetadata
+                    attr_reader :interaction_channel_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @interaction_channel_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @interaction_channel_page << InteractionChannelListResponse.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_channel_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FlexApi::V1PageMetadata>';
+                    end
+                end
+                class InteractionChannelListResponse < InstanceListResource
+
+                    # @param [Array<InteractionChannelInstance>] 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_channel = data_list.map do |data|
+                        InteractionChannelInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def interaction_channel
+                        @interaction_channel
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class InteractionChannelInstance < InstanceResource
                     ##
                     # Initialize the InteractionChannelInstance
@@ -284,6 +498,7 @@ module Twilio
                     def initialize(version, payload , interaction_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -391,6 +606,13 @@ module Twilio
                         context.invites
                     end
 
+                    ##
+                    # Access the transfers
+                    # @return [transfers] transfers
+                    def transfers
+                        context.transfers
+                    end
+
                     ##
                     # Access the participants
                     # @return [participants] participants

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [InteractionList] InteractionList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Interactions"
@@ -35,17 +36,20 @@ module Twilio
                     # @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
+                        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', })
@@ -61,6 +65,46 @@ module Twilio
                         )
                     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
+
                 
 
 
@@ -79,6 +123,7 @@ module Twilio
                     # @return [InteractionContext] InteractionContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -106,6 +151,89 @@ module Twilio
                         )
                     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]
@@ -141,6 +269,53 @@ module Twilio
                     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
@@ -150,6 +325,7 @@ module Twilio
                     # @return [InteractionPage] InteractionPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -169,6 +345,66 @@ module Twilio
                         '<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
@@ -182,6 +418,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -190,6 +427,7 @@ module Twilio
                             'url' => payload['url'],
                             'links' => payload['links'],
                             'interaction_context_sid' => payload['interaction_context_sid'],
+                            'webhook_ttid' => payload['webhook_ttid'],
                         }
 
                         # Context
@@ -244,6 +482,12 @@ module Twilio
                         @properties['interaction_context_sid']
                     end
                     
+                    ##
+                    # @return [String] 
+                    def webhook_ttid
+                        @properties['webhook_ttid']
+                    end
+                    
                     ##
                     # Fetch the InteractionInstance
                     # @return [InteractionInstance] Fetched InteractionInstance
@@ -252,6 +496,19 @@ module Twilio
                         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