class ConnectWise::DocumentInfo

Attributes

_info[RW]

Metadata of the entity

file_name[RW]
html_template_flag[RW]
id[RW]
image_flag[RW]
owner[RW]
public_flag[RW]
read_only_flag[RW]
server_file_name[RW]
size[RW]
title[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 34
def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'file_name' => :'fileName',
    :'server_file_name' => :'serverFileName',
    :'owner' => :'owner',
    :'link_flag' => :'linkFlag',
    :'image_flag' => :'imageFlag',
    :'public_flag' => :'publicFlag',
    :'html_template_flag' => :'htmlTemplateFlag',
    :'read_only_flag' => :'readOnlyFlag',
    :'size' => :'size',
    :'_info' => :'_info'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 71
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?(:'title')
    self.title = attributes[:'title']
  end

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 52
def self.swagger_types
  {
    :'id' => :'Integer',
    :'title' => :'String',
    :'file_name' => :'String',
    :'server_file_name' => :'String',
    :'owner' => :'String',
    :'link_flag' => :'BOOLEAN',
    :'image_flag' => :'BOOLEAN',
    :'public_flag' => :'BOOLEAN',
    :'html_template_flag' => :'BOOLEAN',
    :'read_only_flag' => :'BOOLEAN',
    :'size' => :'Integer',
    :'_info' => :'Metadata'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 142
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      file_name == o.file_name &&
      server_file_name == o.server_file_name &&
      owner == o.owner &&
      link_flag == o.link_flag &&
      image_flag == o.image_flag &&
      public_flag == o.public_flag &&
      html_template_flag == o.html_template_flag &&
      read_only_flag == o.read_only_flag &&
      size == o.size &&
      _info == o._info
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 195
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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = ConnectWise.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 261
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

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 174
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 161
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 167
def hash
  [id, title, file_name, server_file_name, owner, link_flag, image_flag, public_flag, html_template_flag, read_only_flag, size, _info].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/connectwise-ruby-sdk/models/document_info.rb, line 129
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_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 241
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 247
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

Returns the string representation of the object @return [String] String presentation of the object

# File lib/connectwise-ruby-sdk/models/document_info.rb, line 235
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/connectwise-ruby-sdk/models/document_info.rb, line 136
def valid?
  return true
end