purecloudplatformclientv2 85.0.0 → 89.0.0

data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb

@@ -0,0 +1,244 @@
+=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 ApiUsageQueryResult
+    # Query results
+    attr_accessor :results
+
+    # Query status
+    attr_accessor :query_status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'results' => :'results',
+        
+        :'query_status' => :'queryStatus'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'results' => :'Array<ApiUsageRow>',
+        
+        :'query_status' => :'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?(:'results')
+        
+        if (value = attributes[:'results']).is_a?(Array)
+          self.results = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'queryStatus')
+        
+        
+        self.query_status = attributes[:'queryStatus']
+        
+      
+      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 = ["Complete", "Failed", "Running"]
+      if @query_status && !allowed_values.include?(@query_status)
+        return false
+      end
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] query_status Object to be assigned
+    def query_status=(query_status)
+      allowed_values = ["Complete", "Failed", "Running"]
+      if query_status && !allowed_values.include?(query_status)
+        fail ArgumentError, "invalid value for 'query_status', must be one of #{allowed_values}."
+      end
+      @query_status = query_status
+    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 &&
+          results == o.results &&
+          query_status == o.query_status
+    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
+      [results, query_status].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/{reschedule_request.rb → api_usage_row.rb}

@@ -17,50 +17,75 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  class RescheduleRequest
-    # The start date of the range to reschedule in ISO-8601 format
-    attr_accessor :start_date
+  class ApiUsageRow
+    # Client Id associated with this query result
+    attr_accessor :client_id
 
-    # The end date of the range to reschedule in ISO-8601 format
-    attr_accessor :end_date
+    # Client Name associated with this query result
+    attr_accessor :client_name
 
-    # The IDs of the agents to reschedule.  Null or empty means all agents on the schedule
-    attr_accessor :agent_ids
+    # Organization Id associated with this query result
+    attr_accessor :organization_id
 
-    # The IDs of the activity codes to reschedule. Null or empty means all activity codes will be considered
-    attr_accessor :activity_code_ids
+    # User Id associated with this query result
+    attr_accessor :user_id
 
-    # Whether to prevent changes to weekly paid time
-    attr_accessor :do_not_change_weekly_paid_time
+    # Template Uri associated with this query result
+    attr_accessor :template_uri
 
-    # Whether to prevent changes to daily paid time
-    attr_accessor :do_not_change_daily_paid_time
+    # HTTP Method associated with this query result
+    attr_accessor :http_method
 
-    # Whether to prevent changes to shift start times
-    attr_accessor :do_not_change_shift_start_times
+    # Number of requests resulting in a 2xx HTTP status code
+    attr_accessor :status200
 
-    # Whether to prevent changes to manually edited shifts
-    attr_accessor :do_not_change_manually_edited_shifts
+    # Number of requests resulting in a 3xx HTTP status code
+    attr_accessor :status300
+
+    # Number of requests resulting in a 4xx HTTP status code
+    attr_accessor :status400
+
+    # Number of requests resulting in a 5xx HTTP status code
+    attr_accessor :status500
+
+    # Number of requests resulting in a 429 HTTP status code, this is a subset of the count returned with status400
+    attr_accessor :status429
+
+    # Total number of requests
+    attr_accessor :requests
+
+    # Date of requests, based on granularity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
-        :'start_date' => :'startDate',
+        :'client_id' => :'clientId',
+        
+        :'client_name' => :'clientName',
+        
+        :'organization_id' => :'organizationId',
         
-        :'end_date' => :'endDate',
+        :'user_id' => :'userId',
         
-        :'agent_ids' => :'agentIds',
+        :'template_uri' => :'templateUri',
         
-        :'activity_code_ids' => :'activityCodeIds',
+        :'http_method' => :'httpMethod',
         
-        :'do_not_change_weekly_paid_time' => :'doNotChangeWeeklyPaidTime',
+        :'status200' => :'status200',
         
-        :'do_not_change_daily_paid_time' => :'doNotChangeDailyPaidTime',
+        :'status300' => :'status300',
         
-        :'do_not_change_shift_start_times' => :'doNotChangeShiftStartTimes',
+        :'status400' => :'status400',
         
-        :'do_not_change_manually_edited_shifts' => :'doNotChangeManuallyEditedShifts'
+        :'status500' => :'status500',
+        
+        :'status429' => :'status429',
+        
+        :'requests' => :'requests',
+        
+        :'date' => :'date'
         
       }
     end
@@ -69,21 +94,31 @@ module PureCloud
     def self.swagger_types
       {
         
-        :'start_date' => :'DateTime',
+        :'client_id' => :'String',
+        
+        :'client_name' => :'String',
+        
+        :'organization_id' => :'String',
+        
+        :'user_id' => :'String',
         
-        :'end_date' => :'DateTime',
+        :'template_uri' => :'String',
         
-        :'agent_ids' => :'Array<String>',
+        :'http_method' => :'String',
         
-        :'activity_code_ids' => :'Array<String>',
+        :'status200' => :'Integer',
         
-        :'do_not_change_weekly_paid_time' => :'BOOLEAN',
+        :'status300' => :'Integer',
         
-        :'do_not_change_daily_paid_time' => :'BOOLEAN',
+        :'status400' => :'Integer',
         
-        :'do_not_change_shift_start_times' => :'BOOLEAN',
+        :'status500' => :'Integer',
         
-        :'do_not_change_manually_edited_shifts' => :'BOOLEAN'
+        :'status429' => :'Integer',
+        
+        :'requests' => :'Integer',
+        
+        :'date' => :'DateTime'
         
       }
     end
