Class: Dropbox::Sign::SignatureRequestCreateEmbeddedRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignatureRequestCreateEmbeddedRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
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
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 214

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

  if attributes.key?(:'grouped_signers')
    if (value = attributes[:'grouped_signers']).is_a?(Array)
      self.grouped_signers = 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?(:'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?(:'field_options')
    self.field_options = attributes[:'field_options']
  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?(:'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?(:'signing_options')
    self.signing_options = attributes[:'signing_options']
  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?(:'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_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/signature_request_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.

Returns:

  • (Boolean) 


47
48
49
 
# File 'lib/dropbox-sign/models/signature_request_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/signature_request_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/signature_request_create_embedded_request.rb', line 55

def cc_email_addresses
  @cc_email_addresses
end

#client_id ⇒ String

Client id of the app you’re using to create this embedded signature request. Used for security purposes.

Returns:

  • (String) 


23
24
25
 
# File 'lib/dropbox-sign/models/signature_request_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/signature_request_create_embedded_request.rb', line 59

def custom_fields
  @custom_fields
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.

Returns:

  • (Integer, nil) 


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

def expires_at
  @expires_at
end

#field_options ⇒ SubFieldOptions

Returns:



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

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


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

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


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

def files
  @files
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:



66
67
68
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 66

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:



70
71
72
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 70

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. (For more details 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:



74
75
76
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 74

def form_fields_per_document
  @form_fields_per_document
end

#grouped_signers ⇒ Array<SubSignatureRequestGroupedSigners>

Add Grouped Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both.

Returns:



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

def grouped_signers
  @grouped_signers
end

#hide_text_tags ⇒ Boolean

Enables automatic Text Tag removal when set to true. NOTE: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on ‘false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 78

def hide_text_tags
  @hide_text_tags
end

#message ⇒ String

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

Returns:

  • (String) 


82
83
84
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 82

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


86
87
88
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 86

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) 


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

def populate_auto_fill_fields
  @populate_auto_fill_fields
end

#signers ⇒ Array<SubSignatureRequestSigner>

Add Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both.

Returns:



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

def signers
  @signers
end

#signing_options ⇒ SubSigningOptions

Returns:



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

def signing_options
  @signing_options
end

#subject ⇒ String

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

Returns:

  • (String) 


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

def subject
  @subject
end

#test_mode ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def test_mode
  @test_mode
end

#title ⇒ String

The title you want to assign to the SignatureRequest.

Returns:

  • (String) 


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

def title
  @title
end

#use_text_tags ⇒ Boolean

Send with a value of ‘true` if you wish to enable [Text Tags](app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.

Returns:

  • (Boolean) 


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

def use_text_tags
  @use_text_tags
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



146
147
148
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 146

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 116

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'files' => :'files',
    :'file_urls' => :'file_urls',
    :'signers' => :'signers',
    :'grouped_signers' => :'grouped_signers',
    :'allow_decline' => :'allow_decline',
    :'allow_reassign' => :'allow_reassign',
    :'attachments' => :'attachments',
    :'cc_email_addresses' => :'cc_email_addresses',
    :'custom_fields' => :'custom_fields',
    :'field_options' => :'field_options',
    :'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',
    :'message' => :'message',
    :'metadata' => :'metadata',
    :'signing_options' => :'signing_options',
    :'subject' => :'subject',
    :'test_mode' => :'test_mode',
    :'title' => :'title',
    :'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



473
474
475
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 473

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

.init(data) ⇒ SignatureRequestCreateEmbeddedRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



205
206
207
208
209
210
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 205

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



151
152
153
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 151

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



198
199
200
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 198

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



186
187
188
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 186

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



191
192
193
194
195
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 191

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

.openapi_types ⇒ Object

Attribute type mapping.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 156

def self.openapi_types
  {
    :'client_id' => :'String',
    :'files' => :'Array<File>',
    :'file_urls' => :'Array<String>',
    :'signers' => :'Array<SubSignatureRequestSigner>',
    :'grouped_signers' => :'Array<SubSignatureRequestGroupedSigners>',
    :'allow_decline' => :'Boolean',
    :'allow_reassign' => :'Boolean',
    :'attachments' => :'Array<SubAttachment>',
    :'cc_email_addresses' => :'Array<String>',
    :'custom_fields' => :'Array<SubCustomField>',
    :'field_options' => :'SubFieldOptions',
    :'form_field_groups' => :'Array<SubFormFieldGroup>',
    :'form_field_rules' => :'Array<SubFormFieldRule>',
    :'form_fields_per_document' => :'Array<SubFormFieldsPerDocumentBase>',
    :'hide_text_tags' => :'Boolean',
    :'message' => :'String',
    :'metadata' => :'Hash<String, Object>',
    :'signing_options' => :'SubSigningOptions',
    :'subject' => :'String',
    :'test_mode' => :'Boolean',
    :'title' => :'String',
    :'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



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      files == o.files &&
      file_urls == o.file_urls &&
      signers == o.signers &&
      grouped_signers == o.grouped_signers &&
      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 &&
      field_options == o.field_options &&
      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 &&
      message == o.message &&
      metadata == o.metadata &&
      signing_options == o.signing_options &&
      subject == o.subject &&
      test_mode == o.test_mode &&
      title == o.title &&
      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



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
537
538
539
540
541
542
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 503

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



577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 577

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



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 480

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


460
461
462
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 460

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



466
467
468
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 466

def hash
  [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, 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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 360

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 !@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



552
553
554
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 552

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



558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 558

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



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

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



383
384
385
386
387
388
389
 
# File 'lib/dropbox-sign/models/signature_request_create_embedded_request.rb', line 383

def valid?
  return false if @client_id.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