class DocuSign_eSign::Folder

Attributes

error_details[RW]
filter[RW]
folder_id[RW]
folder_items[RW]

A list of the envelopes in the specified folder or folders.

folders[RW]

A collection of folder objects returned in a response.

has_access[RW]
has_sub_folders[RW]
item_count[RW]
name[RW]
owner[RW]
parent_folder_id[RW]
parent_folder_uri[RW]
sub_folder_count[RW]
type[RW]
uri[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_esign/models/folder.rb, line 59
def self.attribute_map
  {
    :'error_details' => :'errorDetails',
    :'filter' => :'filter',
    :'folder_id' => :'folderId',
    :'folder_items' => :'folderItems',
    :'folders' => :'folders',
    :'has_access' => :'hasAccess',
    :'has_sub_folders' => :'hasSubFolders',
    :'item_count' => :'itemCount',
    :'name' => :'name',
    :'owner' => :'owner',
    :'parent_folder_id' => :'parentFolderId',
    :'parent_folder_uri' => :'parentFolderUri',
    :'sub_folder_count' => :'subFolderCount',
    :'type' => :'type',
    :'uri' => :'uri'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/docusign_esign/models/folder.rb, line 102
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?(:'errorDetails')
    self.error_details = attributes[:'errorDetails']
  end

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

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

  if attributes.has_key?(:'folderItems')
    if (value = attributes[:'folderItems']).is_a?(Array)
      self.folder_items = value
    end
  end

  if attributes.has_key?(:'folders')
    if (value = attributes[:'folders']).is_a?(Array)
      self.folders = value
    end
  end

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'uri')
    self.uri = attributes[:'uri']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/folder.rb, line 80
def self.swagger_types
  {
    :'error_details' => :'ErrorDetails',
    :'filter' => :'Filter',
    :'folder_id' => :'String',
    :'folder_items' => :'Array<FolderItemV2>',
    :'folders' => :'Array<Folder>',
    :'has_access' => :'String',
    :'has_sub_folders' => :'String',
    :'item_count' => :'String',
    :'name' => :'String',
    :'owner' => :'UserInfo',
    :'parent_folder_id' => :'String',
    :'parent_folder_uri' => :'String',
    :'sub_folder_count' => :'String',
    :'type' => :'String',
    :'uri' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/docusign_esign/models/folder.rb, line 188
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error_details == o.error_details &&
      filter == o.filter &&
      folder_id == o.folder_id &&
      folder_items == o.folder_items &&
      folders == o.folders &&
      has_access == o.has_access &&
      has_sub_folders == o.has_sub_folders &&
      item_count == o.item_count &&
      name == o.name &&
      owner == o.owner &&
      parent_folder_id == o.parent_folder_id &&
      parent_folder_uri == o.parent_folder_uri &&
      sub_folder_count == o.sub_folder_count &&
      type == o.type &&
      uri == o.uri
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/docusign_esign/models/folder.rb, line 244
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 = DocuSign_eSign.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/docusign_esign/models/folder.rb, line 310
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/docusign_esign/models/folder.rb, line 223
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 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/docusign_esign/models/folder.rb, line 210
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/docusign_esign/models/folder.rb, line 216
def hash
  [error_details, filter, folder_id, folder_items, folders, has_access, has_sub_folders, item_count, name, owner, parent_folder_id, parent_folder_uri, sub_folder_count, type, uri].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/docusign_esign/models/folder.rb, line 175
def list_invalid_properties
  invalid_properties = Array.new
  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/docusign_esign/models/folder.rb, line 290
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/docusign_esign/models/folder.rb, line 296
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/docusign_esign/models/folder.rb, line 284
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/docusign_esign/models/folder.rb, line 182
def valid?
  true
end