Class: SignRequestClient::SignRequestQuickCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/signrequest_client/models/sign_request_quick_create.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignRequestQuickCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
357
358
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
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
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 238

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'from_email')
    self.from_email = attributes[:'from_email']
  end

  if attributes.has_key?(:'from_email_name')
    self.from_email_name = attributes[:'from_email_name']
  end

  if attributes.has_key?(:'is_being_prepared')
    self.is_being_prepared = attributes[:'is_being_prepared']
  end

  if attributes.has_key?(:'prepare_url')
    self.prepare_url = attributes[:'prepare_url']
  end

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

  if attributes.has_key?(:'redirect_url_declined')
    self.redirect_url_declined = attributes[:'redirect_url_declined']
  end

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

  if attributes.has_key?(:'disable_attachments')
    self.disable_attachments = attributes[:'disable_attachments']
  end

  if attributes.has_key?(:'disable_text_signatures')
    self.disable_text_signatures = attributes[:'disable_text_signatures']
  end

  if attributes.has_key?(:'disable_text')
    self.disable_text = attributes[:'disable_text']
  end

  if attributes.has_key?(:'disable_date')
    self.disable_date = attributes[:'disable_date']
  end

  if attributes.has_key?(:'disable_emails')
    self.disable_emails = attributes[:'disable_emails']
  end

  if attributes.has_key?(:'disable_upload_signatures')
    self.disable_upload_signatures = attributes[:'disable_upload_signatures']
  end

  if attributes.has_key?(:'disable_blockchain_proof')
    self.disable_blockchain_proof = attributes[:'disable_blockchain_proof']
  end

  if attributes.has_key?(:'text_message_verification_locked')
    self.text_message_verification_locked = attributes[:'text_message_verification_locked']
  end

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

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

  if attributes.has_key?(:'who')
    self.who = attributes[:'who']
  else
    self.who = 'o'
  end

  if attributes.has_key?(:'send_reminders')
    self.send_reminders = attributes[:'send_reminders']
  end

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

  if attributes.has_key?(:'uuid')
    self.uuid = attributes[:'uuid']
  end

  if attributes.has_key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.has_key?(:'document')
    self.document = attributes[:'document']
  end

  if attributes.has_key?(:'integration')
    self.integration = attributes[:'integration']
  end

  if attributes.has_key?(:'integration_data')
    self.integration_data = attributes[:'integration_data']
  end

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

  if attributes.has_key?(:'external_id')
    self.external_id = attributes[:'external_id']
  end

  if attributes.has_key?(:'frontend_id')
    self.frontend_id = attributes[:'frontend_id']
  end

  if attributes.has_key?(:'file')
    self.file = attributes[:'file']
  end

  if attributes.has_key?(:'file_from_url')
    self.file_from_url = attributes[:'file_from_url']
  end

  if attributes.has_key?(:'events_callback_url')
    self.events_callback_url = attributes[:'events_callback_url']
  end

  if attributes.has_key?(:'file_from_content')
    self.file_from_content = attributes[:'file_from_content']
  end

  if attributes.has_key?(:'file_from_content_name')
    self.file_from_content_name = attributes[:'file_from_content_name']
  end

  if attributes.has_key?(:'template')
    self.template = attributes[:'template']
  end

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

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

  if attributes.has_key?(:'file_from_sf')
    self.file_from_sf = attributes[:'file_from_sf']
  end

  if attributes.has_key?(:'auto_delete_days')
    self.auto_delete_days = attributes[:'auto_delete_days']
  end

  if attributes.has_key?(:'auto_expire_days')
    self.auto_expire_days = attributes[:'auto_expire_days']
  end
end

Instance Attribute Details

#auto_delete_days ⇒ Object

Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted



119
120
121
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 119

def auto_delete_days
  @auto_delete_days
end

#auto_expire_days ⇒ Object

Number of days after which a non finished document will be automatically expired



122
123
124
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 122

def auto_expire_days
  @auto_expire_days
end

#disable_attachments ⇒ Object

