Class: SignwellSDK::Models::V1::DocumentCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/signwell_sdk/models/v1/document_create_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Field, Recipient

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, email:, message: nil, name: nil, passcode: nil, send_email: nil, send_email_delay: nil, subject: nil) ⇒ Object

Some parameter documentations has been truncated, see Recipient for more details.

Parameters:

  • id (String) —

    A unique identifier that you will give to each recipient. We recommend numbering

  • email (String) —

    Email address for the recipient.

  • message (String) (defaults to: nil) —

    Email message for the signature request that the recipient will see. Overrides t

  • name (String) (defaults to: nil) —

    Name of the recipient.

  • passcode (String) (defaults to: nil) —

    If set, signers assigned with a passcode will be required to enter the passcode

  • send_email (Boolean) (defaults to: nil) —

    Applies on when ‘embedded_signing` is `true`. By default, recipients are not not

  • send_email_delay (Integer) (defaults to: nil) —

    If ‘send_email` is `true` recipients will receive a new document notification im

  • subject (String) (defaults to: nil) —

    Email subject for the signature request that the recipient will see. Overrides t




# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 350

Instance Attribute Details

#allow_decline ⇒ Boolean?

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.

Returns:

  • (Boolean, nil) 


33
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 33

optional :allow_decline, SignwellSDK::Internal::Type::Boolean

#allow_reassign ⇒ Boolean?

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.

Returns:

  • (Boolean, nil) 


41
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 41

optional :allow_reassign, SignwellSDK::Internal::Type::Boolean

#api_application_id ⇒ String?

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

Returns:

  • (String, nil) 


49
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 49

optional :api_application_id, String

#apply_signing_order ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


56
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 56

optional :apply_signing_order, SignwellSDK::Internal::Type::Boolean

#attachment_requests ⇒ Array<SignwellSDK::Models::V1::AttachmentRequest>?

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

Returns:



63
64
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 63

optional :attachment_requests,
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::AttachmentRequest] }

#checkbox_groups ⇒ Array<SignwellSDK::Models::V1::CheckboxGroup>?

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.

Returns:



72
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 72

optional :checkbox_groups, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::CheckboxGroup] }

#copied_contacts ⇒ Array<SignwellSDK::Models::V1::CopiedContact>?

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

Returns:



79
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 79

optional :copied_contacts, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::CopiedContact] }

#custom_requester_email ⇒ String?

Sets the custom requester email for the document. When set, this is the email used for all email communications, signing notifications, and in the audit file.

Returns:

  • (String, nil) 


86
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 86

optional :custom_requester_email, String

#custom_requester_name ⇒ String?

Sets the custom requester name for the document. When set, this is the name used for all email communications, signing notifications, and in the audit file.

Returns:

  • (String, nil) 


93
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 93

optional :custom_requester_name, String

#decline_redirect_url ⇒ String?

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

Returns:

  • (String, nil) 


99
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 99

optional :decline_redirect_url, String

#draft ⇒ Boolean?

Whether the document can still be updated before sending a signature request. If set to ‘false` the document is sent for signing as part of this request. Defaults to `false`.

Returns:

  • (Boolean, nil) 


107
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 107

optional :draft, SignwellSDK::Internal::Type::Boolean

#embedded_signing ⇒ Boolean?

When set to ‘true` it enables embedded signing in your website/web application. Embedded functionality works with an iFrame and email authentication is disabled. :embedded_signinig defaults to `false`.

Returns:

  • (Boolean, nil) 


115
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 115

optional :embedded_signing, SignwellSDK::Internal::Type::Boolean

#embedded_signing_notifications ⇒ Boolean?

On embedding signing, document owners (and CC’d contacts) do not get a notification email when documents have been completed. Setting this param to ‘true` will send out those final completed notifications. Default is `false`

Returns:

  • (Boolean, nil) 


123
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 123

optional :embedded_signing_notifications, SignwellSDK::Internal::Type::Boolean

#expires_in ⇒ Integer?

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

Returns:

  • (Integer, nil) 


131
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 131

optional :expires_in, Integer

#fields ⇒ Array<Array<SignwellSDK::Models::V1::DocumentCreateParams::Field>>?

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.

Returns:



142
143
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 142

optional :fields,
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentCreateParams::Field]] }

#files ⇒ Array<SignwellSDK::Models::V1::DocumentFile>

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

Returns:



18
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 18

required :files, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentFile] }

#labels ⇒ Array<SignwellSDK::Models::V1::Label>?

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.

Returns:



150
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 150

optional :labels, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Label] }

#language ⇒ String?

Sets the language for all recipients on the document and updates 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. Defaults to English. Language should be sent in ISO 639-1 format: en, fr, es, de, pl, pt, da, nl, it, ru, sv, ar, el, tr, sk.

Returns:

  • (String, nil) 


161
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 161

optional :language, String

#message ⇒ String?

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

Returns:

  • (String, nil) 


169
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 169

optional :message, String

#metadata ⇒ Hash{Symbol=>String}?

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

Returns:

  • (Hash{Symbol=>String}, nil) 


176
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 176

optional :metadata, SignwellSDK::Internal::Type::HashOf[String]

#name ⇒ String?

The name of the document.

Returns:

  • (String, nil) 


182
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 182

optional :name, String

#recipients ⇒ Array<SignwellSDK::Models::V1::DocumentCreateParams::Recipient>

Document recipients are people that must complete and/or sign a document.

Returns:



24
25
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 24

required :recipients,
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentCreateParams::Recipient] }

#redirect_url ⇒ String?

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

Returns:

  • (String, nil) 


188
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 188

optional :redirect_url, String

#reminders ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


195
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 195

optional :reminders, SignwellSDK::Internal::Type::Boolean

#subject ⇒ String?

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

Returns:

  • (String, nil) 


203
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 203

optional :subject, String

#test_mode ⇒ Boolean?

Set to ‘true` to enable Test Mode. Documents created with Test Mode do not count towards API billing and are not legally binding. Defaults to `false`

Returns:

  • (Boolean, nil) 


210
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 210

optional :test_mode, SignwellSDK::Internal::Type::Boolean

#text_tags ⇒ Boolean?

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.

Returns:

  • (Boolean, nil) 


219
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 219

optional :text_tags, SignwellSDK::Internal::Type::Boolean

#with_signature_page ⇒ Boolean?

When set to ‘true` the document will have a signature page added to the end, and all signers will be required to add their signature on that page.

Returns:

  • (Boolean, nil) 


226
 
# File 'lib/signwell_sdk/models/v1/document_create_params.rb', line 226

optional :with_signature_page, SignwellSDK::Internal::Type::Boolean