class PureCloud::ShiftTradeResponse
Attributes
When this shift trade offer will expire if not matched or approved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The ID of this shift trade
The end date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The ID of the shift offered for trade by the initiating user
The start date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The user who initiated this trade
Version data for this trade
Whether this is a one-sided shift trade (e.g. the initiating user is not asking for a shift in return)
The end date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The ID of the shift being exchanged for the initiating shift, null if the receiving user is picking up a shift
The start date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The user matching the trade, or if the state is not Matched, the user to whom the trade request was sent
The user who reviewed this shift trade
The timestamp when this shift trade was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
A reference to the associated schedule
The state of this shift trade
The start week date of the associated schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 75 def self.attribute_map { :'id' => :'id', :'week_date' => :'weekDate', :'schedule' => :'schedule', :'state' => :'state', :'initiating_user' => :'initiatingUser', :'initiating_shift_id' => :'initiatingShiftId', :'initiating_shift_start' => :'initiatingShiftStart', :'initiating_shift_end' => :'initiatingShiftEnd', :'receiving_user' => :'receivingUser', :'receiving_shift_id' => :'receivingShiftId', :'receiving_shift_start' => :'receivingShiftStart', :'receiving_shift_end' => :'receivingShiftEnd', :'expiration' => :'expiration', :'one_sided' => :'oneSided', :'acceptable_intervals' => :'acceptableIntervals', :'reviewed_by' => :'reviewedBy', :'reviewed_date' => :'reviewedDate', :'metadata' => :'metadata' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 162 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?(:'schedule') self.schedule = attributes[:'schedule'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'initiatingUser') self.initiating_user = attributes[:'initiatingUser'] end if attributes.has_key?(:'initiatingShiftId') self.initiating_shift_id = attributes[:'initiatingShiftId'] end if attributes.has_key?(:'initiatingShiftStart') self.initiating_shift_start = attributes[:'initiatingShiftStart'] end if attributes.has_key?(:'initiatingShiftEnd') self.initiating_shift_end = attributes[:'initiatingShiftEnd'] end if attributes.has_key?(:'receivingUser') self.receiving_user = attributes[:'receivingUser'] end if attributes.has_key?(:'receivingShiftId') self.receiving_shift_id = attributes[:'receivingShiftId'] end if attributes.has_key?(:'receivingShiftStart') self.receiving_shift_start = attributes[:'receivingShiftStart'] end if attributes.has_key?(:'receivingShiftEnd') self.receiving_shift_end = attributes[:'receivingShiftEnd'] end if attributes.has_key?(:'expiration') self.expiration = attributes[:'expiration'] end if attributes.has_key?(:'oneSided') self.one_sided = attributes[:'oneSided'] end if attributes.has_key?(:'acceptableIntervals') if (value = attributes[:'acceptableIntervals']).is_a?(Array) self.acceptable_intervals = value end end if attributes.has_key?(:'reviewedBy') self.reviewed_by = attributes[:'reviewedBy'] end if attributes.has_key?(:'reviewedDate') self.reviewed_date = attributes[:'reviewedDate'] end if attributes.has_key?(:'metadata') self.metadata = attributes[:'metadata'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 118 def self.swagger_types { :'id' => :'String', :'week_date' => :'Date', :'schedule' => :'BuScheduleReferenceForMuRoute', :'state' => :'String', :'initiating_user' => :'UserReference', :'initiating_shift_id' => :'String', :'initiating_shift_start' => :'DateTime', :'initiating_shift_end' => :'DateTime', :'receiving_user' => :'UserReference', :'receiving_shift_id' => :'String', :'receiving_shift_start' => :'DateTime', :'receiving_shift_end' => :'DateTime', :'expiration' => :'DateTime', :'one_sided' => :'BOOLEAN', :'acceptable_intervals' => :'Array<String>', :'reviewed_by' => :'UserReference', :'reviewed_date' => :'DateTime', :'metadata' => :'WfmVersionedEntityMetadata' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 529 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && week_date == o.week_date && schedule == o.schedule && state == o.state && initiating_user == o.initiating_user && initiating_shift_id == o.initiating_shift_id && initiating_shift_start == o.initiating_shift_start && initiating_shift_end == o.initiating_shift_end && receiving_user == o.receiving_user && receiving_shift_id == o.receiving_shift_id && receiving_shift_start == o.receiving_shift_start && receiving_shift_end == o.receiving_shift_end && expiration == o.expiration && one_sided == o.one_sided && acceptable_intervals == o.acceptable_intervals && reviewed_by == o.reviewed_by && reviewed_date == o.reviewed_date && metadata == o.metadata end
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 584 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
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 644 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
build the object from hash
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 565 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
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 554 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 560 def hash [id, week_date, schedule, state, initiating_user, initiating_shift_id, initiating_shift_start, initiating_shift_end, receiving_user, receiving_shift_id, receiving_shift_start, receiving_shift_end, expiration, one_sided, acceptable_intervals, reviewed_by, reviewed_date, metadata].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 337 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 446 def state=(state) allowed_values = ["Unmatched", "Matched", "Approved", "Denied", "Expired", "Canceled"] if state && !allowed_values.include?(state) fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}." end @state = state end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 632 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
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 622 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/shift_trade_response.rb, line 346 def valid? allowed_values = ["Unmatched", "Matched", "Approved", "Denied", "Expired", "Canceled"] if @state && !allowed_values.include?(@state) return false end end