purecloudplatformclientv2 60.0.0 → 64.0.1

data/lib/purecloudplatformclientv2/models/async_conversation_query.rb

@@ -18,23 +18,23 @@ require 'date'
 
 module PureCloud
   class AsyncConversationQuery
-    # Specifies the date and time range of data being queried. Results will include conversations that both started on a day touched by the interval AND either started, ended, or any activity during the interval. Conversations that started before the earliest day of the interval will not be searched. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
+    # Specifies the date and time range of data being queried. Results will include conversations that both started on a day touched by the interval AND either started, ended, or any activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
     attr_accessor :interval
 
     # Filters that target conversation-level data
     attr_accessor :conversation_filters
 
-    # Filters that target quality management evaluation-level data
-    attr_accessor :evaluation_filters
+    # Filters that target individual segments within a conversation
+    attr_accessor :segment_filters
 
-    # Filters that target quality management survey-level data
-    attr_accessor :survey_filters
+    # Filters that target evaluations
+    attr_accessor :evaluation_filters
 
-    # Filters that target call quality of service data
+    # Filters that target mediaEndpointStats
     attr_accessor :media_endpoint_stat_filters
 
-    # Filters that target individual segments within a conversation
-    attr_accessor :segment_filters
+    # Filters that target surveys
+    attr_accessor :survey_filters
 
     # Sort the result set in ascending/descending order. Default is ascending
     attr_accessor :order
@@ -53,13 +53,13 @@ module PureCloud
         
         :'conversation_filters' => :'conversationFilters',
         
-        :'evaluation_filters' => :'evaluationFilters',
+        :'segment_filters' => :'segmentFilters',
         
-        :'survey_filters' => :'surveyFilters',
+        :'evaluation_filters' => :'evaluationFilters',
         
         :'media_endpoint_stat_filters' => :'mediaEndpointStatFilters',
         
-        :'segment_filters' => :'segmentFilters',
+        :'survey_filters' => :'surveyFilters',
         
         :'order' => :'order',
         
@@ -76,15 +76,15 @@ module PureCloud
         
         :'interval' => :'String',
         
-        :'conversation_filters' => :'Array<AnalyticsQueryFilter>',
+        :'conversation_filters' => :'Array<ConversationDetailQueryFilter>',
         
-        :'evaluation_filters' => :'Array<AnalyticsQueryFilter>',
+        :'segment_filters' => :'Array<SegmentDetailQueryFilter>',
         
-        :'survey_filters' => :'Array<AnalyticsQueryFilter>',
+        :'evaluation_filters' => :'Array<EvaluationDetailQueryFilter>',
         
-        :'media_endpoint_stat_filters' => :'Array<AnalyticsQueryFilter>',
+        :'media_endpoint_stat_filters' => :'Array<MediaEndpointStatDetailQueryFilter>',
         
-        :'segment_filters' => :'Array<AnalyticsQueryFilter>',
+        :'survey_filters' => :'Array<SurveyDetailQueryFilter>',
         
         :'order' => :'String',
         
@@ -124,10 +124,10 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'evaluationFilters')
+      if attributes.has_key?(:'segmentFilters')
         
-        if (value = attributes[:'evaluationFilters']).is_a?(Array)
-          self.evaluation_filters = value
+        if (value = attributes[:'segmentFilters']).is_a?(Array)
+          self.segment_filters = value
         end
         
         
@@ -135,10 +135,10 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'surveyFilters')
+      if attributes.has_key?(:'evaluationFilters')
         
-        if (value = attributes[:'surveyFilters']).is_a?(Array)
-          self.survey_filters = value
+        if (value = attributes[:'evaluationFilters']).is_a?(Array)
+          self.evaluation_filters = value
         end
         
         
@@ -157,10 +157,10 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'segmentFilters')
+      if attributes.has_key?(:'surveyFilters')
         
