twilio-ruby 6.9.1 → 7.0.0.pre.rc.1

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

@@ -0,0 +1,274 @@
+##
+#    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 InsightsConversationalAiList < ListResource
+                
+                    ##
+                    # Initialize the InsightsConversationalAiList
+                    # @param [Version] version Version that contains the resource
+                    # @return [InsightsConversationalAiList] InsightsConversationalAiList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.FlexApi.V1.InsightsConversationalAiList>'
+                    end
+                end
+
+
+                class InsightsConversationalAiContext < InstanceContext
+                    ##
+                    # Initialize the InsightsConversationalAiContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] instance_sid Sid of Flex Service Instance
+                    # @return [InsightsConversationalAiContext] InsightsConversationalAiContext
+                    def initialize(version, instance_sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { instance_sid: instance_sid,  }
+                        @uri = "/Insights/Instances/#{@solution[:instance_sid]}/AI/Reports"
+
+                        
+                    end
+                    ##
+                    # Fetch the InsightsConversationalAiInstance
+                    # @param [String] max_rows Maximum number of rows to return
+                    # @param [String] report_id The type of report required to fetch.Like gauge,channel-metrics,queue-metrics
+                    # @param [Granularity] granularity The time period for which report is needed
+                    # @param [Time] include_date A reference date that should be included in the returned period
+                    # @return [InsightsConversationalAiInstance] Fetched InsightsConversationalAiInstance
+                    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)
+                        InsightsConversationalAiInstance.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.InsightsConversationalAiContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.FlexApi.V1.InsightsConversationalAiContext #{context}>"
+                    end
+                end
+
+                class InsightsConversationalAiPage < Page
+                    ##
+                    # Initialize the InsightsConversationalAiPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [InsightsConversationalAiPage] InsightsConversationalAiPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of InsightsConversationalAiInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [InsightsConversationalAiInstance] InsightsConversationalAiInstance
+                    def get_instance(payload)
+                        InsightsConversationalAiInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.FlexApi.V1.InsightsConversationalAiPage>'
+                    end
+                end
+                class InsightsConversationalAiInstance < InstanceResource
+                    ##
+                    # Initialize the InsightsConversationalAiInstance
+                    # @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 InsightsConversationalAi
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [InsightsConversationalAiInstance] InsightsConversationalAiInstance
+                    def initialize(version, payload , instance_sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'instance_sid' => payload['instance_sid'],
+                            'report_id' => payload['report_id'],
+                            'granularity' => payload['granularity'],
+                            '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']),
+                            'total_pages' => payload['total_pages'] == nil ? payload['total_pages'] : payload['total_pages'].to_i,
+                            'page' => payload['page'] == nil ? payload['page'] : payload['page'].to_i,
+                            'rows' => payload['rows'],
+                            '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 [InsightsConversationalAiContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = InsightsConversationalAiContext.new(@version , @params['instance_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] Sid of Flex Service Instance
+                    def instance_sid
+                        @properties['instance_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The type of report required to fetch.Like gauge,channel-metrics,queue-metrics
+                    def report_id
+                        @properties['report_id']
+                    end
+                    
+                    ##
+                    # @return [Granularity] 
+                    def granularity
+                        @properties['granularity']
+                    end
+                    
+                    ##
+                    # @return [Time] The start date from which report data is included
+                    def period_start
+                        @properties['period_start']
+                    end
+                    
+                    ##
+                    # @return [Time] The end date till report data is included
+                    def period_end
+                        @properties['period_end']
+                    end
+                    
+                    ##
+                    # @return [Time] Updated time of the report
+                    def updated
+                        @properties['updated']
+                    end
+                    
+                    ##
+                    # @return [String] Represents total number of pages fetched report has
+                    def total_pages
+                        @properties['total_pages']
+                    end
+                    
+                    ##
+                    # @return [String] Page offset required for pagination
+                    def page
+                        @properties['page']
+                    end
+                    
+                    ##
+                    # @return [Array<Hash>] List of report breakdown 
+                    def rows
+                        @properties['rows']
+                    end
+                    
+                    ##
+                    # @return [String] The URL of this resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the InsightsConversationalAiInstance
+                    # @param [String] max_rows Maximum number of rows to return
+                    # @param [String] report_id The type of report required to fetch.Like gauge,channel-metrics,queue-metrics
+                    # @param [Granularity] granularity The time period for which report is needed
+                    # @param [Time] include_date A reference date that should be included in the returned period
+                    # @return [InsightsConversationalAiInstance] Fetched InsightsConversationalAiInstance
+                    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.InsightsConversationalAiInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.FlexApi.V1.InsightsConversationalAiInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,253 @@
+##
+#    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
+
+
+                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(
@@ -166,8 +168,6 @@ module Twilio
                 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 InsightsQuestionnairesContext < InstanceContext
                     ##
                     # Initialize the InsightsQuestionnairesContext
@@ -191,6 +191,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         @version.delete('DELETE', @uri, headers: headers)
                     end
@@ -203,6 +204,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         payload = @version.fetch('GET', @uri, headers: headers)
                         InsightsQuestionnairesInstance.new(
@@ -235,6 +237,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(
@@ -151,8 +153,6 @@ module Twilio
                 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 InsightsQuestionnairesCategoryContext < InstanceContext
                     ##
                     # Initialize the InsightsQuestionnairesCategoryContext
@@ -176,6 +176,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         @version.delete('DELETE', @uri, headers: headers)
                     end
@@ -194,6 +195,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(
@@ -170,8 +172,6 @@ module Twilio
                 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 InsightsQuestionnairesQuestionContext < InstanceContext
                     ##
                     # Initialize the InsightsQuestionnairesQuestionContext
@@ -195,6 +195,7 @@ module Twilio
                         authorization: :unset
                     )
 
+                        
                         headers = Twilio::Values.of({ 'Authorization' => authorization, })
                         @version.delete('DELETE', @uri, headers: headers)
                     end
@@ -225,6 +226,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