purecloudplatformclientv2 84.0.0 → 88.0.0

data/lib/purecloudplatformclientv2/models/{forecast_result_response.rb → bu_headcount_forecast_response.rb}

@@ -17,11 +17,11 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  class ForecastResultResponse
-    # The forecast result.  If null, fetch the result from the url in downloadUrl
+  class BuHeadcountForecastResponse
+    # The headcount forecast, null when downloadUrl is provided
     attr_accessor :result
 
-    # The downloadUrl to fetch the result if it is too large to be sent directly
+    # Download URL.  Null unless the response is too large to pass directly through the api
     attr_accessor :download_url
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -39,7 +39,7 @@ module PureCloud
     def self.swagger_types
       {
         
-        :'result' => :'RouteGroupList',
+        :'result' => :'BuHeadcountForecast',
         
         :'download_url' => :'String'
         

data/lib/purecloudplatformclientv2/models/{intraday_data_group.rb → bu_intraday_data_group.rb}

@@ -17,27 +17,27 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  class IntradayDataGroup
+  class BuIntradayDataGroup
     # The media type associated with this intraday group
     attr_accessor :media_type
 
-    # Forecast data for this date range
-    attr_accessor :forecast_data_per_interval
+    # Forecast data summary for this date range
+    attr_accessor :forecast_data_summary
 
-    # Schedule data for this date range
-    attr_accessor :schedule_data_per_interval
+    # Forecast data per interval for this date range
+    attr_accessor :forecast_data_per_interval
 
-    # Historical agent data for this date range
-    attr_accessor :historical_agent_data_per_interval
+    # Schedule data summary for this date range
+    attr_accessor :schedule_data_summary
 
-    # Historical queue data for this date range
-    attr_accessor :historical_queue_data_per_interval
+    # Schedule data per interval for this date range
+    attr_accessor :schedule_data_per_interval
 
-    # Performance prediction data for this date range
-    attr_accessor :performance_prediction_agent_data_per_interval
+    # Performance prediction data summary for this date range
+    attr_accessor :performance_prediction_data_summary
 
-    # Performance prediction data for this date range
-    attr_accessor :performance_prediction_queue_data_per_interval
+    # Performance prediction data per interval for this date range
+    attr_accessor :performance_prediction_data_per_interval
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -45,17 +45,17 @@ module PureCloud
         
         :'media_type' => :'mediaType',
         
-        :'forecast_data_per_interval' => :'forecastDataPerInterval',
+        :'forecast_data_summary' => :'forecastDataSummary',
         
-        :'schedule_data_per_interval' => :'scheduleDataPerInterval',
+        :'forecast_data_per_interval' => :'forecastDataPerInterval',
         
-        :'historical_agent_data_per_interval' => :'historicalAgentDataPerInterval',
+        :'schedule_data_summary' => :'scheduleDataSummary',
         
-        :'historical_queue_data_per_interval' => :'historicalQueueDataPerInterval',
+        :'schedule_data_per_interval' => :'scheduleDataPerInterval',
         
-        :'performance_prediction_agent_data_per_interval' => :'performancePredictionAgentDataPerInterval',
+        :'performance_prediction_data_summary' => :'performancePredictionDataSummary',
         
-        :'performance_prediction_queue_data_per_interval' => :'performancePredictionQueueDataPerInterval'
+        :'performance_prediction_data_per_interval' => :'performancePredictionDataPerInterval'
         
       }
     end
@@ -66,17 +66,17 @@ module PureCloud
         
         :'media_type' => :'String',
         
-        :'forecast_data_per_interval' => :'Array<IntradayForecastData>',
+        :'forecast_data_summary' => :'BuIntradayForecastData',
         
-        :'schedule_data_per_interval' => :'Array<IntradayScheduleData>',
+        :'forecast_data_per_interval' => :'Array<BuIntradayForecastData>',
         
