Class: Dropbox::Sign::BulkSendJobGetResponseSignatureRequests

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkSendJobGetResponseSignatureRequests

Initializes the object

Parameters:

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

    Model attributes in the form of hash



237
238
239
240
241
242
243
244
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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 237

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::BulkSendJobGetResponseSignatureRequests` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.merged_attributes.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::BulkSendJobGetResponseSignatureRequests`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'test_mode')
    self.test_mode = attributes[:'test_mode']
  else
    self.test_mode = false
  end

  if attributes.key?(:'signature_request_id')
    self.signature_request_id = attributes[:'signature_request_id']
  end

  if attributes.key?(:'requester_email_address')
    self.requester_email_address = attributes[:'requester_email_address']
  end

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.key?(:'original_title')
    self.original_title = attributes[:'original_title']
  end

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

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self. = value
    end
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'expires_at')
    self.expires_at = attributes[:'expires_at']
  end

  if attributes.key?(:'is_complete')
    self.is_complete = attributes[:'is_complete']
  end

  if attributes.key?(:'is_declined')
    self.is_declined = attributes[:'is_declined']
  end

  if attributes.key?(:'has_error')
    self.has_error = attributes[:'has_error']
  end

  if attributes.key?(:'files_url')
    self.files_url = attributes[:'files_url']
  end

  if attributes.key?(:'signing_url')
    self.signing_url = attributes[:'signing_url']
  end

  if attributes.key?(:'details_url')
    self.details_url = attributes[:'details_url']
  end

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

  if attributes.key?(:'signing_redirect_url')
    self.signing_redirect_url = attributes[:'signing_redirect_url']
  end

  if attributes.key?(:'final_copy_uri')
    self.final_copy_uri = attributes[:'final_copy_uri']
  end

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

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

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

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

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

  if attributes.key?(:'bulk_send_job_id')
    self.bulk_send_job_id = attributes[:'bulk_send_job_id']
  end
end

Instance Attribute Details

#attachmentsArray<SignatureRequestResponseAttachment>?

Signer attachments.

Returns:



107
108
109
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 107

def attachments
  @attachments
end

#bulk_send_job_idString

The id of the BulkSendJob.

Returns:

  • (String)


119
120
121
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 119

def bulk_send_job_id
  @bulk_send_job_id
end

#cc_email_addressesArray<String>

A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.

Returns:

  • (Array<String>)


87
88
89
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 87

def cc_email_addresses
  @cc_email_addresses
end

#created_atInteger

Time the signature request was created.

Returns:

  • (Integer)


55
56
57
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 55

def created_at
  @created_at
end

#custom_fieldsArray<SignatureRequestResponseCustomFieldBase>?

An array of Custom Field objects containing the name and type of each custom field. * Text Field uses ‘SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`



103
104
105
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 103

def custom_fields
  @custom_fields
end

#details_urlString

The URL where the requester and the signers can view the current status of the SignatureRequest.

Returns:

  • (String)


83
84
85
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 83

def details_url
  @details_url
end

#expires_atInteger?

The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](developers.hellosign.com/docs/signature-request/expiration/) for details.

Returns:

  • (Integer, nil)


59
60
61
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 59

def expires_at
  @expires_at
end

#files_urlString

The URL where a copy of the request’s documents can be downloaded.

Returns:

  • (String)


75
76
77
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 75

def files_url
  @files_url
end

#final_copy_uriString?

The path where the completed document can be downloaded

Returns:

  • (String, nil)


95
96
97
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 95

def final_copy_uri
  @final_copy_uri
end

#has_errorBoolean

Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).

Returns:

  • (Boolean)


71
72
73
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 71

def has_error
  @has_error
end

#is_completeBoolean

Whether or not the SignatureRequest has been fully executed by all signers.

Returns:

  • (Boolean)


63
64
65
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 63

def is_complete
  @is_complete
end

#is_declinedBoolean

Whether or not the SignatureRequest has been declined by a signer.

Returns:

  • (Boolean)


67
68
69
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 67

def is_declined
  @is_declined
end

#messageString?

The custom message in the email that was initially sent to the signers.

Returns:

  • (String, nil)


47
48
49
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 47

def message
  @message
end

#metadataHash<String, Object>

The metadata attached to the signature request.

Returns:

  • (Hash<String, Object>)


51
52
53
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 51

def 
  @metadata
end

#original_titleString

Default Label for account.

Returns:

  • (String)


39
40
41
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 39

def original_title
  @original_title
end

#requester_email_addressString?

The email address of the initiator of the SignatureRequest.

Returns:

  • (String, nil)


31
32
33
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 31

def requester_email_address
  @requester_email_address
end

#response_dataArray<SignatureRequestResponseDataBase>?

An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.

Returns:



111
112
113
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 111

def response_data
  @response_data
end

#signature_request_idString

The id of the SignatureRequest.

Returns:

  • (String)


27
28
29
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 27

def signature_request_id
  @signature_request_id
end

#signaturesArray<SignatureRequestResponseSignatures>

An array of signature objects, 1 for each signer.



115
116
117
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 115

def signatures
  @signatures
end

#signing_redirect_urlString?

The URL you want the signer redirected to after they successfully sign.

Returns:

  • (String, nil)


91
92
93
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 91

def signing_redirect_url
  @signing_redirect_url
end

#signing_urlString?

The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.

Returns:

  • (String, nil)


79
80
81
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 79

def signing_url
  @signing_url
end

#subjectString?

The subject in the email that was initially sent to the signers.

Returns:

  • (String, nil)


43
44
45
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 43

def subject
  @subject
end

#template_idsArray<String>?

Templates IDs used in this SignatureRequest (if any).

Returns:

  • (Array<String>, nil)


99
100
101
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 99

def template_ids
  @template_ids
end

#test_modeBoolean

Whether this is a test signature request. Test requests have no legal value. Defaults to ‘false`.

