class ConnectWise::DocumentSetup

Attributes

_info[RW]

Metadata of the entity

doc_path[RW]
id[RW]
is_public_flag[RW]
template_output_path[RW]
template_path[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_setup.rb, line 24
def self.attribute_map
  {
    :'id' => :'id',
    :'upload_as_link_flag' => :'uploadAsLinkFlag',
    :'is_public_flag' => :'isPublicFlag',
    :'doc_path' => :'docPath',
    :'template_path' => :'templatePath',
    :'template_output_path' => :'templateOutputPath',
    :'_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_setup.rb, line 51
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?(:'uploadAsLinkFlag')
    self.upload_as_link_flag = attributes[:'uploadAsLinkFlag']
  end

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

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

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

  if attributes.has_key?(:'templateOutputPath')
    self.template_output_path = attributes[:'templateOutputPath']
  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_setup.rb, line 37
def self.swagger_types
  {
    :'id' => :'Integer',
    :'upload_as_link_flag' => :'BOOLEAN',
    :'is_public_flag' => :'BOOLEAN',
    :'doc_path' => :'String',
    :'template_path' => :'String',
    :'template_output_path' => :'String',
    :'_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_setup.rb, line 150
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      upload_as_link_flag == o.upload_as_link_flag &&
      is_public_flag == o.is_public_flag &&
      doc_path == o.doc_path &&
      template_path == o.template_path &&
      template_output_path == o.template_output_path &&
      _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_setup.rb, line 198
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_setup.rb, line 264
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_setup.rb, line 177
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
doc_path=(doc_path) click to toggle source

Custom attribute writer method with validation @param [Object] doc_path Value to be assigned

# File lib/connectwise-ruby-sdk/models/document_setup.rb, line 117
def doc_path=(doc_path)

  if !doc_path.nil? && doc_path.to_s.length > 100
    fail ArgumentError, "invalid value for 'doc_path', the character length must be smaller than or equal to 100."
  end

  @doc_path = doc_path
end
eql?(o) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/document_setup.rb, line 164
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_setup.rb, line 170
def hash
  [id, upload_as_link_flag, is_public_flag, doc_path, template_path, template_output_path, _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_setup.rb, line 89
def list_invalid_properties
  invalid_properties = Array.new
  if !@doc_path.nil? && @doc_path.to_s.length > 100
    invalid_properties.push("invalid value for 'doc_path', the character length must be smaller than or equal to 100.")
  end

  if !@template_path.nil? && @template_path.to_s.length > 200
    invalid_properties.push("invalid value for 'template_path', the character length must be smaller than or equal to 200.")
  end

  if !@template_output_path.nil? && @template_output_path.to_s.length > 200
    invalid_properties.push("invalid value for 'template_output_path', the character length must be smaller than or equal to 200.")
  end

  return invalid_properties
end
template_output_path=(template_output_path) click to toggle source

Custom attribute writer method with validation @param [Object] template_output_path Value to be assigned

# File lib/connectwise-ruby-sdk/models/document_setup.rb, line 139
def template_output_path=(template_output_path)

  if !template_output_path.nil? && template_output_path.to_s.length > 200
    fail ArgumentError, "invalid value for 'template_output_path', the character length must be smaller than or equal to 200."
  end

  @template_output_path = template_output_path
end
template_path=(template_path) click to toggle source

Custom attribute writer method with validation @param [Object] template_path Value to be assigned

# File lib/connectwise-ruby-sdk/models/document_setup.rb, line 128
def template_path=(template_path)

  if !template_path.nil? && template_path.to_s.length > 200
    fail ArgumentError, "invalid value for 'template_path', the character length must be smaller than or equal to 200."
  end

  @template_path = template_path
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_setup.rb, line 244
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_setup.rb, line 250
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_setup.rb, line 238
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_setup.rb, line 108
def valid?
  return false if !@doc_path.nil? && @doc_path.to_s.length > 100
  return false if !@template_path.nil? && @template_path.to_s.length > 200
  return false if !@template_output_path.nil? && @template_output_path.to_s.length > 200
  return true
end