purecloudplatformclientv2 36.1.0 → 37.0.0

data/lib/purecloudplatformclientv2/models/week_schedule.rb

@@ -0,0 +1,465 @@
+=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: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  # Week schedule information
+  class WeekSchedule
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    # First day of this week schedule in week in yyyy-MM-dd format
+    attr_accessor :week_date
+
+    # Description of the week schedule
+    attr_accessor :description
+
+    # Whether the week schedule is published
+    attr_accessor :published
+
+    # Summary of the results from the schedule run
+    attr_accessor :generation_results
+
+    # Short term forecast associated with this schedule
+    attr_accessor :short_term_forecast
+
+    # Version metadata for this work plan
+    attr_accessor :metadata
+
+    # User schedules in the week
+    attr_accessor :user_schedules
+
+    # Headcount information for the week schedule
+    attr_accessor :headcount_forecast
+
+    # Version of agent schedules in the week schedule
+    attr_accessor :agent_schedules_version
+
+    # The URI for this object
+    attr_accessor :self_uri
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'id' => :'id',
+        
+        :'week_date' => :'weekDate',
+        
+        :'description' => :'description',
+        
+        :'published' => :'published',
+        
+        :'generation_results' => :'generationResults',
+        
+        :'short_term_forecast' => :'shortTermForecast',
+        
+        :'metadata' => :'metadata',
+        
+        :'user_schedules' => :'userSchedules',
+        
+        :'headcount_forecast' => :'headcountForecast',
+        
+        :'agent_schedules_version' => :'agentSchedulesVersion',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'id' => :'String',
+        
+        :'week_date' => :'String',
+        
+        :'description' => :'String',
+        
+        :'published' => :'BOOLEAN',
+        
+        :'generation_results' => :'WeekScheduleGenerationResult',
+        
+        :'short_term_forecast' => :'ShortTermForecastReference',
+        
+        :'metadata' => :'WfmVersionedEntityMetadata',
+        
+        :'user_schedules' => :'Hash<String, UserSchedule>',
+        
+        :'headcount_forecast' => :'HeadcountForecastResponse',
+        
+        :'agent_schedules_version' => :'Integer',
+        
+        :'self_uri' => :'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?(:'id')
+        
+        
+        self.id = attributes[:'id']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'weekDate')
+        
+        
+        self.week_date = attributes[:'weekDate']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'description')
+        
+        
+        self.description = attributes[:'description']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'published')
+        
+        
+        self.published = attributes[:'published']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'generationResults')
+        
+        
+        self.generation_results = attributes[:'generationResults']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'shortTermForecast')
+        
+        
+        self.short_term_forecast = attributes[:'shortTermForecast']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'metadata')
+        
+        
+        self.metadata = attributes[:'metadata']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'userSchedules')
+        
+        if (value = attributes[:'userSchedules']).is_a?(Array)
+          self.user_schedules = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'headcountForecast')
+        
+        
+        self.headcount_forecast = attributes[:'headcountForecast']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'agentSchedulesVersion')
+        
+        
+        self.agent_schedules_version = attributes[:'agentSchedulesVersion']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'selfUri')
+        
+        
+        self.self_uri = attributes[:'selfUri']
+        
+      
+      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 &&
+          id == o.id &&
+          week_date == o.week_date &&
+          description == o.description &&
+          published == o.published &&
+          generation_results == o.generation_results &&
+          short_term_forecast == o.short_term_forecast &&
+          metadata == o.metadata &&
+          user_schedules == o.user_schedules &&
+          headcount_forecast == o.headcount_forecast &&
+          agent_schedules_version == o.agent_schedules_version &&
+          self_uri == o.self_uri
+    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
+      [id, week_date, description, published, generation_results, short_term_forecast, metadata, user_schedules, headcount_forecast, agent_schedules_version, self_uri].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