dropbox-sign 1.10.0 → 1.11.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/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/template_api.rb +2 -2
- 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/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 +179 -74
- 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 +12 -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: 85c8c09a1ecd4a5246f078f22ee2f3c9ce4ee49ef9c515abb27d65afb79596bd
|
|
4
|
+
data.tar.gz: '09743f339f596a29c7d85ed4238f11d1e387815e4ec3d8d7c9de8e863fba3d9f'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a61abfe634182db829cba1c2367b52baa0dada0bd48c1e437e6b5229ce8db99bf419670966e5b31c6c91c8987e96f8ea10358bcde7d58888b53df93c3867935e
|
|
7
|
+
data.tar.gz: 4124389a9610fb384a75880ed40e4b8cbde7c7a1a430b9cf6ddef5ceca0eb2b0922f82824814348d4cdcb23b3ae03ec5064b22c3c7e23bcc7ca39ecf5af77da6
|
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.11.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.11.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.11.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.11.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.11.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.11.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/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"
|
|
@@ -138,7 +138,7 @@ module Dropbox::Sign
|
|
|
138
138
|
end
|
|
139
139
|
|
|
140
140
|
# Create Template
|
|
141
|
-
# Creates a template that can
|
|
141
|
+
# 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.
|
|
142
142
|
# @param template_create_request [TemplateCreateRequest]
|
|
143
143
|
# @param [Hash] opts the optional parameters
|
|
144
144
|
# @return [TemplateCreateResponse]
|
|
@@ -148,7 +148,7 @@ module Dropbox::Sign
|
|
|
148
148
|
end
|
|
149
149
|
|
|
150
150
|
# Create Template
|
|
151
|
-
# Creates a template that can
|
|
151
|
+
# 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.
|
|
152
152
|
# @param template_create_request [TemplateCreateRequest]
|
|
153
153
|
# @param [Hash] opts the optional parameters
|
|
154
154
|
# @return [Array<(TemplateCreateResponse, Integer, Hash)>] TemplateCreateResponse data, response status code and response headers
|
|
@@ -132,6 +132,22 @@ module Dropbox::Sign
|
|
|
132
132
|
end
|
|
133
133
|
end
|
|
134
134
|
|
|
135
|
+
# Workaround for the Typhoeus/libcurl multipart PUT bug.
|
|
136
|
+
# libcurl only builds a multipart body via CURLOPT_HTTPPOST/CURLOPT_MIMEPOST,
|
|
137
|
+
# which is engaged for POST requests. For PUT it falls back to CURLOPT_UPLOAD
|
|
138
|
+
# and silently drops form fields, so the request is sent without a
|
|
139
|
+
# `Content-Type: multipart/form-data; boundary=...` header or body.
|
|
140
|
+
# We send the request as POST so the multipart body is encoded correctly,
|
|
141
|
+
# then use CURLOPT_CUSTOMREQUEST (exposed by Ethon as :customrequest) to
|
|
142
|
+
# restore PUT as the on-the-wire HTTP verb.
|
|
143
|
+
# See: https://github.com/typhoeus/typhoeus/issues/389
|
|
144
|
+
content_type_header = header_params['Content-Type'] || header_params['content-type']
|
|
145
|
+
if http_method == :put && content_type_header.is_a?(String) &&
|
|
146
|
+
content_type_header.start_with?('multipart/form-data')
|
|
147
|
+
req_opts[:method] = :post
|
|
148
|
+
req_opts[:customrequest] = 'PUT'
|
|
149
|
+
end
|
|
150
|
+
|
|
135
151
|
Typhoeus::Request.new(url, req_opts)
|
|
136
152
|
end
|
|
137
153
|
|
|
@@ -60,6 +60,9 @@ module Dropbox::Sign
|
|
|
60
60
|
# @return [AccountResponseUsage]
|
|
61
61
|
attr_accessor :usage
|
|
62
62
|
|
|
63
|
+
# @return [AccountResponseSettings]
|
|
64
|
+
attr_accessor :settings
|
|
65
|
+
|
|
63
66
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
64
67
|
def self.attribute_map
|
|
65
68
|
{
|
|
@@ -73,7 +76,8 @@ module Dropbox::Sign
|
|
|
73
76
|
:'role_code' => :'role_code',
|
|
74
77
|
:'team_id' => :'team_id',
|
|
75
78
|
:'locale' => :'locale',
|
|
76
|
-
:'usage' => :'usage'
|
|
79
|
+
:'usage' => :'usage',
|
|
80
|
+
:'settings' => :'settings'
|
|
77
81
|
}
|
|
78
82
|
end
|
|
79
83
|
|
|
@@ -100,7 +104,8 @@ module Dropbox::Sign
|
|
|
100
104
|
:'role_code' => :'String',
|
|
101
105
|
:'team_id' => :'String',
|
|
102
106
|
:'locale' => :'String',
|
|
103
|
-
:'usage' => :'AccountResponseUsage'
|
|
107
|
+
:'usage' => :'AccountResponseUsage',
|
|
108
|
+
:'settings' => :'AccountResponseSettings'
|
|
104
109
|
}
|
|
105
110
|
end
|
|
106
111
|
|
|
@@ -198,6 +203,10 @@ module Dropbox::Sign
|
|
|
198
203
|
if attributes.key?(:'usage')
|
|
199
204
|
self.usage = attributes[:'usage']
|
|
200
205
|
end
|
|
206
|
+
|
|
207
|
+
if attributes.key?(:'settings')
|
|
208
|
+
self.settings = attributes[:'settings']
|
|
209
|
+
end
|
|
201
210
|
end
|
|
202
211
|
|
|
203
212
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -228,7 +237,8 @@ module Dropbox::Sign
|
|
|
228
237
|
role_code == o.role_code &&
|
|
229
238
|
team_id == o.team_id &&
|
|
230
239
|
locale == o.locale &&
|
|
231
|
-
usage == o.usage
|
|
240
|
+
usage == o.usage &&
|
|
241
|
+
settings == o.settings
|
|
232
242
|
end
|
|
233
243
|
|
|
234
244
|
# @see the `==` method
|
|
@@ -240,7 +250,7 @@ module Dropbox::Sign
|
|
|
240
250
|
# Calculates hash code according to all attributes.
|
|
241
251
|
# @return [Integer] Hash code
|
|
242
252
|
def hash
|
|
243
|
-
[account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas, callback_url, role_code, team_id, locale, usage].hash
|
|
253
|
+
[account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas, callback_url, role_code, team_id, locale, usage, settings].hash
|
|
244
254
|
end
|
|
245
255
|
|
|
246
256
|
# Builds the object from hash
|
|
@@ -17,15 +17,26 @@ module Dropbox
|
|
|
17
17
|
end
|
|
18
18
|
|
|
19
19
|
module Dropbox::Sign
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
#
|
|
23
|
-
|
|
20
|
+
# Subset of configured settings
|
|
21
|
+
class AccountResponseSettings
|
|
22
|
+
# Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
|
|
23
|
+
# @return [Boolean]
|
|
24
|
+
attr_accessor :signer_access_codes
|
|
25
|
+
|
|
26
|
+
# Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
|
|
27
|
+
# @return [Boolean]
|
|
28
|
+
attr_accessor :sms_delivery
|
|
29
|
+
|
|
30
|
+
# Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
|
|
31
|
+
# @return [Boolean]
|
|
32
|
+
attr_accessor :sms_authentication
|
|
24
33
|
|
|
25
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
26
35
|
def self.attribute_map
|
|
27
36
|
{
|
|
28
|
-
:'
|
|
37
|
+
:'signer_access_codes' => :'signer_access_codes',
|
|
38
|
+
:'sms_delivery' => :'sms_delivery',
|
|
39
|
+
:'sms_authentication' => :'sms_authentication'
|
|
29
40
|
}
|
|
30
41
|
end
|
|
31
42
|
|
|
@@ -42,7 +53,9 @@ module Dropbox::Sign
|
|
|
42
53
|
# Attribute type mapping.
|
|
43
54
|
def self.openapi_types
|
|
44
55
|
{
|
|
45
|
-
:'
|
|
56
|
+
:'signer_access_codes' => :'Boolean',
|
|
57
|
+
:'sms_delivery' => :'Boolean',
|
|
58
|
+
:'sms_authentication' => :'Boolean'
|
|
46
59
|
}
|
|
47
60
|
end
|
|
48
61
|
|
|
@@ -69,32 +82,40 @@ module Dropbox::Sign
|
|
|
69
82
|
|
|
70
83
|
# Attempt to instantiate and hydrate a new instance of this class
|
|
71
84
|
# @param [Object] data Data to be converted
|
|
72
|
-
# @return [
|
|
85
|
+
# @return [AccountResponseSettings]
|
|
73
86
|
def self.init(data)
|
|
74
87
|
ApiClient.default.convert_to_type(
|
|
75
88
|
data,
|
|
76
|
-
"
|
|
77
|
-
) ||
|
|
89
|
+
"AccountResponseSettings"
|
|
90
|
+
) || AccountResponseSettings.new
|
|
78
91
|
end
|
|
79
92
|
|
|
80
93
|
# Initializes the object
|
|
81
94
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
82
95
|
def initialize(attributes = {})
|
|
83
96
|
if (!attributes.is_a?(Hash))
|
|
84
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::
|
|
97
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::AccountResponseSettings` initialize method"
|
|
85
98
|
end
|
|
86
99
|
|
|
87
100
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
88
101
|
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
89
102
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
90
103
|
if (!self.class.merged_attributes.key?(k.to_sym))
|
|
91
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::
|
|
104
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountResponseSettings`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
92
105
|
end
|
|
93
106
|
h[k.to_sym] = v
|
|
94
107
|
}
|
|
95
108
|
|
|
96
|
-
if attributes.key?(:'
|
|
97
|
-
self.
|
|
109
|
+
if attributes.key?(:'signer_access_codes')
|
|
110
|
+
self.signer_access_codes = attributes[:'signer_access_codes']
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
if attributes.key?(:'sms_delivery')
|
|
114
|
+
self.sms_delivery = attributes[:'sms_delivery']
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
if attributes.key?(:'sms_authentication')
|
|
118
|
+
self.sms_authentication = attributes[:'sms_authentication']
|
|
98
119
|
end
|
|
99
120
|
end
|
|
100
121
|
|
|
@@ -102,36 +123,23 @@ module Dropbox::Sign
|
|
|
102
123
|
# @return Array for valid properties with the reasons
|
|
103
124
|
def list_invalid_properties
|
|
104
125
|
invalid_properties = Array.new
|
|
105
|
-
if @template_id.nil?
|
|
106
|
-
invalid_properties.push('invalid value for "template_id", template_id cannot be nil.')
|
|
107
|
-
end
|
|
108
|
-
|
|
109
126
|
invalid_properties
|
|
110
127
|
end
|
|
111
128
|
|
|
112
129
|
# Check to see if the all the properties in the model are valid
|
|
113
130
|
# @return true if the model is valid
|
|
114
131
|
def valid?
|
|
115
|
-
return false if @template_id.nil?
|
|
116
132
|
true
|
|
117
133
|
end
|
|
118
134
|
|
|
119
|
-
# Custom attribute writer method with validation
|
|
120
|
-
# @param [Object] template_id Value to be assigned
|
|
121
|
-
def template_id=(template_id)
|
|
122
|
-
if template_id.nil?
|
|
123
|
-
fail ArgumentError, 'template_id cannot be nil'
|
|
124
|
-
end
|
|
125
|
-
|
|
126
|
-
@template_id = template_id
|
|
127
|
-
end
|
|
128
|
-
|
|
129
135
|
# Checks equality by comparing each attribute.
|
|
130
136
|
# @param [Object] Object to be compared
|
|
131
137
|
def ==(o)
|
|
132
138
|
return true if self.equal?(o)
|
|
133
139
|
self.class == o.class &&
|
|
134
|
-
|
|
140
|
+
signer_access_codes == o.signer_access_codes &&
|
|
141
|
+
sms_delivery == o.sms_delivery &&
|
|
142
|
+
sms_authentication == o.sms_authentication
|
|
135
143
|
end
|
|
136
144
|
|
|
137
145
|
# @see the `==` method
|
|
@@ -143,7 +151,7 @@ module Dropbox::Sign
|
|
|
143
151
|
# Calculates hash code according to all attributes.
|
|
144
152
|
# @return [Integer] Hash code
|
|
145
153
|
def hash
|
|
146
|
-
[
|
|
154
|
+
[signer_access_codes, sms_delivery, sms_authentication].hash
|
|
147
155
|
end
|
|
148
156
|
|
|
149
157
|
# Builds the object from hash
|
|
@@ -77,7 +77,7 @@ module Dropbox::Sign
|
|
|
77
77
|
# @return [Boolean]
|
|
78
78
|
attr_accessor :hide_text_tags
|
|
79
79
|
|
|
80
|
-
# 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> **NOTE:**
|
|
80
|
+
# 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> **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.
|
|
81
81
|
# @return [Boolean]
|
|
82
82
|
attr_accessor :is_eid
|
|
83
83
|
|
|
@@ -51,7 +51,7 @@ module Dropbox::Sign
|
|
|
51
51
|
# @return [Array<String>]
|
|
52
52
|
attr_accessor :file_urls
|
|
53
53
|
|
|
54
|
-
# 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> **NOTE:**
|
|
54
|
+
# 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> **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.
|
|
55
55
|
# @return [Boolean]
|
|
56
56
|
attr_accessor :is_eid
|
|
57
57
|
|
|
@@ -81,7 +81,7 @@ module Dropbox::Sign
|
|
|
81
81
|
# @return [Boolean]
|
|
82
82
|
attr_accessor :is_qualified_signature
|
|
83
83
|
|
|
84
|
-
# 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> **NOTE:**
|
|
84
|
+
# 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> **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.
|
|
85
85
|
# @return [Boolean]
|
|
86
86
|
attr_accessor :is_eid
|
|
87
87
|
|
|
@@ -55,7 +55,7 @@ module Dropbox::Sign
|
|
|
55
55
|
# @return [Boolean]
|
|
56
56
|
attr_accessor :is_qualified_signature
|
|
57
57
|
|
|
58
|
-
# 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> **NOTE:**
|
|
58
|
+
# 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> **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.
|
|
59
59
|
# @return [Boolean]
|
|
60
60
|
attr_accessor :is_eid
|
|
61
61
|
|