purecloudplatformclientv2 84.0.0 → 88.0.0

data/lib/purecloudplatformclientv2/models/bu_intraday_schedule_data.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 BuIntradayScheduleData
+    # The total on-queue time in seconds for all agents in this group
+    attr_accessor :on_queue_time_seconds
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'on_queue_time_seconds' => :'onQueueTimeSeconds'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'on_queue_time_seconds' => :'Integer'
+        
+      }
+    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?(:'onQueueTimeSeconds')
+        
+        
+        self.on_queue_time_seconds = attributes[:'onQueueTimeSeconds']
+        
+      
+      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 &&
+          on_queue_time_seconds == o.on_queue_time_seconds
+    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
+      [on_queue_time_seconds].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/{intraday_query_data_command.rb → bu_management_unit_schedule_summary.rb}

@@ -17,35 +17,35 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  class IntradayQueryDataCommand
-    # Start date of the requested date range in ISO-8601 format
-    attr_accessor :start_date
+  class BuManagementUnitScheduleSummary
+    # The management unit to which this summary applies
+    attr_accessor :management_unit
 
-    # End date of the requested date range in ISO-8601 format.  Must be within the same 7 day schedule week as defined by the management unit's start day of week
-    attr_accessor :end_date
+    # The number of agents from this management unit that are in the schedule
+    attr_accessor :agent_count
 
-    # The metrics to validate
-    attr_accessor :metrics
+    # The start of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :start_date
 
-    # The queue IDs for which to fetch data.  Omitting or passing an empty list will return all available queues
-    attr_accessor :queue_ids
+    # The end of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :end_date
 
-    # The period/interval for which to aggregate the data.  Optional, defaults to 15
-    attr_accessor :interval_length_minutes
+    # The changed agents in the management unit. Only populated in schedule update notifications
+    attr_accessor :agents
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
-        :'start_date' => :'startDate',
+        :'management_unit' => :'managementUnit',
         
-        :'end_date' => :'endDate',
+        :'agent_count' => :'agentCount',
         
-        :'metrics' => :'metrics',
+        :'start_date' => :'startDate',
         
-        :'queue_ids' => :'queueIds',
+        :'end_date' => :'endDate',
         
-        :'interval_length_minutes' => :'intervalLengthMinutes'
+        :'agents' => :'agents'
         
       }
     end
@@ -54,15 +54,15 @@ module PureCloud
     def self.swagger_types
       {
         
-        :'start_date' => :'DateTime',
+        :'management_unit' => :'ManagementUnitReference',
         
-        :'end_date' => :'DateTime',
+        :'agent_count' => :'Integer',
         
-        :'metrics' => :'Array<IntradayMetric>',
+        :'start_date' => :'DateTime',
         
-        :'queue_ids' => :'Array<String>',
+        :'end_date' => :'DateTime',
         
-        :'interval_length_minutes' => :'Integer'
+        :'agents' => :'Array<UserReference>'
         
       }
     end
@@ -76,50 +76,48 @@ module PureCloud
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       
-      if attributes.has_key?(:'startDate')
+      if attributes.has_key?(:'managementUnit')
         
         
-        self.start_date = attributes[:'startDate']
+        self.management_unit = attributes[:'managementUnit']
         
       
       end
 
       
-      if attributes.has_key?(:'endDate')
+      if attributes.has_key?(:'agentCount')
         
         
-        self.end_date = attributes[:'endDate']
+        self.agent_count = attributes[:'agentCount']
         
       
       end
 
       
-      if attributes.has_key?(:'metrics')
+      if attributes.has_key?(:'startDate')
         
-        if (value = attributes[:'metrics']).is_a?(Array)
-          self.metrics = value
-        end
         
+        self.start_date = attributes[:'startDate']
         
       
       end
 
       
-      if attributes.has_key?(:'queueIds')
+      if attributes.has_key?(:'endDate')
         
-        if (value = attributes[:'queueIds']).is_a?(Array)
-          self.queue_ids = value
-        end
         
+        self.end_date = attributes[:'endDate']
         
       
       end
 
       
-      if attributes.has_key?(:'intervalLengthMinutes')
+      if attributes.has_key?(:'agents')
         
+        if (value = attributes[:'agents']).is_a?(Array)
+          self.agents = value
+        end
         
-        self.interval_length_minutes = attributes[:'intervalLengthMinutes']
         
       
       end
@@ -141,28 +139,13 @@ module PureCloud
     def valid?
       
       
-      if @start_date.nil?
-        return false
-      end
-
-      
-      
-      
       
       
-      if @end_date.nil?
-        return false
-      end
-
       
       
       
       
       
-      if @metrics.nil?
-        return false
-      end
-
       
       
       
@@ -208,11 +191,11 @@ module PureCloud
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          management_unit == o.management_unit &&
+          agent_count == o.agent_count &&
           start_date == o.start_date &&
           end_date == o.end_date &&
-          metrics == o.metrics &&
-          queue_ids == o.queue_ids &&
-          interval_length_minutes == o.interval_length_minutes
+          agents == o.agents
     end
 
     # @see the `==` method
@@ -224,7 +207,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [start_date, end_date, metrics, queue_ids, interval_length_minutes].hash
+      [management_unit, agent_count, start_date, end_date, agents].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/bu_planning_group_headcount_forecast.rb

@@ -0,0 +1,258 @@
+=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 BuPlanningGroupHeadcountForecast
+    # The planning group to which this portion of the headcount forecast applies
+    attr_accessor :planning_group
+
+    # Required headcount per interval, referenced against the reference start date
+    attr_accessor :required_per_interval
+
+    # Required headcount per interval without accounting for shrinkage, referenced against the reference start date
+    attr_accessor :required_without_shrinkage_per_interval
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'planning_group' => :'planningGroup',
+        
+        :'required_per_interval' => :'requiredPerInterval',
+        
+        :'required_without_shrinkage_per_interval' => :'requiredWithoutShrinkagePerInterval'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'planning_group' => :'PlanningGroupReference',
+        
+        :'required_per_interval' => :'Array<Float>',
+        
+        :'required_without_shrinkage_per_interval' => :'Array<Float>'
+        
+      }
+    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?(:'planningGroup')
+        
+        
+        self.planning_group = attributes[:'planningGroup']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'requiredPerInterval')
+        
+        if (value = attributes[:'requiredPerInterval']).is_a?(Array)
+          self.required_per_interval = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'requiredWithoutShrinkagePerInterval')
+        
+        if (value = attributes[:'requiredWithoutShrinkagePerInterval']).is_a?(Array)
+          self.required_without_shrinkage_per_interval = value
+        end
+        
+        
+      
+      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 &&
+          planning_group == o.planning_group &&
+          required_per_interval == o.required_per_interval &&
+          required_without_shrinkage_per_interval == o.required_without_shrinkage_per_interval
+    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
+      [planning_group, required_per_interval, required_without_shrinkage_per_interval].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