Class: SignwellSDK::Models::V1::DocumentSendParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• SignwellSDK::Models::V1::DocumentSendParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/signwell_sdk/models/v1/document_send_params.rb

Overview

See Also:

• Resources::V1::Documents#send_

Instance Attribute Summary

• #allow_decline ⇒ Boolean^?

  Whether to allow recipients the option to decline signing a document.

• #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.

• #api_application_id ⇒ String^?

  Unique identifier for API Application settings to use.

• #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.

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

  Checkbox fields that are placed on a document can be grouped with selection requirements.

• #custom_requester_email ⇒ String^?

  Sets the custom requester email for the document.

• #custom_requester_name ⇒ String^?

  Sets the custom requester name for the document.

• #decline_redirect_url ⇒ String^?

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

• #embedded_signing ⇒ Boolean^?

  When set to ‘true` it enables embedded signing in your website/web application.

• #embedded_signing_notifications ⇒ Boolean^?

  On embedding signing, document owners (and CC’d contacts) do not get a notification email when documents have been completed.

• #expires_in ⇒ Integer^?

  Number of days before the signature request expires.

• #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.

• #message ⇒ String^?

  Email message for the signature request that recipients will see.

• #metadata ⇒ Hash{Symbol=>String}^?

  Optional key-value data that can be associated with the document.

• #name ⇒ String^?

  The name of the document.

• #redirect_url ⇒ String^?

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

• #reminders ⇒ Boolean^?

  Whether to send signing reminders to recipients.

• #subject ⇒ String^?

  Email subject for the signature request that recipients will see.

• #test_mode ⇒ Boolean^?

  Set to ‘true` to enable Test Mode.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(allow_decline: nil, allow_reassign: nil, api_application_id: nil, apply_signing_order: nil, checkbox_groups: nil, custom_requester_email: nil, custom_requester_name: nil, decline_redirect_url: nil, embedded_signing: nil, embedded_signing_notifications: nil, expires_in: nil, labels: nil, message: nil, metadata: nil, name: nil, redirect_url: nil, reminders: nil, subject: nil, test_mode: nil, request_options: {}) ⇒ Object constructor

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

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(allow_decline: nil, allow_reassign: nil, api_application_id: nil, apply_signing_order: nil, checkbox_groups: nil, custom_requester_email: nil, custom_requester_name: nil, decline_redirect_url: nil, embedded_signing: nil, embedded_signing_notifications: nil, expires_in: nil, labels: nil, message: nil, metadata: nil, name: nil, redirect_url: nil, reminders: nil, subject: nil, test_mode: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see SignwellSDK::Models::V1::DocumentSendParams for more details.

Parameters:

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

  Whether to allow recipients the option to decline signing a document. If multipl

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

  In some cases a signer is not the right person to sign and may need to reassign

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

  Unique identifier for API Application settings to use. API Applications are opti

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

  When set to ‘true` recipients will sign one at a time in the order of the `recip

• checkbox_groups (Array<SignwellSDK::Models::V1::CheckboxGroup>) (defaults to: nil) —

  Checkbox fields that are placed on a document can be grouped with selection requ

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

  Sets the custom requester email for the document. When set, this is the email us

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

  Sets the custom requester name for the document. When set, this is the name used

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

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

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

  When set to ‘true` it enables embedded signing in your website/web application.

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

  On embedding signing, document owners (and CC’d contacts) do not get a notificat

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

  Number of days before the signature request expires. Defaults to the account exp

• labels (Array<SignwellSDK::Models::V1::Label>) (defaults to: nil) —

  Labels can be used to organize documents in a way that can make it easy to find

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

  Email message for the signature request that recipients will see. Defaults to th

• metadata (Hash{Symbol=>String}) (defaults to: nil) —

  Optional key-value data that can be associated with the document. If set, will b

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

  The name of the document.

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

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

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

  Whether to send signing reminders to recipients. Reminders are sent on day 3, da

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

  Email subject for the signature request that recipients will see. Defaults to th

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

  Set to ‘true` to enable Test Mode. Documents created with Test Mode do not count

• request_options (SignwellSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 152

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)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 17

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)

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

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)

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

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)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 40

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

#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:

• (Array<SignwellSDK::Models::V1::CheckboxGroup>, nil)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 48

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

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

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 55

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)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 62

optional :custom_requester_name, String

#decline_redirect_url ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 68

optional :decline_redirect_url, String

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

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 76

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)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 84

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)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 92

optional :expires_in, Integer

#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. Updating labels on a document will replace any existing labels for that document.

Returns:

• (Array<SignwellSDK::Models::V1::Label>, nil)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 101

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

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

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 109

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)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 116

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

#name ⇒ String^?

The name of the document.

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 122

optional :name, String

#redirect_url ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 128

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)

# File 'lib/signwell_sdk/models/v1/document_send_params.rb', line 135

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)

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

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)

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

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