twilio-ruby 5.19.0 → 5.77.0

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

@@ -0,0 +1,144 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class InsightsSettingsAnswerSetsList < ListResource
+          ##
+          # Initialize the InsightsSettingsAnswerSetsList
+          # @param [Version] version Version that contains the resource
+          # @return [InsightsSettingsAnswerSetsList] InsightsSettingsAnswerSetsList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Insights/QM/Settings/AnswerSets"
+          end
+
+          ##
+          # Fetch the InsightsSettingsAnswerSetsInstance
+          # @param [String] token The Token HTTP request header
+          # @return [InsightsSettingsAnswerSetsInstance] Fetched InsightsSettingsAnswerSetsInstance
+          def fetch(token: :unset)
+            headers = Twilio::Values.of({'Token' => token, })
+
+            payload = @version.fetch('GET', @uri, headers: headers)
+
+            InsightsSettingsAnswerSetsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FlexApi.V1.InsightsSettingsAnswerSetsList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class InsightsSettingsAnswerSetsPage < Page
+          ##
+          # Initialize the InsightsSettingsAnswerSetsPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [InsightsSettingsAnswerSetsPage] InsightsSettingsAnswerSetsPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of InsightsSettingsAnswerSetsInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [InsightsSettingsAnswerSetsInstance] InsightsSettingsAnswerSetsInstance
+          def get_instance(payload)
+            InsightsSettingsAnswerSetsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FlexApi.V1.InsightsSettingsAnswerSetsPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class InsightsSettingsAnswerSetsInstance < InstanceResource
+          ##
+          # Initialize the InsightsSettingsAnswerSetsInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [InsightsSettingsAnswerSetsInstance] InsightsSettingsAnswerSetsInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'answer_sets' => payload['answer_sets'],
+                'answer_set_categories' => payload['answer_set_categories'],
+                'not_applicable' => payload['not_applicable'],
+                'url' => payload['url'],
+            }
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource and owns this Flex Insights
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [Hash] Answer Set list
+          def answer_sets
+            @properties['answer_sets']
+          end
+
+          ##
+          # @return [Hash] Categories of Answer Set
+          def answer_set_categories
+            @properties['answer_set_categories']
+          end
+
+          ##
+          # @return [Hash] NA answer set
+          def not_applicable
+            @properties['not_applicable']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.FlexApi.V1.InsightsSettingsAnswerSetsInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.FlexApi.V1.InsightsSettingsAnswerSetsInstance>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,130 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class InsightsSettingsCommentList < ListResource
+          ##
+          # Initialize the InsightsSettingsCommentList
+          # @param [Version] version Version that contains the resource
+          # @return [InsightsSettingsCommentList] InsightsSettingsCommentList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Insights/QM/Settings/CommentTags"
+          end
+
+          ##
+          # Fetch the InsightsSettingsCommentInstance
+          # @param [String] token The Token HTTP request header
+          # @return [InsightsSettingsCommentInstance] Fetched InsightsSettingsCommentInstance
+          def fetch(token: :unset)
+            headers = Twilio::Values.of({'Token' => token, })
+
+            payload = @version.fetch('GET', @uri, headers: headers)
+
+            InsightsSettingsCommentInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FlexApi.V1.InsightsSettingsCommentList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class InsightsSettingsCommentPage < Page
+          ##
+          # Initialize the InsightsSettingsCommentPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [InsightsSettingsCommentPage] InsightsSettingsCommentPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of InsightsSettingsCommentInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [InsightsSettingsCommentInstance] InsightsSettingsCommentInstance
+          def get_instance(payload)
+            InsightsSettingsCommentInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FlexApi.V1.InsightsSettingsCommentPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class InsightsSettingsCommentInstance < InstanceResource
+          ##
+          # Initialize the InsightsSettingsCommentInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [InsightsSettingsCommentInstance] InsightsSettingsCommentInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'comments' => payload['comments'],
+                'url' => payload['url'],
+            }
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource and owns this Flex Insights
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [Hash] The comments
+          def comments
+            @properties['comments']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.FlexApi.V1.InsightsSettingsCommentInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.FlexApi.V1.InsightsSettingsCommentInstance>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,174 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class InsightsUserRolesList < ListResource
+          ##
+          # Initialize the InsightsUserRolesList
+          # @param [Version] version Version that contains the resource
+          # @return [InsightsUserRolesList] InsightsUserRolesList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FlexApi.V1.InsightsUserRolesList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class InsightsUserRolesPage < Page
+          ##
+          # Initialize the InsightsUserRolesPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [InsightsUserRolesPage] InsightsUserRolesPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of InsightsUserRolesInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [InsightsUserRolesInstance] InsightsUserRolesInstance
+          def get_instance(payload)
+            InsightsUserRolesInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FlexApi.V1.InsightsUserRolesPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class InsightsUserRolesContext < InstanceContext
+          ##
+          # Initialize the InsightsUserRolesContext
+          # @param [Version] version Version that contains the resource
+          # @return [InsightsUserRolesContext] InsightsUserRolesContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Insights/UserRoles"
+          end
+
+          ##
+          # Fetch the InsightsUserRolesInstance
+          # @param [String] authorization The Authorization HTTP request header
+          # @return [InsightsUserRolesInstance] Fetched InsightsUserRolesInstance
+          def fetch(authorization: :unset)
+            headers = Twilio::Values.of({'Authorization' => authorization, })
+
+            payload = @version.fetch('GET', @uri, headers: headers)
+
+            InsightsUserRolesInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FlexApi.V1.InsightsUserRolesContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FlexApi.V1.InsightsUserRolesContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class InsightsUserRolesInstance < InstanceResource
+          ##
+          # Initialize the InsightsUserRolesInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [InsightsUserRolesInstance] InsightsUserRolesInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {'roles' => payload['roles'], 'url' => payload['url'], }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          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 [InsightsUserRolesContext] InsightsUserRolesContext for this InsightsUserRolesInstance
+          def context
+            unless @instance_context
+              @instance_context = InsightsUserRolesContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [Array[String]] Flex Insights roles for the user
+          def roles
+            @properties['roles']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the InsightsUserRolesInstance
+          # @param [String] authorization The Authorization HTTP request header
+          # @return [InsightsUserRolesInstance] Fetched InsightsUserRolesInstance
+          def fetch(authorization: :unset)
+            context.fetch(authorization: authorization, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FlexApi.V1.InsightsUserRolesInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FlexApi.V1.InsightsUserRolesInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,236 @@
+##
+# 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 InteractionChannelContext < InstanceContext
+            class InteractionChannelInviteList < ListResource
+              ##
+              # Initialize the InteractionChannelInviteList
+              # @param [Version] version Version that contains the resource
+              # @param [String] interaction_sid The Interaction SID for this Channel.
+              # @param [String] channel_sid The Channel SID for this Invite.
+              # @return [InteractionChannelInviteList] InteractionChannelInviteList
+              def initialize(version, interaction_sid: nil, channel_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {interaction_sid: interaction_sid, channel_sid: channel_sid}
+                @uri = "/Interactions/#{@solution[:interaction_sid]}/Channels/#{@solution[:channel_sid]}/Invites"
+              end
+
+              ##
+              # Create the InteractionChannelInviteInstance
+              # @param [Hash] routing The Interaction's routing logic.
+              # @return [InteractionChannelInviteInstance] Created InteractionChannelInviteInstance
+              def create(routing: nil)
+                data = Twilio::Values.of({'Routing' => Twilio.serialize_object(routing), })
+
+                payload = @version.create('POST', @uri, data: data)
+
+                InteractionChannelInviteInstance.new(
+                    @version,
+                    payload,
+                    interaction_sid: @solution[:interaction_sid],
+                    channel_sid: @solution[:channel_sid],
+                )
+              end
+
+              ##
+              # Lists InteractionChannelInviteInstance 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 InteractionChannelInviteInstance 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 InteractionChannelInviteInstance 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 InteractionChannelInviteInstance 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 InteractionChannelInviteInstance
+              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)
+
+                InteractionChannelInvitePage.new(@version, response, @solution)
+              end
+
+              ##
+              # Retrieve a single page of InteractionChannelInviteInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] target_url API-generated URL for the requested results page
+              # @return [Page] Page of InteractionChannelInviteInstance
+              def get_page(target_url)
+                response = @version.domain.request(
+                    'GET',
+                    target_url
+                )
+                InteractionChannelInvitePage.new(@version, response, @solution)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.FlexApi.V1.InteractionChannelInviteList>'
+              end
+            end
+
+            class InteractionChannelInvitePage < Page
+              ##
+              # Initialize the InteractionChannelInvitePage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [InteractionChannelInvitePage] InteractionChannelInvitePage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of InteractionChannelInviteInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [InteractionChannelInviteInstance] InteractionChannelInviteInstance
+              def get_instance(payload)
+                InteractionChannelInviteInstance.new(
+                    @version,
+                    payload,
+                    interaction_sid: @solution[:interaction_sid],
+                    channel_sid: @solution[:channel_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.FlexApi.V1.InteractionChannelInvitePage>'
+              end
+            end
+
+            class InteractionChannelInviteInstance < InstanceResource
+              ##
+              # Initialize the InteractionChannelInviteInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] interaction_sid The Interaction SID for this Channel.
+              # @param [String] channel_sid The Channel SID for this Invite.
+              # @return [InteractionChannelInviteInstance] InteractionChannelInviteInstance
+              def initialize(version, payload, interaction_sid: nil, channel_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'sid' => payload['sid'],
+                    'interaction_sid' => payload['interaction_sid'],
+                    'channel_sid' => payload['channel_sid'],
+                    'routing' => payload['routing'],
+                    'url' => payload['url'],
+                }
+              end
+
+              ##
+              # @return [String] The unique string that identifies the resource
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [String] The Interaction SID for this Channel
+              def interaction_sid
+                @properties['interaction_sid']
+              end
+
+              ##
+              # @return [String] The Channel SID for this Invite
+              def channel_sid
+                @properties['channel_sid']
+              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
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.FlexApi.V1.InteractionChannelInviteInstance>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                "<Twilio.FlexApi.V1.InteractionChannelInviteInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end