dropbox-sign 1.10.0 → 1.12.0
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 +10 -8
- data/README.md +5 -5
- data/VERSION +1 -1
- data/docs/AccountResponse.md +1 -0
- data/docs/AccountResponseSettings.md +12 -0
- data/docs/ErrorResponseError.md +1 -1
- data/docs/SignatureRequestApi.md +4 -0
- data/docs/SignatureRequestEditRequest.md +1 -1
- data/docs/SignatureRequestEditWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestSendRequest.md +1 -1
- data/docs/SignatureRequestSendWithTemplateRequest.md +1 -1
- data/docs/SubSigningOptions.md +4 -1
- data/docs/TemplateApi.md +1 -1
- data/examples/SignatureRequestCreateEmbeddedExample.rb +1 -0
- data/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb +1 -0
- data/examples/SignatureRequestSendExample.rb +1 -0
- data/examples/SignatureRequestSendWithTemplateExample.rb +1 -0
- data/lib/dropbox-sign/api/account_api.rb +8 -4
- data/lib/dropbox-sign/api/api_app_api.rb +9 -4
- data/lib/dropbox-sign/api/bulk_send_job_api.rb +4 -2
- data/lib/dropbox-sign/api/embedded_api.rb +4 -2
- data/lib/dropbox-sign/api/fax_api.rb +9 -4
- data/lib/dropbox-sign/api/fax_line_api.rb +13 -6
- data/lib/dropbox-sign/api/o_auth_api.rb +4 -2
- data/lib/dropbox-sign/api/report_api.rb +2 -1
- data/lib/dropbox-sign/api/signature_request_api.rb +38 -18
- data/lib/dropbox-sign/api/team_api.rb +19 -9
- data/lib/dropbox-sign/api/template_api.rb +23 -12
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +8 -4
- data/lib/dropbox-sign/api_client.rb +16 -0
- data/lib/dropbox-sign/models/account_response.rb +14 -4
- data/lib/dropbox-sign/models/{template_edit_response.rb → account_response_settings.rb} +38 -30
- data/lib/dropbox-sign/models/error_response_error.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_edit_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_send_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/sub_signing_options.rb +18 -5
- data/lib/dropbox-sign/version.rb +1 -1
- data/lib/dropbox-sign.rb +1 -1
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +577 -172
- data/spec/api/error_handling_spec.rb +73 -0
- data/templates/api.mustache +2 -1
- data/templates/api_client_typhoeus_partial.mustache +16 -0
- data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +4 -2
- data/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +2 -1
- data/test_fixtures/SignatureRequestSendRequest.json +4 -2
- data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +2 -1
- data/test_fixtures/TemplateUpdateRequest.json +18 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +2 -1
- data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +2 -1
- data/test_fixtures/UnclaimedDraftCreateRequest.json +2 -1
- metadata +14 -11
- data/docs/TemplateEditResponse.md +0 -10
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bdc20da80c4fe1e4a4db10bdc5d70784495d6e32d77ce6b0c4375d950b29d31b
|
|
4
|
+
data.tar.gz: 2dd1ad5d32e72350d90c388ef63378a26c0a2f603b3e96b83689932bd2ebabb6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6f4c0f6b49ef0b33f1ad8fb1faa79ecb63fca8eda9feccedf9f06de0d0ff8b1e8c2d913a96046841aa7f4415ac1bd48dc03a5e64d723f128de9b77b49a292cc0
|
|
7
|
+
data.tar.gz: f3242439cb3082c71eea28953123a120e913ed0f3a371a41e441b7653edb62814687caf8172f2a21e196e4209e8bfe82b8b98e1ca4a818e1a95e7780c0fd44fc
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
dropbox-sign (1.
|
|
4
|
+
dropbox-sign (1.12.0)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
@@ -11,17 +11,19 @@ GEM
|
|
|
11
11
|
byebug (11.1.3)
|
|
12
12
|
coderay (1.1.3)
|
|
13
13
|
diff-lcs (1.5.1)
|
|
14
|
-
ethon (0.
|
|
14
|
+
ethon (0.18.0)
|
|
15
15
|
ffi (>= 1.15.0)
|
|
16
|
-
|
|
17
|
-
ffi (1.17.
|
|
18
|
-
ffi (1.17.
|
|
19
|
-
ffi (1.17.
|
|
16
|
+
logger
|
|
17
|
+
ffi (1.17.4-aarch64-linux-gnu)
|
|
18
|
+
ffi (1.17.4-arm64-darwin)
|
|
19
|
+
ffi (1.17.4-x86_64-darwin)
|
|
20
|
+
ffi (1.17.4-x86_64-linux-gnu)
|
|
20
21
|
json (2.7.2)
|
|
21
22
|
json_spec (1.1.5)
|
|
22
23
|
multi_json (~> 1.0)
|
|
23
24
|
rspec (>= 2.0, < 4.0)
|
|
24
25
|
language_server-protocol (3.17.0.3)
|
|
26
|
+
logger (1.7.0)
|
|
25
27
|
method_source (1.1.0)
|
|
26
28
|
multi_json (1.15.0)
|
|
27
29
|
parallel (1.26.3)
|
|
@@ -64,8 +66,8 @@ GEM
|
|
|
64
66
|
rubocop-ast (1.32.3)
|
|
65
67
|
parser (>= 3.3.1.0)
|
|
66
68
|
ruby-progressbar (1.13.0)
|
|
67
|
-
typhoeus (1.
|
|
68
|
-
ethon (>= 0.
|
|
69
|
+
typhoeus (1.6.0)
|
|
70
|
+
ethon (>= 0.18.0)
|
|
69
71
|
unicode-display_width (2.5.0)
|
|
70
72
|
|
|
71
73
|
PLATFORMS
|
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.
|
|
28
|
+
- Package version: 1.12.0
|
|
29
29
|
- Generator version: 7.12.0
|
|
30
30
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
31
31
|
|
|
@@ -47,15 +47,15 @@ gem build dropbox-sign.gemspec
|
|
|
47
47
|
Then install the gem locally:
|
|
48
48
|
|
|
49
49
|
```shell
|
|
50
|
-
gem install ./dropbox-sign-1.
|
|
50
|
+
gem install ./dropbox-sign-1.12.0.gem
|
|
51
51
|
```
|
|
52
52
|
|
|
53
|
-
(for development, run `gem install --dev ./dropbox-sign-1.
|
|
53
|
+
(for development, run `gem install --dev ./dropbox-sign-1.12.0.gem` to install the development dependencies)
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
Finally add this to the Gemfile:
|
|
57
57
|
|
|
58
|
-
gem 'dropbox-sign', '~> 1.
|
|
58
|
+
gem 'dropbox-sign', '~> 1.12.0'
|
|
59
59
|
|
|
60
60
|
### Install from Git
|
|
61
61
|
|
|
@@ -189,6 +189,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
|
189
189
|
- [Dropbox::Sign::AccountGetResponse](docs/AccountGetResponse.md)
|
|
190
190
|
- [Dropbox::Sign::AccountResponse](docs/AccountResponse.md)
|
|
191
191
|
- [Dropbox::Sign::AccountResponseQuotas](docs/AccountResponseQuotas.md)
|
|
192
|
+
- [Dropbox::Sign::AccountResponseSettings](docs/AccountResponseSettings.md)
|
|
192
193
|
- [Dropbox::Sign::AccountResponseUsage](docs/AccountResponseUsage.md)
|
|
193
194
|
- [Dropbox::Sign::AccountUpdateRequest](docs/AccountUpdateRequest.md)
|
|
194
195
|
- [Dropbox::Sign::AccountVerifyRequest](docs/AccountVerifyRequest.md)
|
|
@@ -332,7 +333,6 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
|
332
333
|
- [Dropbox::Sign::TemplateCreateRequest](docs/TemplateCreateRequest.md)
|
|
333
334
|
- [Dropbox::Sign::TemplateCreateResponse](docs/TemplateCreateResponse.md)
|
|
334
335
|
- [Dropbox::Sign::TemplateCreateResponseTemplate](docs/TemplateCreateResponseTemplate.md)
|
|
335
|
-
- [Dropbox::Sign::TemplateEditResponse](docs/TemplateEditResponse.md)
|
|
336
336
|
- [Dropbox::Sign::TemplateGetResponse](docs/TemplateGetResponse.md)
|
|
337
337
|
- [Dropbox::Sign::TemplateListResponse](docs/TemplateListResponse.md)
|
|
338
338
|
- [Dropbox::Sign::TemplateRemoveUserRequest](docs/TemplateRemoveUserRequest.md)
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.12.0
|
data/docs/AccountResponse.md
CHANGED
|
@@ -17,4 +17,5 @@
|
|
|
17
17
|
| `team_id` | ```String``` | The id of the team account belongs to. | |
|
|
18
18
|
| `locale` | ```String``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | |
|
|
19
19
|
| `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | |
|
|
20
|
+
| `settings` | [```AccountResponseSettings```](AccountResponseSettings.md) | | |
|
|
20
21
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Dropbox::Sign::AccountResponseSettings
|
|
2
|
+
|
|
3
|
+
Subset of configured settings
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
| Name | Type | Description | Notes |
|
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
|
9
|
+
| `signer_access_codes` | ```Boolean``` | Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |
|
|
10
|
+
| `sms_delivery` | ```Boolean``` | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |
|
|
11
|
+
| `sms_authentication` | ```Boolean``` | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |
|
|
12
|
+
|
data/docs/ErrorResponseError.md
CHANGED
|
@@ -7,6 +7,6 @@ Contains information about an error that occurred.
|
|
|
7
7
|
| Name | Type | Description | Notes |
|
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
|
9
9
|
| `error_msg`<sup>*_required_</sup> | ```String``` | Message describing an error. | |
|
|
10
|
-
| `error_name`<sup>*_required_</sup> | ```String``` | Name of the error. | |
|
|
10
|
+
| `error_name`<sup>*_required_</sup> | ```String``` | Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance. | |
|
|
11
11
|
| `error_path` | ```String``` | Path at which an error occurred. | |
|
|
12
12
|
|
data/docs/SignatureRequestApi.md
CHANGED
|
@@ -390,6 +390,7 @@ signing_options.draw = true
|
|
|
390
390
|
signing_options.phone = false
|
|
391
391
|
signing_options.type = true
|
|
392
392
|
signing_options.upload = true
|
|
393
|
+
signing_options.force_advanced_signature_details = false
|
|
393
394
|
|
|
394
395
|
signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
|
395
396
|
signers_1.name = "Jack"
|
|
@@ -497,6 +498,7 @@ signing_options.draw = true
|
|
|
497
498
|
signing_options.phone = false
|
|
498
499
|
signing_options.type = true
|
|
499
500
|
signing_options.upload = true
|
|
501
|
+
signing_options.force_advanced_signature_details = false
|
|
500
502
|
|
|
501
503
|
signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
|
502
504
|
signers_1.role = "Client"
|
|
@@ -1609,6 +1611,7 @@ signing_options.draw = true
|
|
|
1609
1611
|
signing_options.phone = false
|
|
1610
1612
|
signing_options.type = true
|
|
1611
1613
|
signing_options.upload = true
|
|
1614
|
+
signing_options.force_advanced_signature_details = false
|
|
1612
1615
|
|
|
1613
1616
|
signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
|
1614
1617
|
signers_1.name = "Jack"
|
|
@@ -1723,6 +1726,7 @@ signing_options.draw = true
|
|
|
1723
1726
|
signing_options.phone = false
|
|
1724
1727
|
signing_options.type = true
|
|
1725
1728
|
signing_options.upload = true
|
|
1729
|
+
signing_options.force_advanced_signature_details = false
|
|
1726
1730
|
|
|
1727
1731
|
signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
|
1728
1732
|
signers_1.role = "Client"
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
| `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
|
|
22
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
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_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:**
|
|
24
|
+
| `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:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
|
|
25
25
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
|
26
26
|
| `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
27
|
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
|
|
@@ -14,7 +14,7 @@
|
|
|
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_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:**
|
|
17
|
+
| `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:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
|
|
18
18
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
|
19
19
|
| `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
20
|
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
|
|
@@ -22,7 +22,7 @@
|
|
|
22
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
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
|
| `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:**
|
|
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:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
|
|
26
26
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
|
27
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. | |
|
|
28
28
|
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
|
|
@@ -15,7 +15,7 @@
|
|
|
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
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:**
|
|
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:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
|
|
19
19
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
|
20
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. | |
|
|
21
21
|
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
|
data/docs/SubSigningOptions.md
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
# Dropbox::Sign::SubSigningOptions
|
|
2
2
|
|
|
3
|
-
This allows the requester to specify the types allowed for creating a signature.
|
|
3
|
+
This allows the requester to specify the types allowed for creating a signature and specify another signing options.
|
|
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
|
+
**NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.
|
|
8
|
+
|
|
7
9
|
## Properties
|
|
8
10
|
|
|
9
11
|
| Name | Type | Description | Notes |
|
|
@@ -13,4 +15,5 @@ This allows the requester to specify the types allowed for creating a signature.
|
|
|
13
15
|
| `phone` | ```Boolean``` | Allows using a smartphone to email the signature | [default to false] |
|
|
14
16
|
| `type` | ```Boolean``` | Allows typing the signature | [default to false] |
|
|
15
17
|
| `upload` | ```Boolean``` | Allows uploading the signature | [default to false] |
|
|
18
|
+
| `force_advanced_signature_details` | ```Boolean``` | Turning on advanced signature details for the signature request | [default to false] |
|
|
16
19
|
|
data/docs/TemplateApi.md
CHANGED
|
@@ -97,7 +97,7 @@ end
|
|
|
97
97
|
|
|
98
98
|
Create Template
|
|
99
99
|
|
|
100
|
-
Creates a template that can
|
|
100
|
+
Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. 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 and retry the request if necessary.
|
|
101
101
|
|
|
102
102
|
### Examples
|
|
103
103
|
|
|
@@ -12,6 +12,7 @@ signing_options.draw = true
|
|
|
12
12
|
signing_options.phone = false
|
|
13
13
|
signing_options.type = true
|
|
14
14
|
signing_options.upload = true
|
|
15
|
+
signing_options.force_advanced_signature_details = false
|
|
15
16
|
|
|
16
17
|
signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
|
17
18
|
signers_1.name = "Jack"
|
|
@@ -12,6 +12,7 @@ signing_options.draw = true
|
|
|
12
12
|
signing_options.phone = false
|
|
13
13
|
signing_options.type = true
|
|
14
14
|
signing_options.upload = true
|
|
15
|
+
signing_options.force_advanced_signature_details = false
|
|
15
16
|
|
|
16
17
|
signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
|
17
18
|
signers_1.role = "Client"
|
|
@@ -15,6 +15,7 @@ signing_options.draw = true
|
|
|
15
15
|
signing_options.phone = false
|
|
16
16
|
signing_options.type = true
|
|
17
17
|
signing_options.upload = true
|
|
18
|
+
signing_options.force_advanced_signature_details = false
|
|
18
19
|
|
|
19
20
|
signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
|
20
21
|
signers_1.name = "Jack"
|
|
@@ -12,6 +12,7 @@ signing_options.draw = true
|
|
|
12
12
|
signing_options.phone = false
|
|
13
13
|
signing_options.type = true
|
|
14
14
|
signing_options.upload = true
|
|
15
|
+
signing_options.force_advanced_signature_details = false
|
|
15
16
|
|
|
16
17
|
signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
|
17
18
|
signers_1.role = "Client"
|
|
@@ -111,7 +111,7 @@ module Dropbox::Sign
|
|
|
111
111
|
range_code = "4XX".split('').first
|
|
112
112
|
range_code_left = "#{range_code}00".to_i
|
|
113
113
|
range_code_right = "#{range_code}99".to_i
|
|
114
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
114
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
115
115
|
body = @api_client.convert_to_type(
|
|
116
116
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
117
117
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -123,6 +123,7 @@ module Dropbox::Sign
|
|
|
123
123
|
e.message
|
|
124
124
|
end
|
|
125
125
|
|
|
126
|
+
raise e
|
|
126
127
|
end
|
|
127
128
|
|
|
128
129
|
if @api_client.config.debugging
|
|
@@ -205,7 +206,7 @@ module Dropbox::Sign
|
|
|
205
206
|
range_code = "4XX".split('').first
|
|
206
207
|
range_code_left = "#{range_code}00".to_i
|
|
207
208
|
range_code_right = "#{range_code}99".to_i
|
|
208
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
209
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
209
210
|
body = @api_client.convert_to_type(
|
|
210
211
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
211
212
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -217,6 +218,7 @@ module Dropbox::Sign
|
|
|
217
218
|
e.message
|
|
218
219
|
end
|
|
219
220
|
|
|
221
|
+
raise e
|
|
220
222
|
end
|
|
221
223
|
|
|
222
224
|
if @api_client.config.debugging
|
|
@@ -314,7 +316,7 @@ module Dropbox::Sign
|
|
|
314
316
|
range_code = "4XX".split('').first
|
|
315
317
|
range_code_left = "#{range_code}00".to_i
|
|
316
318
|
range_code_right = "#{range_code}99".to_i
|
|
317
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
319
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
318
320
|
body = @api_client.convert_to_type(
|
|
319
321
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
320
322
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -326,6 +328,7 @@ module Dropbox::Sign
|
|
|
326
328
|
e.message
|
|
327
329
|
end
|
|
328
330
|
|
|
331
|
+
raise e
|
|
329
332
|
end
|
|
330
333
|
|
|
331
334
|
if @api_client.config.debugging
|
|
@@ -423,7 +426,7 @@ module Dropbox::Sign
|
|
|
423
426
|
range_code = "4XX".split('').first
|
|
424
427
|
range_code_left = "#{range_code}00".to_i
|
|
425
428
|
range_code_right = "#{range_code}99".to_i
|
|
426
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
429
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
427
430
|
body = @api_client.convert_to_type(
|
|
428
431
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
429
432
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -435,6 +438,7 @@ module Dropbox::Sign
|
|
|
435
438
|
e.message
|
|
436
439
|
end
|
|
437
440
|
|
|
441
|
+
raise e
|
|
438
442
|
end
|
|
439
443
|
|
|
440
444
|
if @api_client.config.debugging
|
|
@@ -111,7 +111,7 @@ module Dropbox::Sign
|
|
|
111
111
|
range_code = "4XX".split('').first
|
|
112
112
|
range_code_left = "#{range_code}00".to_i
|
|
113
113
|
range_code_right = "#{range_code}99".to_i
|
|
114
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
114
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
115
115
|
body = @api_client.convert_to_type(
|
|
116
116
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
117
117
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -123,6 +123,7 @@ module Dropbox::Sign
|
|
|
123
123
|
e.message
|
|
124
124
|
end
|
|
125
125
|
|
|
126
|
+
raise e
|
|
126
127
|
end
|
|
127
128
|
|
|
128
129
|
if @api_client.config.debugging
|
|
@@ -190,6 +191,7 @@ module Dropbox::Sign
|
|
|
190
191
|
begin
|
|
191
192
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
192
193
|
rescue Dropbox::Sign::ApiError => e
|
|
194
|
+
raise e
|
|
193
195
|
end
|
|
194
196
|
|
|
195
197
|
if @api_client.config.debugging
|
|
@@ -272,7 +274,7 @@ module Dropbox::Sign
|
|
|
272
274
|
range_code = "4XX".split('').first
|
|
273
275
|
range_code_left = "#{range_code}00".to_i
|
|
274
276
|
range_code_right = "#{range_code}99".to_i
|
|
275
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
277
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
276
278
|
body = @api_client.convert_to_type(
|
|
277
279
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
278
280
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -284,6 +286,7 @@ module Dropbox::Sign
|
|
|
284
286
|
e.message
|
|
285
287
|
end
|
|
286
288
|
|
|
289
|
+
raise e
|
|
287
290
|
end
|
|
288
291
|
|
|
289
292
|
if @api_client.config.debugging
|
|
@@ -366,7 +369,7 @@ module Dropbox::Sign
|
|
|
366
369
|
range_code = "4XX".split('').first
|
|
367
370
|
range_code_left = "#{range_code}00".to_i
|
|
368
371
|
range_code_right = "#{range_code}99".to_i
|
|
369
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
372
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
370
373
|
body = @api_client.convert_to_type(
|
|
371
374
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
372
375
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -378,6 +381,7 @@ module Dropbox::Sign
|
|
|
378
381
|
e.message
|
|
379
382
|
end
|
|
380
383
|
|
|
384
|
+
raise e
|
|
381
385
|
end
|
|
382
386
|
|
|
383
387
|
if @api_client.config.debugging
|
|
@@ -481,7 +485,7 @@ module Dropbox::Sign
|
|
|
481
485
|
range_code = "4XX".split('').first
|
|
482
486
|
range_code_left = "#{range_code}00".to_i
|
|
483
487
|
range_code_right = "#{range_code}99".to_i
|
|
484
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
488
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
485
489
|
body = @api_client.convert_to_type(
|
|
486
490
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
487
491
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -493,6 +497,7 @@ module Dropbox::Sign
|
|
|
493
497
|
e.message
|
|
494
498
|
end
|
|
495
499
|
|
|
500
|
+
raise e
|
|
496
501
|
end
|
|
497
502
|
|
|
498
503
|
if @api_client.config.debugging
|
|
@@ -102,7 +102,7 @@ module Dropbox::Sign
|
|
|
102
102
|
range_code = "4XX".split('').first
|
|
103
103
|
range_code_left = "#{range_code}00".to_i
|
|
104
104
|
range_code_right = "#{range_code}99".to_i
|
|
105
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
105
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
106
106
|
body = @api_client.convert_to_type(
|
|
107
107
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
108
108
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -114,6 +114,7 @@ module Dropbox::Sign
|
|
|
114
114
|
e.message
|
|
115
115
|
end
|
|
116
116
|
|
|
117
|
+
raise e
|
|
117
118
|
end
|
|
118
119
|
|
|
119
120
|
if @api_client.config.debugging
|
|
@@ -196,7 +197,7 @@ module Dropbox::Sign
|
|
|
196
197
|
range_code = "4XX".split('').first
|
|
197
198
|
range_code_left = "#{range_code}00".to_i
|
|
198
199
|
range_code_right = "#{range_code}99".to_i
|
|
199
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
200
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
200
201
|
body = @api_client.convert_to_type(
|
|
201
202
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
202
203
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -208,6 +209,7 @@ module Dropbox::Sign
|
|
|
208
209
|
e.message
|
|
209
210
|
end
|
|
210
211
|
|
|
212
|
+
raise e
|
|
211
213
|
end
|
|
212
214
|
|
|
213
215
|
if @api_client.config.debugging
|
|
@@ -117,7 +117,7 @@ module Dropbox::Sign
|
|
|
117
117
|
range_code = "4XX".split('').first
|
|
118
118
|
range_code_left = "#{range_code}00".to_i
|
|
119
119
|
range_code_right = "#{range_code}99".to_i
|
|
120
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
120
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
121
121
|
body = @api_client.convert_to_type(
|
|
122
122
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
123
123
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -129,6 +129,7 @@ module Dropbox::Sign
|
|
|
129
129
|
e.message
|
|
130
130
|
end
|
|
131
131
|
|
|
132
|
+
raise e
|
|
132
133
|
end
|
|
133
134
|
|
|
134
135
|
if @api_client.config.debugging
|
|
@@ -211,7 +212,7 @@ module Dropbox::Sign
|
|
|
211
212
|
range_code = "4XX".split('').first
|
|
212
213
|
range_code_left = "#{range_code}00".to_i
|
|
213
214
|
range_code_right = "#{range_code}99".to_i
|
|
214
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
215
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
215
216
|
body = @api_client.convert_to_type(
|
|
216
217
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
217
218
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -223,6 +224,7 @@ module Dropbox::Sign
|
|
|
223
224
|
e.message
|
|
224
225
|
end
|
|
225
226
|
|
|
227
|
+
raise e
|
|
226
228
|
end
|
|
227
229
|
|
|
228
230
|
if @api_client.config.debugging
|
|
@@ -81,6 +81,7 @@ module Dropbox::Sign
|
|
|
81
81
|
begin
|
|
82
82
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
83
83
|
rescue Dropbox::Sign::ApiError => e
|
|
84
|
+
raise e
|
|
84
85
|
end
|
|
85
86
|
|
|
86
87
|
if @api_client.config.debugging
|
|
@@ -163,7 +164,7 @@ module Dropbox::Sign
|
|
|
163
164
|
range_code = "4XX".split('').first
|
|
164
165
|
range_code_left = "#{range_code}00".to_i
|
|
165
166
|
range_code_right = "#{range_code}99".to_i
|
|
166
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
167
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
167
168
|
body = @api_client.convert_to_type(
|
|
168
169
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
169
170
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -175,6 +176,7 @@ module Dropbox::Sign
|
|
|
175
176
|
e.message
|
|
176
177
|
end
|
|
177
178
|
|
|
179
|
+
raise e
|
|
178
180
|
end
|
|
179
181
|
|
|
180
182
|
if @api_client.config.debugging
|
|
@@ -257,7 +259,7 @@ module Dropbox::Sign
|
|
|
257
259
|
range_code = "4XX".split('').first
|
|
258
260
|
range_code_left = "#{range_code}00".to_i
|
|
259
261
|
range_code_right = "#{range_code}99".to_i
|
|
260
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
262
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
261
263
|
body = @api_client.convert_to_type(
|
|
262
264
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
263
265
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -269,6 +271,7 @@ module Dropbox::Sign
|
|
|
269
271
|
e.message
|
|
270
272
|
end
|
|
271
273
|
|
|
274
|
+
raise e
|
|
272
275
|
end
|
|
273
276
|
|
|
274
277
|
if @api_client.config.debugging
|
|
@@ -363,7 +366,7 @@ module Dropbox::Sign
|
|
|
363
366
|
range_code = "4XX".split('').first
|
|
364
367
|
range_code_left = "#{range_code}00".to_i
|
|
365
368
|
range_code_right = "#{range_code}99".to_i
|
|
366
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
369
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
367
370
|
body = @api_client.convert_to_type(
|
|
368
371
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
369
372
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -375,6 +378,7 @@ module Dropbox::Sign
|
|
|
375
378
|
e.message
|
|
376
379
|
end
|
|
377
380
|
|
|
381
|
+
raise e
|
|
378
382
|
end
|
|
379
383
|
|
|
380
384
|
if @api_client.config.debugging
|
|
@@ -472,7 +476,7 @@ module Dropbox::Sign
|
|
|
472
476
|
range_code = "4XX".split('').first
|
|
473
477
|
range_code_left = "#{range_code}00".to_i
|
|
474
478
|
range_code_right = "#{range_code}99".to_i
|
|
475
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
|
479
|
+
if e.code && e.code >= range_code_left && e.code <= range_code_right
|
|
476
480
|
body = @api_client.convert_to_type(
|
|
477
481
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
|
478
482
|
"Dropbox::Sign::ErrorResponse"
|
|
@@ -484,6 +488,7 @@ module Dropbox::Sign
|
|
|
484
488
|
e.message
|
|
485
489
|
end
|
|
486
490
|
|
|
491
|
+
raise e
|
|
487
492
|
end
|
|
488
493
|
|
|
489
494
|
if @api_client.config.debugging
|