class PureCloud::CoachingAppointmentResponse
Coaching appointment response
Attributes
The list of attendees attending the coaching
The list of conversations associated with coaching appointment.
The user who created the coaching appointment
The date/time the coaching appointment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The description of coaching appointment
The list of documents associated with coaching appointment.
The facilitator of coaching appointment
The globally unique identifier for the object.
Whether the appointment is overdue.
The duration of coaching appointment in minutes
The last user to modify the coaching appointment
The name of coaching appointment
The URI for this object
The status of coaching appointment
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/coaching_appointment_response.rb, line 71 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'description' => :'description', :'date_start' => :'dateStart', :'length_in_minutes' => :'lengthInMinutes', :'status' => :'status', :'facilitator' => :'facilitator', :'attendees' => :'attendees', :'created_by' => :'createdBy', :'date_created' => :'dateCreated', :'modified_by' => :'modifiedBy', :'date_modified' => :'dateModified', :'conversations' => :'conversations', :'documents' => :'documents', :'is_overdue' => :'isOverdue', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/coaching_appointment_response.rb, line 150 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'dateStart') self.date_start = attributes[:'dateStart'] end if attributes.has_key?(:'lengthInMinutes') self.length_in_minutes = attributes[:'lengthInMinutes'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'facilitator') self.facilitator = attributes[:'facilitator'] end if attributes.has_key?(:'attendees') if (value = attributes[:'attendees']).is_a?(Array) self.attendees = value end end if attributes.has_key?(:'createdBy') self.created_by = attributes[:'createdBy'] end if attributes.has_key?(:'dateCreated') self.date_created = attributes[:'dateCreated'] end if attributes.has_key?(:'modifiedBy') self.modified_by = attributes[:'modifiedBy'] end if attributes.has_key?(:'dateModified') self.date_modified = attributes[:'dateModified'] end if attributes.has_key?(:'conversations') if (value = attributes[:'conversations']).is_a?(Array) self.conversations = value end end if attributes.has_key?(:'documents') if (value = attributes[:'documents']).is_a?(Array) self.documents = value end end if attributes.has_key?(:'isOverdue') self.is_overdue = attributes[:'isOverdue'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/coaching_appointment_response.rb, line 110 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'description' => :'String', :'date_start' => :'DateTime', :'length_in_minutes' => :'Integer', :'status' => :'String', :'facilitator' => :'UserReference', :'attendees' => :'Array<UserReference>', :'created_by' => :'UserReference', :'date_created' => :'DateTime', :'modified_by' => :'UserReference', :'date_modified' => :'DateTime', :'conversations' => :'Array<ConversationReference>', :'documents' => :'Array<DocumentReference>', :'is_overdue' => :'BOOLEAN', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/coaching_appointment_response.rb, line 485 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && description == o.description && date_start == o.date_start && length_in_minutes == o.length_in_minutes && status == o.status && facilitator == o.facilitator && attendees == o.attendees && created_by == o.created_by && date_created == o.date_created && modified_by == o.modified_by && date_modified == o.date_modified && conversations == o.conversations && documents == o.documents && is_overdue == o.is_overdue && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/coaching_appointment_response.rb, line 538 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/coaching_appointment_response.rb, line 598 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/coaching_appointment_response.rb, line 519 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/coaching_appointment_response.rb, line 508 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/coaching_appointment_response.rb, line 514 def hash [id, name, description, date_start, length_in_minutes, status, facilitator, attendees, created_by, date_created, modified_by, date_modified, conversations, documents, is_overdue, self_uri].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/coaching_appointment_response.rb, line 311 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/purecloudplatformclientv2/models/coaching_appointment_response.rb, line 422 def status=(status) allowed_values = ["Scheduled", "InProgress", "Completed", "InvalidSchedule"] if status && !allowed_values.include?(status) fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}." end @status = status end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/coaching_appointment_response.rb, line 586 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/coaching_appointment_response.rb, line 576 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/coaching_appointment_response.rb, line 320 def valid? allowed_values = ["Scheduled", "InProgress", "Completed", "InvalidSchedule"] if @status && !allowed_values.include?(@status) return false end end