twilio-ruby 7.11.1 → 7.11.2

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

@@ -0,0 +1,654 @@
+##
+#    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 QueryJobList < ListResource
+                
+                    class InsightsQueryRequest
+                            # @param [domain]: [String] The business domain to execute the query against
+                            # @param [query]: [QueryList.QueryDefinition] 
+                        attr_accessor :domain, :query
+                        def initialize(payload)
+                                @domain = payload["domain"]
+                                @query = payload["query"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "domain": @domain,
+                                "query": @query,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class QueryDefinition
+                            # @param [measures]: [Array<String>] Array of measures to retrieve, representing quantitative values or metrics to be calculated
+                            # @param [dimensions]: [Array<String>] Array of dimensions to retrieve, representing categorical attributes for grouping and organizing data
+                            # @param [filters]: [Array<QueryList.QueryDefinitionFilters>] Nested filter conditions. Always use `op` and `expressions`.
+                            # @param [order_by]: [Array<QueryList.QueryDefinitionOrderBy>] Specifications for sorting the query results by specific fields in ascending or descending order
+                        attr_accessor :measures, :dimensions, :filters, :order_by
+                        def initialize(payload)
+                                @measures = payload["measures"]
+                                @dimensions = payload["dimensions"]
+                                @filters = payload["filters"]
+                                @order_by = payload["order_by"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "measures": @measures,
+                                "dimensions": @dimensions,
+                                "filters": @filters,
+                                "orderBy": @order_by,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class QueryDefinitionFilters
+                            # @param [op]: [String] 
+                            # @param [expressions]: [Array<QueryList.QueryDefinitionFiltersExpressions>] 
+                        attr_accessor :op, :expressions
+                        def initialize(payload)
+                                @op = payload["op"]
+                                @expressions = payload["expressions"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "op": @op,
+                                "expressions": @expressions,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class QueryDefinitionFiltersExpressions
+                            # @param [op]: [String] 
+                            # @param [field]: [String] 
+                            # @param [values]: [Array<String>] 
+                        attr_accessor :op, :field, :values
+                        def initialize(payload)
+                                @op = payload["op"]
+                                @field = payload["field"]
+                                @values = payload["values"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "op": @op,
+                                "field": @field,
+                                "values": @values,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class QueryDefinitionOrderBy
+                            # @param [field]: [String] Dimension or measure to order by
+                            # @param [direction]: [String] Sort order direction, ascending or descending
+                        attr_accessor :field, :direction
+                        def initialize(payload)
+                                @field = payload["field"]
+                                @direction = payload["direction"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "field": @field,
+                                "direction": @direction,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the QueryJobList
+                    # @param [Version] version Version that contains the resource
+                    # @return [QueryJobList] QueryJobList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/InsightsDomains/Conversations/QueryJobs"
+                        
+                    end
+                    ##
+                    # Create the QueryJobInstance
+                    # @param [String] idempotency_key A client-generated UUIDv7 key that ensures idempotent behavior. Submitting the same key with an identical request returns the same operation without re-execution. Scoped to Account + Region. Retained for 24 hours. 
+                    # @param [InsightsQueryRequest] insights_query_request 
+                    # @return [QueryJobInstance] Created QueryJobInstance
+                    def create(
+                      idempotency_key: :unset,
+                      insights_query_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: insights_query_request.to_json)
+                        QueryJobInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the QueryJobInstanceMetadata
+                    # @param [String] idempotency_key A client-generated UUIDv7 key that ensures idempotent behavior. Submitting the same key with an identical request returns the same operation without re-execution. Scoped to Account + Region. Retained for 24 hours. 
+                    # @param [InsightsQueryRequest] insights_query_request 
+                    # @return [QueryJobInstance] Created QueryJobInstance
+                    def create_with_metadata(
+                      idempotency_key: :unset,
+                    insights_query_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: insights_query_request.to_json)
+                        query_job_instance = QueryJobInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        QueryJobInstanceMetadata.new(
+                            @version,
+                            query_job_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # Lists QueryJobInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] page_token Token for pagination
+                    # @param [LongRunningOperationStatus] status The operation status to filter results by.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list(page_token: :unset, status: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            page_token: page_token,
+                            status: status,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [String] page_token Token for pagination
+                    # @param [LongRunningOperationStatus] status The operation status to filter results by.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Enumerable] Enumerable that will yield up to limit results
+                    def stream(page_token: :unset, status: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_token: page_token,
+                            status: status,
+                            page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists QueryJobPageMetadata records from the API as a list.
+                      # @param [String] page_token Token for pagination
+                      # @param [LongRunningOperationStatus] status The operation status to filter results by.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(page_token: :unset, status: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            'status' => status,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        QueryJobPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields QueryJobInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of QueryJobInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] page_token Token for pagination
+                    # @param [LongRunningOperationStatus] status The operation status to filter results by.
+                    
+                    # @return [Page] Page of QueryJobInstance
+                    def page(page_token: :unset, status: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            'status' => status,
+                                                        'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        QueryJobPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of QueryJobInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of QueryJobInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    QueryJobPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Insights.V3.QueryJobList>'
+                    end
+                end
+
+
+                class QueryJobContext < InstanceContext
+                    ##
+                    # Initialize the QueryJobContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] operation_id The unique identifier for the asynchronous query operation, in TTID format.
+                    # @return [QueryJobContext] QueryJobContext
+                    def initialize(version, operation_id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { operation_id: operation_id,  }
+                        @uri = "/InsightsDomains/Conversations/QueryJobs/#{@solution[:operation_id]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the QueryJobInstance
+                    # @return [QueryJobInstance] Fetched QueryJobInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        QueryJobInstance.new(
+                            @version,
+                            payload,
+                            operation_id: @solution[:operation_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the QueryJobInstanceMetadata
+                    # @return [QueryJobInstance] Fetched QueryJobInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        query_job_instance = QueryJobInstance.new(
+                            @version,
+                            response.body,
+                            operation_id: @solution[:operation_id],
+                        )
+                        QueryJobInstanceMetadata.new(
+                            @version,
+                            query_job_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Insights.V3.QueryJobContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Insights.V3.QueryJobContext #{context}>"
+                    end
+                end
+
+                class QueryJobInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new QueryJobInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}QueryJobInstance] query_job_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [QueryJobInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, query_job_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @query_job_instance = query_job_instance
+                    end
+
+                    def query_job
+                        @query_job_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.QueryJobInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class QueryJobListResponse < InstanceListResource
+                    # @param [Array<QueryJobInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @query_job_instance = payload.body[key].map do |data|
+                        QueryJobInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def query_job_instance
+                          @instance
+                      end
+                  end
+
+                class QueryJobPage < TokenPage
+                    ##
+                    # Initialize the QueryJobPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [QueryJobPage] QueryJobPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of QueryJobInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [QueryJobInstance] QueryJobInstance
+                    def get_instance(payload)
+                        QueryJobInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Insights.V3.QueryJobPage>'
+                    end
+                end
+
+                class QueryJobPageMetadata < PageMetadata
+                    attr_reader :query_job_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @query_job_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @query_job_page << QueryJobListResponse.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
+                        @query_job_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Insights::V3PageMetadata>';
+                    end
+                end
+                class QueryJobListResponse < InstanceListResource
+
+                    # @param [Array<QueryJobInstance>] 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
+                      @query_job = data_list.map do |data|
+                        QueryJobInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def query_job
+                        @query_job
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class QueryJobInstance < InstanceResource
+                    ##
+                    # Initialize the QueryJobInstance
+                    # @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 QueryJob
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [QueryJobInstance] QueryJobInstance
+                    def initialize(version, payload , operation_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'operation_id' => payload['operation_id'],
+                            'status' => payload['status'],
+                            'status_url' => payload['status_url'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'completed_at' => Twilio.deserialize_iso8601_datetime(payload['completed_at']),
+                            'error' => payload['error'],
+                            'result_url' => payload['result_url'],
+                            'result_id' => payload['result_id'],
+                            'result_retention_period' => payload['result_retention_period'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'operation_id' => operation_id  || @properties['operation_id']  , }
+                    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 [QueryJobContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = QueryJobContext.new(@version , @params['operation_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique identifier for the asynchronous query operation, in TTID format.
+                    def operation_id
+                        @properties['operation_id']
+                    end
+                    
+                    ##
+                    # @return [LongRunningOperationStatus] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] The URI to poll for operation status.
+                    def status_url
+                        @properties['status_url']
+                    end
+                    
+                    ##
+                    # @return [Time] The time when the operation was accepted, in RFC 3339 UTC format.
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Time] The time when the operation reached a terminal state (CANCELLED, COMPLETED, or FAILED), in RFC 3339 UTC format. Null while the operation is still PENDING or RUNNING.
+                    def completed_at
+                        @properties['completed_at']
+                    end
+                    
+                    ##
+                    # @return [OperationError] The error details, present only when status is FAILED.
+                    def error
+                        @properties['error']
+                    end
+                    
+                    ##
+                    # @return [String] The URL to retrieve query results, present only when status is COMPLETED. Supports pagination via the pageSize and pageToken query parameters. 
+                    def result_url
+                        @properties['result_url']
+                    end
+                    
+                    ##
+                    # @return [String] The identifier of the results resource, present only when status is COMPLETED. Equal to operationId, since results are keyed by the operation ID. 
+                    def result_id
+                        @properties['result_id']
+                    end
+                    
+                    ##
+                    # @return [String] The duration for how long results are retained, in ISO 8601 format.
+                    def result_retention_period
+                        @properties['result_retention_period']
+                    end
+                    
+                    ##
+                    # Fetch the QueryJobInstance
+                    # @return [QueryJobInstance] Fetched QueryJobInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Insights.V3.QueryJobInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Insights.V3.QueryJobInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end