class PureCloud::FaxTopicFaxDataV2

Attributes

caller_address[RW]
change_number[RW]
content_length[RW]
content_type[RW]
created_by[RW]
date_created[RW]
date_modified[RW]
date_uploaded[RW]
filename[RW]
id[RW]
lock_info[RW]
name[RW]
read[RW]
receiver_address[RW]
self_uri[RW]
uploaded_by[RW]
workspace[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/fax_topic_fax_data_v2.rb, line 56
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'workspace' => :'workspace',
    
    :'created_by' => :'createdBy',
    
    :'content_type' => :'contentType',
    
    :'content_length' => :'contentLength',
    
    :'filename' => :'filename',
    
    :'change_number' => :'changeNumber',
    
    :'date_uploaded' => :'dateUploaded',
    
    :'uploaded_by' => :'uploadedBy',
    
    :'lock_info' => :'lockInfo',
    
    :'self_uri' => :'selfUri',
    
    :'caller_address' => :'callerAddress',
    
    :'receiver_address' => :'receiverAddress',
    
    :'read' => :'read'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/fax_topic_fax_data_v2.rb, line 139
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?(:'dateCreated')
    
    
    self.date_created = attributes[:'dateCreated']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/fax_topic_fax_data_v2.rb, line 97
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'workspace' => :'FaxTopicWorkspaceData',
    
    :'created_by' => :'FaxTopicUserData',
    
    :'content_type' => :'String',
    
    :'content_length' => :'Integer',
    
    :'filename' => :'String',
    
    :'change_number' => :'Integer',
    
    :'date_uploaded' => :'DateTime',
    
    :'uploaded_by' => :'FaxTopicUserData',
    
    :'lock_info' => :'FaxTopicLockData',
    
    :'self_uri' => :'String',
    
    :'caller_address' => :'String',
    
    :'receiver_address' => :'String',
    
    :'read' => :'BOOLEAN'
    
  }
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/fax_topic_fax_data_v2.rb, line 472
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      workspace == o.workspace &&
      created_by == o.created_by &&
      content_type == o.content_type &&
      content_length == o.content_length &&
      filename == o.filename &&
      change_number == o.change_number &&
      date_uploaded == o.date_uploaded &&
      uploaded_by == o.uploaded_by &&
      lock_info == o.lock_info &&
      self_uri == o.self_uri &&
      caller_address == o.caller_address &&
      receiver_address == o.receiver_address &&
      read == o.read
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/fax_topic_fax_data_v2.rb, line 526
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/fax_topic_fax_data_v2.rb, line 586
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_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/fax_topic_fax_data_v2.rb, line 507
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/fax_topic_fax_data_v2.rb, line 496
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/fax_topic_fax_data_v2.rb, line 502
def hash
  [id, name, date_created, date_modified, workspace, created_by, content_type, content_length, filename, change_number, date_uploaded, uploaded_by, lock_info, self_uri, caller_address, receiver_address, read].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/fax_topic_fax_data_v2.rb, line 303
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/fax_topic_fax_data_v2.rb, line 574
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/fax_topic_fax_data_v2.rb, line 564
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/fax_topic_fax_data_v2.rb, line 312
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end