-        :'historical_agent_data_per_interval' => :'Array<IntradayHistoricalAgentData>',
+        :'schedule_data_summary' => :'BuIntradayScheduleData',
         
-        :'historical_queue_data_per_interval' => :'Array<IntradayHistoricalQueueData>',
+        :'schedule_data_per_interval' => :'Array<BuIntradayScheduleData>',
         
-        :'performance_prediction_agent_data_per_interval' => :'Array<IntradayPerformancePredictionAgentData>',
+        :'performance_prediction_data_summary' => :'IntradayPerformancePredictionData',
         
-        :'performance_prediction_queue_data_per_interval' => :'Array<IntradayPerformancePredictionQueueData>'
+        :'performance_prediction_data_per_interval' => :'Array<IntradayPerformancePredictionData>'
         
       }
     end
@@ -99,21 +99,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'forecastDataPerInterval')
+      if attributes.has_key?(:'forecastDataSummary')
         
-        if (value = attributes[:'forecastDataPerInterval']).is_a?(Array)
-          self.forecast_data_per_interval = value
-        end
         
+        self.forecast_data_summary = attributes[:'forecastDataSummary']
         
       
       end
 
       
-      if attributes.has_key?(:'scheduleDataPerInterval')
+      if attributes.has_key?(:'forecastDataPerInterval')
         
-        if (value = attributes[:'scheduleDataPerInterval']).is_a?(Array)
-          self.schedule_data_per_interval = value
+        if (value = attributes[:'forecastDataPerInterval']).is_a?(Array)
+          self.forecast_data_per_interval = value
         end
         
         
@@ -121,21 +119,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'historicalAgentDataPerInterval')
+      if attributes.has_key?(:'scheduleDataSummary')
         
-        if (value = attributes[:'historicalAgentDataPerInterval']).is_a?(Array)
-          self.historical_agent_data_per_interval = value
-        end
         
+        self.schedule_data_summary = attributes[:'scheduleDataSummary']
         
       
       end
 
       
-      if attributes.has_key?(:'historicalQueueDataPerInterval')
+      if attributes.has_key?(:'scheduleDataPerInterval')
         
-        if (value = attributes[:'historicalQueueDataPerInterval']).is_a?(Array)
-          self.historical_queue_data_per_interval = value
+        if (value = attributes[:'scheduleDataPerInterval']).is_a?(Array)
+          self.schedule_data_per_interval = value
         end
         
         
@@ -143,21 +139,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'performancePredictionAgentDataPerInterval')
+      if attributes.has_key?(:'performancePredictionDataSummary')
         
-        if (value = attributes[:'performancePredictionAgentDataPerInterval']).is_a?(Array)
-          self.performance_prediction_agent_data_per_interval = value
-        end
         
+        self.performance_prediction_data_summary = attributes[:'performancePredictionDataSummary']
         
       
       end
 
       
-      if attributes.has_key?(:'performancePredictionQueueDataPerInterval')
+      if attributes.has_key?(:'performancePredictionDataPerInterval')
         
-        if (value = attributes[:'performancePredictionQueueDataPerInterval']).is_a?(Array)
-          self.performance_prediction_queue_data_per_interval = value
+        if (value = attributes[:'performancePredictionDataPerInterval']).is_a?(Array)
+          self.performance_prediction_data_per_interval = value
         end
         
         
@@ -266,12 +260,12 @@ module PureCloud
       return true if self.equal?(o)
       self.class == o.class &&
           media_type == o.media_type &&
+          forecast_data_summary == o.forecast_data_summary &&
           forecast_data_per_interval == o.forecast_data_per_interval &&
+          schedule_data_summary == o.schedule_data_summary &&
           schedule_data_per_interval == o.schedule_data_per_interval &&
