Class: Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UnclaimedDraftCreateEmbeddedWithTemplateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest` 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::UnclaimedDraftCreateEmbeddedWithTemplateRequest`. 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?(:'template_ids')
    if (value = attributes[:'template_ids']).is_a?(Array)
      self.template_ids = value
    end
  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?(:'ccs')
    if (value = attributes[:'ccs']).is_a?(Array)
      self.ccs = 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?(:'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?(:'force_signer_roles')
    self.force_signer_roles = attributes[:'force_signer_roles']
  else
    self.force_signer_roles = 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?(:'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?(:'preview_only')
    self.preview_only = attributes[:'preview_only']
  else
    self.preview_only = false
  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']
  else
    self.show_preview = false
  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?(:'title')
    self.title = attributes[:'title']
  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?(:'allow_ccs')
    self.allow_ccs = attributes[:'allow_ccs']
  else
    self.allow_ccs = false
  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) 


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

def allow_ccs
  @allow_ccs
end

#allow_decline ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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) 


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

def allow_reassign
  @allow_reassign
end

#ccs ⇒ Array<SubCC>

Add CC email recipients. Required when a CC role exists for the Template.

Returns:



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

def ccs
  @ccs
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_with_template_request.rb', line 23

def client_id
  @client_id
end

#custom_fields ⇒ Array<SubCustomField>

An array defining values and options for custom fields. Required when a custom field exists in the Template.

Returns:



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

def custom_fields
  @custom_fields
end

#editor_options ⇒ SubEditorOptions

Returns:



50
51
52
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 50

def editor_options
  @editor_options
end

#field_options ⇒ SubFieldOptions

Returns:



53
54
55
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 53

def field_options
  @field_options
end

#file_urls ⇒ Array<String>

Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored. files or file_urls[] is required, but not both.

Returns:

  • (Array<String>) 


61
62
63
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 61

def file_urls
  @file_urls
end

#files ⇒ Array<File>

Use ‘files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. files or file_urls[] is required, but not both.

Returns:

  • (Array<File>) 


57
58
59
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 57

def files
  @files
end

#force_signer_roles ⇒ Boolean

Provide users the ability to review/edit the template signer roles.

Returns:

  • (Boolean) 


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

def force_signer_roles
  @force_signer_roles
end

#force_subject_message ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def force_subject_message
  @force_subject_message
end

#hold_request ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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) 


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

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) 


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

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


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

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) 


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

def populate_auto_fill_fields
  @populate_auto_fill_fields
end

#preview_only ⇒ Boolean

This allows the requester to enable the preview experience (i.e. does not allow the requester’s end user to add any additional fields via the editor). - ‘preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience. NOTE: This parameter overwrites `show_preview=1` (if set).

Returns:

  • (Boolean) 


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

def preview_only
  @preview_only
end

#requester_email_address ⇒ String

The email address of the user that should be designated as the requester of this draft.

Returns:

  • (String) 


27
28
29
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_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) 


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

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) 


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

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) 


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

def show_progress_stepper
  @show_progress_stepper
end

#signers ⇒ Array<SubUnclaimedDraftTemplateSigner>

Add Signers to your Templated-based Signature Request.

Returns:



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

def signers
  @signers
end

#signing_options ⇒ SubSigningOptions

Returns:



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

def signing_options
  @signing_options
end

#signing_redirect_url ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def skip_me_now
  @skip_me_now
end

#subject ⇒ String

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

Returns:

  • (String) 


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

def subject
  @subject
end

#template_ids ⇒ Array<String>

Use ‘template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.

Returns:

  • (Array<String>) 


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

def template_ids
  @template_ids
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) 


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

def test_mode
  @test_mode
end

#title ⇒ String

The title you want to assign to the SignatureRequest.

Returns:

  • (String) 


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

def title
  @title
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



