twilio-ruby 5.67.3 → 5.74.5

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

@@ -0,0 +1,133 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi < Domain
+      class V2 < Version
+        class WebChannelsList < ListResource
+          ##
+          # Initialize the WebChannelsList
+          # @param [Version] version Version that contains the resource
+          # @return [WebChannelsList] WebChannelsList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/WebChats"
+          end
+
+          ##
+          # Create the WebChannelsInstance
+          # @param [String] address_sid The SID of the Conversations Address. See {Address
+          #   Configuration
+          #   Resource}[https://www.twilio.com/docs/conversations/api/address-configuration-resource]
+          #   for configuration details. When a conversation is created on the Flex backend,
+          #   the callback URL will be set to the corresponding Studio Flow SID or webhook URL
+          #   in your address configuration.
+          # @param [String] chat_friendly_name The Conversation's friendly name. See the
+          #   {Conversation
+          #   resource}[https://www.twilio.com/docs/conversations/api/conversation-resource]
+          #   for an example.
+          # @param [String] customer_friendly_name The Conversation participant's friendly
+          #   name. See the {Conversation Participant
+          #   Resource}[https://www.twilio.com/docs/conversations/api/conversation-participant-resource]
+          #   for an example.
+          # @param [String] pre_engagement_data The pre-engagement data.
+          # @return [WebChannelsInstance] Created WebChannelsInstance
+          def create(address_sid: nil, chat_friendly_name: :unset, customer_friendly_name: :unset, pre_engagement_data: :unset)
+            data = Twilio::Values.of({
+                'AddressSid' => address_sid,
+                'ChatFriendlyName' => chat_friendly_name,
+                'CustomerFriendlyName' => customer_friendly_name,
+                'PreEngagementData' => pre_engagement_data,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            WebChannelsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FlexApi.V2.WebChannelsList>'
+          end
+        end
+
+        class WebChannelsPage < Page
+          ##
+          # Initialize the WebChannelsPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [WebChannelsPage] WebChannelsPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of WebChannelsInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [WebChannelsInstance] WebChannelsInstance
+          def get_instance(payload)
+            WebChannelsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FlexApi.V2.WebChannelsPage>'
+          end
+        end
+
+        class WebChannelsInstance < InstanceResource
+          ##
+          # Initialize the WebChannelsInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [WebChannelsInstance] WebChannelsInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {'conversation_sid' => payload['conversation_sid'], 'identity' => payload['identity'], }
+          end
+
+          ##
+          # @return [String] The unique string representing the Conversation resource created
+          def conversation_sid
+            @properties['conversation_sid']
+          end
+
+          ##
+          # @return [String] The unique string representing the User created
+          def identity
+            @properties['identity']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.FlexApi.V2.WebChannelsInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.FlexApi.V2.WebChannelsInstance>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,6 +20,7 @@ module Twilio
 
         # Versions
         @v1 = nil
+        @v2 = nil
       end
 
       ##
@@ -28,6 +29,12 @@ module Twilio
         @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.
@@ -52,6 +59,76 @@ module Twilio
         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
+
+      ##
+      # @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.
@@ -70,6 +147,12 @@ module Twilio
         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

data/lib/twilio-ruby/rest/insights/v1/call/annotation.rb

@@ -0,0 +1,322 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Insights < Domain
+      class V1 < Version
+        class CallContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationList < ListResource
+            ##
+            # Initialize the AnnotationList
+            # @param [Version] version Version that contains the resource
+            # @param [String] call_sid The unique SID identifier of the Call.
+            # @return [AnnotationList] AnnotationList
+            def initialize(version, call_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {call_sid: call_sid}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Insights.V1.AnnotationList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationPage < Page
+            ##
+            # Initialize the AnnotationPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [AnnotationPage] AnnotationPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of AnnotationInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [AnnotationInstance] AnnotationInstance
+            def get_instance(payload)
+              AnnotationInstance.new(@version, payload, call_sid: @solution[:call_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Insights.V1.AnnotationPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationContext < InstanceContext
+            ##
+            # Initialize the AnnotationContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] call_sid The unique SID identifier of the Call.
+            # @return [AnnotationContext] AnnotationContext
+            def initialize(version, call_sid)
+              super(version)
+
+              # Path Solution
+              @solution = {call_sid: call_sid, }
+              @uri = "/Voice/#{@solution[:call_sid]}/Annotation"
+            end
+
+            ##
+            # Update the AnnotationInstance
+            # @param [annotation.AnsweredBy] answered_by Which entity answered the call as
+            #   determined by Answering Machine Detection. Use this to provide feedback on
+            #   Answering Machine Detection accuracy. Possible enumerated values, one of: human,
+            #   machine. human indicates the call was answered by a person. machine indicates
+            #   the call was answered by an answering machine.
+            # @param [annotation.ConnectivityIssue] connectivity_issue Specify if the call had
+            #   any connectivity issues. Possible enumerated values, one :
+            #   no_connectivity_issue, invalid_number, caller_id, dropped_call,
+            #   number_reachability.
+            # @param [String] quality_issues Specify if the call had any subjective quality
+            #   issues. Possible values, one or more of:  no_quality_issue, low_volume,
+            #   choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated
+            #   values to indicate multiple quality issues for the same call
+            # @param [Boolean] spam Specify if the call was a spam call. Use this to provide
+            #   feedback on whether calls placed from your account were marked as spam, or if
+            #   inbound calls received by your account were unwanted spam. Is of type Boolean:
+            #   true, false. Use true if the call was a spam call.
+            # @param [String] call_score Specify the call score. This is of type integer. Use
+            #   a range of 1-5 to indicate the call experience score, with the following mapping
+            #   as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor,
+            #   1: Bad].
+            # @param [String] comment Specify any comments pertaining to the call. This of
+            #   type string with a max limit of 100 characters. Twilio does not treat this field
+            #   as PII, so don’t put any PII in here.
+            # @param [String] incident Associate this call with an incident or support ticket.
+            #   This is of type string with a max limit of 100 characters. Twilio does not treat
+            #   this field as PII, so don’t put any PII in here.
+            # @return [AnnotationInstance] Updated AnnotationInstance
+            def update(answered_by: :unset, connectivity_issue: :unset, quality_issues: :unset, spam: :unset, call_score: :unset, comment: :unset, incident: :unset)
+              data = Twilio::Values.of({
+                  'AnsweredBy' => answered_by,
+                  'ConnectivityIssue' => connectivity_issue,
+                  'QualityIssues' => quality_issues,
+                  'Spam' => spam,
+                  'CallScore' => call_score,
+                  'Comment' => comment,
+                  'Incident' => incident,
+              })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              AnnotationInstance.new(@version, payload, call_sid: @solution[:call_sid], )
+            end
+
+            ##
+            # Fetch the AnnotationInstance
+            # @return [AnnotationInstance] Fetched AnnotationInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              AnnotationInstance.new(@version, payload, call_sid: @solution[:call_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Insights.V1.AnnotationContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Insights.V1.AnnotationContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationInstance < InstanceResource
+            ##
+            # Initialize the AnnotationInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] call_sid The unique SID identifier of the Call.
+            # @return [AnnotationInstance] AnnotationInstance
+            def initialize(version, payload, call_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'call_sid' => payload['call_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'answered_by' => payload['answered_by'],
+                  'connectivity_issue' => payload['connectivity_issue'],
+                  'quality_issues' => payload['quality_issues'],
+                  'spam' => payload['spam'],
+                  'call_score' => payload['call_score'] == nil ? payload['call_score'] : payload['call_score'].to_i,
+                  'comment' => payload['comment'],
+                  'incident' => payload['incident'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'call_sid' => call_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 [AnnotationContext] AnnotationContext for this AnnotationInstance
+            def context
+              unless @instance_context
+                @instance_context = AnnotationContext.new(@version, @params['call_sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] Call SID.
+            def call_sid
+              @properties['call_sid']
+            end
+
+            ##
+            # @return [String] Account SID.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [annotation.AnsweredBy] Indicates the answering entity as determined by Answering Machine Detection.
+            def answered_by
+              @properties['answered_by']
+            end
+
+            ##
+            # @return [annotation.ConnectivityIssue] Indicates if the call had any connectivity issue
+            def connectivity_issue
+              @properties['connectivity_issue']
+            end
+
+            ##
+            # @return [Array[String]] Indicates if the call had audio quality issues.
+            def quality_issues
+              @properties['quality_issues']
+            end
+
+            ##
+            # @return [Boolean] Call spam indicator
+            def spam
+              @properties['spam']
+            end
+
+            ##
+            # @return [String] Call Score
+            def call_score
+              @properties['call_score']
+            end
+
+            ##
+            # @return [String] User comments
+            def comment
+              @properties['comment']
+            end
+
+            ##
+            # @return [String] Call tag for incidents or support ticket
+            def incident
+              @properties['incident']
+            end
+
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Update the AnnotationInstance
+            # @param [annotation.AnsweredBy] answered_by Which entity answered the call as
+            #   determined by Answering Machine Detection. Use this to provide feedback on
+            #   Answering Machine Detection accuracy. Possible enumerated values, one of: human,
+            #   machine. human indicates the call was answered by a person. machine indicates
+            #   the call was answered by an answering machine.
+            # @param [annotation.ConnectivityIssue] connectivity_issue Specify if the call had
+            #   any connectivity issues. Possible enumerated values, one :
+            #   no_connectivity_issue, invalid_number, caller_id, dropped_call,
+            #   number_reachability.
+            # @param [String] quality_issues Specify if the call had any subjective quality
+            #   issues. Possible values, one or more of:  no_quality_issue, low_volume,
+            #   choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated
+            #   values to indicate multiple quality issues for the same call
+            # @param [Boolean] spam Specify if the call was a spam call. Use this to provide
+            #   feedback on whether calls placed from your account were marked as spam, or if
+            #   inbound calls received by your account were unwanted spam. Is of type Boolean:
+            #   true, false. Use true if the call was a spam call.
+            # @param [String] call_score Specify the call score. This is of type integer. Use
+            #   a range of 1-5 to indicate the call experience score, with the following mapping
+            #   as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor,
+            #   1: Bad].
+            # @param [String] comment Specify any comments pertaining to the call. This of
+            #   type string with a max limit of 100 characters. Twilio does not treat this field
+            #   as PII, so don’t put any PII in here.
+            # @param [String] incident Associate this call with an incident or support ticket.
+            #   This is of type string with a max limit of 100 characters. Twilio does not treat
+            #   this field as PII, so don’t put any PII in here.
+            # @return [AnnotationInstance] Updated AnnotationInstance
+            def update(answered_by: :unset, connectivity_issue: :unset, quality_issues: :unset, spam: :unset, call_score: :unset, comment: :unset, incident: :unset)
+              context.update(
+                  answered_by: answered_by,
+                  connectivity_issue: connectivity_issue,
+                  quality_issues: quality_issues,
+                  spam: spam,
+                  call_score: call_score,
+                  comment: comment,
+                  incident: incident,
+              )
+            end
+
+            ##
+            # Fetch the AnnotationInstance
+            # @return [AnnotationInstance] Fetched AnnotationInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Insights.V1.AnnotationInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Insights.V1.AnnotationInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/insights/v1/call/summary.rb

@@ -117,6 +117,7 @@ module Twilio
                   'call_sid' => payload['call_sid'],
                   'call_type' => payload['call_type'],
                   'call_state' => payload['call_state'],
+                  'answered_by' => payload['answered_by'],
                   'processing_state' => payload['processing_state'],
                   'created_time' => Twilio.deserialize_iso8601_datetime(payload['created_time']),
                   'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
@@ -134,6 +135,7 @@ module Twilio
                   'attributes' => payload['attributes'],
                   'properties' => payload['properties'],
                   'trust' => payload['trust'],
+                  'annotation' => payload['annotation'],
               }
 
               # Context
@@ -176,6 +178,12 @@ module Twilio
               @properties['call_state']
             end
 
+            ##
+            # @return [call_summary.AnsweredBy] The answered_by
+            def answered_by
+              @properties['answered_by']
+            end
+
             ##
             # @return [call_summary.ProcessingState] The processing_state
             def processing_state
@@ -278,6 +286,12 @@ module Twilio
               @properties['trust']
             end
 
+            ##
+            # @return [Hash] The annotation
+            def annotation
+              @properties['annotation']
+            end
+
             ##
             # Fetch the CallSummaryInstance
             # @param [call_summary.ProcessingState] processing_state The processing_state