Class: Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UnclaimedDraftCreateEmbeddedRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
367
368
369
370
371
372
373
374
375
376
377
378
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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
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
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 307

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest` 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::UnclaimedDraftCreateEmbeddedRequest`. 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?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

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

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

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

  if attributes.key?(:'allow_ccs')
    self.allow_ccs = attributes[:'allow_ccs']
  else
    self.allow_ccs = true
  end

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

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

  if attributes.key?(:'attachments')
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
  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?(:'custom_fields')
    if (value = attributes[:'custom_fields']).is_a?(Array)
      self.custom_fields = value
    end
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'is_for_embedded_signing')
    self.is_for_embedded_signing = attributes[:'is_for_embedded_signing']
  else
    self.is_for_embedded_signing = false
  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?(:'requesting_redirect_url')
    self.requesting_redirect_url = attributes[:'requesting_redirect_url']
  end

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

  if attributes.key?(:'show_progress_stepper')
    self.show_progress_stepper = attributes[:'show_progress_stepper']
  else
    self.show_progress_stepper = true
  end

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

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

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

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'request_signature'
  end

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

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

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

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

Instance Attribute Details

#allow_ccs ⇒ Boolean

This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.

Returns:

  • (Boolean) 


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

def allow_ccs
  @allow_ccs
end

#allow_decline ⇒ Boolean

Allows signers to decline to sign a document if ‘true`. Defaults to `false`.

Returns:

  • (Boolean) 


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

def allow_decline
  @allow_decline
end

#allow_reassign ⇒ Boolean

Allows signers to reassign their signature requests to other signers if set to ‘true`. Defaults to `false`. Note: Only available for Premium plan and higher.

Returns:

  • (Boolean) 


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

def allow_reassign
  @allow_reassign
end

#attachments ⇒ Array<SubAttachment>

A list describing the attachments

Returns:



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

def attachments
  @attachments
end

#cc_email_addresses ⇒ Array<String>

The email addresses that should be CCed.

Returns:

  • (Array<String>) 


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

def cc_email_addresses
  @cc_email_addresses
end

#client_id ⇒ String

Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.

Returns:

  • (String) 


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

def client_id
  @client_id
end

#custom_fields ⇒ Array<SubCustomField>

When used together with merge fields, ‘custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.

Returns:



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

def custom_fields
  @custom_fields
end

#editor_options ⇒ SubEditorOptions

Returns:



62
63
64
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 62

def editor_options
  @editor_options
end

#expires_at ⇒ Integer?

When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](developers.hellosign.com/docs/signature-request/expiration/) for details. Note: This does not correspond to the expires_at returned in the response.

Returns:

  • (Integer, nil) 


160
161
162
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 160

def expires_at
  @expires_at
end

#field_options ⇒ SubFieldOptions

Returns:



65
66
67
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 65

def field_options
  @field_options
end

#file_urls ⇒ Array<String>

Use ‘file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.

Returns:

  • (Array<String>) 


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

def file_urls
  @file_urls
end

#files ⇒ Array<File>

Use ‘files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.

Returns:

  • (Array<File>) 


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

def files
  @files
end

#force_signer_page ⇒ Boolean

Provide users the ability to review/edit the signers.

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 69

def force_signer_page
  @force_signer_page
end

#force_subject_message ⇒ Boolean

Provide users the ability to review/edit the subject and message.

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 73

def force_subject_message
  @force_subject_message
end

#form_field_groups ⇒ Array<SubFormFieldGroup>

Group information for fields defined in ‘form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.

Returns:



77
78
79
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 77

def form_field_groups
  @form_field_groups
end

#form_field_rules ⇒ Array<SubFormFieldRule>

Conditional Logic rules for fields defined in ‘form_fields_per_document`.

Returns:



81
82
83
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 81

def form_field_rules
  @form_field_rules
end

#form_fields_per_document ⇒ Array<SubFormFieldsPerDocumentBase>

The fields that should appear on the document, expressed as an array of objects. (We’re currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use ‘SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`

Returns:



85
86
87
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 85

def form_fields_per_document
  @form_fields_per_document
end

#hide_text_tags ⇒ Boolean

Send with a value of ‘true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 89

def hide_text_tags
  @hide_text_tags
end

#hold_request ⇒ Boolean

The request from this draft will not automatically send to signers post-claim if set to ‘true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 93

def hold_request
  @hold_request
end

#is_for_embedded_signing ⇒ Boolean

The request created from this draft will also be signable in embedded mode if set to ‘true`. Defaults to `false`.

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 97

def is_for_embedded_signing
  @is_for_embedded_signing
end

#message ⇒ String

The custom message in the email that will be sent to the signers.

Returns:

  • (String) 


101
102
103
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 101

def message
  @message
end

#metadata ⇒ Hash<String, Object>

Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer’s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.

Returns:

  • (Hash<String, Object>) 


105
106
107
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 105

def metadata
  @metadata
end

#populate_auto_fill_fields ⇒ Boolean

Controls whether [auto fill fields](faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer’s information during signing. ⚠️ Note ⚠️: Keep your signer’s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.

Returns:

  • (Boolean) 


156
157
158
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 156

def populate_auto_fill_fields
  @populate_auto_fill_fields
end

#requester_email_address ⇒ String

The email address of the user that should be designated as the requester of this draft, if the draft type is ‘request_signature`.

