twilio-ruby 5.19.0 → 5.77.0

data/lib/twilio-ruby/rest/flex_api/v2.rb

@@ -0,0 +1,35 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi
+      class V2 < Version
+        ##
+        # Initialize the V2 version of FlexApi
+        def initialize(domain)
+          super
+          @version = 'v2'
+          @web_channels = nil
+        end
+
+        ##
+        # @return [Twilio::REST::Flex_api::V2::WebChannelsContext]
+        def web_channels
+          @web_channels ||= WebChannelsList.new self
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::FlexApi::V2>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,169 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi < Domain
+      ##
+      # Initialize the FlexApi Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://flex-api.twilio.com'
+        @host = 'flex-api.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+        @v2 = nil
+      end
+
+      ##
+      # Version v1 of flex_api
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # Version v2 of flex_api
+      def v2
+        @v2 ||= V2.new self
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Channel
+      #   resource.
+      # @return [Twilio::REST::Flex_api::V1::ChannelInstance] if sid was passed.
+      # @return [Twilio::REST::Flex_api::V1::ChannelList]
+      def channel(sid=:unset)
+        self.v1.channel(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Flex_api::V1::ConfigurationInstance]
+      def configuration
+        self.v1.configuration()
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Flex Flow
+      #   resource.
+      # @return [Twilio::REST::Flex_api::V1::FlexFlowInstance] if sid was passed.
+      # @return [Twilio::REST::Flex_api::V1::FlexFlowList]
+      def flex_flow(sid=:unset)
+        self.v1.flex_flow(sid)
+      end
+
+      ##
+      # @param [String] assessment_id The unique id of the assessment
+      # @return [Twilio::REST::Flex_api::V1::AssessmentsInstance] if assessment_id was passed.
+      # @return [Twilio::REST::Flex_api::V1::AssessmentsList]
+      def assessments(assessment_id=:unset)
+        self.v1.assessments(assessment_id)
+      end
+
+      ##
+      # @return [Twilio::REST::Flex_api::V1::InsightsAssessmentsCommentInstance]
+      def insights_assessments_comment
+        self.v1.insights_assessments_comment()
+      end
+
+      ##
+      # @return [Twilio::REST::Flex_api::V1::InsightsConversationsInstance]
+      def insights_conversations
+        self.v1.insights_conversations()
+      end
+
+      ##
+      # @param [String] id The unique id of this questionnaire
+      # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesInstance] if id was passed.
+      # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesList]
+      def insights_questionnaires(id=:unset)
+        self.v1.insights_questionnaires(id)
+      end
+
+      ##
+      # @param [String] category_id The unique ID for the category
+      # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesCategoryInstance] if category_id was passed.
+      # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesCategoryList]
+      def insights_questionnaires_category(category_id=:unset)
+        self.v1.insights_questionnaires_category(category_id)
+      end
+
+      ##
+      # @param [String] question_id The unique ID of the question
+      # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesQuestionInstance] if question_id was passed.
+      # @return [Twilio::REST::Flex_api::V1::InsightsQuestionnairesQuestionList]
+      def insights_questionnaires_question(question_id=:unset)
+        self.v1.insights_questionnaires_question(question_id)
+      end
+
+      ##
+      # @param [String] segment_id To unique id of the segment
+      # @return [Twilio::REST::Flex_api::V1::InsightsSegmentsInstance] if segment_id was passed.
+      # @return [Twilio::REST::Flex_api::V1::InsightsSegmentsList]
+      def insights_segments(segment_id=:unset)
+        self.v1.insights_segments(segment_id)
+      end
+
+      ##
+      # @return [Twilio::REST::Flex_api::V1::InsightsSessionInstance]
+      def insights_session
+        self.v1.insights_session()
+      end
+
+      ##
+      # @return [Twilio::REST::Flex_api::V1::InsightsSettingsAnswerSetsInstance]
+      def insights_settings_answer_sets
+        self.v1.insights_settings_answer_sets()
+      end
+
+      ##
+      # @return [Twilio::REST::Flex_api::V1::InsightsSettingsCommentInstance]
+      def insights_settings_comment
+        self.v1.insights_settings_comment()
+      end
+
+      ##
+      # @return [Twilio::REST::Flex_api::V1::InsightsUserRolesInstance]
+      def insights_user_roles
+        self.v1.insights_user_roles()
+      end
+
+      ##
+      # @param [String] sid The unique string created by Twilio to identify an
+      #   Interaction resource, prefixed with KD.
+      # @return [Twilio::REST::Flex_api::V1::InteractionInstance] if sid was passed.
+      # @return [Twilio::REST::Flex_api::V1::InteractionList]
+      def interaction(sid=:unset)
+        self.v1.interaction(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the WebChannel
+      #   resource.
+      # @return [Twilio::REST::Flex_api::V1::WebChannelInstance] if sid was passed.
+      # @return [Twilio::REST::Flex_api::V1::WebChannelList]
+      def web_channel(sid=:unset)
+        self.v1.web_channel(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Flex_api::V2::WebChannelsInstance]
+      def web_channels
+        self.v2.web_channels()
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::FlexApi>'
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/frontline_api/v1/user.rb

@@ -0,0 +1,258 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FrontlineApi < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserList < ListResource
+          ##
+          # Initialize the UserList
+          # @param [Version] version Version that contains the resource
+          # @return [UserList] UserList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FrontlineApi.V1.UserList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserPage < Page
+          ##
+          # Initialize the UserPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [UserPage] UserPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of UserInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [UserInstance] UserInstance
+          def get_instance(payload)
+            UserInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FrontlineApi.V1.UserPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserContext < InstanceContext
+          ##
+          # Initialize the UserContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the User resource to fetch. This value can be
+          #   either the `sid` or the `identity` of the User resource to fetch.
+          # @return [UserContext] UserContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Users/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the UserInstance
+          # @return [UserInstance] Fetched UserInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            UserInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Update the UserInstance
+          # @param [String] friendly_name The string that you assigned to describe the User.
+          # @param [String] avatar The avatar URL which will be shown in Frontline
+          #   application.
+          # @param [user.StateType] state Current state of this user. Can be either `active`
+          #   or `deactivated`.
+          # @param [Boolean] is_available Whether the User is available for new
+          #   conversations. Set to `false` to prevent User from receiving new inbound
+          #   conversations if you are using {Pool
+          #   Routing}[https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing].
+          # @return [UserInstance] Updated UserInstance
+          def update(friendly_name: :unset, avatar: :unset, state: :unset, is_available: :unset)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'Avatar' => avatar,
+                'State' => state,
+                'IsAvailable' => is_available,
+            })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            UserInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FrontlineApi.V1.UserContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FrontlineApi.V1.UserContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserInstance < InstanceResource
+          ##
+          # Initialize the UserInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the User resource to fetch. This value can be
+          #   either the `sid` or the `identity` of the User resource to fetch.
+          # @return [UserInstance] UserInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'identity' => payload['identity'],
+                'friendly_name' => payload['friendly_name'],
+                'avatar' => payload['avatar'],
+                'state' => payload['state'],
+                'is_available' => payload['is_available'],
+                'url' => payload['url'],
+            }
+
+            # 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 [UserContext] UserContext for this UserInstance
+          def context
+            unless @instance_context
+              @instance_context = UserContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The string that identifies the resource's User
+          def identity
+            @properties['identity']
+          end
+
+          ##
+          # @return [String] The string that you assigned to describe the User
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] The avatar URL which will be shown in Frontline application
+          def avatar
+            @properties['avatar']
+          end
+
+          ##
+          # @return [user.StateType] Current state of this user
+          def state
+            @properties['state']
+          end
+
+          ##
+          # @return [Boolean] Whether the User is available for new conversations
+          def is_available
+            @properties['is_available']
+          end
+
+          ##
+          # @return [String] An absolute URL for this user.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the UserInstance
+          # @return [UserInstance] Fetched UserInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the UserInstance
+          # @param [String] friendly_name The string that you assigned to describe the User.
+          # @param [String] avatar The avatar URL which will be shown in Frontline
+          #   application.
+          # @param [user.StateType] state Current state of this user. Can be either `active`
+          #   or `deactivated`.
+          # @param [Boolean] is_available Whether the User is available for new
+          #   conversations. Set to `false` to prevent User from receiving new inbound
+          #   conversations if you are using {Pool
+          #   Routing}[https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing].
+          # @return [UserInstance] Updated UserInstance
+          def update(friendly_name: :unset, avatar: :unset, state: :unset, is_available: :unset)
+            context.update(
+                friendly_name: friendly_name,
+                avatar: avatar,
+                state: state,
+                is_available: is_available,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FrontlineApi.V1.UserInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FrontlineApi.V1.UserInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/frontline_api/v1.rb

@@ -0,0 +1,45 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FrontlineApi
+      class V1 < Version
+        ##
+        # Initialize the V1 version of FrontlineApi
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @users = nil
+        end
+
+        ##
+        # @param [String] sid The SID of the User resource to fetch. This value can be
+        #   either the `sid` or the `identity` of the User resource to fetch.
+        # @return [Twilio::REST::Frontline_api::V1::UserContext] if sid was passed.
+        # @return [Twilio::REST::Frontline_api::V1::UserList]
+        def users(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @users ||= UserList.new self
+          else
+              UserContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::FrontlineApi::V1>'
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/frontline_api.rb

@@ -0,0 +1,47 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FrontlineApi < Domain
+      ##
+      # Initialize the FrontlineApi Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://frontline-api.twilio.com'
+        @host = 'frontline-api.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of frontline_api
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the User
+      #   resource.
+      # @return [Twilio::REST::Frontline_api::V1::UserInstance] if sid was passed.
+      # @return [Twilio::REST::Frontline_api::V1::UserList]
+      def users(sid=:unset)
+        self.v1.users(sid)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::FrontlineApi>'
+      end
+    end
+  end
+end