class PureCloud::FaxDocument
Attributes
caller_address[RW]
content_length[RW]
content_type[RW]
content_uri[RW]
created_by[RW]
date_created[RW]
Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
date_modified[RW]
Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
download_sharing_uri[RW]
filename[RW]
id[RW]
The globally unique identifier for the object.
name[RW]
page_count[RW]
read[RW]
receiver_address[RW]
self_uri[RW]
The URI for this object
sharing_uri[RW]
thumbnails[RW]
workspace[RW]
Public Class Methods
attribute_map()
click to toggle source
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/fax_document.rb, line 62 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'date_created' => :'dateCreated', :'date_modified' => :'dateModified', :'content_uri' => :'contentUri', :'workspace' => :'workspace', :'created_by' => :'createdBy', :'content_type' => :'contentType', :'content_length' => :'contentLength', :'filename' => :'filename', :'read' => :'read', :'page_count' => :'pageCount', :'caller_address' => :'callerAddress', :'receiver_address' => :'receiverAddress', :'thumbnails' => :'thumbnails', :'sharing_uri' => :'sharingUri', :'download_sharing_uri' => :'downloadSharingUri', :'self_uri' => :'selfUri' } end
new(attributes = {})
click to toggle source
# File lib/purecloud/models/fax_document.rb, line 129 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'name'] self.name = attributes[:'name'] end if attributes[:'dateCreated'] self.date_created = attributes[:'dateCreated'] end if attributes[:'dateModified'] self.date_modified = attributes[:'dateModified'] end if attributes[:'contentUri'] self.content_uri = attributes[:'contentUri'] end if attributes[:'workspace'] self.workspace = attributes[:'workspace'] end if attributes[:'createdBy'] self.created_by = attributes[:'createdBy'] end if attributes[:'contentType'] self.content_type = attributes[:'contentType'] end if attributes[:'contentLength'] self.content_length = attributes[:'contentLength'] end if attributes[:'filename'] self.filename = attributes[:'filename'] end if attributes[:'read'] self.read = attributes[:'read'] end if attributes[:'pageCount'] self.page_count = attributes[:'pageCount'] end if attributes[:'callerAddress'] self.caller_address = attributes[:'callerAddress'] end if attributes[:'receiverAddress'] self.receiver_address = attributes[:'receiverAddress'] end if attributes[:'thumbnails'] if (value = attributes[:'thumbnails']).is_a?(Array) self.thumbnails = value end end if attributes[:'sharingUri'] self.sharing_uri = attributes[:'sharingUri'] end if attributes[:'downloadSharingUri'] self.download_sharing_uri = attributes[:'downloadSharingUri'] end if attributes[:'selfUri'] self.self_uri = attributes[:'selfUri'] end end
swagger_types()
click to toggle source
Attribute
type mapping.
# File lib/purecloud/models/fax_document.rb, line 105 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'date_created' => :'DateTime', :'date_modified' => :'DateTime', :'content_uri' => :'String', :'workspace' => :'UriReference', :'created_by' => :'UriReference', :'content_type' => :'String', :'content_length' => :'Integer', :'filename' => :'String', :'read' => :'BOOLEAN', :'page_count' => :'Integer', :'caller_address' => :'String', :'receiver_address' => :'String', :'thumbnails' => :'Array<DocumentThumbnail>', :'sharing_uri' => :'String', :'download_sharing_uri' => :'String', :'self_uri' => :'String' } end
Public Instance Methods
==(o)
click to toggle source
Check equality by comparing each attribute.
# File lib/purecloud/models/fax_document.rb, line 213 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 && content_uri == o.content_uri && workspace == o.workspace && created_by == o.created_by && content_type == o.content_type && content_length == o.content_length && filename == o.filename && read == o.read && page_count == o.page_count && caller_address == o.caller_address && receiver_address == o.receiver_address && thumbnails == o.thumbnails && sharing_uri == o.sharing_uri && download_sharing_uri == o.download_sharing_uri && self_uri == o.self_uri end
_deserialize(type, value)
click to toggle source
# File lib/purecloud/models/fax_document.rb, line 266 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/purecloud/models/fax_document.rb, line 326 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/purecloud/models/fax_document.rb, line 247 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
# File lib/purecloud/models/fax_document.rb, line 237 def eql?(o) self == o end
hash()
click to toggle source
Calculate hash code according to all attributes.
# File lib/purecloud/models/fax_document.rb, line 242 def hash [id, name, date_created, date_modified, content_uri, workspace, created_by, content_type, content_length, filename, read, page_count, caller_address, receiver_address, thumbnails, sharing_uri, download_sharing_uri, self_uri].hash end
to_body()
click to toggle source
to_hash()
click to toggle source
return the object in the form of hash
# File lib/purecloud/models/fax_document.rb, line 314 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/purecloud/models/fax_document.rb, line 304 def to_s to_hash.to_s end