Class: Dropbox::Sign::SignatureRequestResponse

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

Overview

Contains information about a signature request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignatureRequestResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



234
235
236
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
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 234

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

  # check to see if the attribute exists and convert string to symbol for hash key
  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::SignatureRequestResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.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.metadata = 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

#attachments ⇒ Array<SignatureRequestResponseAttachment>?

Signer attachments.

Returns:



108
109
110
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 108

def attachments
  @attachments
end

#bulk_send_job_id ⇒ String?

The ID of the Bulk Send job which sent the signature request, if applicable.

Returns:

  • (String, nil) 


120
121
122
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 120

def bulk_send_job_id
  @bulk_send_job_id
end

#cc_email_addresses ⇒ Array<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>) 


88
89
90
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 88

def cc_email_addresses
  @cc_email_addresses
end

#created_at ⇒ Integer

Time the signature request was created.

Returns:

  • (Integer) 


56
57
58
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 56

def created_at
  @created_at
end

#custom_fields ⇒ Array<SignatureRequestResponseCustomFieldBase>?

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

Returns:



104
105
106
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 104

def custom_fields
  @custom_fields
end

#details_url ⇒ String

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

Returns:

  • (String) 


84
85
86
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 84

def details_url
  @details_url
end

#expires_at ⇒ Integer?

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) 


60
61
62
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 60

def expires_at
  @expires_at
end

#files_url ⇒ String

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

Returns:

  • (String) 


76
77
78
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 76

def files_url
  @files_url
end

#final_copy_uri ⇒ String?

The path where the completed document can be downloaded

Returns:

  • (String, nil) 


96
97
98
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 96

def final_copy_uri
  @final_copy_uri
end

#has_error ⇒ Boolean

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

Returns:

  • (Boolean) 


72
73
74
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 72

def has_error
  @has_error
end

#is_complete ⇒ Boolean

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

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 64

def is_complete
  @is_complete
end

#is_declined ⇒ Boolean

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

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 68

def is_declined
  @is_declined
end

#message ⇒ String?

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

Returns:

  • (String, nil) 


48
49
50
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 48

def message
  @message
end

#metadata ⇒ Hash<String, Object>

The metadata attached to the signature request.

Returns:

  • (Hash<String, Object>) 


52
53
54
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 52

def metadata
  @metadata
end

#original_title ⇒ String

Default Label for account.

Returns:

  • (String) 


40
41
42
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 40

def original_title
  @original_title
end

#requester_email_address ⇒ String?

The email address of the initiator of the SignatureRequest.

Returns:

  • (String, nil) 


32
33
34
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 32

def requester_email_address
  @requester_email_address
end

#response_data ⇒ Array<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:



112
113
114
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 112

def response_data
  @response_data
end

#signature_request_id ⇒ String

The id of the SignatureRequest.

Returns:

  • (String) 


28
29
30
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 28

def signature_request_id
  @signature_request_id
end

#signatures ⇒ Array<SignatureRequestResponseSignatures>

An array of signature objects, 1 for each signer.

Returns:



116
117
118
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 116

def signatures
  @signatures
end

#signing_redirect_url ⇒ String?

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

Returns:

  • (String, nil) 


92
93
94
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 92

def signing_redirect_url
  @signing_redirect_url
end

#signing_url ⇒ String?

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) 


80
81
82
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 80

def signing_url
  @signing_url
end

#subject ⇒ String?

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

Returns:

  • (String, nil) 


44
45
46
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 44

def subject
  @subject
end

#template_ids ⇒ Array<String>?

Templates IDs used in this SignatureRequest (if any).

Returns:

  • (Array<String>, nil) 


100
101
102
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 100

def template_ids
  @template_ids
end

#test_mode ⇒ Boolean

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

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 24

def test_mode
  @test_mode
end

#title ⇒ String

The title the specified Account uses for the SignatureRequest.

Returns:

  • (String) 


36
37
38
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 36

def title
  @title
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



154
155
156
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 154

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



424
425
426
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 424

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

.init(data) ⇒ SignatureRequestResponse

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



225
226
227
228
229
230
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 225

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



208
209
210
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 208

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



218
219
220
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 218

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



213
214
215
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 213

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 190

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',
    :'bulk_send_job_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

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



379
380
381
382
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
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 379

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 &&
      metadata == o.metadata &&
      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



454
455
456
457
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
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 454

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



525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 525

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



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 431

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


411
412
413
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 411

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



417
418
419
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 417

def hash
  [test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, 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_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



366
367
368
369
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 366

def list_invalid_properties
  invalid_properties = Array.new
  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



500
501
502
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 500

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



506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 506

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



494
495
496
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 494

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



373
374
375
 
# File 'lib/dropbox-sign/models/signature_request_response.rb', line 373

def valid?
  true
end