twilio-ruby 5.40.3 → 5.74.1

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

@@ -0,0 +1,405 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi < Domain
+      class V1 < Version
+        class InteractionContext < InstanceContext
+          class InteractionChannelList < ListResource
+            ##
+            # Initialize the InteractionChannelList
+            # @param [Version] version Version that contains the resource
+            # @param [String] interaction_sid The unique string created by Twilio to identify
+            #   an Interaction resource, prefixed with KD.
+            # @return [InteractionChannelList] InteractionChannelList
+            def initialize(version, interaction_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {interaction_sid: interaction_sid}
+              @uri = "/Interactions/#{@solution[:interaction_sid]}/Channels"
+            end
+
+            ##
+            # Lists InteractionChannelInstance 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 InteractionChannelInstance 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 InteractionChannelInstance 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 InteractionChannelInstance 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 InteractionChannelInstance
+            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)
+
+              InteractionChannelPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of InteractionChannelInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of InteractionChannelInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              InteractionChannelPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.FlexApi.V1.InteractionChannelList>'
+            end
+          end
+
+          class InteractionChannelPage < Page
+            ##
+            # Initialize the InteractionChannelPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [InteractionChannelPage] InteractionChannelPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of InteractionChannelInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [InteractionChannelInstance] InteractionChannelInstance
+            def get_instance(payload)
+              InteractionChannelInstance.new(@version, payload, interaction_sid: @solution[:interaction_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.FlexApi.V1.InteractionChannelPage>'
+            end
+          end
+
+          class InteractionChannelContext < InstanceContext
+            ##
+            # Initialize the InteractionChannelContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] interaction_sid The unique string created by Twilio to identify
+            #   an Interaction resource, prefixed with KD.
+            # @param [String] sid The unique string created by Twilio to identify an
+            #   Interaction Channel resource, prefixed with UO.
+            # @return [InteractionChannelContext] InteractionChannelContext
+            def initialize(version, interaction_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {interaction_sid: interaction_sid, sid: sid, }
+              @uri = "/Interactions/#{@solution[:interaction_sid]}/Channels/#{@solution[:sid]}"
+
+              # Dependents
+              @invites = nil
+              @participants = nil
+            end
+
+            ##
+            # Fetch the InteractionChannelInstance
+            # @return [InteractionChannelInstance] Fetched InteractionChannelInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              InteractionChannelInstance.new(
+                  @version,
+                  payload,
+                  interaction_sid: @solution[:interaction_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Update the InteractionChannelInstance
+            # @param [interaction_channel.Status] status Required. Indicates the Interaction
+            #   channel's status. When a channel is set to `closed`, all tasks are put in the
+            #   `wrapping` state by default unless the Routing status is set to `closed` in
+            #   which case the tasks will be `completed`. Value: `closed`.
+            # @param [Hash] routing Optional. The state of associated tasks. If not specified,
+            #   all tasks will be set to `wrapping`.
+            # @return [InteractionChannelInstance] Updated InteractionChannelInstance
+            def update(status: nil, routing: :unset)
+              data = Twilio::Values.of({'Status' => status, 'Routing' => Twilio.serialize_object(routing), })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              InteractionChannelInstance.new(
+                  @version,
+                  payload,
+                  interaction_sid: @solution[:interaction_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Access the invites
+            # @return [InteractionChannelInviteList]
+            # @return [InteractionChannelInviteContext]
+            def invites
+              unless @invites
+                @invites = InteractionChannelInviteList.new(
+                    @version,
+                    interaction_sid: @solution[:interaction_sid],
+                    channel_sid: @solution[:sid],
+                )
+              end
+
+              @invites
+            end
+
+            ##
+            # Access the participants
+            # @return [InteractionChannelParticipantList]
+            # @return [InteractionChannelParticipantContext] if sid was passed.
+            def participants(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return InteractionChannelParticipantContext.new(
+                    @version,
+                    @solution[:interaction_sid],
+                    @solution[:sid],
+                    sid,
+                )
+              end
+
+              unless @participants
+                @participants = InteractionChannelParticipantList.new(
+                    @version,
+                    interaction_sid: @solution[:interaction_sid],
+                    channel_sid: @solution[:sid],
+                )
+              end
+
+              @participants
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.FlexApi.V1.InteractionChannelContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.FlexApi.V1.InteractionChannelContext #{context}>"
+            end
+          end
+
+          class InteractionChannelInstance < InstanceResource
+            ##
+            # Initialize the InteractionChannelInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] interaction_sid The unique string created by Twilio to identify
+            #   an Interaction resource, prefixed with KD.
+            # @param [String] sid The unique string created by Twilio to identify an
+            #   Interaction Channel resource, prefixed with UO.
+            # @return [InteractionChannelInstance] InteractionChannelInstance
+            def initialize(version, payload, interaction_sid: nil, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'interaction_sid' => payload['interaction_sid'],
+                  'type' => payload['type'],
+                  'status' => payload['status'],
+                  'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
+                  'error_message' => payload['error_message'],
+                  'url' => payload['url'],
+                  'links' => payload['links'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'interaction_sid' => interaction_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 [InteractionChannelContext] InteractionChannelContext for this InteractionChannelInstance
+            def context
+              unless @instance_context
+                @instance_context = InteractionChannelContext.new(
+                    @version,
+                    @params['interaction_sid'],
+                    @params['sid'],
+                )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique string that identifies the resource
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The unique string that identifies the resource.
+            def interaction_sid
+              @properties['interaction_sid']
+            end
+
+            ##
+            # @return [interaction_channel.Type] The Interaction Channel's type.
+            def type
+              @properties['type']
+            end
+
+            ##
+            # @return [interaction_channel.ChannelStatus] The status of this channel.
+            def status
+              @properties['status']
+            end
+
+            ##
+            # @return [String] The Twilio error code for a failed channel.
+            def error_code
+              @properties['error_code']
+            end
+
+            ##
+            # @return [String] The error message for a failed channel.
+            def error_message
+              @properties['error_message']
+            end
+
+            ##
+            # @return [String] The url
+            def url
+              @properties['url']
+            end
+
+            ##
+            # @return [String] The links
+            def links
+              @properties['links']
+            end
+
+            ##
+            # Fetch the InteractionChannelInstance
+            # @return [InteractionChannelInstance] Fetched InteractionChannelInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the InteractionChannelInstance
+            # @param [interaction_channel.Status] status Required. Indicates the Interaction
+            #   channel's status. When a channel is set to `closed`, all tasks are put in the
+            #   `wrapping` state by default unless the Routing status is set to `closed` in
+            #   which case the tasks will be `completed`. Value: `closed`.
+            # @param [Hash] routing Optional. The state of associated tasks. If not specified,
+            #   all tasks will be set to `wrapping`.
+            # @return [InteractionChannelInstance] Updated InteractionChannelInstance
+            def update(status: nil, routing: :unset)
+              context.update(status: status, routing: routing, )
+            end
+
+            ##
+            # Access the invites
+            # @return [invites] invites
+            def invites
+              context.invites
+            end
+
+            ##
+            # Access the participants
+            # @return [participants] participants
+            def participants
+              context.participants
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.FlexApi.V1.InteractionChannelInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.FlexApi.V1.InteractionChannelInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,233 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# 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
+
+        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