Class: SignWell::DocumentTemplateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/signwell_sdk/models/document_template_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentTemplateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 158

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SignWell::DocumentTemplateRequest` 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 (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SignWell::DocumentTemplateRequest`. 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?(:'files')
    if (value = attributes[:'files']).is_a?(Array)
      self.files = value
    end
  else
    self.files = nil
  end

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

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

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

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

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

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

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

  if attributes.key?(:'reminders')
    self.reminders = attributes[:'reminders']
  else
    self.reminders = true
  end

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

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

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

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

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

  if attributes.key?(:'allow_reassign')
    self.allow_reassign = attributes[:'allow_reassign']
  else
    self.allow_reassign = true
  end

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

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

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

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

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

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

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

Instance Attribute Details

#allow_decline ⇒ Object

Whether to allow recipients the option to decline signing a document. If multiple signers are involved in a document, any single recipient can cancel the entire document signing process by declining to sign.



58
59
60
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 58

def allow_decline
  @allow_decline
end

#allow_reassign ⇒ Object

In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else.



61
62
63
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 61

def allow_reassign
  @allow_reassign
end

#api_application_id ⇒ Object

Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings



49
50
51
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 49

def api_application_id
  @api_application_id
end

#apply_signing_order ⇒ Object

When set to true recipients will sign one at a time in the order of the recipients collection of this request.



46
47
48
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 46

def apply_signing_order
  @apply_signing_order
end

#attachment_requests ⇒ Object

Attachments that a recipient must upload to complete the signing process. Attachment requests are shown after all document fields have been completed.



76
77
78
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 76

def attachment_requests
  @attachment_requests
end

#checkbox_groups ⇒ Object

Checkbox fields that are placed on a document can be grouped with selection requirements. At least 2 checkbox fields in an array of fields must be assigned to the same recipient.



82
83
84
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 82

def checkbox_groups
  @checkbox_groups
end

#copied_placeholders ⇒ Object

Copied placeholders are emailed the final document once it has been completed by all recipients.



34
35
36
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 34

def copied_placeholders
  @copied_placeholders
end

#decline_redirect_url ⇒ Object

A URL that recipients are redirected to if the document is declined.



64
65
66
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 64

def decline_redirect_url
  @decline_redirect_url
end

#draft ⇒ Object

Whether the template can still be updated before it is ready for usage. If set to false the template is marked as Available and it will be ready for use. Defaults to false.



37
38
39
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 37

def draft
  @draft
end

#expires_in ⇒ Object

Number of days before the signature request expires. Defaults to the account expiration setting or template expiration (if the document is created from a template).



40
41
42
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 40

def expires_in
  @expires_in
end

#fields ⇒ Object

Document fields placed on a document for collecting data or signatures from recipients. At least one field must be present in the Create Document request if draft is false (unless adding a signature page by using with_signature_page). Field data should be sent as a 2-dimensional JSON array. One array of fields is needed for each file in the files array. An array of fields can be empty if you have a file that does not contain any fields.



73
74
75
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 73

def fields
  @fields
end

#files ⇒ Object

Document files can be uploaded by specifying a file URL or base64 string. Either file_url or file_base64 must be present (not both). Valid file types are: .pdf, .doc, .docx, .pages, .ppt, .pptx, .key, .xls, .xlsx, .numbers, .jpg, .jpeg, .png, .tiff, .tif, .webp, .html, and .htm



19
20
21
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 19

def files
  @files
end

#labels ⇒ Object

Labels can be used to organize documents in a way that can make it easy to find using the document search in SignWell. A document can have multiple labels.



79
80
81
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 79

def labels
  @labels
end

#language ⇒ Object

Sets the language for the template and documents created from the template for all recipient side interactions including the document email and the document itself. Accepted languages: English, Français, Español, Deutsch, Polski, Português, Dansk, Nederlands, Italiano, Русский, Svenska, العربية, Ελληνικά, Türkçe, Slovenčina. Language should be sent in ISO 639-1 format: en, fr, es, de, pl, pt, da, nl, it, ru, sv, ar, el, tr, sk.



67
68
69
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 67

def language
  @language
end

#message ⇒ Object

Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template).



28
29
30
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 28

def message
  @message
end

#metadata ⇒ Object

Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned.



70
71
72
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 70

def metadata
  @metadata
end

#name ⇒ Object

The name of the template.



22
23
24
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 22

def name
  @name
end

#placeholders ⇒ Object

Placeholders are generally job roles that must complete and/or sign the document. For example, a placeholder might be “Client” or “Legal Department”. When a document is created from the template, you assign a person to each placeholder.



31
32
33
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 31

def placeholders
  @placeholders
end

#redirect_url ⇒ Object

A URL that recipients are redirected to after successfully signing a document.



55
56
57
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 55

def redirect_url
  @redirect_url
end

#reminders ⇒ Object

