twilio-ruby 6.9.1 → 6.11.0

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

@@ -0,0 +1,255 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Flex
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class FlexApi < FlexApiBase
+            class V1 < Version
+                class InsightsConversationalAiReportInsightsList < ListResource
+                
+                    ##
+                    # Initialize the InsightsConversationalAiReportInsightsList
+                    # @param [Version] version Version that contains the resource
+                    # @return [InsightsConversationalAiReportInsightsList] InsightsConversationalAiReportInsightsList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.FlexApi.V1.InsightsConversationalAiReportInsightsList>'
+                    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 InsightsConversationalAiReportInsightsContext < InstanceContext
+                    ##
+                    # Initialize the InsightsConversationalAiReportInsightsContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] instance_sid The Instance SID of the instance for which report insights will be fetched
+                    # @return [InsightsConversationalAiReportInsightsContext] InsightsConversationalAiReportInsightsContext
+                    def initialize(version, instance_sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { instance_sid: instance_sid,  }
+                        @uri = "/Insights/Instances/#{@solution[:instance_sid]}/AI/ReportInsights"
+
+                        
+                    end
+                    ##
+                    # Fetch the InsightsConversationalAiReportInsightsInstance
+                    # @param [String] max_rows Maximum number of rows to return
+                    # @param [String] report_id The type of report insights required to fetch.Like gauge,channel-metrics,queue-metrics
+                    # @param [String] granularity The time period for which report insights is needed
+                    # @param [Time] include_date A reference date that should be included in the returned period
+                    # @return [InsightsConversationalAiReportInsightsInstance] Fetched InsightsConversationalAiReportInsightsInstance
+                    def fetch(
+                        max_rows: :unset, 
+                        report_id: :unset, 
+                        granularity: :unset, 
+                        include_date: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'MaxRows' => max_rows,
+                            'ReportId' => report_id,
+                            'Granularity' => granularity,
+                            'IncludeDate' => Twilio.serialize_iso8601_datetime(include_date),
+                        })
+                        
+                        payload = @version.fetch('GET', @uri, params: params)
+                        InsightsConversationalAiReportInsightsInstance.new(
+                            @version,
+                            payload,
+                            instance_sid: @solution[:instance_sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.FlexApi.V1.InsightsConversationalAiReportInsightsContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.FlexApi.V1.InsightsConversationalAiReportInsightsContext #{context}>"
+                    end
+                end
+
+                class InsightsConversationalAiReportInsightsPage < Page
+                    ##
+                    # Initialize the InsightsConversationalAiReportInsightsPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [InsightsConversationalAiReportInsightsPage] InsightsConversationalAiReportInsightsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of InsightsConversationalAiReportInsightsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [InsightsConversationalAiReportInsightsInstance] InsightsConversationalAiReportInsightsInstance
+                    def get_instance(payload)
+                        InsightsConversationalAiReportInsightsInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.FlexApi.V1.InsightsConversationalAiReportInsightsPage>'
+                    end
+                end
+                class InsightsConversationalAiReportInsightsInstance < InstanceResource
+                    ##
+                    # Initialize the InsightsConversationalAiReportInsightsInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this InsightsConversationalAiReportInsights
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [InsightsConversationalAiReportInsightsInstance] InsightsConversationalAiReportInsightsInstance
+                    def initialize(version, payload , instance_sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'instance_sid' => payload['instance_sid'],
+                            'report_id' => payload['report_id'],
+                            'period_start' => Twilio.deserialize_iso8601_datetime(payload['period_start']),
+                            'period_end' => Twilio.deserialize_iso8601_datetime(payload['period_end']),
+                            'updated' => Twilio.deserialize_iso8601_datetime(payload['updated']),
+                            'insights' => payload['insights'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'instance_sid' => instance_sid  || @properties['instance_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 [InsightsConversationalAiReportInsightsContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = InsightsConversationalAiReportInsightsContext.new(@version , @params['instance_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The Instance SID of the instance for which report insights is fetched
+                    def instance_sid
+                        @properties['instance_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The type of report insights required to fetch.Like gauge,channel-metrics,queue-metrics
+                    def report_id
+                        @properties['report_id']
+                    end
+                    
+                    ##
+                    # @return [Time] The start date from which report insights data is included
+                    def period_start
+                        @properties['period_start']
+                    end
+                    
+                    ##
+                    # @return [Time] The end date till report insights data is included
+                    def period_end
+                        @properties['period_end']
+                    end
+                    
+                    ##
+                    # @return [Time] Updated time of the report insights
+                    def updated
+                        @properties['updated']
+                    end
+                    
+                    ##
+                    # @return [Array<Hash>] List of report insights breakdown
+                    def insights
+                        @properties['insights']
+                    end
+                    
+                    ##
+                    # @return [String] The URL of this resource
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the InsightsConversationalAiReportInsightsInstance
+                    # @param [String] max_rows Maximum number of rows to return
+                    # @param [String] report_id The type of report insights required to fetch.Like gauge,channel-metrics,queue-metrics
+                    # @param [String] granularity The time period for which report insights is needed
+                    # @param [Time] include_date A reference date that should be included in the returned period
+                    # @return [InsightsConversationalAiReportInsightsInstance] Fetched InsightsConversationalAiReportInsightsInstance
+                    def fetch(
+                        max_rows: :unset, 
+                        report_id: :unset, 
+                        granularity: :unset, 
+                        include_date: :unset
+                    )
+
+                        context.fetch(
+                            max_rows: max_rows, 
+                            report_id: report_id, 
+                            granularity: granularity, 
+                            include_date: include_date, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.FlexApi.V1.InsightsConversationalAiReportInsightsInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.FlexApi.V1.InsightsConversationalAiReportInsightsInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class InsightsConversationsList < ListResource
+                
                     ##
                     # Initialize the InsightsConversationsList
                     # @param [Version] version Version that contains the resource

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class InsightsQuestionnairesList < ListResource
+                
                     ##
                     # Initialize the InsightsQuestionnairesList
                     # @param [Version] version Version that contains the resource
@@ -52,6 +53,7 @@ module Twilio
                             'QuestionSids' => Twilio.serialize_list(question_sids) { |e| e },
                         })
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         InsightsQuestionnairesInstance.new(
@@ -191,6 +193,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         @version.delete('DELETE', @uri, headers: headers)
                     end
@@ -203,6 +206,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.fetch('GET', @uri, headers: headers)
                         InsightsQuestionnairesInstance.new(
@@ -235,6 +239,7 @@ module Twilio
                             'QuestionSids' => Twilio.serialize_list(question_sids) { |e| e },
                         })
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         InsightsQuestionnairesInstance.new(

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class InsightsQuestionnairesCategoryList < ListResource
+                
                     ##
                     # Initialize the InsightsQuestionnairesCategoryList
                     # @param [Version] version Version that contains the resource
@@ -43,6 +44,7 @@ module Twilio
                             'Name' => name,
                         })
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         InsightsQuestionnairesCategoryInstance.new(
@@ -176,6 +178,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         @version.delete('DELETE', @uri, headers: headers)
                     end
@@ -194,6 +197,7 @@ module Twilio
                             'Name' => name,
                         })
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         InsightsQuestionnairesCategoryInstance.new(

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class InsightsQuestionnairesQuestionList < ListResource
+                
                     ##
                     # Initialize the InsightsQuestionnairesQuestionList
                     # @param [Version] version Version that contains the resource
@@ -55,6 +56,7 @@ module Twilio
                             'Description' => description,
                         })
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         InsightsQuestionnairesQuestionInstance.new(
@@ -195,6 +197,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         @version.delete('DELETE', @uri, headers: headers)
                     end
@@ -225,6 +228,7 @@ module Twilio
                             'AnswerSetId' => answer_set_id,
                         })
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         InsightsQuestionnairesQuestionInstance.new(

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class InsightsSegmentsList < ListResource
+                
                     ##
                     # Initialize the InsightsSegmentsList
                     # @param [Version] version Version that contains the resource

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class InsightsSessionList < ListResource
+                
                     ##
                     # Initialize the InsightsSessionList
                     # @param [Version] version Version that contains the resource
@@ -63,6 +64,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.create('POST', @uri, headers: headers)
                         InsightsSessionInstance.new(

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class InsightsSettingsAnswerSetsList < ListResource
+                
                     ##
                     # Initialize the InsightsSettingsAnswerSetsList
                     # @param [Version] version Version that contains the resource
@@ -37,6 +38,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.fetch('GET', @uri, headers: headers)
                         InsightsSettingsAnswerSetsInstance.new(

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class InsightsSettingsCommentList < ListResource
+                
                     ##
                     # Initialize the InsightsSettingsCommentList
                     # @param [Version] version Version that contains the resource
@@ -37,6 +38,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.fetch('GET', @uri, headers: headers)
                         InsightsSettingsCommentInstance.new(

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class InsightsUserRolesList < ListResource
+                
                     ##
                     # Initialize the InsightsUserRolesList
                     # @param [Version] version Version that contains the resource
@@ -63,6 +64,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.fetch('GET', @uri, headers: headers)
                         InsightsUserRolesInstance.new(

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

@@ -21,6 +21,7 @@ module Twilio
                 class InteractionChannelContext < InstanceContext
 
                      class InteractionChannelInviteList < ListResource
+                
                     ##
                     # Initialize the InteractionChannelInviteList
                     # @param [Version] version Version that contains the resource
@@ -44,6 +45,7 @@ module Twilio
                             'Routing' => Twilio.serialize_object(routing),
                         })
 
+                        
                         payload = @version.create('POST', @uri, data: data)
                         InteractionChannelInviteInstance.new(
                             @version,

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

@@ -21,6 +21,7 @@ module Twilio
                 class InteractionChannelContext < InstanceContext
 
                      class InteractionChannelParticipantList < ListResource
+                
                     ##
                     # Initialize the InteractionChannelParticipantList
                     # @param [Version] version Version that contains the resource
@@ -47,6 +48,7 @@ module Twilio
                             'MediaProperties' => Twilio.serialize_object(media_properties),
                         })
 
+                        
                         payload = @version.create('POST', @uri, data: data)
                         InteractionChannelParticipantInstance.new(
                             @version,
@@ -179,6 +181,7 @@ module Twilio
                             'Status' => status,
                         })
 
+                        
                         payload = @version.update('POST', @uri, data: data)
                         InteractionChannelParticipantInstance.new(
                             @version,

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

@@ -20,6 +20,7 @@ module Twilio
                 class InteractionContext < InstanceContext
 
                      class InteractionChannelList < ListResource
+                
                     ##
                     # Initialize the InteractionChannelList
                     # @param [Version] version Version that contains the resource
@@ -148,6 +149,7 @@ module Twilio
                     # @return [InteractionChannelInstance] Fetched InteractionChannelInstance
                     def fetch
 
+                        
                         payload = @version.fetch('GET', @uri)
                         InteractionChannelInstance.new(
                             @version,
@@ -172,6 +174,7 @@ module Twilio
                             'Routing' => Twilio.serialize_object(routing),
                         })
 
+                        
                         payload = @version.update('POST', @uri, data: data)
                         InteractionChannelInstance.new(
                             @version,

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class InteractionList < ListResource
+                
                     ##
                     # Initialize the InteractionList
                     # @param [Version] version Version that contains the resource
@@ -47,6 +48,7 @@ module Twilio
                             'InteractionContextSid' => interaction_context_sid,
                         })
 
+                        
                         payload = @version.create('POST', @uri, data: data)
                         InteractionInstance.new(
                             @version,
@@ -85,6 +87,7 @@ module Twilio
                     # @return [InteractionInstance] Fetched InteractionInstance
                     def fetch
 
+                        
                         payload = @version.fetch('GET', @uri)
                         InteractionInstance.new(
                             @version,

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class ProvisioningStatusList < ListResource
+                
                     ##
                     # Initialize the ProvisioningStatusList
                     # @param [Version] version Version that contains the resource
@@ -60,6 +61,7 @@ module Twilio
                     # @return [ProvisioningStatusInstance] Fetched ProvisioningStatusInstance
                     def fetch
 
+                        
                         payload = @version.fetch('GET', @uri)
                         ProvisioningStatusInstance.new(
                             @version,

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class WebChannelList < ListResource
+                
                     ##
                     # Initialize the WebChannelList
                     # @param [Version] version Version that contains the resource
@@ -56,6 +57,7 @@ module Twilio
                             'PreEngagementData' => pre_engagement_data,
                         })
 
+                        
                         payload = @version.create('POST', @uri, data: data)
                         WebChannelInstance.new(
                             @version,
@@ -177,6 +179,7 @@ module Twilio
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
+                        
                         @version.delete('DELETE', @uri)
                     end
 
@@ -185,6 +188,7 @@ module Twilio
                     # @return [WebChannelInstance] Fetched WebChannelInstance
                     def fetch
 
+                        
                         payload = @version.fetch('GET', @uri)
                         WebChannelInstance.new(
                             @version,
@@ -208,6 +212,7 @@ module Twilio
                             'PostEngagementData' => post_engagement_data,
                         })
 
+                        
                         payload = @version.update('POST', @uri, data: data)
                         WebChannelInstance.new(
                             @version,

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

@@ -26,6 +26,8 @@ module Twilio
                     @configuration = nil
                     @flex_flow = nil
                     @insights_assessments_comment = nil
+                    @insights_conversational_ai = nil
+                    @insights_conversational_ai_report_insights = nil
                     @insights_conversations = nil
                     @insights_questionnaires = nil
                     @insights_questionnaires_category = nil
@@ -93,6 +95,34 @@ module Twilio
                     @insights_assessments_comment ||= InsightsAssessmentsCommentList.new self
                 end
                 ##
+                # @param [String] instance_sid Sid of Flex Service Instance
+                # @return [Twilio::REST::FlexApi::V1::InsightsConversationalAiContext] if instanceSid was passed.
+                # @return [Twilio::REST::FlexApi::V1::InsightsConversationalAiList]
+                def insights_conversational_ai(instance_sid=:unset)
+                    if instance_sid.nil?
+                        raise ArgumentError, 'instance_sid cannot be nil'
+                    end
+                    if instance_sid == :unset
+                        @insights_conversational_ai ||= InsightsConversationalAiList.new self
+                    else
+                        InsightsConversationalAiContext.new(self, instance_sid)
+                    end
+                end
+                ##
+                # @param [String] instance_sid The Instance SID of the instance for which report insights will be fetched
+                # @return [Twilio::REST::FlexApi::V1::InsightsConversationalAiReportInsightsContext] if instanceSid was passed.
+                # @return [Twilio::REST::FlexApi::V1::InsightsConversationalAiReportInsightsList]
+                def insights_conversational_ai_report_insights(instance_sid=:unset)
+                    if instance_sid.nil?
+                        raise ArgumentError, 'instance_sid cannot be nil'
+                    end
+                    if instance_sid == :unset
+                        @insights_conversational_ai_report_insights ||= InsightsConversationalAiReportInsightsList.new self
+                    else
+                        InsightsConversationalAiReportInsightsContext.new(self, instance_sid)
+                    end
+                end
+                ##
                 # @return [Twilio::REST::FlexApi::V1::InsightsConversationsList]
                 def insights_conversations
                     @insights_conversations ||= InsightsConversationsList.new self

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

@@ -18,6 +18,7 @@ module Twilio
         class FlexApi < FlexApiBase
             class V2 < Version
                 class WebChannelsList < ListResource
+                
                     ##
                     # Initialize the WebChannelsList
                     # @param [Version] version Version that contains the resource
@@ -50,6 +51,7 @@ module Twilio
                             'PreEngagementData' => pre_engagement_data,
                         })
 
+                        
                         payload = @version.create('POST', @uri, data: data)
                         WebChannelsInstance.new(
                             @version,