175
176
177
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 175

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 139

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'requester_email_address' => :'requester_email_address',
    :'template_ids' => :'template_ids',
    :'allow_decline' => :'allow_decline',
    :'allow_reassign' => :'allow_reassign',
    :'ccs' => :'ccs',
    :'custom_fields' => :'custom_fields',
    :'editor_options' => :'editor_options',
    :'field_options' => :'field_options',
    :'files' => :'files',
    :'file_urls' => :'file_urls',
    :'force_signer_roles' => :'force_signer_roles',
    :'force_subject_message' => :'force_subject_message',
    :'hold_request' => :'hold_request',
    :'is_for_embedded_signing' => :'is_for_embedded_signing',
    :'message' => :'message',
    :'metadata' => :'metadata',
    :'preview_only' => :'preview_only',
    :'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',
    :'title' => :'title',
    :'populate_auto_fill_fields' => :'populate_auto_fill_fields',
    :'allow_ccs' => :'allow_ccs'
  }
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



553
554
555
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 553

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

.init(data) ⇒ UnclaimedDraftCreateEmbeddedWithTemplateRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



239
240
241
242
243
244
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 239

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



222
223
224
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 222

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



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

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



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

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'client_id' => :'String',
    :'requester_email_address' => :'String',
    :'template_ids' => :'Array<String>',
    :'allow_decline' => :'Boolean',
    :'allow_reassign' => :'Boolean',
    :'ccs' => :'Array<SubCC>',
    :'custom_fields' => :'Array<SubCustomField>',
    :'editor_options' => :'SubEditorOptions',
    :'field_options' => :'SubFieldOptions',
    :'files' => :'Array<File>',
    :'file_urls' => :'Array<String>',
    :'force_signer_roles' => :'Boolean',
    :'force_subject_message' => :'Boolean',
    :'hold_request' => :'Boolean',
    :'is_for_embedded_signing' => :'Boolean',
    :'message' => :'String',
    :'metadata' => :'Hash<String, Object>',
    :'preview_only' => :'Boolean',
    :'requesting_redirect_url' => :'String',
    :'show_preview' => :'Boolean',
    :'show_progress_stepper' => :'Boolean',
    :'signers' => :'Array<SubUnclaimedDraftTemplateSigner>',
    :'signing_options' => :'SubSigningOptions',
    :'signing_redirect_url' => :'String',
    :'skip_me_now' => :'Boolean',
    :'subject' => :'String',
    :'test_mode' => :'Boolean',
    :'title' => :'String',
    :'populate_auto_fill_fields' => :'Boolean',
    :'allow_ccs' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



503
504
505
506
507
508
509
510
511
512
513
514
515
516
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_with_template_request.rb', line 503

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      requester_email_address == o.requester_email_address &&
      template_ids == o.template_ids &&
      allow_decline == o.allow_decline &&
      allow_reassign == o.allow_reassign &&
      ccs == o.ccs &&
      custom_fields == o.custom_fields &&
      editor_options == o.editor_options &&
      field_options == o.field_options &&
      files == o.files &&
      file_urls == o.file_urls &&
      force_signer_roles == o.force_signer_roles &&
      force_subject_message == o.force_subject_message &&
      hold_request == o.hold_request &&
      is_for_embedded_signing == o.is_for_embedded_signing &&
      message == o.message &&
      metadata == o.metadata &&
      preview_only == o.preview_only &&
      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 &&
      title == o.title &&
      populate_auto_fill_fields == o.populate_auto_fill_fields &&
      allow_ccs == o.allow_ccs
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



583
584
585
586
587
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
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 583

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



654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 654

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



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 560

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


540
541
542
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 540

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



546
547
548
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 546

def hash
  [client_id, requester_email_address, template_ids, allow_decline, allow_reassign, ccs, custom_fields, editor_options, field_options, files, file_urls, force_signer_roles, force_subject_message, hold_request, is_for_embedded_signing, message, metadata, preview_only, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, title, populate_auto_fill_fields, allow_ccs].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



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

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 @template_ids.nil?
    invalid_properties.push('invalid value for "template_ids", template_ids 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 > 255
    invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.')
  end

  if !@title.nil? && @title.to_s.length > 255
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.')
  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



629
630
631
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 629

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



635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 635

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



623
624
625
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 623

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



455
456
457
458
459
460
461
462
463
 
# File 'lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb', line 455

def valid?
  return false if @client_id.nil?
  return false if @requester_email_address.nil?
  return false if @template_ids.nil?
  return false if !@message.nil? && @message.to_s.length > 5000
  return false if !@subject.nil? && @subject.to_s.length > 255
  return false if !@title.nil? && @title.to_s.length > 255
  true
end