Returns:

  • (String) 


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

def requester_email_address
  @requester_email_address
end

#requesting_redirect_url ⇒ String

The URL you want signers redirected to after they successfully request a signature.

Returns:

  • (String) 


109
110
111
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 109

def requesting_redirect_url
  @requesting_redirect_url
end

#show_preview ⇒ Boolean

This allows the requester to enable the editor/preview experience. - ‘show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience.

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 113

def show_preview
  @show_preview
end

#show_progress_stepper ⇒ Boolean

When only one step remains in the signature request process and this parameter is set to ‘false` then the progress stepper will be hidden.

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 117

def show_progress_stepper
  @show_progress_stepper
end

#signers ⇒ Array<SubUnclaimedDraftSigner>

Add Signers to your Unclaimed Draft Signature Request.

Returns:



121
122
123
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 121

def signers
  @signers
end

#signing_options ⇒ SubSigningOptions

Returns:



124
125
126
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 124

def signing_options
  @signing_options
end

#signing_redirect_url ⇒ String

The URL you want signers redirected to after they successfully sign.

Returns:

  • (String) 


128
129
130
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 128

def signing_redirect_url
  @signing_redirect_url
end

#skip_me_now ⇒ Boolean

Disables the "Me (Now)" option for the person preparing the document. Does not work with type ‘send_document`. Defaults to `false`.

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 132

def skip_me_now
  @skip_me_now
end

#subject ⇒ String

The subject in the email that will be sent to the signers.

Returns:

  • (String) 


136
137
138
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 136

def subject
  @subject
end

#test_mode ⇒ Boolean

Whether this is a test, the signature request created from this draft will not be legally binding if set to ‘true`. Defaults to `false`.

Returns:

  • (Boolean) 


140
141
142
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 140

def test_mode
  @test_mode
end

#type ⇒ String

The type of the draft. By default this is ‘request_signature`, but you can set it to `send_document` if you want to self sign a document and download it.

Returns:

  • (String) 


144
145
146
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 144

def type
  @type
end

#use_preexisting_fields ⇒ Boolean

Set ‘use_text_tags` to `true` to enable [Text Tags](app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.

Returns:

  • (Boolean) 


148
149
150
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 148

def use_preexisting_fields
  @use_preexisting_fields
end

#use_text_tags ⇒ Boolean

Set ‘use_text_tags` to `true` to enable [Text Tags](app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.

Returns:

  • (Boolean) 


152
153
154
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 152

def use_text_tags
  @use_text_tags
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



227
228
229
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 227

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'requester_email_address' => :'requester_email_address',
    :'files' => :'files',
    :'file_urls' => :'file_urls',
    :'allow_ccs' => :'allow_ccs',
    :'allow_decline' => :'allow_decline',
    :'allow_reassign' => :'allow_reassign',
    :'attachments' => :'attachments',
    :'cc_email_addresses' => :'cc_email_addresses',
    :'custom_fields' => :'custom_fields',
    :'editor_options' => :'editor_options',
    :'field_options' => :'field_options',
    :'force_signer_page' => :'force_signer_page',
    :'force_subject_message' => :'force_subject_message',
    :'form_field_groups' => :'form_field_groups',
    :'form_field_rules' => :'form_field_rules',
    :'form_fields_per_document' => :'form_fields_per_document',
    :'hide_text_tags' => :'hide_text_tags',
    :'hold_request' => :'hold_request',
    :'is_for_embedded_signing' => :'is_for_embedded_signing',
    :'message' => :'message',
    :'metadata' => :'metadata',
    :'requesting_redirect_url' => :'requesting_redirect_url',
    :'show_preview' => :'show_preview',
    :'show_progress_stepper' => :'show_progress_stepper',
    :'signers' => :'signers',
    :'signing_options' => :'signing_options',
    :'signing_redirect_url' => :'signing_redirect_url',
    :'skip_me_now' => :'skip_me_now',
    :'subject' => :'subject',
    :'test_mode' => :'test_mode',
    :'type' => :'type',
    :'use_preexisting_fields' => :'use_preexisting_fields',
    :'use_text_tags' => :'use_text_tags',
    :'populate_auto_fill_fields' => :'populate_auto_fill_fields',
    :'expires_at' => :'expires_at'
  }
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



644
645
646
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 644

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

.init(data) ⇒ UnclaimedDraftCreateEmbeddedRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



298
299
300
301
302
303
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 298

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



232
233
234
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 232

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



291
292
293
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 291

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



