class PureCloud::CoachingNotification

Attributes

action_type[RW]

Action causing the notification.

appointment[RW]

The appointment

date_start[RW]

The start time of the appointment relating to this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

id[RW]

The globally unique identifier for the object.

length_in_minutes[RW]

The duration of the appointment on this notification

marked_as_read[RW]

Indicates if notification is read or unread

name[RW]

The name of the appointment for this notification.

relationship[RW]

The relationship of this user to this notification's appointment

self_uri[RW]

The URI for this object

status[RW]

The status of the appointment for this notification

user[RW]

The user of this notification

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 55
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'marked_as_read' => :'markedAsRead',
    
    :'action_type' => :'actionType',
    
    :'relationship' => :'relationship',
    
    :'date_start' => :'dateStart',
    
    :'length_in_minutes' => :'lengthInMinutes',
    
    :'status' => :'status',
    
    :'user' => :'user',
    
    :'appointment' => :'appointment',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 114
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?(:'markedAsRead')
    
    
    self.marked_as_read = attributes[:'markedAsRead']
    
  
  end

  
  if attributes.has_key?(:'actionType')
    
    
    self.action_type = attributes[:'actionType']
    
  
  end

  
  if attributes.has_key?(:'relationship')
    
    
    self.relationship = attributes[:'relationship']
    
  
  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?(:'user')
    
    
    self.user = attributes[:'user']
    
  
  end

  
  if attributes.has_key?(:'appointment')
    
    
    self.appointment = attributes[:'appointment']
    
  
  end

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 84
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'marked_as_read' => :'BOOLEAN',
    
    :'action_type' => :'String',
    
    :'relationship' => :'String',
    
    :'date_start' => :'DateTime',
    
    :'length_in_minutes' => :'Integer',
    
    :'status' => :'String',
    
    :'user' => :'UserReference',
    
    :'appointment' => :'CoachingAppointmentResponse',
    
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 381
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      marked_as_read == o.marked_as_read &&
      action_type == o.action_type &&
      relationship == o.relationship &&
      date_start == o.date_start &&
      length_in_minutes == o.length_in_minutes &&
      status == o.status &&
      user == o.user &&
      appointment == o.appointment &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 429
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
_to_hash(value) click to toggle source

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_notification.rb, line 489
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
action_type=(action_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] action_type Object to be assigned

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 315
def action_type=(action_type)
  allowed_values = ["Create", "Update", "Delete", "StatusChange"]
  if action_type && !allowed_values.include?(action_type)
    fail ArgumentError, "invalid value for 'action_type', must be one of #{allowed_values}."
  end
  @action_type = action_type
end
build_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 410
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 399
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 405
def hash
  [id, name, marked_as_read, action_type, relationship, date_start, length_in_minutes, status, user, appointment, self_uri].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 224
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
relationship=(relationship) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] relationship Object to be assigned

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 329
def relationship=(relationship)
  allowed_values = ["Attendee", "Creator", "Facilitator"]
  if relationship && !allowed_values.include?(relationship)
    fail ArgumentError, "invalid value for 'relationship', must be one of #{allowed_values}."
  end
  @relationship = relationship
end
status=(status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 353
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
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 472
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 477
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
to_s() click to toggle source
# File lib/purecloudplatformclientv2/models/coaching_notification.rb, line 467
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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_notification.rb, line 233
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Create", "Update", "Delete", "StatusChange"]
  if @action_type && !allowed_values.include?(@action_type)
    return false
  end
  
  
  
  
  
  allowed_values = ["Attendee", "Creator", "Facilitator"]
  if @relationship && !allowed_values.include?(@relationship)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Scheduled", "InProgress", "Completed", "InvalidSchedule"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end