purecloudplatformclientv2 43.1.0 → 44.0.0

data/lib/purecloudplatformclientv2/models/reschedule_result.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: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  class RescheduleResult
+    # The url from which to download the resulting WeekSchedule object for the rescheduling range
+    attr_accessor :download_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'download_url' => :'downloadUrl'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'download_url' => :'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?(:'downloadUrl')
+        
+        
+        self.download_url = attributes[:'downloadUrl']
+        
+      
+      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 &&
+          download_url == o.download_url
+    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
+      [download_url].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/rescheduling_options_response.rb

@@ -0,0 +1,470 @@
+=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
+  class ReschedulingOptionsResponse
+    # The start date of the range to reschedule in ISO-8601 format
+    attr_accessor :start_date
+
+    # The end date of the range to reschedule in ISO-8601 format
+    attr_accessor :end_date
+
+    # The IDs of the agents to reschedule.  Null or empty means all agents on the schedule
+    attr_accessor :agent_ids
+
+    # The IDs of the activity codes to reschedule. Null or empty means all activity codes will be considered
+    attr_accessor :activity_code_ids
+
+    # Whether to prevent changes to weekly paid time
+    attr_accessor :do_not_change_weekly_paid_time
+
+    # Whether to prevent changes to daily paid time
+    attr_accessor :do_not_change_daily_paid_time
+
+    # Whether to prevent changes to shift start times
+    attr_accessor :do_not_change_shift_start_times
+
+    # Whether to prevent changes to manually edited shifts
+    attr_accessor :do_not_change_manually_edited_shifts
+
+    # The schedule ID of the schedule to which the results will be applied
+    attr_accessor :existing_schedule_id
+
+    # The version of the schedule at the time the rescheduling was initiated
+    attr_accessor :existing_schedule_version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'start_date' => :'startDate',
+        
+        :'end_date' => :'endDate',
+        
+        :'agent_ids' => :'agentIds',
+        
+        :'activity_code_ids' => :'activityCodeIds',
+        
+        :'do_not_change_weekly_paid_time' => :'doNotChangeWeeklyPaidTime',
+        
+        :'do_not_change_daily_paid_time' => :'doNotChangeDailyPaidTime',
+        
+        :'do_not_change_shift_start_times' => :'doNotChangeShiftStartTimes',
+        
+        :'do_not_change_manually_edited_shifts' => :'doNotChangeManuallyEditedShifts',
+        
+        :'existing_schedule_id' => :'existingScheduleId',
+        
+        :'existing_schedule_version' => :'existingScheduleVersion'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'start_date' => :'DateTime',
+        
+        :'end_date' => :'DateTime',
+        
+        :'agent_ids' => :'Array<String>',
+        
+        :'activity_code_ids' => :'Array<String>',
+        
+        :'do_not_change_weekly_paid_time' => :'BOOLEAN',
+        
+        :'do_not_change_daily_paid_time' => :'BOOLEAN',
+        
+        :'do_not_change_shift_start_times' => :'BOOLEAN',
+        
+        :'do_not_change_manually_edited_shifts' => :'BOOLEAN',
+        
+        :'existing_schedule_id' => :'String',
+        
+        :'existing_schedule_version' => :'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?(:'startDate')
+        
+        
+        self.start_date = attributes[:'startDate']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'endDate')
+        
+        
+        self.end_date = attributes[:'endDate']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'agentIds')
+        
+        if (value = attributes[:'agentIds']).is_a?(Array)
+          self.agent_ids = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'activityCodeIds')
+        
+        if (value = attributes[:'activityCodeIds']).is_a?(Array)
+          self.activity_code_ids = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'doNotChangeWeeklyPaidTime')
+        
+        
+        self.do_not_change_weekly_paid_time = attributes[:'doNotChangeWeeklyPaidTime']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'doNotChangeDailyPaidTime')
+        
+        
+        self.do_not_change_daily_paid_time = attributes[:'doNotChangeDailyPaidTime']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'doNotChangeShiftStartTimes')
+        
+        
+        self.do_not_change_shift_start_times = attributes[:'doNotChangeShiftStartTimes']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'doNotChangeManuallyEditedShifts')
+        
+        
+        self.do_not_change_manually_edited_shifts = attributes[:'doNotChangeManuallyEditedShifts']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'existingScheduleId')
+        
+        
+        self.existing_schedule_id = attributes[:'existingScheduleId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'existingScheduleVersion')
+        
+        
+        self.existing_schedule_version = attributes[:'existingScheduleVersion']
+        
+      
+      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?
+      
+      
+      if @start_date.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @end_date.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      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
+
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    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 &&
+          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 &&
+          existing_schedule_id == o.existing_schedule_id &&
+          existing_schedule_version == o.existing_schedule_version
+    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
+      [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, existing_schedule_id, existing_schedule_version].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