twilio-ruby 7.10.4 → 7.10.6

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

@@ -0,0 +1,394 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Insights
+#    Insights Domain V3 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 Insights < InsightsBase
+            class V3 < Version
+                class QueryList < 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 QueryList
+                    # @param [Version] version Version that contains the resource
+                    # @return [QueryList] QueryList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/InsightsDomains/Conversations/Query"
+                        
+                    end
+                    ##
+                    # Create the QueryInstance
+                    # @param [String] page_size Number of items per page
+                    # @param [InsightsQueryRequest] insights_query_request 
+                    # @return [QueryInstance] Created QueryInstance
+                    def create(
+                      page_size: :unset,
+                      insights_query_request: nil
+                    )
+
+                        params = Twilio::Values.of({
+                            'pageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, params: params, headers: headers, data: insights_query_request.to_json)
+                        QueryInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the QueryInstanceMetadata
+                    # @param [String] page_size Number of items per page
+                    # @param [InsightsQueryRequest] insights_query_request 
+                    # @return [QueryInstance] Created QueryInstance
+                    def create_with_metadata(
+                      page_size: :unset,
+                    insights_query_request: nil
+                    )
+
+                        params = Twilio::Values.of({
+                            'pageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, params: params, headers: headers, data: insights_query_request.to_json)
+                        query_instance = QueryInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        QueryInstanceMetadata.new(
+                            @version,
+                            query_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Fetch the QueryInstance
+                    # @param [String] page_token Pagination token
+                    # @return [QueryInstance] Fetched QueryInstance
+                    def fetch(
+                      page_token: nil
+                    )
+
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        QueryInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Fetch the QueryInstanceMetadata
+                    # @param [String] page_token Pagination token
+                    # @return [QueryInstance] Fetched QueryInstance
+                    def fetch_with_metadata(
+                      page_token: nil
+                    )
+
+                        params = Twilio::Values.of({
+                            '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)
+                        query_instance = QueryInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        QueryInstanceMetadata.new(
+                            @version,
+                            query_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Insights.V3.QueryList>'
+                    end
+                end
+
+                class QueryPage < TokenPage
+                    ##
+                    # Initialize the QueryPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [QueryPage] QueryPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of QueryInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [QueryInstance] QueryInstance
+                    def get_instance(payload)
+                        QueryInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Insights.V3.QueryPage>'
+                    end
+                end
+
+                class QueryPageMetadata < PageMetadata
+                    attr_reader :query_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @query_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @query_page << QueryListResponse.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_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Insights::V3PageMetadata>';
+                    end
+                end
+                class QueryListResponse < InstanceListResource
+
+                    # @param [Array<QueryInstance>] 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 = data_list.map do |data|
+                        QueryInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def query
+                        @query
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class QueryInstance < InstanceResource
+                    ##
+                    # Initialize the QueryInstance
+                    # @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 Query
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [QueryInstance] QueryInstance
+                    def initialize(version, payload )
+                        
+                        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.QueryInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Insights.V3.QueryInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,46 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Insights
+#    Insights Domain V3 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 Insights
+            class V3 < Version
+                ##
+                # Initialize the V3 version of Insights
+                def initialize(domain)
+                    super
+                    @version = 'v3'
+                    @metadata = nil
+                    @query = nil
+                end
+
+                ##
+                # @return [Twilio::REST::Insights::V3::MetadataList]
+                def metadata
+                    @metadata ||= MetadataList.new self
+                end
+                ##
+                # @return [Twilio::REST::Insights::V3::QueryList]
+                def query
+                    @query ||= QueryList.new self
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Insights::V3>';
+                end
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/insights_base.rb

@@ -23,6 +23,7 @@ module Twilio
         @port = 443
         @v1 = nil
         @v2 = nil
+        @v3 = nil
       end
 
       def v1
@@ -33,6 +34,10 @@ module Twilio
         @v2 ||= Insights::V2.new self
       end
 
+      def v3
+        @v3 ||= Insights::V3.new self
+      end
+
       ##
       # Provide a user friendly representation
       def to_s

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

@@ -38,9 +38,9 @@ module Twilio
                     # @param [Object] config Operator configuration, following the schema defined by the Operator Type.
                     # @return [CustomOperatorInstance] Created CustomOperatorInstance
                     def create(
-                        friendly_name: nil, 
-                        operator_type: nil, 
-                        config: nil
+                      friendly_name: nil, 
+                      operator_type: nil, 
+                      config: nil
                     )
 
                         data = Twilio::Values.of({
@@ -143,7 +143,11 @@ module Twilio
                             language_code: language_code,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
                     end
 
                     ##
@@ -181,9 +185,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -333,9 +341,9 @@ module Twilio
                     # @param [String] if_match The If-Match HTTP request header
                     # @return [CustomOperatorInstance] Updated CustomOperatorInstance
                     def update(
-                        friendly_name: nil, 
-                        config: nil, 
-                        if_match: :unset
+                      friendly_name: nil, 
+                      config: nil, 
+                      if_match: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -500,7 +508,7 @@ module Twilio
                             @custom_operator_page << CustomOperatorListResponse.new(version, @payload, key, limit - records)
                             @payload = self.next_page
                             break unless @payload
-                            records += @payload.body[key].size
+                            records += (@payload.body[key] || []).size
                         end
                         # Path Solution
                         @solution = solution
@@ -522,7 +530,7 @@ module Twilio
                     # @param [Hash{String => Object}] headers
                     # @param [Integer] status_code
                     def initialize(version, payload, key, limit = :unset)
-                      data_list = payload.body[key]
+                      data_list = payload.body[key]  || []
                       if limit != :unset
                         data_list = data_list[0, limit]
                       end
@@ -687,9 +695,9 @@ module Twilio
                     # @param [String] if_match The If-Match HTTP request header
                     # @return [CustomOperatorInstance] Updated CustomOperatorInstance
                     def update(
-                        friendly_name: nil, 
-                        config: nil, 
-                        if_match: :unset
+                      friendly_name: nil, 
+                      config: nil, 
+                      if_match: :unset
                     )
 
                         context.update(

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

@@ -75,7 +75,11 @@ module Twilio
                             language_code: language_code,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
                     end
 
                     ##
@@ -113,9 +117,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -332,7 +340,7 @@ module Twilio
                             @operator_page << OperatorListResponse.new(version, @payload, key, limit - records)
                             @payload = self.next_page
                             break unless @payload
-                            records += @payload.body[key].size
+                            records += (@payload.body[key] || []).size
                         end
                         # Path Solution
                         @solution = solution
@@ -354,7 +362,7 @@ module Twilio
                     # @param [Hash{String => Object}] headers
                     # @param [Integer] status_code
                     def initialize(version, payload, key, limit = :unset)
-                      data_list = payload.body[key]
+                      data_list = payload.body[key]  || []
                       if limit != :unset
                         data_list = data_list[0, limit]
                       end

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

@@ -242,7 +242,7 @@ module Twilio
                             @operator_attachment_page << OperatorAttachmentListResponse.new(version, @payload, key, limit - records)
                             @payload = self.next_page
                             break unless @payload
-                            records += @payload.body[key].size
+                            records += (@payload.body[key] || []).size
                         end
                         # Path Solution
                         @solution = solution
@@ -264,7 +264,7 @@ module Twilio
                     # @param [Hash{String => Object}] headers
                     # @param [Integer] status_code
                     def initialize(version, payload, key, limit = :unset)
-                      data_list = payload.body[key]
+                      data_list = payload.body[key]  || []
                       if limit != :unset
                         data_list = data_list[0, limit]
                       end

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

@@ -207,7 +207,7 @@ module Twilio
                             @operator_attachments_page << OperatorAttachmentsListResponse.new(version, @payload, key, limit - records)
                             @payload = self.next_page
                             break unless @payload
-                            records += @payload.body[key].size
+                            records += (@payload.body[key] || []).size
                         end
                         # Path Solution
                         @solution = solution
@@ -229,7 +229,7 @@ module Twilio
                     # @param [Hash{String => Object}] headers
                     # @param [Integer] status_code
                     def initialize(version, payload, key, limit = :unset)
-                      data_list = payload.body[key]
+                      data_list = payload.body[key]  || []
                       if limit != :unset
                         data_list = data_list[0, limit]
                       end

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

@@ -71,7 +71,11 @@ module Twilio
                             language_code: language_code,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
                     end
 
                     ##
@@ -107,9 +111,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -324,7 +332,7 @@ module Twilio
                             @operator_type_page << OperatorTypeListResponse.new(version, @payload, key, limit - records)
                             @payload = self.next_page
                             break unless @payload
-                            records += @payload.body[key].size
+                            records += (@payload.body[key] || []).size
                         end
                         # Path Solution
                         @solution = solution
@@ -346,7 +354,7 @@ module Twilio
                     # @param [Hash{String => Object}] headers
                     # @param [Integer] status_code
                     def initialize(version, payload, key, limit = :unset)
-                      data_list = payload.body[key]
+                      data_list = payload.body[key]  || []
                       if limit != :unset
                         data_list = data_list[0, limit]
                       end