-        if (value = attributes[:'segmentFilters']).is_a?(Array)
-          self.segment_filters = value
+        if (value = attributes[:'surveyFilters']).is_a?(Array)
+          self.survey_filters = value
         end
         
         
@@ -329,10 +329,10 @@ module PureCloud
       self.class == o.class &&
           interval == o.interval &&
           conversation_filters == o.conversation_filters &&
+          segment_filters == o.segment_filters &&
           evaluation_filters == o.evaluation_filters &&
-          survey_filters == o.survey_filters &&
           media_endpoint_stat_filters == o.media_endpoint_stat_filters &&
-          segment_filters == o.segment_filters &&
+          survey_filters == o.survey_filters &&
           order == o.order &&
           order_by == o.order_by &&
           limit == o.limit
@@ -347,7 +347,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [interval, conversation_filters, evaluation_filters, survey_filters, media_endpoint_stat_filters, segment_filters, order, order_by, limit].hash
+      [interval, conversation_filters, segment_filters, evaluation_filters, media_endpoint_stat_filters, survey_filters, order, order_by, limit].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/async_query_response.rb

@@ -0,0 +1,202 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@genesys.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: UNLICENSED
+https://help.mypurecloud.com/articles/terms-and-conditions/
+
+Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
+
+=end
+
+require 'date'
+
+module PureCloud
+  class AsyncQueryResponse
+    # Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results.
+    attr_accessor :job_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'job_id' => :'jobId'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'job_id' => :'String'
+        
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      
+      if attributes.has_key?(:'jobId')
+        
+        
+        self.job_id = attributes[:'jobId']
+        
+      
+      end
+
+      
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      
+      
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          job_id == o.job_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [job_id].hash
+    end
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = Object.const_get("PureCloud").const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/purecloudplatformclientv2/models/async_query_status.rb

@@ -0,0 +1,320 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@genesys.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: UNLICENSED
+https://help.mypurecloud.com/articles/terms-and-conditions/
+
+Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
+
+=end
+
+require 'date'
+
+module PureCloud
+  class AsyncQueryStatus
+    # The current state of the asynchronous query
+    attr_accessor :state
+
+    # The error associated with the current query, if the state is FAILED
+    attr_accessor :error_message
+
+    # The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :expiration_date
+
+    # The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :submission_date
+
+    # The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :completion_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'state' => :'state',
+        
+        :'error_message' => :'errorMessage',
+        
+        :'expiration_date' => :'expirationDate',
+        
+        :'submission_date' => :'submissionDate',
+        
+        :'completion_date' => :'completionDate'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'state' => :'String',
+        
+        :'error_message' => :'String',
+        
+        :'expiration_date' => :'DateTime',
+        
+        :'submission_date' => :'DateTime',
+        
+        :'completion_date' => :'DateTime'
+        
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      
+      if attributes.has_key?(:'state')
+        
+        
+        self.state = attributes[:'state']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'errorMessage')
+        
+        
+        self.error_message = attributes[:'errorMessage']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'expirationDate')
+        
+        
+        self.expiration_date = attributes[:'expirationDate']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'submissionDate')
+        
+        
+        self.submission_date = attributes[:'submissionDate']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'completionDate')
+        
+        
+        self.completion_date = attributes[:'completionDate']
+        
+      
+      end
+
+      
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      
+      
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      
+      
+      
+      allowed_values = ["PENDING", "FAILED", "CANCELLED", "FULFILLED", "EXPIRED"]
+      if @state && !allowed_values.include?(@state)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      allowed_values = ["PENDING", "FAILED", "CANCELLED", "FULFILLED", "EXPIRED"]
+      if state && !allowed_values.include?(state)
+        fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}."
+      end
+      @state = state
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          state == o.state &&
+          error_message == o.error_message &&
+          expiration_date == o.expiration_date &&
+          submission_date == o.submission_date &&
+          completion_date == o.completion_date
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [state, error_message, expiration_date, submission_date, completion_date].hash
+    end
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = Object.const_get("PureCloud").const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end