Disable uploading/adding of attachments



38
39
40
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 38

def disable_attachments
  @disable_attachments
end

#disable_blockchain_proof ⇒ Object

Disables storing timestamp proof hashes in blockchain integrations.



56
57
58
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 56

def disable_blockchain_proof
  @disable_blockchain_proof
end

#disable_date ⇒ Object

Disable adding of dates



47
48
49
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 47

def disable_date
  @disable_date
end

#disable_emails ⇒ Object

Disable all SignRequest status emails as well as the email that contains the signed documents



50
51
52
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 50

def disable_emails
  @disable_emails
end

#disable_text ⇒ Object

Disable adding of text



44
45
46
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 44

def disable_text
  @disable_text
end

#disable_text_signatures ⇒ Object

Disable usage of signatures generated by typing (text)



41
42
43
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 41

def disable_text_signatures
  @disable_text_signatures
end

#disable_upload_signatures ⇒ Object

Disable usage of uploaded signatures (images)



53
54
55
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 53

def disable_upload_signatures
  @disable_upload_signatures
end

#document ⇒ Object

Returns the value of attribute document.



79
80
81
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 79

def document
  @document
end

#events_callback_url ⇒ Object

URL at which to receive [event callbacks](#section/Events/Events-callback) for this document



101
102
103
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 101

def events_callback_url
  @events_callback_url
end

#external_id ⇒ Object

ID used to reference document in external system



89
90
91
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 89

def external_id
  @external_id
end

#file ⇒ Object

Temporary URL to original file, expires in five minutes



95
96
97
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 95

def file
  @file
end

#file_from_content ⇒ Object

Base64 encoded document content



104
105
106
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 104

def file_from_content
  @file_from_content
end

#file_from_content_name ⇒ Object

Filename, including extension. Required when using file_from_content.



107
108
109
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 107

def file_from_content_name
  @file_from_content_name
end

#file_from_sf ⇒ Object

Returns the value of attribute file_from_sf.



116
117
118
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 116

def file_from_sf
  @file_from_sf
end

#file_from_url ⇒ Object

Publicly accessible URL of document to be downloaded by SignRequest



98
99
100
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 98

def file_from_url
  @file_from_url
end

#from_email ⇒ Object

Email of user sending the SignRequest (must be a validated email)



18
19
20
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 18

def from_email
  @from_email
end

#from_email_name ⇒ Object

Name to be used in the From email header, e.g. ‘#from_email_name <[email protected]>`



21
22
23
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 21

def from_email_name
  @from_email_name
end

#frontend_id ⇒ Object

Shared secret used in conjunction with <a href="#section/Frontend-API/SignRequest-js-client-(beta)">SignRequest-js client</a> to grant user access to a document that’s not a member of the document’s team



92
93
94
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 92

def frontend_id
  @frontend_id
end

#integration ⇒ Object

Returns the value of attribute integration.



81
82
83
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 81

def integration
  @integration
end

#integration_data ⇒ Object

Returns the value of attribute integration_data.



83
84
85
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 83

def integration_data
  @integration_data
end

#integrations ⇒ Object

Returns the value of attribute integrations.



114
115
116
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 114

def integrations
  @integrations
end

#is_being_prepared ⇒ Object

Have the sender of a SignRequest prepare the document before sending the request out, see: [prepare using the web interface](#section/Preparing-a-document/Prepare-using-the-web-interface)



24
25
26
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 24

def is_being_prepared
  @is_being_prepared
end

#message ⇒ Object

Message to include in SignRequest email, may contain the following html tags: a, abbr, acronym, b, blockquote, code, em, i, ul, li, ol, and strong



65
66
67
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 65

def message
  @message
end

#name ⇒ Object

Defaults to filename, including extension



86
87
88
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 86

def name
  @name
end

#prefill_tags ⇒ Object

Prefill signer input data, see [prefill tags](#section/Preparing-a-document/Prefill-tags-templates)



112
113
114
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 112

def prefill_tags
  @prefill_tags
end

#prepare_url ⇒ Object

Returns the value of attribute prepare_url.



26
27
28
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 26

def prepare_url
  @prepare_url
end

#redirect_url ⇒ Object

URL at which SignRequest will redirect to when a document is signed



29
30
31
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 29

def redirect_url
  @redirect_url
end

#redirect_url_declined ⇒ Object

URL at which SignRequest will redirect to when a document is declined



32
33
34
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 32

def redirect_url_declined
  @redirect_url_declined
end

#required_attachments ⇒ Object

Attachments that signers are required to upload



35
36
37
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 35

def required_attachments
  @required_attachments
end

#send_reminders ⇒ Object

Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders)



71
72
73
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 71

def send_reminders
  @send_reminders
end

#signers ⇒ Object

Returns the value of attribute signers.



73
74
75
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 73

def signers
  @signers
end

#subject ⇒ Object

Subject of SignRequest email



62
63
64
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 62

def subject
  @subject
end

#template ⇒ Object

Returns the value of attribute template.



109
110
111
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 109

def template
  @template
end

#text_message_verification_locked ⇒ Object

When true a text message verification is needed before the signer can see the document



59
60
61
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 59

def text_message_verification_locked
  @text_message_verification_locked
end

#url ⇒ Object

Returns the value of attribute url.



77
78
79
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 77

def url
  @url
end

#uuid ⇒ Object

Returns the value of attribute uuid.



75
76
77
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 75

def uuid
  @uuid
end

#who ⇒ Object

m: only me, mo: me and others, o: only others



68
69
70
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 68

def who
  @who
end

Class Method Details

.attribute_map ⇒ Object

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



147
148
149
150
151
152
153
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
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 147

def self.attribute_map
  {
    :'from_email' => :'from_email',
    :'from_email_name' => :'from_email_name',
    :'is_being_prepared' => :'is_being_prepared',
    :'prepare_url' => :'prepare_url',
    :'redirect_url' => :'redirect_url',
    :'redirect_url_declined' => :'redirect_url_declined',
    :'required_attachments' => :'required_attachments',
    :'disable_attachments' => :'disable_attachments',
    :'disable_text_signatures' => :'disable_text_signatures',
    :'disable_text' => :'disable_text',
    :'disable_date' => :'disable_date',
    :'disable_emails' => :'disable_emails',
    :'disable_upload_signatures' => :'disable_upload_signatures',
    :'disable_blockchain_proof' => :'disable_blockchain_proof',
    :'text_message_verification_locked' => :'text_message_verification_locked',
    :'subject' => :'subject',
    :'message' => :'message',
    :'who' => :'who',
    :'send_reminders' => :'send_reminders',
    :'signers' => :'signers',
    :'uuid' => :'uuid',
    :'url' => :'url',
    :'document' => :'document',
    :'integration' => :'integration',
    :'integration_data' => :'integration_data',
    :'name' => :'name',
    :'external_id' => :'external_id',
    :'frontend_id' => :'frontend_id',
    :'file' => :'file',
    :'file_from_url' => :'file_from_url',
    :'events_callback_url' => :'events_callback_url',
    :'file_from_content' => :'file_from_content',
    :'file_from_content_name' => :'file_from_content_name',
    :'template' => :'template',
    :'prefill_tags' => :'prefill_tags',
    :'integrations' => :'integrations',
    :'file_from_sf' => :'file_from_sf',
    :'auto_delete_days' => :'auto_delete_days',
    :'auto_expire_days' => :'auto_expire_days'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 192

def self.swagger_types
  {
    :'from_email' => :'String',
    :'from_email_name' => :'String',
    :'is_being_prepared' => :'BOOLEAN',
    :'prepare_url' => :'String',
    :'redirect_url' => :'String',
    :'redirect_url_declined' => :'String',
    :'required_attachments' => :'Array<RequiredAttachment>',
    :'disable_attachments' => :'BOOLEAN',
    :'disable_text_signatures' => :'BOOLEAN',
    :'disable_text' => :'BOOLEAN',
    :'disable_date' => :'BOOLEAN',
    :'disable_emails' => :'BOOLEAN',
    :'disable_upload_signatures' => :'BOOLEAN',
    :'disable_blockchain_proof' => :'BOOLEAN',
    :'text_message_verification_locked' => :'BOOLEAN',
    :'subject' => :'String',
    :'message' => :'String',
    :'who' => :'String',
    :'send_reminders' => :'BOOLEAN',
    :'signers' => :'Array<Signer>',
    :'uuid' => :'String',
    :'url' => :'String',
    :'document' => :'String',
    :'integration' => :'String',
    :'integration_data' => :'Object',
    :'name' => :'String',
    :'external_id' => :'String',
    :'frontend_id' => :'String',
    :'file' => :'String',
    :'file_from_url' => :'String',
    :'events_callback_url' => :'String',
    :'file_from_content' => :'String',
    :'file_from_content_name' => :'String',
    :'template' => :'String',
    :'prefill_tags' => :'Array<InlinePrefillTags>',
    :'integrations' => :'Array<InlineIntegrationData>',
    :'file_from_sf' => :'FileFromSf',
    :'auto_delete_days' => :'Integer',
    :'auto_expire_days' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 692

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from_email == o.from_email &&
      from_email_name == o.from_email_name &&
      is_being_prepared == o.is_being_prepared &&
      prepare_url == o.prepare_url &&
      redirect_url == o.redirect_url &&
      redirect_url_declined == o.redirect_url_declined &&
      required_attachments == o.required_attachments &&
      disable_attachments == o.disable_attachments &&
      disable_text_signatures == o.disable_text_signatures &&
      disable_text == o.disable_text &&
      disable_date == o.disable_date &&
      disable_emails == o.disable_emails &&
      disable_upload_signatures == o.disable_upload_signatures &&
      disable_blockchain_proof == o.disable_blockchain_proof &&
      text_message_verification_locked == o.text_message_verification_locked &&
      subject == o.subject &&
      message == o.message &&
      who == o.who &&
      send_reminders == o.send_reminders &&
      signers == o.signers &&
      uuid == o.uuid &&
      url == o.url &&
      document == o.document &&
      integration == o.integration &&
      integration_data == o.integration_data &&
      name == o.name &&
      external_id == o.external_id &&
      frontend_id == o.frontend_id &&
      file == o.file &&
      file_from_url == o.file_from_url &&
      events_callback_url == o.events_callback_url &&
      file_from_content == o.file_from_content &&
      file_from_content_name == o.file_from_content_name &&
      template == o.template &&
      prefill_tags == o.prefill_tags &&
      integrations == o.integrations &&
      file_from_sf == o.file_from_sf &&
      auto_delete_days == o.auto_delete_days &&
      auto_expire_days == o.auto_expire_days
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



772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 772

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = SignRequestClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 838

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

#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



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 751

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


738
739
740
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 738

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



744
745
746
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 744

def hash
  [from_email, from_email_name, is_being_prepared, prepare_url, redirect_url, redirect_url_declined, required_attachments, disable_attachments, disable_text_signatures, disable_text, disable_date, disable_emails, disable_upload_signatures, disable_blockchain_proof, text_message_verification_locked, subject, message, who, send_reminders, signers, uuid, url, document, integration, integration_data, name, external_id, frontend_id, file, file_from_url, events_callback_url, file_from_content, file_from_content_name, template, prefill_tags, integrations, file_from_sf, auto_delete_days, auto_expire_days].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



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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 413

def list_invalid_properties
  invalid_properties = Array.new
  if !@from_email.nil? && @from_email.to_s.length > 255
    invalid_properties.push('invalid value for "from_email", the character length must be smaller than or equal to 255.')
  end

  if !@from_email.nil? && @from_email.to_s.length < 1
    invalid_properties.push('invalid value for "from_email", the character length must be great than or equal to 1.')
  end

  if !@from_email_name.nil? && @from_email_name.to_s.length > 255
    invalid_properties.push('invalid value for "from_email_name", the character length must be smaller than or equal to 255.')
  end

  if !@prepare_url.nil? && @prepare_url.to_s.length < 1
    invalid_properties.push('invalid value for "prepare_url", the character length must be great than or equal to 1.')
  end

  if !@redirect_url.nil? && @redirect_url.to_s.length > 2100
    invalid_properties.push('invalid value for "redirect_url", the character length must be smaller than or equal to 2100.')
  end

  if !@redirect_url_declined.nil? && @redirect_url_declined.to_s.length > 2100
    invalid_properties.push('invalid value for "redirect_url_declined", the character length must be smaller than or equal to 2100.')
  end

  if !@subject.nil? && @subject.to_s.length > 512
    invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 512.')
  end

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

  if !@uuid.nil? && @uuid.to_s.length < 1
    invalid_properties.push('invalid value for "uuid", the character length must be great than or equal to 1.')
  end

  if !@name.nil? && @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  if !@external_id.nil? && @external_id.to_s.length > 255
    invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 255.')
  end

  if !@frontend_id.nil? && @frontend_id.to_s.length > 255
    invalid_properties.push('invalid value for "frontend_id", the character length must be smaller than or equal to 255.')
  end

  if !@file_from_url.nil? && @file_from_url.to_s.length > 2100
    invalid_properties.push('invalid value for "file_from_url", the character length must be smaller than or equal to 2100.')
  end

  if !@events_callback_url.nil? && @events_callback_url.to_s.length > 2100
    invalid_properties.push('invalid value for "events_callback_url", the character length must be smaller than or equal to 2100.')
  end

  if !@auto_delete_days.nil? && @auto_delete_days > 730
    invalid_properties.push('invalid value for "auto_delete_days", must be smaller than or equal to 730.')
  end

  if !@auto_delete_days.nil? && @auto_delete_days < 1
    invalid_properties.push('invalid value for "auto_delete_days", must be greater than or equal to 1.')
  end

  if !@auto_expire_days.nil? && @auto_expire_days > 730
    invalid_properties.push('invalid value for "auto_expire_days", must be smaller than or equal to 730.')
  end

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



818
819
820
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 818

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



824
825
826
827
828
829
830
831
832
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 824

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



812
813
814
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 812

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



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/signrequest_client/models/sign_request_quick_create.rb', line 492

def valid?
  return false if !@from_email.nil? && @from_email.to_s.length > 255
  return false if !@from_email.nil? && @from_email.to_s.length < 1
  return false if !@from_email_name.nil? && @from_email_name.to_s.length > 255
  return false if !@prepare_url.nil? && @prepare_url.to_s.length < 1
  return false if !@redirect_url.nil? && @redirect_url.to_s.length > 2100
  return false if !@redirect_url_declined.nil? && @redirect_url_declined.to_s.length > 2100
  return false if !@subject.nil? && @subject.to_s.length > 512
  who_validator = EnumAttributeValidator.new('String', ['m', 'mo', 'o'])
  return false unless who_validator.valid?(@who)
  return false if @signers.nil?
  return false if !@uuid.nil? && @uuid.to_s.length < 1
  integration_validator = EnumAttributeValidator.new('String', ['mfiles', 'salesforce', 'formdesk', 'zapier'])
  return false unless integration_validator.valid?(@integration)
  return false if !@name.nil? && @name.to_s.length > 255
  return false if !@external_id.nil? && @external_id.to_s.length > 255
  return false if !@frontend_id.nil? && @frontend_id.to_s.length > 255
  return false if !@file_from_url.nil? && @file_from_url.to_s.length > 2100
  return false if !@events_callback_url.nil? && @events_callback_url.to_s.length > 2100
  return false if !@auto_delete_days.nil? && @auto_delete_days > 730
  return false if !@auto_delete_days.nil? && @auto_delete_days < 1
  return false if !@auto_expire_days.nil? && @auto_expire_days > 730
  return false if !@auto_expire_days.nil? && @auto_expire_days < 1
  true
end