279
280
281
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 279

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



284
285
286
287
288
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 284

def self.openapi_nullable
  Set.new([
    :'expires_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'client_id' => :'String',
    :'requester_email_address' => :'String',
    :'files' => :'Array<File>',
    :'file_urls' => :'Array<String>',
    :'allow_ccs' => :'Boolean',
    :'allow_decline' => :'Boolean',
    :'allow_reassign' => :'Boolean',
    :'attachments' => :'Array<SubAttachment>',
    :'cc_email_addresses' => :'Array<String>',
    :'custom_fields' => :'Array<SubCustomField>',
    :'editor_options' => :'SubEditorOptions',
    :'field_options' => :'SubFieldOptions',
    :'force_signer_page' => :'Boolean',
    :'force_subject_message' => :'Boolean',
    :'form_field_groups' => :'Array<SubFormFieldGroup>',
    :'form_field_rules' => :'Array<SubFormFieldRule>',
    :'form_fields_per_document' => :'Array<SubFormFieldsPerDocumentBase>',
    :'hide_text_tags' => :'Boolean',
    :'hold_request' => :'Boolean',
    :'is_for_embedded_signing' => :'Boolean',
    :'message' => :'String',
    :'metadata' => :'Hash<String, Object>',
    :'requesting_redirect_url' => :'String',
    :'show_preview' => :'Boolean',
    :'show_progress_stepper' => :'Boolean',
    :'signers' => :'Array<SubUnclaimedDraftSigner>',
    :'signing_options' => :'SubSigningOptions',
    :'signing_redirect_url' => :'String',
    :'skip_me_now' => :'Boolean',
    :'subject' => :'String',
    :'test_mode' => :'Boolean',
    :'type' => :'String',
    :'use_preexisting_fields' => :'Boolean',
    :'use_text_tags' => :'Boolean',
    :'populate_auto_fill_fields' => :'Boolean',
    :'expires_at' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 588

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      requester_email_address == o.requester_email_address &&
      files == o.files &&
      file_urls == o.file_urls &&
      allow_ccs == o.allow_ccs &&
      allow_decline == o.allow_decline &&
      allow_reassign == o.allow_reassign &&
      attachments == o.attachments &&
      cc_email_addresses == o.cc_email_addresses &&
      custom_fields == o.custom_fields &&
      editor_options == o.editor_options &&
      field_options == o.field_options &&
      force_signer_page == o.force_signer_page &&
      force_subject_message == o.force_subject_message &&
      form_field_groups == o.form_field_groups &&
      form_field_rules == o.form_field_rules &&
      form_fields_per_document == o.form_fields_per_document &&
      hide_text_tags == o.hide_text_tags &&
      hold_request == o.hold_request &&
      is_for_embedded_signing == o.is_for_embedded_signing &&
      message == o.message &&
      metadata == o.metadata &&
      requesting_redirect_url == o.requesting_redirect_url &&
      show_preview == o.show_preview &&
      show_progress_stepper == o.show_progress_stepper &&
      signers == o.signers &&
      signing_options == o.signing_options &&
      signing_redirect_url == o.signing_redirect_url &&
      skip_me_now == o.skip_me_now &&
      subject == o.subject &&
      test_mode == o.test_mode &&
      type == o.type &&
      use_preexisting_fields == o.use_preexisting_fields &&
      use_text_tags == o.use_text_tags &&
      populate_auto_fill_fields == o.populate_auto_fill_fields &&
      expires_at == o.expires_at
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



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 674

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 :File
    value
  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
    # models (e.g. Pet)
    klass = Dropbox::Sign.const_get(type)
    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



748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 748

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



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 651

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


631
632
633
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 631

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



637
638
639
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 637

def hash
  [client_id, requester_email_address, files, file_urls, allow_ccs, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, editor_options, field_options, force_signer_page, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, hold_request, is_for_embedded_signing, message, metadata, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, type, use_preexisting_fields, use_text_tags, populate_auto_fill_fields, expires_at].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



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 517

def list_invalid_properties
  invalid_properties = Array.new
  if @client_id.nil?
    invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
  end

  if @requester_email_address.nil?
    invalid_properties.push('invalid value for "requester_email_address", requester_email_address cannot be nil.')
  end

  if !@message.nil? && @message.to_s.length > 5000
    invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.')
  end

  if !@subject.nil? && @subject.to_s.length > 200
    invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 200.')
  end

  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



723
724
725
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 723

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



729
730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 729

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



717
718
719
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 717

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



540
541
542
543
544
545
546
547
548
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb', line 540

def valid?
  return false if @client_id.nil?
  return false if @requester_email_address.nil?
  return false if !@message.nil? && @message.to_s.length > 5000
  return false if !@subject.nil? && @subject.to_s.length > 200
  type_validator = EnumAttributeValidator.new('String', ["send_document", "request_signature"])
  return false unless type_validator.valid?(@type)
  true
end