Class: DocuSign_eSign::FolderItem

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FolderItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/docusign_esign/models/folder_item.rb', line 137

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?(:'completedDateTime')
    self.completed_date_time = attributes[:'completedDateTime']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#completed_date_time ⇒ Object

Specifies the date and time this item was completed.



18
19
20
 
# File 'lib/docusign_esign/models/folder_item.rb', line 18

def completed_date_time
  @completed_date_time
end

#created_date_time ⇒ Object

Indicates the date and time the item was created.



21
22
23
 
# File 'lib/docusign_esign/models/folder_item.rb', line 21

def created_date_time
  @created_date_time
end

#custom_fields ⇒ Object

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.



24
25
26
 
# File 'lib/docusign_esign/models/folder_item.rb', line 24

def custom_fields
  @custom_fields
end

#description ⇒ Object

Returns the value of attribute description.



27
28
29
 
# File 'lib/docusign_esign/models/folder_item.rb', line 27

def description
  @description
end

#envelope_id ⇒ Object

The envelope ID of the envelope status that failed to post.



30
31
32
 
# File 'lib/docusign_esign/models/folder_item.rb', line 30

def envelope_id
  @envelope_id
end

#envelope_uri ⇒ Object

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.



33
34
35
 
# File 'lib/docusign_esign/models/folder_item.rb', line 33

def envelope_uri
  @envelope_uri
end

#is21_cfr_part11 ⇒ Object

When set to true, indicates that this module is enabled on the account.



36
37
38
 
# File 'lib/docusign_esign/models/folder_item.rb', line 36

def is21_cfr_part11
  @is21_cfr_part11
end

#is_signature_provider_envelope ⇒ Object

Returns the value of attribute is_signature_provider_envelope.



39
40
41
 
# File 'lib/docusign_esign/models/folder_item.rb', line 39

def is_signature_provider_envelope
  @is_signature_provider_envelope
end

#last_modified ⇒ Object

Returns the value of attribute last_modified.



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

def last_modified
  @last_modified
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#owner_name ⇒ Object

Name of the envelope owner.



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

def owner_name
  @owner_name
end

#page_count ⇒ Object

Returns the value of attribute page_count.



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

def page_count
  @page_count
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#sender_email ⇒ Object

Returns the value of attribute sender_email.



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

def sender_email
  @sender_email
end

#sender_name ⇒ Object

Name of the envelope sender.



60
61
62
 
# File 'lib/docusign_esign/models/folder_item.rb', line 60

def sender_name
  @sender_name
end

#sent_date_time ⇒ Object

The date and time the envelope was sent.



63
64
65
 
# File 'lib/docusign_esign/models/folder_item.rb', line 63

def sent_date_time
  @sent_date_time
end

#shared ⇒ Object

When set to true, this custom tab is shared.



66
67
68
 
# File 'lib/docusign_esign/models/folder_item.rb', line 66

def shared
  @shared
end

#status ⇒ Object

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.



69
70
71
 
# File 'lib/docusign_esign/models/folder_item.rb', line 69

def status
  @status
end

#subject ⇒ Object

Returns the value of attribute subject.



72
73
74
 
# File 'lib/docusign_esign/models/folder_item.rb', line 72

def subject
  @subject
end

#template_id ⇒ Object

The unique identifier of the template. If this is not provided, DocuSign will generate a value.



75
76
77
 
# File 'lib/docusign_esign/models/folder_item.rb', line 75

def template_id
  @template_id
end

#uri ⇒ Object

Returns the value of attribute uri.



78
79
80
 
# File 'lib/docusign_esign/models/folder_item.rb', line 78

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/docusign_esign/models/folder_item.rb', line 82

def self.attribute_map
  {
    :'completed_date_time' => :'completedDateTime',
    :'created_date_time' => :'createdDateTime',
    :'custom_fields' => :'customFields',
    :'description' => :'description',
    :'envelope_id' => :'envelopeId',
    :'envelope_uri' => :'envelopeUri',
    :'is21_cfr_part11' => :'is21CFRPart11',
    :'is_signature_provider_envelope' => :'isSignatureProviderEnvelope',
    :'last_modified' => :'lastModified',
    :'name' => :'name',
    :'owner_name' => :'ownerName',
    :'page_count' => :'pageCount',
    :'password' => :'password',
    :'sender_email' => :'senderEmail',
    :'sender_name' => :'senderName',
    :'sent_date_time' => :'sentDateTime',
    :'shared' => :'shared',
    :'status' => :'status',
    :'subject' => :'subject',
    :'template_id' => :'templateId',
    :'uri' => :'uri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/docusign_esign/models/folder_item.rb', line 109

def self.swagger_types
  {
    :'completed_date_time' => :'String',
    :'created_date_time' => :'String',
    :'custom_fields' => :'Array<CustomFieldV2>',
    :'description' => :'String',
    :'envelope_id' => :'String',
    :'envelope_uri' => :'String',
    :'is21_cfr_part11' => :'String',
    :'is_signature_provider_envelope' => :'String',
    :'last_modified' => :'String',
    :'name' => :'String',
    :'owner_name' => :'String',
    :'page_count' => :'Integer',
    :'password' => :'String',
    :'sender_email' => :'String',
    :'sender_name' => :'String',
    :'sent_date_time' => :'String',
    :'shared' => :'String',
    :'status' => :'String',
    :'subject' => :'String',
    :'template_id' => :'String',
    :'uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/docusign_esign/models/folder_item.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      completed_date_time == o.completed_date_time &&
      created_date_time == o.created_date_time &&
      custom_fields == o.custom_fields &&
      description == o.description &&
      envelope_id == o.envelope_id &&
      envelope_uri == o.envelope_uri &&
      is21_cfr_part11 == o.is21_cfr_part11 &&
      is_signature_provider_envelope == o.is_signature_provider_envelope &&
      last_modified == o.last_modified &&
      name == o.name &&
      owner_name == o.owner_name &&
      page_count == o.page_count &&
      password == o.password &&
      sender_email == o.sender_email &&
      sender_name == o.sender_name &&
      sent_date_time == o.sent_date_time &&
      shared == o.shared &&
      status == o.status &&
      subject == o.subject &&
      template_id == o.template_id &&
      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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/docusign_esign/models/folder_item.rb', line 308

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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/docusign_esign/models/folder_item.rb', line 374

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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/docusign_esign/models/folder_item.rb', line 287

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


274
275
276
 
# File 'lib/docusign_esign/models/folder_item.rb', line 274

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



280
281
282
 
# File 'lib/docusign_esign/models/folder_item.rb', line 280

def hash
  [completed_date_time, created_date_time, custom_fields, description, envelope_id, envelope_uri, is21_cfr_part11, is_signature_provider_envelope, last_modified, name, owner_name, page_count, password, sender_email, sender_name, sent_date_time, shared, status, subject, template_id, uri].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



233
234
235
236
 
# File 'lib/docusign_esign/models/folder_item.rb', line 233

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



354
355
356
 
# File 'lib/docusign_esign/models/folder_item.rb', line 354

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



360
361
362
363
364
365
366
367
368
 
# File 'lib/docusign_esign/models/folder_item.rb', line 360

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



348
349
350
 
# File 'lib/docusign_esign/models/folder_item.rb', line 348

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



240
241
242
 
# File 'lib/docusign_esign/models/folder_item.rb', line 240

def valid?
  return true
end