-          historical_agent_data_per_interval == o.historical_agent_data_per_interval &&
-          historical_queue_data_per_interval == o.historical_queue_data_per_interval &&
-          performance_prediction_agent_data_per_interval == o.performance_prediction_agent_data_per_interval &&
-          performance_prediction_queue_data_per_interval == o.performance_prediction_queue_data_per_interval
+          performance_prediction_data_summary == o.performance_prediction_data_summary &&
+          performance_prediction_data_per_interval == o.performance_prediction_data_per_interval
     end
 
     # @see the `==` method
@@ -283,7 +277,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [media_type, forecast_data_per_interval, schedule_data_per_interval, historical_agent_data_per_interval, historical_queue_data_per_interval, performance_prediction_agent_data_per_interval, performance_prediction_queue_data_per_interval].hash
+      [media_type, forecast_data_summary, forecast_data_per_interval, schedule_data_summary, schedule_data_per_interval, performance_prediction_data_summary, performance_prediction_data_per_interval].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/bu_intraday_forecast_data.rb

@@ -0,0 +1,228 @@
+=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 BuIntradayForecastData
+    # The number of interactions routed into the queues in the selected planning groups for the given media type for an agent to answer
+    attr_accessor :offered
+
+    # The average handle time in seconds an agent spent handling interactions
+    attr_accessor :average_handle_time_seconds
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'offered' => :'offered',
+        
+        :'average_handle_time_seconds' => :'averageHandleTimeSeconds'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'offered' => :'Float',
+        
+        :'average_handle_time_seconds' => :'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?(:'offered')
+        
+        
+        self.offered = attributes[:'offered']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'averageHandleTimeSeconds')
+        
+        
+        self.average_handle_time_seconds = attributes[:'averageHandleTimeSeconds']
+        
+      
+      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 &&
+          offered == o.offered &&
+          average_handle_time_seconds == o.average_handle_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
+      [offered, average_handle_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_response.rb → bu_intraday_response.rb}

@@ -17,7 +17,7 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  class IntradayResponse
+  class BuIntradayResponse
     # The start of the date range for which this data applies.  This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :start_date
 
@@ -27,19 +27,19 @@ module PureCloud
     # The aggregation period in minutes, which determines the interval duration of the returned data
     attr_accessor :interval_length_minutes
 
-    # The total number of time intervals represented by this data
-    attr_accessor :number_of_intervals
-
-    # The metrics to which this data corresponds
-    attr_accessor :metrics
-
     # If not null, the reason there was no data for the request
     attr_accessor :no_data_reason
 
-    # The IDs of the queues this data corresponds to
-    attr_accessor :queue_ids
+    # The categories to which this data corresponds
+    attr_accessor :categories
+
+    # Short term forecast reference
+    attr_accessor :short_term_forecast
 
-    # Intraday data grouped by a single media type and set of queue IDs
+    # Schedule reference
+    attr_accessor :schedule
+
+    # Intraday data grouped by a single media type and set of planning group IDs
     attr_accessor :intraday_data_groupings
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -52,13 +52,13 @@ module PureCloud
         
         :'interval_length_minutes' => :'intervalLengthMinutes',
         
-        :'number_of_intervals' => :'numberOfIntervals',
+        :'no_data_reason' => :'noDataReason',
         
-        :'metrics' => :'metrics',
+        :'categories' => :'categories',
         
-        :'no_data_reason' => :'noDataReason',
+        :'short_term_forecast' => :'shortTermForecast',
         
-        :'queue_ids' => :'queueIds',
+        :'schedule' => :'schedule',
         
         :'intraday_data_groupings' => :'intradayDataGroupings'
         
@@ -75,15 +75,15 @@ module PureCloud
         
         :'interval_length_minutes' => :'Integer',
         
-        :'number_of_intervals' => :'Integer',
+        :'no_data_reason' => :'String',
         
-        :'metrics' => :'Array<IntradayMetric>',
+        :'categories' => :'Array<String>',
         
-        :'no_data_reason' => :'String',
+        :'short_term_forecast' => :'BuShortTermForecastReference',
         
