dropbox-sign 1.1.2 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +6 -3
- data/README.md +9 -4
- data/VERSION +1 -1
- data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -0
- data/docs/EmbeddedEditUrlRequest.md +1 -1
- data/docs/EventCallbackRequestEvent.md +1 -1
- data/docs/OAuthApi.md +0 -16
- data/docs/SignatureRequestApi.md +11 -10
- data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestCreateEmbeddedRequest.md +4 -4
- data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestResponse.md +2 -0
- data/docs/SignatureRequestSendRequest.md +5 -4
- data/docs/SignatureRequestSendWithTemplateRequest.md +2 -1
- data/docs/SignatureRequestUpdateRequest.md +2 -2
- data/docs/SubAttachment.md +1 -1
- data/docs/SubCustomField.md +1 -1
- data/docs/SubFieldOptions.md +1 -1
- data/docs/SubFormFieldsPerDocumentBase.md +2 -2
- data/docs/SubFormFieldsPerDocumentDateSigned.md +2 -0
- data/docs/SubFormFieldsPerDocumentDropdown.md +2 -0
- data/docs/SubFormFieldsPerDocumentFontEnum.md +9 -0
- data/docs/SubFormFieldsPerDocumentHyperlink.md +2 -0
- data/docs/SubFormFieldsPerDocumentText.md +4 -1
- data/docs/SubFormFieldsPerDocumentTextMerge.md +2 -0
- data/docs/SubSignatureRequestGroupedSigners.md +1 -1
- data/docs/SubSignatureRequestSigner.md +1 -1
- data/docs/SubSignatureRequestTemplateSigner.md +1 -1
- data/docs/SubSigningOptions.md +1 -1
- data/docs/SubWhiteLabelingOptions.md +1 -1
- data/docs/TeamAddMemberRequest.md +1 -1
- data/docs/TeamRemoveMemberRequest.md +2 -2
- data/docs/TemplateAddUserRequest.md +2 -2
- data/docs/TemplateApi.md +106 -3
- data/docs/TemplateCreateEmbeddedDraftRequest.md +2 -2
- data/docs/TemplateCreateRequest.md +27 -0
- data/docs/TemplateCreateResponse.md +11 -0
- data/docs/TemplateCreateResponseTemplate.md +10 -0
- data/docs/TemplateResponseDocument.md +1 -1
- data/docs/TemplateResponseDocumentStaticFieldBase.md +1 -1
- data/docs/UnclaimedDraftApi.md +3 -3
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +4 -4
- data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +4 -3
- data/docs/UnclaimedDraftCreateRequest.md +2 -2
- data/examples/OauthTokenGenerate.rb +0 -8
- data/examples/OauthTokenRefresh.rb +0 -8
- data/examples/SignatureRequestEdit.rb +58 -0
- data/examples/SignatureRequestEditEmbedded.rb +48 -0
- data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +41 -0
- data/examples/SignatureRequestEditWithTemplate.rb +52 -0
- data/examples/TemplateCreate.rb +49 -0
- data/lib/dropbox-sign/api/api_app_api.rb +1 -1
- data/lib/dropbox-sign/api/signature_request_api.rb +17 -14
- data/lib/dropbox-sign/api/team_api.rb +1 -1
- data/lib/dropbox-sign/api/template_api.rb +112 -0
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +6 -6
- data/lib/dropbox-sign/event_callback_helper.rb +1 -1
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +13 -1
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +1 -1
- data/lib/dropbox-sign/models/event_callback_request_event.rb +2 -7
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +4 -4
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_response.rb +28 -4
- data/lib/dropbox-sign/models/signature_request_send_request.rb +18 -5
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +15 -2
- data/lib/dropbox-sign/models/signature_request_update_request.rb +2 -2
- data/lib/dropbox-sign/models/sub_attachment.rb +1 -1
- data/lib/dropbox-sign/models/sub_custom_field.rb +1 -1
- data/lib/dropbox-sign/models/sub_field_options.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +2 -2
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +62 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +62 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +54 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +62 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +52 -5
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +62 -4
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +1 -1
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +1 -1
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +1 -1
- data/lib/dropbox-sign/models/sub_signing_options.rb +1 -1
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +1 -1
- data/lib/dropbox-sign/models/team_add_member_request.rb +1 -1
- data/lib/dropbox-sign/models/team_remove_member_request.rb +2 -2
- data/lib/dropbox-sign/models/template_add_user_request.rb +2 -2
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +2 -2
- data/lib/dropbox-sign/models/template_create_request.rb +509 -0
- data/lib/dropbox-sign/models/template_create_response.rb +263 -0
- data/lib/dropbox-sign/models/template_create_response_template.rb +252 -0
- data/lib/dropbox-sign/models/template_response_document.rb +1 -1
- data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +1 -1
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +4 -4
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +20 -7
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +2 -2
- data/lib/dropbox-sign/version.rb +1 -1
- data/lib/dropbox-sign.rb +4 -0
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +1010 -499
- data/spec/event_callback_helper_spec.rb +17 -3
- data/templates/event_callback_helper.mustache +1 -1
- data/test_fixtures/EventCallbackHelper_AccountCallbacks.json +82 -0
- data/test_fixtures/{EventCallbackHelper.json → EventCallbackHelper_AppCallbacks.json} +8 -4
- data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +6 -2
- data/test_fixtures/SignatureRequestSendRequest.json +20 -8
- data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +1 -0
- data/test_fixtures/SubFormFieldsPerDocument.json +8 -4
- data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +3 -1
- data/test_fixtures/TemplateCreateRequest.json +120 -0
- data/test_fixtures/TemplateCreateResponse.json +7 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +3 -1
- data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +2 -1
- data/test_fixtures/UnclaimedDraftCreateRequest.json +3 -1
- metadata +27 -11
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f4fd3f8f12a3fb32891d97e33879626fa74968ef7dc42b6c776719050403d2ab
|
4
|
+
data.tar.gz: 12bca7ef36e1c8b70d3a9a90203e8571fdd6f326feb59b1cb83dde8dac81eca2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0d213ff3b27c639fcd4595c7fa0ff033c40d5b0a63efa0f9e97ea6c4021a8b524e3130da971c0152324877c827e6aeb091797cc49d5a14011d44b5fe13f89ab0
|
7
|
+
data.tar.gz: c2d43976c66b990c24f631d25d24ae8aa5885a2e903701ef06a61de96a35a470b502da8fec8d00a99910b65d1165d4c02d396a49dbfc1205f3a3ee348fa2868d
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
dropbox-sign (1.1
|
4
|
+
dropbox-sign (1.4.1)
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
6
6
|
|
7
7
|
GEM
|
@@ -13,7 +13,10 @@ GEM
|
|
13
13
|
diff-lcs (1.5.0)
|
14
14
|
ethon (0.16.0)
|
15
15
|
ffi (>= 1.15.0)
|
16
|
-
ffi (1.
|
16
|
+
ffi (1.17.0-aarch64-linux-gnu)
|
17
|
+
ffi (1.17.0-arm64-darwin)
|
18
|
+
ffi (1.17.0-x86_64-darwin)
|
19
|
+
ffi (1.17.0-x86_64-linux-gnu)
|
17
20
|
jaro_winkler (1.5.4)
|
18
21
|
json_spec (1.1.5)
|
19
22
|
multi_json (~> 1.0)
|
@@ -56,7 +59,7 @@ GEM
|
|
56
59
|
unicode-display_width (>= 1.4.0, < 1.6)
|
57
60
|
ruby-progressbar (1.11.0)
|
58
61
|
stringio (3.0.1)
|
59
|
-
typhoeus (1.4.
|
62
|
+
typhoeus (1.4.1)
|
60
63
|
ethon (>= 0.9.0)
|
61
64
|
unicode-display_width (1.5.0)
|
62
65
|
|
data/README.md
CHANGED
@@ -25,7 +25,7 @@ directory that corresponds to the file you want updated.
|
|
25
25
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
26
26
|
|
27
27
|
- API version: 3.0.0
|
28
|
-
- Package version: 1.1
|
28
|
+
- Package version: 1.4.1
|
29
29
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
30
30
|
|
31
31
|
## Installation
|
@@ -46,14 +46,14 @@ gem build dropbox-sign.gemspec
|
|
46
46
|
Then install the gem locally:
|
47
47
|
|
48
48
|
```shell
|
49
|
-
gem install ./dropbox-sign-1.1.
|
49
|
+
gem install ./dropbox-sign-1.4.1.gem
|
50
50
|
```
|
51
51
|
|
52
|
-
(for development, run `gem install --dev ./dropbox-sign-1.1.
|
52
|
+
(for development, run `gem install --dev ./dropbox-sign-1.4.1.gem` to install the development dependencies)
|
53
53
|
|
54
54
|
Finally add this to the Gemfile:
|
55
55
|
|
56
|
-
gem 'dropbox-sign', '~> 1.1
|
56
|
+
gem 'dropbox-sign', '~> 1.4.1'
|
57
57
|
|
58
58
|
### Install from Git
|
59
59
|
|
@@ -149,6 +149,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
149
149
|
|*Dropbox::Sign::TeamApi* | [**team_sub_teams**](docs/TeamApi.md#team_sub_teams) | **GET** /team/sub_teams/{team_id} | List Sub Teams |
|
150
150
|
|*Dropbox::Sign::TeamApi* | [**team_update**](docs/TeamApi.md#team_update) | **PUT** /team | Update Team |
|
151
151
|
|*Dropbox::Sign::TemplateApi* | [**template_add_user**](docs/TemplateApi.md#template_add_user) | **POST** /template/add_user/{template_id} | Add User to Template |
|
152
|
+
|*Dropbox::Sign::TemplateApi* | [**template_create**](docs/TemplateApi.md#template_create) | **POST** /template/create | Create Template |
|
152
153
|
|*Dropbox::Sign::TemplateApi* | [**template_create_embedded_draft**](docs/TemplateApi.md#template_create_embedded_draft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft |
|
153
154
|
|*Dropbox::Sign::TemplateApi* | [**template_delete**](docs/TemplateApi.md#template_delete) | **POST** /template/delete/{template_id} | Delete Template |
|
154
155
|
|*Dropbox::Sign::TemplateApi* | [**template_files**](docs/TemplateApi.md#template_files) | **GET** /template/files/{template_id} | Get Template Files |
|
@@ -252,6 +253,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
252
253
|
- [Dropbox::Sign::SubFormFieldsPerDocumentCheckboxMerge](docs/SubFormFieldsPerDocumentCheckboxMerge.md)
|
253
254
|
- [Dropbox::Sign::SubFormFieldsPerDocumentDateSigned](docs/SubFormFieldsPerDocumentDateSigned.md)
|
254
255
|
- [Dropbox::Sign::SubFormFieldsPerDocumentDropdown](docs/SubFormFieldsPerDocumentDropdown.md)
|
256
|
+
- [Dropbox::Sign::SubFormFieldsPerDocumentFontEnum](docs/SubFormFieldsPerDocumentFontEnum.md)
|
255
257
|
- [Dropbox::Sign::SubFormFieldsPerDocumentHyperlink](docs/SubFormFieldsPerDocumentHyperlink.md)
|
256
258
|
- [Dropbox::Sign::SubFormFieldsPerDocumentInitials](docs/SubFormFieldsPerDocumentInitials.md)
|
257
259
|
- [Dropbox::Sign::SubFormFieldsPerDocumentRadio](docs/SubFormFieldsPerDocumentRadio.md)
|
@@ -289,6 +291,9 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
289
291
|
- [Dropbox::Sign::TemplateCreateEmbeddedDraftRequest](docs/TemplateCreateEmbeddedDraftRequest.md)
|
290
292
|
- [Dropbox::Sign::TemplateCreateEmbeddedDraftResponse](docs/TemplateCreateEmbeddedDraftResponse.md)
|
291
293
|
- [Dropbox::Sign::TemplateCreateEmbeddedDraftResponseTemplate](docs/TemplateCreateEmbeddedDraftResponseTemplate.md)
|
294
|
+
- [Dropbox::Sign::TemplateCreateRequest](docs/TemplateCreateRequest.md)
|
295
|
+
- [Dropbox::Sign::TemplateCreateResponse](docs/TemplateCreateResponse.md)
|
296
|
+
- [Dropbox::Sign::TemplateCreateResponseTemplate](docs/TemplateCreateResponseTemplate.md)
|
292
297
|
- [Dropbox::Sign::TemplateEditResponse](docs/TemplateEditResponse.md)
|
293
298
|
- [Dropbox::Sign::TemplateGetResponse](docs/TemplateGetResponse.md)
|
294
299
|
- [Dropbox::Sign::TemplateListResponse](docs/TemplateListResponse.md)
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.1
|
1
|
+
1.4.1
|
@@ -24,6 +24,7 @@
|
|
24
24
|
| `details_url` | ```String``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | |
|
25
25
|
| `cc_email_addresses` | ```Array<String>``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | |
|
26
26
|
| `signing_redirect_url` | ```String``` | The URL you want the signer redirected to after they successfully sign. | |
|
27
|
+
| `final_copy_uri` | ```String``` | The path where the completed document can be downloaded | |
|
27
28
|
| `template_ids` | ```Array<String>``` | Templates IDs used in this SignatureRequest (if any). | |
|
28
29
|
| `custom_fields` | [```Array<SignatureRequestResponseCustomFieldBase>```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.<br><br>* Text Field uses `SignatureRequestResponseCustomFieldText`<br>* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | |
|
29
30
|
| `attachments` | [```Array<SignatureRequestResponseAttachment>```](SignatureRequestResponseAttachment.md) | Signer attachments. | |
|
@@ -12,7 +12,7 @@
|
|
12
12
|
| `force_signer_roles` | ```Boolean``` | Provide users the ability to review/edit the template signer roles. | [default to false] |
|
13
13
|
| `force_subject_message` | ```Boolean``` | Provide users the ability to review/edit the template subject and message. | [default to false] |
|
14
14
|
| `merge_fields` | [```Array<SubMergeField>```](SubMergeField.md) | Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.<br><br>Remove all merge fields on the template by passing an empty array `[]`. | |
|
15
|
-
| `preview_only` | ```Boolean``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).<br><br>**
|
15
|
+
| `preview_only` | ```Boolean``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).<br><br>**NOTE:** This parameter overwrites `show_preview=true` (if set). | [default to false] |
|
16
16
|
| `show_preview` | ```Boolean``` | This allows the requester to enable the editor/preview experience. | [default to false] |
|
17
17
|
| `show_progress_stepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] |
|
18
18
|
| `test_mode` | ```Boolean``` | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [default to false] |
|
@@ -9,5 +9,5 @@ Basic information about the event that occurred.
|
|
9
9
|
| `event_time`<sup>*_required_</sup> | ```String``` | Time the event was created (using Unix time). | |
|
10
10
|
| `event_type`<sup>*_required_</sup> | ```String``` | Type of callback event that was triggered. | |
|
11
11
|
| `event_hash`<sup>*_required_</sup> | ```String``` | Generated hash used to verify source of event data. | |
|
12
|
-
| `event_metadata
|
12
|
+
| `event_metadata` | [```EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | | |
|
13
13
|
|
data/docs/OAuthApi.md
CHANGED
@@ -21,14 +21,6 @@ Once you have retrieved the code from the user callback, you will need to exchan
|
|
21
21
|
```ruby
|
22
22
|
require "dropbox-sign"
|
23
23
|
|
24
|
-
Dropbox::Sign.configure do |config|
|
25
|
-
# Configure HTTP basic authorization: api_key
|
26
|
-
config.username = "YOUR_API_KEY"
|
27
|
-
|
28
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
29
|
-
# config.access_token = "YOUR_ACCESS_TOKEN"
|
30
|
-
end
|
31
|
-
|
32
24
|
oauth_api = Dropbox::Sign::OAuthApi.new
|
33
25
|
|
34
26
|
data = Dropbox::Sign::OAuthTokenGenerateRequest.new
|
@@ -97,14 +89,6 @@ Access tokens are only valid for a given period of time (typically one hour) for
|
|
97
89
|
```ruby
|
98
90
|
require "dropbox-sign"
|
99
91
|
|
100
|
-
Dropbox::Sign.configure do |config|
|
101
|
-
# Configure HTTP basic authorization: api_key
|
102
|
-
config.username = "YOUR_API_KEY"
|
103
|
-
|
104
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
105
|
-
# config.access_token = "YOUR_ACCESS_TOKEN"
|
106
|
-
end
|
107
|
-
|
108
92
|
oauth_api = Dropbox::Sign::OAuthApi.new
|
109
93
|
|
110
94
|
data = Dropbox::Sign::OAuthTokenRefreshRequest.new
|
data/docs/SignatureRequestApi.md
CHANGED
@@ -28,7 +28,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
28
28
|
|
29
29
|
Embedded Bulk Send with Template
|
30
30
|
|
31
|
-
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE
|
31
|
+
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
|
32
32
|
|
33
33
|
### Examples
|
34
34
|
|
@@ -139,7 +139,7 @@ end
|
|
139
139
|
|
140
140
|
Bulk Send with Template
|
141
141
|
|
142
|
-
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE
|
142
|
+
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
|
143
143
|
|
144
144
|
### Examples
|
145
145
|
|
@@ -249,7 +249,7 @@ end
|
|
249
249
|
|
250
250
|
Cancel Incomplete Signature Request
|
251
251
|
|
252
|
-
Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE
|
252
|
+
Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
|
253
253
|
|
254
254
|
### Examples
|
255
255
|
|
@@ -321,7 +321,7 @@ nil (empty response body)
|
|
321
321
|
|
322
322
|
Create Embedded Signature Request
|
323
323
|
|
324
|
-
Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
|
324
|
+
Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
325
325
|
|
326
326
|
### Examples
|
327
327
|
|
@@ -419,7 +419,7 @@ end
|
|
419
419
|
|
420
420
|
Create Embedded Signature Request with Template
|
421
421
|
|
422
|
-
Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame.
|
422
|
+
Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
423
423
|
|
424
424
|
### Examples
|
425
425
|
|
@@ -651,7 +651,7 @@ end
|
|
651
651
|
|
652
652
|
## `signature_request_files_as_file_url`
|
653
653
|
|
654
|
-
> `<FileResponse> signature_request_files_as_file_url(signature_request_id)`
|
654
|
+
> `<FileResponse> signature_request_files_as_file_url(signature_request_id, opts)`
|
655
655
|
|
656
656
|
Download Files as File Url
|
657
657
|
|
@@ -687,12 +687,12 @@ end
|
|
687
687
|
|
688
688
|
This returns an Array which contains the response data, status code and headers.
|
689
689
|
|
690
|
-
> `<Array(<FileResponse>, Integer, Hash)> signature_request_files_as_file_url_with_http_info(signature_request_id)`
|
690
|
+
> `<Array(<FileResponse>, Integer, Hash)> signature_request_files_as_file_url_with_http_info(signature_request_id, opts)`
|
691
691
|
|
692
692
|
```ruby
|
693
693
|
begin
|
694
694
|
# Download Files as File Url
|
695
|
-
data, status_code, headers = api_instance.signature_request_files_as_file_url_with_http_info(signature_request_id)
|
695
|
+
data, status_code, headers = api_instance.signature_request_files_as_file_url_with_http_info(signature_request_id, opts)
|
696
696
|
p status_code # => 2xx
|
697
697
|
p headers # => { ... }
|
698
698
|
p data # => <FileResponse>
|
@@ -706,6 +706,7 @@ end
|
|
706
706
|
| Name | Type | Description | Notes |
|
707
707
|
| ---- | ---- | ----------- | ----- |
|
708
708
|
| `signature_request_id` | **String** | The id of the SignatureRequest to retrieve. | |
|
709
|
+
| `force_download` | **Integer** | By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional][default to 1] |
|
709
710
|
|
710
711
|
### Return type
|
711
712
|
|
@@ -947,7 +948,7 @@ end
|
|
947
948
|
|
948
949
|
Send Request Reminder
|
949
950
|
|
950
|
-
Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE
|
951
|
+
Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
|
951
952
|
|
952
953
|
### Examples
|
953
954
|
|
@@ -1305,7 +1306,7 @@ end
|
|
1305
1306
|
|
1306
1307
|
Update Signature Request
|
1307
1308
|
|
1308
|
-
Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. **NOTE
|
1309
|
+
Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
|
1309
1310
|
|
1310
1311
|
### Examples
|
1311
1312
|
|
@@ -8,7 +8,7 @@
|
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `template_ids`<sup>*_required_</sup> | ```Array<String>``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | |
|
10
10
|
| `client_id`<sup>*_required_</sup> | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | |
|
11
|
-
| `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:<br><br>- `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)<br><br> **
|
11
|
+
| `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:<br><br>- `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)<br><br> 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](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br> **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)<br><br> You may only specify field values here, any other options should be set in the custom_fields request parameter.<br><br>Example CSV:<br><br>``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | |
|
12
12
|
| `signer_list` | [```Array<SubBulkSignerList>```](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | |
|
13
13
|
| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
|
14
14
|
| `ccs` | [```Array<SubCC>```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | |
|
@@ -7,7 +7,7 @@
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `template_ids`<sup>*_required_</sup> | ```Array<String>``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | |
|
10
|
-
| `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:<br><br>- `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)<br><br> **
|
10
|
+
| `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:<br><br>- `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)<br><br> 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](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br> **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)<br><br> You may only specify field values here, any other options should be set in the custom_fields request parameter.<br><br>Example CSV:<br><br>``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | |
|
11
11
|
| `signer_list` | [```Array<SubBulkSignerList>```](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | |
|
12
12
|
| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
|
13
13
|
| `ccs` | [```Array<SubCC>```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | |
|
@@ -12,15 +12,15 @@
|
|
12
12
|
| `signers` | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
|
13
13
|
| `grouped_signers` | [```Array<SubSignatureRequestGroupedSigners>```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
|
14
14
|
| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
|
15
|
-
| `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.<br><br>**
|
15
|
+
| `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.<br><br>**NOTE:** Only available for Premium plan. | [default to false] |
|
16
16
|
| `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
|
17
17
|
| `cc_email_addresses` | ```Array<String>``` | The email addresses that should be CCed. | |
|
18
18
|
| `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.<br><br>Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.<br><br>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. | |
|
19
19
|
| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
|
20
20
|
| `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | |
|
21
21
|
| `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
|
22
|
-
| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE
|
23
|
-
| `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.<br><br>**NOTE
|
22
|
+
| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
|
23
|
+
| `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.<br><br>**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] |
|
24
24
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
25
25
|
| `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.<br><br>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. | |
|
26
26
|
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
|
@@ -28,6 +28,6 @@
|
|
28
28
|
| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
|
29
29
|
| `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
|
30
30
|
| `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] |
|
31
|
-
| `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.<br><br
|
31
|
+
| `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.<br><br>**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
|
32
32
|
| `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | |
|
33
33
|
|
@@ -20,5 +20,5 @@
|
|
20
20
|
| `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
|
21
21
|
| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
|
22
22
|
| `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
|
23
|
-
| `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.<br><br
|
23
|
+
| `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.<br><br>**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
|
24
24
|
|
@@ -24,9 +24,11 @@ Contains information about a signature request.
|
|
24
24
|
| `details_url` | ```String``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | |
|
25
25
|
| `cc_email_addresses` | ```Array<String>``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | |
|
26
26
|
| `signing_redirect_url` | ```String``` | The URL you want the signer redirected to after they successfully sign. | |
|
27
|
+
| `final_copy_uri` | ```String``` | The path where the completed document can be downloaded | |
|
27
28
|
| `template_ids` | ```Array<String>``` | Templates IDs used in this SignatureRequest (if any). | |
|
28
29
|
| `custom_fields` | [```Array<SignatureRequestResponseCustomFieldBase>```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.<br><br>* Text Field uses `SignatureRequestResponseCustomFieldText`<br>* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | |
|
29
30
|
| `attachments` | [```Array<SignatureRequestResponseAttachment>```](SignatureRequestResponseAttachment.md) | Signer attachments. | |
|
30
31
|
| `response_data` | [```Array<SignatureRequestResponseDataBase>```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | |
|
31
32
|
| `signatures` | [```Array<SignatureRequestResponseSignatures>```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | |
|
33
|
+
| `bulk_send_job_id` | ```String``` | The ID of the Bulk Send job which sent the signature request, if applicable. | |
|
32
34
|
|
@@ -11,7 +11,7 @@
|
|
11
11
|
| `signers` | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
|
12
12
|
| `grouped_signers` | [```Array<SubSignatureRequestGroupedSigners>```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
|
13
13
|
| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
|
14
|
-
| `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.<br><br>**
|
14
|
+
| `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.<br><br>**NOTE:** Only available for Premium plan and higher. | [default to false] |
|
15
15
|
| `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
|
16
16
|
| `cc_email_addresses` | ```Array<String>``` | The email addresses that should be CCed. | |
|
17
17
|
| `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. | |
|
@@ -19,9 +19,10 @@
|
|
19
19
|
| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
|
20
20
|
| `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | |
|
21
21
|
| `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
|
22
|
-
| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE
|
23
|
-
| `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.<br><br>**NOTE
|
24
|
-
| `is_qualified_signature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br><br>**
|
22
|
+
| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
|
23
|
+
| `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.<br><br>**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] |
|
24
|
+
| `is_qualified_signature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br><br>**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
|
25
|
+
| `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br><br>**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
|
25
26
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
26
27
|
| `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.<br><br>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. | |
|
27
28
|
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
|
@@ -14,7 +14,8 @@
|
|
14
14
|
| `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
|
15
15
|
| `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
|
16
16
|
| `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
|
17
|
-
| `is_qualified_signature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br><br>**
|
17
|
+
| `is_qualified_signature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br><br>**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
|
18
|
+
| `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br><br>**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
|
18
19
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
19
20
|
| `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.<br><br>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. | |
|
20
21
|
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
|
@@ -7,7 +7,7 @@
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `signature_id`<sup>*_required_</sup> | ```String``` | The signature ID for the recipient. | |
|
10
|
-
| `email_address` | ```String``` | The new email address for the recipient.<br><br>**NOTE
|
11
|
-
| `name` | ```String``` | The new name for the recipient.<br><br>**NOTE
|
10
|
+
| `email_address` | ```String``` | The new email address for the recipient.<br><br>This will generate a new `signature_id` value.<br><br>**NOTE:** Optional if `name` is provided. | |
|
11
|
+
| `name` | ```String``` | The new name for the recipient.<br><br>**NOTE:** Optional if `email_address` is provided. | |
|
12
12
|
| `expires_at` | ```Integer``` | The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | |
|
13
13
|
|
data/docs/SubAttachment.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `name`<sup>*_required_</sup> | ```String``` | The name of attachment. | |
|
10
|
-
| `signer_index`<sup>*_required_</sup> | ```Integer``` | The signer's index in the `signers` parameter (0-based indexing).<br><br>**NOTE
|
10
|
+
| `signer_index`<sup>*_required_</sup> | ```Integer``` | The signer's index in the `signers` parameter (0-based indexing).<br><br>**NOTE:** Only one signer can be assigned per attachment. | |
|
11
11
|
| `instructions` | ```String``` | The instructions for uploading the attachment. | |
|
12
12
|
| `required` | ```Boolean``` | Determines if the attachment must be uploaded. | [default to false] |
|
13
13
|
|
data/docs/SubCustomField.md
CHANGED
@@ -11,7 +11,7 @@ For using pre-filled on repeatable signature requests, merge fields are added to
|
|
11
11
|
| Name | Type | Description | Notes |
|
12
12
|
| ---- | ---- | ----------- | ----- |
|
13
13
|
| `name`<sup>*_required_</sup> | ```String``` | The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing. | |
|
14
|
-
| `editor` | ```String``` | Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.<br><br>**
|
14
|
+
| `editor` | ```String``` | Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.<br><br>**NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable. | |
|
15
15
|
| `required` | ```Boolean``` | Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`. | [default to false] |
|
16
16
|
| `value` | ```String``` | The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing. | |
|
17
17
|
|
data/docs/SubFieldOptions.md
CHANGED
@@ -6,5 +6,5 @@ This allows the requester to specify field options for a signature request.
|
|
6
6
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
|
-
| `date_format`<sup>*_required_</sup> | ```String``` | Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))<br><br>**
|
9
|
+
| `date_format`<sup>*_required_</sup> | ```String``` | Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))<br><br>**NOTE:** Only available for Premium and higher. | |
|
10
10
|
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
|
4
4
|
|
5
|
-
**NOTE
|
5
|
+
**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
|
6
6
|
|
7
7
|
* Text Field use `SubFormFieldsPerDocumentText`
|
8
8
|
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
|
@@ -23,7 +23,7 @@ The fields that should appear on the document, expressed as an array of objects.
|
|
23
23
|
| `api_id`<sup>*_required_</sup> | ```String``` | An identifier for the field that is unique across all documents in the request. | |
|
24
24
|
| `height`<sup>*_required_</sup> | ```Integer``` | Size of the field in pixels. | |
|
25
25
|
| `required`<sup>*_required_</sup> | ```Boolean``` | Whether this field is required. | |
|
26
|
-
| `signer`<sup>*_required_</sup> | ```String``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.<br><br>**NOTE
|
26
|
+
| `signer`<sup>*_required_</sup> | ```String``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.<br><br>**NOTE:** To set the value of the field as the preparer you must set this to `me_now`<br><br>**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | |
|
27
27
|
| `type`<sup>*_required_</sup> | ```String``` | | |
|
28
28
|
| `width`<sup>*_required_</sup> | ```Integer``` | Size of the field in pixels. | |
|
29
29
|
| `x`<sup>*_required_</sup> | ```Integer``` | Location coordinates of the field in pixels. | |
|
@@ -7,4 +7,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `type`<sup>*_required_</sup> | ```String``` | A date. Use the `SubFormFieldsPerDocumentDateSigned` class. | [default to 'date_signed'] |
|
10
|
+
| `font_family` | ```String``` | Font family for the field. | |
|
11
|
+
| `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
|
10
12
|
|
@@ -9,4 +9,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
|
|
9
9
|
| `type`<sup>*_required_</sup> | ```String``` | An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class. | [default to 'dropdown'] |
|
10
10
|
| `options`<sup>*_required_</sup> | ```Array<String>``` | Array of string values representing dropdown values. | |
|
11
11
|
| `content` | ```String``` | Selected value in `options` array. Value must exist in array. | |
|
12
|
+
| `font_family` | ```String``` | Font family for the field. | |
|
13
|
+
| `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
|
12
14
|
|
@@ -9,4 +9,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
|
|
9
9
|
| `type`<sup>*_required_</sup> | ```String``` | A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class. | [default to 'hyperlink'] |
|
10
10
|
| `content`<sup>*_required_</sup> | ```String``` | Link Text. | |
|
11
11
|
| `content_url`<sup>*_required_</sup> | ```String``` | Link URL. | |
|
12
|
+
| `font_family` | ```String``` | Font family for the field. | |
|
13
|
+
| `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
|
12
14
|
|
@@ -11,7 +11,10 @@ This class extends `SubFormFieldsPerDocumentBase`.
|
|
11
11
|
| `auto_fill_type` | ```String``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | |
|
12
12
|
| `link_id` | ```String``` | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | |
|
13
13
|
| `masked` | ```Boolean``` | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | |
|
14
|
-
| `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.<br><br>**NOTE
|
14
|
+
| `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.<br><br>**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | |
|
15
15
|
| `validation_custom_regex` | ```String``` | | |
|
16
16
|
| `validation_custom_regex_format_label` | ```String``` | | |
|
17
|
+
| `content` | ```String``` | Content of a `me_now` text field | |
|
18
|
+
| `font_family` | ```String``` | Font family for the field. | |
|
19
|
+
| `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
|
17
20
|
|
@@ -7,4 +7,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `type`<sup>*_required_</sup> | ```String``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to 'text-merge'] |
|
10
|
+
| `font_family` | ```String``` | Font family for the field. | |
|
11
|
+
| `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
|
10
12
|
|
@@ -7,6 +7,6 @@
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `group`<sup>*_required_</sup> | ```String``` | The name of the group. | |
|
10
|
-
| `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Signers belonging to this Group.<br><br>**NOTE
|
10
|
+
| `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Signers belonging to this Group.<br><br>**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. | |
|
11
11
|
| `order` | ```Integer``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | |
|
12
12
|
|
@@ -10,6 +10,6 @@
|
|
10
10
|
| `email_address`<sup>*_required_</sup> | ```String``` | The email address of the signer. | |
|
11
11
|
| `order` | ```Integer``` | The order the signer is required to sign in. | |
|
12
12
|
| `pin` | ```String``` | The 4- to 12-character access code that will secure this signer's signature page. | |
|
13
|
-
| `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>**
|
13
|
+
| `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>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](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br>**NOTE:** Not available in test mode and requires a Standard plan or higher. | |
|
14
14
|
| `sms_phone_number_type` | ```String``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.<br><br>If `authentication`, signer is sent a verification code via SMS that is required to access the document.<br><br>If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | |
|
15
15
|
|
@@ -10,6 +10,6 @@
|
|
10
10
|
| `name`<sup>*_required_</sup> | ```String``` | The name of the signer. | |
|
11
11
|
| `email_address`<sup>*_required_</sup> | ```String``` | The email address of the signer. | |
|
12
12
|
| `pin` | ```String``` | The 4- to 12-character access code that will secure this signer's signature page. | |
|
13
|
-
| `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>**
|
13
|
+
| `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>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](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br>**NOTE:** Not available in test mode and requires a Standard plan or higher. | |
|
14
14
|
| `sms_phone_number_type` | ```String``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.<br><br>If `authentication`, signer is sent a verification code via SMS that is required to access the document.<br><br>If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | |
|
15
15
|
|
data/docs/SubSigningOptions.md
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
This allows the requester to specify the types allowed for creating a signature.
|
4
4
|
|
5
|
-
**
|
5
|
+
**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
|
6
6
|
|
7
7
|
## Properties
|
8
8
|
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans)
|
4
4
|
|
5
|
-
Take a look at our [white labeling guide](/api/reference/
|
5
|
+
Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.
|
6
6
|
|
7
7
|
## Properties
|
8
8
|
|
@@ -8,5 +8,5 @@
|
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `account_id` | ```String``` | `account_id` or `email_address` is required. If both are provided, the account id prevails.<br><br>Account id of the user to invite to your Team. | |
|
10
10
|
| `email_address` | ```String``` | `account_id` or `email_address` is required, If both are provided, the account id prevails.<br><br>Email address of the user to invite to your Team. | |
|
11
|
-
| `role` | ```String``` | A role member will take in a new Team.<br><br>**
|
11
|
+
| `role` | ```String``` | A role member will take in a new Team.<br><br>**NOTE:** This parameter is used only if `team_id` is provided. | |
|
12
12
|
|