Class: DocuSign_eSign::Folder

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/folder.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Folder

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/docusign_esign/models/folder.rb', line 103

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

Instance Attribute Details

#error_detailsObject

Returns the value of attribute error_details


17
18
19
# File 'lib/docusign_esign/models/folder.rb', line 17

def error_details
  @error_details
end

#filterObject

Returns the value of attribute filter


19
20
21
# File 'lib/docusign_esign/models/folder.rb', line 19

def filter
  @filter
end

#folder_idObject

Returns the value of attribute folder_id


22
23
24
# File 'lib/docusign_esign/models/folder.rb', line 22

def folder_id
  @folder_id
end

#folder_itemsObject

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


25
26
27
# File 'lib/docusign_esign/models/folder.rb', line 25

def folder_items
  @folder_items
end

#foldersObject

A collection of folder objects returned in a response.


28
29
30
# File 'lib/docusign_esign/models/folder.rb', line 28

def folders
  @folders
end

#has_accessObject

Returns the value of attribute has_access


31
32
33
# File 'lib/docusign_esign/models/folder.rb', line 31

def has_access
  @has_access
end

#has_sub_foldersObject

Returns the value of attribute has_sub_folders


34
35
36
# File 'lib/docusign_esign/models/folder.rb', line 34

def has_sub_folders
  @has_sub_folders
end

#item_countObject

Returns the value of attribute item_count


37
38
39
# File 'lib/docusign_esign/models/folder.rb', line 37

def item_count
  @item_count
end

#nameObject

Returns the value of attribute name


40
41
42
# File 'lib/docusign_esign/models/folder.rb', line 40

def name
  @name
end

#ownerObject

Returns the value of attribute owner


42
43
44
# File 'lib/docusign_esign/models/folder.rb', line 42

def owner
  @owner
end

#parent_folder_idObject

Returns the value of attribute parent_folder_id


45
46
47
# File 'lib/docusign_esign/models/folder.rb', line 45

def parent_folder_id
  @parent_folder_id
end

#parent_folder_uriObject

Returns the value of attribute parent_folder_uri


48
49
50
# File 'lib/docusign_esign/models/folder.rb', line 48

def parent_folder_uri
  @parent_folder_uri
end

#sub_folder_countObject

Returns the value of attribute sub_folder_count


51
52
53
# File 'lib/docusign_esign/models/folder.rb', line 51

def sub_folder_count
  @sub_folder_count
end

#typeObject

Returns the value of attribute type


54
55
56
# File 'lib/docusign_esign/models/folder.rb', line 54

def type
  @type
end

#uriObject

Returns the value of attribute uri


57
58
59
# File 'lib/docusign_esign/models/folder.rb', line 57

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/docusign_esign/models/folder.rb', line 60

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

.swagger_typesObject

Attribute type mapping.


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/docusign_esign/models/folder.rb', line 81

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'lib/docusign_esign/models/folder.rb', line 189

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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'lib/docusign_esign/models/folder.rb', line 245

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


311
312
313
314
315
316
317
318
319
320
321
322
323
# File 'lib/docusign_esign/models/folder.rb', line 311

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/docusign_esign/models/folder.rb', line 224

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) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

211
212
213
# File 'lib/docusign_esign/models/folder.rb', line 211

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


217
218
219
# File 'lib/docusign_esign/models/folder.rb', line 217

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_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


176
177
178
179
# File 'lib/docusign_esign/models/folder.rb', line 176

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


291
292
293
# File 'lib/docusign_esign/models/folder.rb', line 291

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


297
298
299
300
301
302
303
304
305
# File 'lib/docusign_esign/models/folder.rb', line 297

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


285
286
287
# File 'lib/docusign_esign/models/folder.rb', line 285

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


183
184
185
# File 'lib/docusign_esign/models/folder.rb', line 183

def valid?
  true
end