Returns:

  • (Boolean)


23
24
25
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 23

def test_mode
  @test_mode
end

#titleString

The title the specified Account uses for the SignatureRequest.

Returns:

  • (String)


35
36
37
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 35

def title
  @title
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



153
154
155
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 153

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



158
159
160
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 158

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



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
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 122

def self.attribute_map
  {
    :'test_mode' => :'test_mode',
    :'signature_request_id' => :'signature_request_id',
    :'requester_email_address' => :'requester_email_address',
    :'title' => :'title',
    :'original_title' => :'original_title',
    :'subject' => :'subject',
    :'message' => :'message',
    :'metadata' => :'metadata',
    :'created_at' => :'created_at',
    :'expires_at' => :'expires_at',
    :'is_complete' => :'is_complete',
    :'is_declined' => :'is_declined',
    :'has_error' => :'has_error',
    :'files_url' => :'files_url',
    :'signing_url' => :'signing_url',
    :'details_url' => :'details_url',
    :'cc_email_addresses' => :'cc_email_addresses',
    :'signing_redirect_url' => :'signing_redirect_url',
    :'final_copy_uri' => :'final_copy_uri',
    :'template_ids' => :'template_ids',
    :'custom_fields' => :'custom_fields',
    :'attachments' => :'attachments',
    :'response_data' => :'response_data',
    :'signatures' => :'signatures',
    :'bulk_send_job_id' => :'bulk_send_job_id'
  }
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



428
429
430
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 428

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.init(data) ⇒ BulkSendJobGetResponseSignatureRequests

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object)

    Data to be converted

Returns:



228
229
230
231
232
233
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 228

def self.init(data)
  ApiClient.default.convert_to_type(
    data,
    "BulkSendJobGetResponseSignatureRequests"
  ) || BulkSendJobGetResponseSignatureRequests.new
end

.merged_attributesObject

Returns attribute map of this model + parent



211
212
213
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 211

def self.merged_attributes
  self.attribute_map
end

.merged_nullableObject

Returns list of attributes with nullable: true of this model + parent



221
222
223
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 221

def self.merged_nullable
  self.openapi_nullable
end

.merged_typesObject

Attribute type mapping of this model + parent



216
217
218
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 216

def self.merged_types
  self.openapi_types
end

.openapi_nullableObject

List of attributes with nullable: true



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 194

def self.openapi_nullable
  Set.new([
    :'requester_email_address',
    :'subject',
    :'message',
    :'expires_at',
    :'signing_url',
    :'signing_redirect_url',
    :'final_copy_uri',
    :'template_ids',
    :'custom_fields',
    :'attachments',
    :'response_data',
  ])
end

.openapi_typesObject

Attribute type mapping.



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
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 163

def self.openapi_types
  {
    :'test_mode' => :'Boolean',
    :'signature_request_id' => :'String',
    :'requester_email_address' => :'String',
    :'title' => :'String',
    :'original_title' => :'String',
    :'subject' => :'String',
    :'message' => :'String',
    :'metadata' => :'Hash<String, Object>',
    :'created_at' => :'Integer',
    :'expires_at' => :'Integer',
    :'is_complete' => :'Boolean',
    :'is_declined' => :'Boolean',
    :'has_error' => :'Boolean',
    :'files_url' => :'String',
    :'signing_url' => :'String',
    :'details_url' => :'String',
    :'cc_email_addresses' => :'Array<String>',
    :'signing_redirect_url' => :'String',
    :'final_copy_uri' => :'String',
    :'template_ids' => :'Array<String>',
    :'custom_fields' => :'Array<SignatureRequestResponseCustomFieldBase>',
    :'attachments' => :'Array<SignatureRequestResponseAttachment>',
    :'response_data' => :'Array<SignatureRequestResponseDataBase>',
    :'signatures' => :'Array<SignatureRequestResponseSignatures>',
    :'bulk_send_job_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 383

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      test_mode == o.test_mode &&
      signature_request_id == o.signature_request_id &&
      requester_email_address == o.requester_email_address &&
      title == o.title &&
      original_title == o.original_title &&
      subject == o.subject &&
      message == o.message &&
       == o. &&
      created_at == o.created_at &&
      expires_at == o.expires_at &&
      is_complete == o.is_complete &&
      is_declined == o.is_declined &&
      has_error == o.has_error &&
      files_url == o.files_url &&
      signing_url == o.signing_url &&
      details_url == o.details_url &&
      cc_email_addresses == o.cc_email_addresses &&
      signing_redirect_url == o.signing_redirect_url &&
      final_copy_uri == o.final_copy_uri &&
      template_ids == o.template_ids &&
      custom_fields == o.custom_fields &&
      attachments == o.attachments &&
      response_data == o.response_data &&
      signatures == o.signatures &&
      bulk_send_job_id == o.bulk_send_job_id
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



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 458

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    klass = Dropbox::Sign.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value, include_nil = true) ⇒ 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



529
530
531
532
533
534
535
536
537
538
539
540
541
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 529

def _to_hash(value, include_nil = true)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v, include_nil) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(include_nil)
  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



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 435

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attribute_map = self.class.merged_attributes

  self.class.merged_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


415
416
417
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 415

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



421
422
423
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 421

def hash
  [test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, , created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, final_copy_uri, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



370
371
372
373
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 370

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



504
505
506
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 504

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 510

def to_hash(include_nil = true)
  hash = {}
  self.class.merged_attributes.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      next unless include_nil
      is_nullable = self.class.merged_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value, include_nil)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



498
499
500
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 498

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



377
378
379
# File 'lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb', line 377

def valid?
  true
end