Whether to send signing reminders to recipients. Reminders are sent on day 3, day 6, and day 10 if set to true. Defaults to true.



43
44
45
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 43

def reminders
  @reminders
end

#subject ⇒ Object

Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template).



25
26
27
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 25

def subject
  @subject
end

#text_tags ⇒ Object

An alternative way (if you can’t use the recommended way) of placing fields in specific locations of your document by using special text tags. Useful when changing the content of your files changes the location of fields. See API documentation for “Text Tags” for details. Defaults to false.



52
53
54
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 52

def text_tags
  @text_tags
end

Class Method Details

._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



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
456
457
458
459
460
461
462
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 425

def self._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
    # models (e.g. Pet) or oneOf
    klass = SignWell.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

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



113
114
115
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 113

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



118
119
120
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 118

def self.acceptable_attributes
  acceptable_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
105
106
107
108
109
110
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 85

def self.attribute_map
  {
    :'files' => :'files',
    :'name' => :'name',
    :'subject' => :'subject',
    :'message' => :'message',
    :'placeholders' => :'placeholders',
    :'copied_placeholders' => :'copied_placeholders',
    :'draft' => :'draft',
    :'expires_in' => :'expires_in',
    :'reminders' => :'reminders',
    :'apply_signing_order' => :'apply_signing_order',
    :'api_application_id' => :'api_application_id',
    :'text_tags' => :'text_tags',
    :'redirect_url' => :'redirect_url',
    :'allow_decline' => :'allow_decline',
    :'allow_reassign' => :'allow_reassign',
    :'decline_redirect_url' => :'decline_redirect_url',
    :'language' => :'language',
    :'metadata' => :'metadata',
    :'fields' => :'fields',
    :'attachment_requests' => :'attachment_requests',
    :'labels' => :'labels',
    :'checkbox_groups' => :'checkbox_groups'
  }
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



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 401

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



151
152
153
154
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 151

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

.openapi_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 123

def self.openapi_types
  {
    :'files' => :'Array<FilesInner>',
    :'name' => :'String',
    :'subject' => :'String',
    :'message' => :'String',
    :'placeholders' => :'Array<PlaceholdersInner>',
    :'copied_placeholders' => :'Array<CopiedPlaceholdersInner>',
    :'draft' => :'Boolean',
    :'expires_in' => :'Integer',
    :'reminders' => :'Boolean',
    :'apply_signing_order' => :'Boolean',
    :'api_application_id' => :'String',
    :'text_tags' => :'Boolean',
    :'redirect_url' => :'String',
    :'allow_decline' => :'Boolean',
    :'allow_reassign' => :'Boolean',
    :'decline_redirect_url' => :'String',
    :'language' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'fields' => :'Array<Array<TemplateFieldsInnerInner>>',
    :'attachment_requests' => :'Array<TemplateAttachmentRequestsInner>',
    :'labels' => :'Array<LabelRequest>',
    :'checkbox_groups' => :'Array<TemplateCheckboxGroupsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 359

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      files == o.files &&
      name == o.name &&
      subject == o.subject &&
      message == o.message &&
      placeholders == o.placeholders &&
      copied_placeholders == o.copied_placeholders &&
      draft == o.draft &&
      expires_in == o.expires_in &&
      reminders == o.reminders &&
      apply_signing_order == o.apply_signing_order &&
      api_application_id == o.api_application_id &&
      text_tags == o.text_tags &&
      redirect_url == o.redirect_url &&
      allow_decline == o.allow_decline &&
      allow_reassign == o.allow_reassign &&
      decline_redirect_url == o.decline_redirect_url &&
      language == o.language &&
      metadata == o.metadata &&
      fields == o.fields &&
      attachment_requests == o.attachment_requests &&
      labels == o.labels &&
      checkbox_groups == o.checkbox_groups
end

#_to_hash(value) ⇒ 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



496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 496

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


388
389
390
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 388

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



394
395
396
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 394

def hash
  [files, name, subject, message, placeholders, copied_placeholders, draft, expires_in, reminders, apply_signing_order, api_application_id, text_tags, redirect_url, allow_decline, allow_reassign, decline_redirect_url, language, metadata, fields, attachment_requests, labels, checkbox_groups].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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 295

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @files.nil?
    invalid_properties.push('invalid value for "files", files cannot be nil.')
  end

  if @placeholders.nil?
    invalid_properties.push('invalid value for "placeholders", placeholders cannot be nil.')
  end

  if !@expires_in.nil? && @expires_in < 1
    invalid_properties.push('invalid value for "expires_in", must be greater than or equal to 1.')
  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



472
473
474
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 472

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 478

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



466
467
468
 
# File 'lib/signwell_sdk/models/document_template_request.rb', line 466

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/signwell_sdk/models/document_template_request.rb', line 315

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @files.nil?
  return false if @placeholders.nil?
  return false if !@expires_in.nil? && @expires_in < 1
  true
end