Class: Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignatureRequestBulkSendWithTemplateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  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::SignatureRequestBulkSendWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_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?(:'signer_file')
    self.signer_file = attributes[:'signer_file']
  end

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


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

def allow_decline
  @allow_decline
end

#ccs ⇒ Array<SubCC>

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

Returns:



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

def ccs
  @ccs
end

#client_id ⇒ String

The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.

Returns:

  • (String) 


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

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:



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

def custom_fields
  @custom_fields
end

#message ⇒ String

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

Returns:

  • (String) 


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

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


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

def metadata
  @metadata
end

#signer_file ⇒ File

‘signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer’s signature page (optional) - ‘sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer’s signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer’s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). NOTE: Not available in test mode and requires a Standard plan or higher. - ‘*_field`: any column with a _field" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: “` name, email_address, pin, company_field George, [email protected], d79a3td, ABC Corp Mary, [email protected], gd9as5b, 123 LLC “`

Returns:

  • (File) 


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

def signer_file
  @signer_file
end

#signer_list ⇒ Array<SubBulkSignerList>

‘signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.

Returns:



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

def signer_list
  @signer_list
end

#signing_redirect_url ⇒ String

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

Returns:

  • (String) 


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

def signing_redirect_url
  @signing_redirect_url
end

#subject ⇒ String

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

Returns:

  • (String) 


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

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


67
68
69
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 67

def test_mode
  @test_mode
end

#title ⇒ String

The title you want to assign to the SignatureRequest.

Returns:

  • (String) 


71
72
73
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 71

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 98

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 74

def self.attribute_map
  {
    :'template_ids' => :'template_ids',
    :'signer_file' => :'signer_file',
    :'signer_list' => :'signer_list',
    :'allow_decline' => :'allow_decline',
    :'ccs' => :'ccs',
    :'client_id' => :'client_id',
    :'custom_fields' => :'custom_fields',
    :'message' => :'message',
    :'metadata' => :'metadata',
    :'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



349
350
351
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 349

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

.init(data) ⇒ SignatureRequestBulkSendWithTemplateRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



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

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



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

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



138
139
140
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 138

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



133
134
135
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 133

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 103

def self.openapi_types
  {
    :'template_ids' => :'Array<String>',
    :'signer_file' => :'File',
    :'signer_list' => :'Array<SubBulkSignerList>',
    :'allow_decline' => :'Boolean',
    :'ccs' => :'Array<SubCC>',
    :'client_id' => :'String',
    :'custom_fields' => :'Array<SubCustomField>',
    :'message' => :'String',
    :'metadata' => :'Hash<String, Object>',
    :'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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 316

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      template_ids == o.template_ids &&
      signer_file == o.signer_file &&
      signer_list == o.signer_list &&
      allow_decline == o.allow_decline &&
      ccs == o.ccs &&
      client_id == o.client_id &&
      custom_fields == o.custom_fields &&
      message == o.message &&
      metadata == o.metadata &&
      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



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

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



450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 450

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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 356

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


336
337
338
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 336

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



342
343
344
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 342

def hash
  [template_ids, signer_file, signer_list, allow_decline, ccs, client_id, custom_fields, message, metadata, 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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 237

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



425
426
427
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 425

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



431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 431

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



419
420
421
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 419

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



260
261
262
263
264
265
266
 
# File 'lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb', line 260

def valid?
  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