Class: Dropbox::Sign::SignatureRequestSendWithTemplateRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignatureRequestSendWithTemplateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



166
167
168
169
170
171
172
173
174
175
176
177
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
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 166

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

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

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

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

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

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

Instance Attribute Details

#allow_decline ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def allow_decline
  @allow_decline
end

#ccs ⇒ Array<SubCC>

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

Returns:



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

def ccs
  @ccs
end

#client_id ⇒ String

Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.

Returns:

  • (String) 


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

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:



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

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


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

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


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

def files
  @files
end

#is_qualified_signature ⇒ Boolean

Send with a value of ‘true` if you wish to enable [Qualified Electronic Signatures](www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer’s identity.
Note: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in ‘test_mode`. Only works on requests with one signer.

Returns:

  • (Boolean) 


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

def is_qualified_signature
  @is_qualified_signature
end

#message ⇒ String

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

Returns:

  • (String) 


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

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


63
64
65
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 63

def metadata
  @metadata
end

#signers ⇒ Array<SubSignatureRequestTemplateSigner>

Add Signers to your Templated-based Signature Request.

Returns:



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

def signers
  @signers
end

#signing_options ⇒ SubSigningOptions

Returns:



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

def signing_options
  @signing_options
end

#signing_redirect_url ⇒ String

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

Returns:

  • (String) 


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

def signing_redirect_url
  @signing_redirect_url
end

#subject ⇒ String

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

Returns:

  • (String) 


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

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 template will be used.

Returns:

  • (Array<String>) 


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

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


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

def test_mode
  @test_mode
end

#title ⇒ String

The title you want to assign to the SignatureRequest.

Returns:

  • (String) 


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

def title
  @title
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



107
108
109
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 107

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 85

def self.attribute_map
  {
    :'template_ids' => :'template_ids',
    :'signers' => :'signers',
    :'allow_decline' => :'allow_decline',
    :'ccs' => :'ccs',
    :'client_id' => :'client_id',
    :'custom_fields' => :'custom_fields',
    :'files' => :'files',
    :'file_urls' => :'file_urls',
    :'is_qualified_signature' => :'is_qualified_signature',
    :'message' => :'message',
    :'metadata' => :'metadata',
    :'signing_options' => :'signing_options',
    :'signing_redirect_url' => :'signing_redirect_url',
    :'subject' => :'subject',
    :'test_mode' => :'test_mode',
    :'title' => :'title'
  }
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



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

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

.init(data) ⇒ SignatureRequestSendWithTemplateRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



157
158
159
160
161
162
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 157

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



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

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



150
151
152
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 150

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



139
140
141
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 139

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 117

def self.openapi_types
  {
    :'template_ids' => :'Array<String>',
    :'signers' => :'Array<SubSignatureRequestTemplateSigner>',
    :'allow_decline' => :'Boolean',
    :'ccs' => :'Array<SubCC>',
    :'client_id' => :'String',
    :'custom_fields' => :'Array<SubCustomField>',
    :'files' => :'Array<File>',
    :'file_urls' => :'Array<String>',
    :'is_qualified_signature' => :'Boolean',
    :'message' => :'String',
    :'metadata' => :'Hash<String, Object>',
    :'signing_options' => :'SubSigningOptions',
    :'signing_redirect_url' => :'String',
    :'subject' => :'String',
    :'test_mode' => :'Boolean',
    :'title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 340

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



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

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



480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 480

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



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 383

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


363
364
365
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 363

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



369
370
371
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 369

def hash
  [template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_qualified_signature, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title].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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 266

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

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



455
456
457
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 455

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



461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 461

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



449
450
451
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 449

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



293
294
295
296
297
298
299
300
 
# File 'lib/dropbox-sign/models/signature_request_send_with_template_request.rb', line 293

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