-        :'queue_ids' => :'Array<String>',
+        :'schedule' => :'BuScheduleReference',
         
-        :'intraday_data_groupings' => :'Array<IntradayDataGroup>'
+        :'intraday_data_groupings' => :'Array<BuIntradayDataGroup>'
         
       }
     end
@@ -124,19 +124,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'numberOfIntervals')
+      if attributes.has_key?(:'noDataReason')
         
         
-        self.number_of_intervals = attributes[:'numberOfIntervals']
+        self.no_data_reason = attributes[:'noDataReason']
         
       
       end
 
       
-      if attributes.has_key?(:'metrics')
+      if attributes.has_key?(:'categories')
         
-        if (value = attributes[:'metrics']).is_a?(Array)
-          self.metrics = value
+        if (value = attributes[:'categories']).is_a?(Array)
+          self.categories = value
         end
         
         
@@ -144,21 +144,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'noDataReason')
+      if attributes.has_key?(:'shortTermForecast')
         
         
-        self.no_data_reason = attributes[:'noDataReason']
+        self.short_term_forecast = attributes[:'shortTermForecast']
         
       
       end
 
       
-      if attributes.has_key?(:'queueIds')
+      if attributes.has_key?(:'schedule')
         
-        if (value = attributes[:'queueIds']).is_a?(Array)
-          self.queue_ids = value
-        end
         
+        self.schedule = attributes[:'schedule']
         
       
       end
@@ -204,6 +202,10 @@ module PureCloud
       
       
       
+      allowed_values = ["NoPublishedSchedule", "NoSourceForecast"]
+      if @no_data_reason && !allowed_values.include?(@no_data_reason)
+        return false
+      end
       
       
       
@@ -212,10 +214,6 @@ module PureCloud
       
       
       
-      allowed_values = ["NoWeekData", "NoPublishedSchedule", "NoSourceForecast"]
-      if @no_data_reason && !allowed_values.include?(@no_data_reason)
-        return false
-      end
       
       
       
@@ -246,6 +244,16 @@ module PureCloud
     
     
     
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] no_data_reason Object to be assigned
+    def no_data_reason=(no_data_reason)
+      allowed_values = ["NoPublishedSchedule", "NoSourceForecast"]
+      if no_data_reason && !allowed_values.include?(no_data_reason)
+        fail ArgumentError, "invalid value for 'no_data_reason', must be one of #{allowed_values}."
+      end
+      @no_data_reason = no_data_reason
+    end
+
     
     
     
@@ -256,16 +264,6 @@ module PureCloud
     
     
     
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] no_data_reason Object to be assigned
-    def no_data_reason=(no_data_reason)
-      allowed_values = ["NoWeekData", "NoPublishedSchedule", "NoSourceForecast"]
-      if no_data_reason && !allowed_values.include?(no_data_reason)
-        fail ArgumentError, "invalid value for 'no_data_reason', must be one of #{allowed_values}."
-      end
-      @no_data_reason = no_data_reason
-    end
-
     
     
     
@@ -287,10 +285,10 @@ module PureCloud
           start_date == o.start_date &&
           end_date == o.end_date &&
           interval_length_minutes == o.interval_length_minutes &&
-          number_of_intervals == o.number_of_intervals &&
-          metrics == o.metrics &&
           no_data_reason == o.no_data_reason &&
-          queue_ids == o.queue_ids &&
+          categories == o.categories &&
+          short_term_forecast == o.short_term_forecast &&
+          schedule == o.schedule &&
           intraday_data_groupings == o.intraday_data_groupings
     end
 
@@ -303,7 +301,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [start_date, end_date, interval_length_minutes, number_of_intervals, metrics, no_data_reason, queue_ids, intraday_data_groupings].hash
+      [start_date, end_date, interval_length_minutes, no_data_reason, categories, short_term_forecast, schedule, intraday_data_groupings].hash
     end
 
     # build the object from hash