class PureCloud::Document

Attributes

acl[RW]

A list of permitted action rights for the user making the request

attributes[RW]
caller_address[RW]
change_number[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

date_uploaded[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.

lock_info[RW]
name[RW]
page_count[RW]
read[RW]
receiver_address[RW]
self_uri[RW]

The URI for this object

sharing_status[RW]
sharing_uri[RW]
system_type[RW]
tag_values[RW]
tags[RW]
thumbnails[RW]
upload_destination_uri[RW]
upload_method[RW]
upload_status[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/purecloud/models/document.rb, line 90
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'change_number' => :'changeNumber',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'date_uploaded' => :'dateUploaded',
    
    :'content_uri' => :'contentUri',
    
    :'workspace' => :'workspace',
    
    :'created_by' => :'createdBy',
    
    :'uploaded_by' => :'uploadedBy',
    
    :'content_type' => :'contentType',
    
    :'content_length' => :'contentLength',
    
    :'system_type' => :'systemType',
    
    :'filename' => :'filename',
    
    :'page_count' => :'pageCount',
    
    :'read' => :'read',
    
    :'caller_address' => :'callerAddress',
    
    :'receiver_address' => :'receiverAddress',
    
    :'tags' => :'tags',
    
    :'tag_values' => :'tagValues',
    
    :'attributes' => :'attributes',
    
    :'thumbnails' => :'thumbnails',
    
    :'upload_status' => :'uploadStatus',
    
    :'upload_destination_uri' => :'uploadDestinationUri',
    
    :'upload_method' => :'uploadMethod',
    
    :'lock_info' => :'lockInfo',
    
    :'acl' => :'acl',
    
    :'sharing_status' => :'sharingStatus',
    
    :'sharing_uri' => :'sharingUri',
    
    :'download_sharing_uri' => :'downloadSharingUri',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/document.rb, line 196
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[:'changeNumber']
    self.change_number = attributes[:'changeNumber']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'dateUploaded']
    self.date_uploaded = attributes[:'dateUploaded']
  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[:'uploadedBy']
    self.uploaded_by = attributes[:'uploadedBy']
  end
  
  if attributes[:'contentType']
    self.content_type = attributes[:'contentType']
  end
  
  if attributes[:'contentLength']
    self.content_length = attributes[:'contentLength']
  end
  
  if attributes[:'systemType']
    self.system_type = attributes[:'systemType']
  end
  
  if attributes[:'filename']
    self.filename = attributes[:'filename']
  end
  
  if attributes[:'pageCount']
    self.page_count = attributes[:'pageCount']
  end
  
  if attributes[:'read']
    self.read = attributes[:'read']
  end
  
  if attributes[:'callerAddress']
    self.caller_address = attributes[:'callerAddress']
  end
  
  if attributes[:'receiverAddress']
    self.receiver_address = attributes[:'receiverAddress']
  end
  
  if attributes[:'tags']
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end
  
  if attributes[:'tagValues']
    if (value = attributes[:'tagValues']).is_a?(Array)
      self.tag_values = value
    end
  end
  
  if attributes[:'attributes']
    if (value = attributes[:'attributes']).is_a?(Array)
      self.attributes = value
    end
  end
  
  if attributes[:'thumbnails']
    if (value = attributes[:'thumbnails']).is_a?(Array)
      self.thumbnails = value
    end
  end
  
  if attributes[:'uploadStatus']
    self.upload_status = attributes[:'uploadStatus']
  end
  
  if attributes[:'uploadDestinationUri']
    self.upload_destination_uri = attributes[:'uploadDestinationUri']
  end
  
  if attributes[:'uploadMethod']
    self.upload_method = attributes[:'uploadMethod']
  end
  
  if attributes[:'lockInfo']
    self.lock_info = attributes[:'lockInfo']
  end
  
  if attributes[:'acl']
    if (value = attributes[:'acl']).is_a?(Array)
      self.acl = value
    end
  end
  
  if attributes[:'sharingStatus']
    self.sharing_status = attributes[:'sharingStatus']
  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/document.rb, line 159
def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'change_number' => :'Integer',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'date_uploaded' => :'DateTime',
    :'content_uri' => :'String',
    :'workspace' => :'UriReference',
    :'created_by' => :'UriReference',
    :'uploaded_by' => :'UriReference',
    :'content_type' => :'String',
    :'content_length' => :'Integer',
    :'system_type' => :'String',
    :'filename' => :'String',
    :'page_count' => :'Integer',
    :'read' => :'BOOLEAN',
    :'caller_address' => :'String',
    :'receiver_address' => :'String',
    :'tags' => :'Array<String>',
    :'tag_values' => :'Array<TagValue>',
    :'attributes' => :'Array<DocumentAttribute>',
    :'thumbnails' => :'Array<DocumentThumbnail>',
    :'upload_status' => :'UriReference',
    :'upload_destination_uri' => :'String',
    :'upload_method' => :'String',
    :'lock_info' => :'LockInfo',
    :'acl' => :'Array<String>',
    :'sharing_status' => :'String',
    :'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/document.rb, line 367
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      change_number == o.change_number &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      date_uploaded == o.date_uploaded &&
      content_uri == o.content_uri &&
      workspace == o.workspace &&
      created_by == o.created_by &&
      uploaded_by == o.uploaded_by &&
      content_type == o.content_type &&
      content_length == o.content_length &&
      system_type == o.system_type &&
      filename == o.filename &&
      page_count == o.page_count &&
      read == o.read &&
      caller_address == o.caller_address &&
      receiver_address == o.receiver_address &&
      tags == o.tags &&
      tag_values == o.tag_values &&
      attributes == o.attributes &&
      thumbnails == o.thumbnails &&
      upload_status == o.upload_status &&
      upload_destination_uri == o.upload_destination_uri &&
      upload_method == o.upload_method &&
      lock_info == o.lock_info &&
      acl == o.acl &&
      sharing_status == o.sharing_status &&
      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/document.rb, line 433
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/document.rb, line 493
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/document.rb, line 414
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/document.rb, line 404
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/document.rb, line 409
def hash
  [id, name, change_number, date_created, date_modified, date_uploaded, content_uri, workspace, created_by, uploaded_by, content_type, content_length, system_type, filename, page_count, read, caller_address, receiver_address, tags, tag_values, attributes, thumbnails, upload_status, upload_destination_uri, upload_method, lock_info, acl, sharing_status, sharing_uri, download_sharing_uri, self_uri].hash
end
sharing_status=(sharing_status) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/document.rb, line 358
def sharing_status=(sharing_status)
  allowed_values = ["NONE", "LIMITED", "PUBLIC"]
  if sharing_status && !allowed_values.include?(sharing_status)
    fail "invalid value for 'sharing_status', must be one of #{allowed_values}"
  end
  @sharing_status = sharing_status
end
system_type=(system_type) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/document.rb, line 340
def system_type=(system_type)
  allowed_values = ["DOCUMENT", "FAX", "RECORDING"]
  if system_type && !allowed_values.include?(system_type)
    fail "invalid value for 'system_type', must be one of #{allowed_values}"
  end
  @system_type = system_type
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/document.rb, line 476
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/document.rb, line 481
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/document.rb, line 471
def to_s
  to_hash.to_s
end
upload_method=(upload_method) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/document.rb, line 349
def upload_method=(upload_method)
  allowed_values = ["SINGLE_PUT", "MULTIPART_POST"]
  if upload_method && !allowed_values.include?(upload_method)
    fail "invalid value for 'upload_method', must be one of #{allowed_values}"
  end
  @upload_method = upload_method
end