Class: Dropbox::Sign::TemplateCreateRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'client_id')
    self.client_id = attributes[:'client_id']
  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?(:'merge_fields')
    if (value = attributes[:'merge_fields']).is_a?(Array)
      self.merge_fields = value
    end
  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?(:'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_preexisting_fields')
    self.use_preexisting_fields = attributes[:'use_preexisting_fields']
  else
    self.use_preexisting_fields = false
  end
end

Instance Attribute Details

#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/template_create_request.rb', line 39

def allow_reassign
  @allow_reassign
end

#attachments ⇒ Array<SubAttachment>

A list describing the attachments

Returns:



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

def attachments
  @attachments
end

#cc_roles ⇒ Array<String>

The CC roles that must be assigned when using the template to send a signature request

Returns:

  • (Array<String>) 


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

def cc_roles
  @cc_roles
end

#client_id ⇒ String

Client id of the app you’re using to create this draft. Used to apply the branding and callback url defined for the app.

Returns:

  • (String) 


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

def client_id
  @client_id
end

#field_options ⇒ SubFieldOptions

Returns:



54
55
56
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 54

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/template_create_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/template_create_request.rb', line 31

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:



58
59
60
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 58

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:



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

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:



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

def form_fields_per_document
  @form_fields_per_document
end

#merge_fields ⇒ Array<SubMergeField>

Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the ‘custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.

Returns:



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

def merge_fields
  @merge_fields
end

#message ⇒ String

The default template email message.

Returns:

  • (String) 


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

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


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

def metadata
  @metadata
end

#signer_roles ⇒ Array<SubTemplateRole>

An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.

Returns:



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

def signer_roles
  @signer_roles
end

#subject ⇒ String

The template title (alias).

Returns:

  • (String) 


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

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) 


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

def test_mode
  @test_mode
end

#title ⇒ String

The title you want to assign to the SignatureRequest.

Returns:

  • (String) 


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

def title
  @title
end

#use_preexisting_fields ⇒ Boolean

Enable the detection of predefined PDF fields by setting the ‘use_preexisting_fields` to `true` (defaults to disabled, or `false`).

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 90

def use_preexisting_fields
  @use_preexisting_fields
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 93

def self.attribute_map
  {
    :'form_fields_per_document' => :'form_fields_per_document',
    :'signer_roles' => :'signer_roles',
    :'files' => :'files',
    :'file_urls' => :'file_urls',
    :'allow_reassign' => :'allow_reassign',
    :'attachments' => :'attachments',
    :'cc_roles' => :'cc_roles',
    :'client_id' => :'client_id',
    :'field_options' => :'field_options',
    :'form_field_groups' => :'form_field_groups',
    :'form_field_rules' => :'form_field_rules',
    :'merge_fields' => :'merge_fields',
    :'message' => :'message',
    :'metadata' => :'metadata',
    :'subject' => :'subject',
    :'test_mode' => :'test_mode',
    :'title' => :'title',
    :'use_preexisting_fields' => :'use_preexisting_fields'
  }
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



389
390
391
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 389

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

.init(data) ⇒ TemplateCreateRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



169
170
171
172
173
174
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 169

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



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

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



162
163
164
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 162

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



157
158
159
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 157

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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/template_create_request.rb', line 122

def self.openapi_types
  {
    :'form_fields_per_document' => :'Array<SubFormFieldsPerDocumentBase>',
    :'signer_roles' => :'Array<SubTemplateRole>',
    :'files' => :'Array<File>',
    :'file_urls' => :'Array<String>',
    :'allow_reassign' => :'Boolean',
    :'attachments' => :'Array<SubAttachment>',
    :'cc_roles' => :'Array<String>',
    :'client_id' => :'String',
    :'field_options' => :'SubFieldOptions',
    :'form_field_groups' => :'Array<SubFormFieldGroup>',
    :'form_field_rules' => :'Array<SubFormFieldRule>',
    :'merge_fields' => :'Array<SubMergeField>',
    :'message' => :'String',
    :'metadata' => :'Hash<String, Object>',
    :'subject' => :'String',
    :'test_mode' => :'Boolean',
    :'title' => :'String',
    :'use_preexisting_fields' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 351

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      form_fields_per_document == o.form_fields_per_document &&
      signer_roles == o.signer_roles &&
      files == o.files &&
      file_urls == o.file_urls &&
      allow_reassign == o.allow_reassign &&
      attachments == o.attachments &&
      cc_roles == o.cc_roles &&
      client_id == o.client_id &&
      field_options == o.field_options &&
      form_field_groups == o.form_field_groups &&
      form_field_rules == o.form_field_rules &&
      merge_fields == o.merge_fields &&
      message == o.message &&
      metadata == o.metadata &&
      subject == o.subject &&
      test_mode == o.test_mode &&
      title == o.title &&
      use_preexisting_fields == o.use_preexisting_fields
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



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

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



490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 490

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



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 396

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


376
377
378
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 376

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



382
383
384
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 382

def hash
  [form_fields_per_document, signer_roles, files, file_urls, allow_reassign, attachments, cc_roles, client_id, field_options, form_field_groups, form_field_rules, merge_fields, message, metadata, subject, test_mode, title, use_preexisting_fields].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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 292

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

  if @signer_roles.nil?
    invalid_properties.push('invalid value for "signer_roles", signer_roles 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



465
466
467
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 465

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



471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 471

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



459
460
461
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 459

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



315
316
317
318
319
320
321
 
# File 'lib/dropbox-sign/models/template_create_request.rb', line 315

def valid?
  return false if @form_fields_per_document.nil?
  return false if @signer_roles.nil?
  return false if !@message.nil? && @message.to_s.length > 5000
  return false if !@subject.nil? && @subject.to_s.length > 200
  true
end