twilio-ruby 7.10.7 → 7.11.2

data/lib/twilio-ruby/rest/insights/v3/result.rb

@@ -0,0 +1,195 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Insights
+#    The Twilio Insights v3 API provides semantic query access to Conversations analytics data. Resources include synchronous Query, Metadata, and asynchronous QueryJobs for long-running queries. 
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Insights < InsightsBase
+            class V3 < Version
+                class ResultList < ListResource
+                
+                    ##
+                    # Initialize the ResultList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ResultList] ResultList
+                    def initialize(version, operation_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = { operation_id: operation_id }
+                        @uri = "/InsightsDomains/Conversations/QueryJobs/#{@solution[:operation_id]}/Results"
+                        
+                    end
+                    ##
+                    # Fetch the ResultInstance
+                    # @param [String] page_size The maximum number of resources to return
+                    # @param [String] page_token Token for pagination
+                    # @return [ResultInstance] Fetched ResultInstance
+                    def fetch(
+                      page_size: :unset, 
+                      page_token: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'pageSize' => page_size,
+                            'pageToken' => page_token,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        ResultInstance.new(
+                            @version,
+                            payload,
+                            operation_id: @solution[:operation_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the ResultInstanceMetadata
+                    # @param [String] page_size The maximum number of resources to return
+                    # @param [String] page_token Token for pagination
+                    # @return [ResultInstance] Fetched ResultInstance
+                    def fetch_with_metadata(
+                      page_size: :unset, 
+                      page_token: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'pageSize' => page_size,
+                            'pageToken' => page_token,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        result_instance = ResultInstance.new(
+                            @version,
+                            response.body,
+                            operation_id: @solution[:operation_id],
+                        )
+                        ResultInstanceMetadata.new(
+                            @version,
+                            result_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Insights.V3.ResultList>'
+                    end
+                end
+
+                class ResultPage < TokenPage
+                    ##
+                    # Initialize the ResultPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ResultPage] ResultPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ResultInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ResultInstance] ResultInstance
+                    def get_instance(payload)
+                        ResultInstance.new(@version, payload, operation_id: @solution[:operation_id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Insights.V3.ResultPage>'
+                    end
+                end
+
+                class ResultInstance < InstanceResource
+                    ##
+                    # Initialize the ResultInstance
+                    # @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 Result
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ResultInstance] ResultInstance
+                    def initialize(version, payload , operation_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'domain' => payload['domain'],
+                            'items' => payload['items'],
+                            'meta' => payload['meta'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] Indicates the business domain the query was executed against
+                    def domain
+                        @properties['domain']
+                    end
+                    
+                    ##
+                    # @return [Array<Hash<String, Object>>] Array of result objects containing the query results. Each object contains properties matching the requested measures and dimensions.
+                    def items
+                        @properties['items']
+                    end
+                    
+                    ##
+                    # @return [PaginationMeta] 
+                    def meta
+                        @properties['meta']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Insights.V3.ResultInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Insights.V3.ResultInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/insights/v3.rb

@@ -5,7 +5,7 @@
 #     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
 #
 #    Twilio - Insights
-#    Insights Domain V3 API.
+#    The Twilio Insights v3 API provides semantic query access to Conversations analytics data. Resources include synchronous Query, Metadata, and asynchronous QueryJobs for long-running queries. 
 #
 #    NOTE: This class is auto generated by OpenAPI Generator.
 #    https://openapi-generator.tech
@@ -23,6 +23,7 @@ module Twilio
                     @version = 'v3'
                     @metadata = nil
                     @query = nil
+                    @query_jobs = nil
                 end
 
                 ##
@@ -36,6 +37,21 @@ module Twilio
                     @query ||= QueryList.new self
                 end
                 ##
+                # @param [String] operation_id The unique identifier for the asynchronous query operation, in TTID format.
+                # @return [Twilio::REST::Insights::V3::QueryJobContext] if operationId was passed.
+                # @return [Twilio::REST::Insights::V3::QueryJobList]
+                def query_jobs(operation_id=:unset)
+                    if operation_id.nil?
+                        raise ArgumentError, 'operation_id cannot be nil'
+                    end
+
+                    if operation_id == :unset
+                        @query_jobs ||= QueryJobList.new self
+                    else
+                        QueryJobContext.new(self, operation_id)
+                    end
+                end
+                ##
                 # Provide a user friendly representation
                 def to_s
                     '<Twilio::REST::Insights::V3>';

data/lib/twilio-ruby/rest/intelligence/v2/operator_attachment.rb

@@ -229,65 +229,6 @@ module Twilio
                     end
                 end
 
-                class OperatorAttachmentPageMetadata < PageMetadata
-                    attr_reader :operator_attachment_page
-
-                    def initialize(version, response, solution, limit)
-                        super(version, response)
-                        @operator_attachment_page = []
-                        @limit = limit
-                        key = get_key(response.body)
-                        records = 0
-                        while( limit != :unset && records < limit )
-                            @operator_attachment_page << OperatorAttachmentListResponse.new(version, @payload, key, limit - records)
-                            @payload = self.next_page
-                            break unless @payload
-                            records += (@payload.body[key] || []).size
-                        end
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    def each
-                        @operator_attachment_page.each do |record|
-                          yield record
-                        end
-                    end
-
-                    def to_s
-                      '<Twilio::REST::Intelligence::V2PageMetadata>';
-                    end
-                end
-                class OperatorAttachmentListResponse < InstanceListResource
-
-                    # @param [Array<OperatorAttachmentInstance>] instance
-                    # @param [Hash{String => Object}] headers
-                    # @param [Integer] status_code
-                    def initialize(version, payload, key, limit = :unset)
-                      data_list = payload.body[key]  || []
-                      if limit != :unset
-                        data_list = data_list[0, limit]
-                      end
-                      @operator_attachment = data_list.map do |data|
-                        OperatorAttachmentInstance.new(version, data)
-                      end
-                      @headers = payload.headers
-                      @status_code = payload.status_code
-                    end
-
-                    def operator_attachment
-                        @operator_attachment
-                    end
-
-                    def headers
-                      @headers
-                    end
-
-                    def status_code
-                      @status_code
-                    end
-                end
-
                 class OperatorAttachmentInstance < InstanceResource
                     ##
                     # Initialize the OperatorAttachmentInstance

data/lib/twilio-ruby/rest/intelligence/v2/operator_attachments.rb

@@ -194,65 +194,6 @@ module Twilio
                     end
                 end
 
-                class OperatorAttachmentsPageMetadata < PageMetadata
-                    attr_reader :operator_attachments_page
-
-                    def initialize(version, response, solution, limit)
-                        super(version, response)
-                        @operator_attachments_page = []
-                        @limit = limit
-                        key = get_key(response.body)
-                        records = 0
-                        while( limit != :unset && records < limit )
-                            @operator_attachments_page << OperatorAttachmentsListResponse.new(version, @payload, key, limit - records)
-                            @payload = self.next_page
-                            break unless @payload
-                            records += (@payload.body[key] || []).size
-                        end
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    def each
-                        @operator_attachments_page.each do |record|
-                          yield record
-                        end
-                    end
-
-                    def to_s
-                      '<Twilio::REST::Intelligence::V2PageMetadata>';
-                    end
-                end
-                class OperatorAttachmentsListResponse < InstanceListResource
-
-                    # @param [Array<OperatorAttachmentsInstance>] instance
-                    # @param [Hash{String => Object}] headers
-                    # @param [Integer] status_code
-                    def initialize(version, payload, key, limit = :unset)
-                      data_list = payload.body[key]  || []
-                      if limit != :unset
-                        data_list = data_list[0, limit]
-                      end
-                      @operator_attachments = data_list.map do |data|
-                        OperatorAttachmentsInstance.new(version, data)
-                      end
-                      @headers = payload.headers
-                      @status_code = payload.status_code
-                    end
-
-                    def operator_attachments
-                        @operator_attachments
-                    end
-
-                    def headers
-                      @headers
-                    end
-
-                    def status_code
-                      @status_code
-                    end
-                end
-
                 class OperatorAttachmentsInstance < InstanceResource
                     ##
                     # Initialize the OperatorAttachmentsInstance

data/lib/twilio-ruby/rest/intelligence/v2/transcript/encrypted_operator_results.rb

@@ -208,65 +208,6 @@ module Twilio
                     end
                 end
 
-                class EncryptedOperatorResultsPageMetadata < PageMetadata
-                    attr_reader :encrypted_operator_results_page
-
-                    def initialize(version, response, solution, limit)
-                        super(version, response)
-                        @encrypted_operator_results_page = []
-                        @limit = limit
-                        key = get_key(response.body)
-                        records = 0
-                        while( limit != :unset && records < limit )
-                            @encrypted_operator_results_page << EncryptedOperatorResultsListResponse.new(version, @payload, key, limit - records)
-                            @payload = self.next_page
-                            break unless @payload
-                            records += (@payload.body[key] || []).size
-                        end
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    def each
-                        @encrypted_operator_results_page.each do |record|
-                          yield record
-                        end
-                    end
-
-                    def to_s
-                      '<Twilio::REST::Intelligence::V2PageMetadata>';
-                    end
-                end
-                class EncryptedOperatorResultsListResponse < InstanceListResource
-
-                    # @param [Array<EncryptedOperatorResultsInstance>] instance
-                    # @param [Hash{String => Object}] headers
-                    # @param [Integer] status_code
-                    def initialize(version, payload, key, limit = :unset)
-                      data_list = payload.body[key]  || []
-                      if limit != :unset
-                        data_list = data_list[0, limit]
-                      end
-                      @encrypted_operator_results = data_list.map do |data|
-                        EncryptedOperatorResultsInstance.new(version, data)
-                      end
-                      @headers = payload.headers
-                      @status_code = payload.status_code
-                    end
-
-                    def encrypted_operator_results
-                        @encrypted_operator_results
-                    end
-
-                    def headers
-                      @headers
-                    end
-
-                    def status_code
-                      @status_code
-                    end
-                end
-
                 class EncryptedOperatorResultsInstance < InstanceResource
                     ##
                     # Initialize the EncryptedOperatorResultsInstance

data/lib/twilio-ruby/rest/intelligence/v2/transcript/encrypted_sentences.rb

@@ -208,65 +208,6 @@ module Twilio
                     end
                 end
 
-                class EncryptedSentencesPageMetadata < PageMetadata
-                    attr_reader :encrypted_sentences_page
-
-                    def initialize(version, response, solution, limit)
-                        super(version, response)
-                        @encrypted_sentences_page = []
-                        @limit = limit
-                        key = get_key(response.body)
-                        records = 0
-                        while( limit != :unset && records < limit )
-                            @encrypted_sentences_page << EncryptedSentencesListResponse.new(version, @payload, key, limit - records)
-                            @payload = self.next_page
-                            break unless @payload
-                            records += (@payload.body[key] || []).size
-                        end
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    def each
-                        @encrypted_sentences_page.each do |record|
-                          yield record
-                        end
-                    end
-
-                    def to_s
-                      '<Twilio::REST::Intelligence::V2PageMetadata>';
-                    end
-                end
-                class EncryptedSentencesListResponse < InstanceListResource
-
-                    # @param [Array<EncryptedSentencesInstance>] instance
-                    # @param [Hash{String => Object}] headers
-                    # @param [Integer] status_code
-                    def initialize(version, payload, key, limit = :unset)
-                      data_list = payload.body[key]  || []
-                      if limit != :unset
-                        data_list = data_list[0, limit]
-                      end
-                      @encrypted_sentences = data_list.map do |data|
-                        EncryptedSentencesInstance.new(version, data)
-                      end
-                      @headers = payload.headers
-                      @status_code = payload.status_code
-                    end
-
-                    def encrypted_sentences
-                        @encrypted_sentences
-                    end
-
-                    def headers
-                      @headers
-                    end
-
-                    def status_code
-                      @status_code
-                    end
-                end
-
                 class EncryptedSentencesInstance < InstanceResource
                     ##
                     # Initialize the EncryptedSentencesInstance

data/lib/twilio-ruby/rest/intelligence/v2/transcript/media.rb

@@ -208,65 +208,6 @@ module Twilio
                     end
                 end
 
-                class MediaPageMetadata < PageMetadata
-                    attr_reader :media_page
-
-                    def initialize(version, response, solution, limit)
-                        super(version, response)
-                        @media_page = []
-                        @limit = limit
-                        key = get_key(response.body)
-                        records = 0
-                        while( limit != :unset && records < limit )
-                            @media_page << MediaListResponse.new(version, @payload, key, limit - records)
-                            @payload = self.next_page
-                            break unless @payload
-                            records += (@payload.body[key] || []).size
-                        end
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    def each
-                        @media_page.each do |record|
-                          yield record
-                        end
-                    end
-
-                    def to_s
-                      '<Twilio::REST::Intelligence::V2PageMetadata>';
-                    end
-                end
-                class MediaListResponse < InstanceListResource
-
-                    # @param [Array<MediaInstance>] instance
-                    # @param [Hash{String => Object}] headers
-                    # @param [Integer] status_code
-                    def initialize(version, payload, key, limit = :unset)
-                      data_list = payload.body[key]  || []
-                      if limit != :unset
-                        data_list = data_list[0, limit]
-                      end
-                      @media = data_list.map do |data|
-                        MediaInstance.new(version, data)
-                      end
-                      @headers = payload.headers
-                      @status_code = payload.status_code
-                    end
-
-                    def media
-                        @media
-                    end
-
-                    def headers
-                      @headers
-                    end
-
-                    def status_code
-                      @status_code
-                    end
-                end
-
                 class MediaInstance < InstanceResource
                     ##
                     # Initialize the MediaInstance

data/lib/twilio-ruby/rest/intelligence/v3/conversation.rb

@@ -38,8 +38,8 @@ module Twilio
                     # Unlike stream(), this operation is eager and will load `limit` records into
                     # memory before returning.
                     # @param [String] page_token Token for pagination
-                    # @param [Time] created_at_before Filter by Conversations created before this timestamp.
-                    # @param [Time] created_at_after Filter by Conversations created after this timestamp.
+                    # @param [Time] created_at_before Filter by Conversations created before this timestamp. The maximum allowed time range between `createdAtBefore` and `createdAtAfter` is 31 days.
+                    # @param [Time] created_at_after Filter by Conversations created after this timestamp. The maximum allowed time range between `createdAtBefore` and `createdAtAfter` is 31 days.
                     # @param [String] status Filter by Conversation status.
                     # @param [String] channel_id Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID.
                     # @param [Array[String]] channels Filters Conversations that include one or more of the specified communication channels (`OR` match).
@@ -74,8 +74,8 @@ module Twilio
                     # This operation lazily loads records as efficiently as possible until the limit
                     # is reached.
                     # @param [String] page_token Token for pagination
-                    # @param [Time] created_at_before Filter by Conversations created before this timestamp.
-                    # @param [Time] created_at_after Filter by Conversations created after this timestamp.
+                    # @param [Time] created_at_before Filter by Conversations created before this timestamp. The maximum allowed time range between `createdAtBefore` and `createdAtAfter` is 31 days.
+                    # @param [Time] created_at_after Filter by Conversations created after this timestamp. The maximum allowed time range between `createdAtBefore` and `createdAtAfter` is 31 days.
                     # @param [String] status Filter by Conversation status.
                     # @param [String] channel_id Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID.
                     # @param [Array[String]] channels Filters Conversations that include one or more of the specified communication channels (`OR` match).
@@ -114,8 +114,8 @@ module Twilio
                     ##
                     # Lists ConversationPageMetadata records from the API as a list.
                       # @param [String] page_token Token for pagination
-                      # @param [Time] created_at_before Filter by Conversations created before this timestamp.
-                      # @param [Time] created_at_after Filter by Conversations created after this timestamp.
+                      # @param [Time] created_at_before Filter by Conversations created before this timestamp. The maximum allowed time range between `createdAtBefore` and `createdAtAfter` is 31 days.
+                      # @param [Time] created_at_after Filter by Conversations created after this timestamp. The maximum allowed time range between `createdAtBefore` and `createdAtAfter` is 31 days.
                       # @param [String] status Filter by Conversation status.
                       # @param [String] channel_id Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID.
                       # @param [Array[String]] channels Filters Conversations that include one or more of the specified communication channels (`OR` match).
@@ -176,8 +176,8 @@ module Twilio
                     # Retrieve a single page of ConversationInstance records from the API.
                     # Request is executed immediately.
                     # @param [String] page_token Token for pagination
-                    # @param [Time] created_at_before Filter by Conversations created before this timestamp.
-                    # @param [Time] created_at_after Filter by Conversations created after this timestamp.
+                    # @param [Time] created_at_before Filter by Conversations created before this timestamp. The maximum allowed time range between `createdAtBefore` and `createdAtAfter` is 31 days.
+                    # @param [Time] created_at_after Filter by Conversations created after this timestamp. The maximum allowed time range between `createdAtBefore` and `createdAtAfter` is 31 days.
                     # @param [String] status Filter by Conversation status.
                     # @param [String] channel_id Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID.
                     # @param [Array[String]] channels Filters Conversations that include one or more of the specified communication channels (`OR` match).