@@ -97,77 +132,118 @@ module PureCloud
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       
-      if attributes.has_key?(:'startDate')
+      if attributes.has_key?(:'clientId')
         
         
-        self.start_date = attributes[:'startDate']
+        self.client_id = attributes[:'clientId']
         
       
       end
 
       
-      if attributes.has_key?(:'endDate')
+      if attributes.has_key?(:'clientName')
         
         
-        self.end_date = attributes[:'endDate']
+        self.client_name = attributes[:'clientName']
         
       
       end
 
       
-      if attributes.has_key?(:'agentIds')
+      if attributes.has_key?(:'organizationId')
         
-        if (value = attributes[:'agentIds']).is_a?(Array)
-          self.agent_ids = value
-        end
         
+        self.organization_id = attributes[:'organizationId']
         
       
       end
 
       
-      if attributes.has_key?(:'activityCodeIds')
+      if attributes.has_key?(:'userId')
+        
+        
+        self.user_id = attributes[:'userId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'templateUri')
+        
+        
+        self.template_uri = attributes[:'templateUri']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'httpMethod')
+        
+        
+        self.http_method = attributes[:'httpMethod']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'status200')
+        
+        
+        self.status200 = attributes[:'status200']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'status300')
+        
+        
+        self.status300 = attributes[:'status300']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'status400')
         
-        if (value = attributes[:'activityCodeIds']).is_a?(Array)
-          self.activity_code_ids = value
-        end
         
+        self.status400 = attributes[:'status400']
         
       
       end
 
       
-      if attributes.has_key?(:'doNotChangeWeeklyPaidTime')
+      if attributes.has_key?(:'status500')
         
         
-        self.do_not_change_weekly_paid_time = attributes[:'doNotChangeWeeklyPaidTime']
+        self.status500 = attributes[:'status500']
         
       
       end
 
       
-      if attributes.has_key?(:'doNotChangeDailyPaidTime')
+      if attributes.has_key?(:'status429')
         
         
-        self.do_not_change_daily_paid_time = attributes[:'doNotChangeDailyPaidTime']
+        self.status429 = attributes[:'status429']
         
       
       end
 
       
-      if attributes.has_key?(:'doNotChangeShiftStartTimes')
+      if attributes.has_key?(:'requests')
         
         
-        self.do_not_change_shift_start_times = attributes[:'doNotChangeShiftStartTimes']
+        self.requests = attributes[:'requests']
         
       
       end
 
       
-      if attributes.has_key?(:'doNotChangeManuallyEditedShifts')
+      if attributes.has_key?(:'date')
         
         
-        self.do_not_change_manually_edited_shifts = attributes[:'doNotChangeManuallyEditedShifts']
+        self.date = attributes[:'date']
         
       
       end
@@ -189,19 +265,11 @@ module PureCloud
     def valid?
       
       
-      if @start_date.nil?
-        return false
-      end
-
       
       
       
       
       
-      if @end_date.nil?
-        return false
-      end
-
       
       
       
@@ -215,37 +283,35 @@ module PureCloud
       
       
       
-      if @do_not_change_weekly_paid_time.nil?
-        return false
-      end
-
       
       
       
       
       
-      if @do_not_change_daily_paid_time.nil?
-        return false
-      end
-
       
       
       
       
       
-      if @do_not_change_shift_start_times.nil?
-        return false
-      end
-
       
       
       
       
       
-      if @do_not_change_manually_edited_shifts.nil?
-        return false
-      end
-
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -272,6 +338,31 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -298,14 +389,19 @@ module PureCloud
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          start_date == o.start_date &&
-          end_date == o.end_date &&
-          agent_ids == o.agent_ids &&
-          activity_code_ids == o.activity_code_ids &&
-          do_not_change_weekly_paid_time == o.do_not_change_weekly_paid_time &&
-          do_not_change_daily_paid_time == o.do_not_change_daily_paid_time &&
-          do_not_change_shift_start_times == o.do_not_change_shift_start_times &&
-          do_not_change_manually_edited_shifts == o.do_not_change_manually_edited_shifts
+          client_id == o.client_id &&
+          client_name == o.client_name &&
+          organization_id == o.organization_id &&
+          user_id == o.user_id &&
+          template_uri == o.template_uri &&
+          http_method == o.http_method &&
+          status200 == o.status200 &&
+          status300 == o.status300 &&
+          status400 == o.status400 &&
+          status500 == o.status500 &&
+          status429 == o.status429 &&
+          requests == o.requests &&
+          date == o.date
     end
 
     # @see the `==` method
@@ -317,7 +413,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [start_date, end_date, agent_ids, activity_code_ids, do_not_change_weekly_paid_time, do_not_change_daily_paid_time, do_not_change_shift_start_times, do_not_change_manually_edited_shifts].hash
+      [client_id, client_name, organization_id, user_id, template_uri, http_method, status200, status300, status400, status500, status429, requests, date].hash
     end
 
     # build the object from hash