Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ script:
- bundle install --path vendor/bundle
- bundle exec rspec
- gem build dropbox-sign.gemspec
- gem install ./dropbox-sign-1.10.0.gem
- gem install ./dropbox-sign-1.11.0.gem
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
dropbox-sign (1.10.0)
dropbox-sign (1.11.0)
typhoeus (~> 1.0, >= 1.0.1)

GEM
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ directory that corresponds to the file you want updated.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 3.0.0
- Package version: 1.10.0
- Package version: 1.11.0
- Generator version: 7.12.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen

Expand All @@ -47,15 +47,15 @@ gem build dropbox-sign.gemspec
Then install the gem locally:

```shell
gem install ./dropbox-sign-1.10.0.gem
gem install ./dropbox-sign-1.11.0.gem
```

(for development, run `gem install --dev ./dropbox-sign-1.10.0.gem` to install the development dependencies)
(for development, run `gem install --dev ./dropbox-sign-1.11.0.gem` to install the development dependencies)


Finally add this to the Gemfile:

gem 'dropbox-sign', '~> 1.10.0'
gem 'dropbox-sign', '~> 1.11.0'

### Install from Git

Expand Down Expand Up @@ -189,6 +189,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
- [Dropbox::Sign::AccountGetResponse](docs/AccountGetResponse.md)
- [Dropbox::Sign::AccountResponse](docs/AccountResponse.md)
- [Dropbox::Sign::AccountResponseQuotas](docs/AccountResponseQuotas.md)
- [Dropbox::Sign::AccountResponseSettings](docs/AccountResponseSettings.md)
- [Dropbox::Sign::AccountResponseUsage](docs/AccountResponseUsage.md)
- [Dropbox::Sign::AccountUpdateRequest](docs/AccountUpdateRequest.md)
- [Dropbox::Sign::AccountVerifyRequest](docs/AccountVerifyRequest.md)
Expand Down Expand Up @@ -332,7 +333,6 @@ All URIs are relative to *https://api.hellosign.com/v3*
- [Dropbox::Sign::TemplateCreateRequest](docs/TemplateCreateRequest.md)
- [Dropbox::Sign::TemplateCreateResponse](docs/TemplateCreateResponse.md)
- [Dropbox::Sign::TemplateCreateResponseTemplate](docs/TemplateCreateResponseTemplate.md)
- [Dropbox::Sign::TemplateEditResponse](docs/TemplateEditResponse.md)
- [Dropbox::Sign::TemplateGetResponse](docs/TemplateGetResponse.md)
- [Dropbox::Sign::TemplateListResponse](docs/TemplateListResponse.md)
- [Dropbox::Sign::TemplateRemoveUserRequest](docs/TemplateRemoveUserRequest.md)
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.10.0
1.11.0
1 change: 1 addition & 0 deletions docs/AccountResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,5 @@
| `team_id` | ```String``` | The id of the team account belongs to. | |
| `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. | |
| `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | |
| `settings` | [```AccountResponseSettings```](AccountResponseSettings.md) | | |

12 changes: 12 additions & 0 deletions docs/AccountResponseSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Dropbox::Sign::AccountResponseSettings

Subset of configured settings

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `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). | |
| `sms_delivery` | ```Boolean``` | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |
| `sms_authentication` | ```Boolean``` | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |

4 changes: 4 additions & 0 deletions docs/SignatureRequestApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,7 @@ signing_options.draw = true
signing_options.phone = false
signing_options.type = true
signing_options.upload = true
signing_options.force_advanced_signature_details = false

signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
signers_1.name = "Jack"
Expand Down Expand Up @@ -497,6 +498,7 @@ signing_options.draw = true
signing_options.phone = false
signing_options.type = true
signing_options.upload = true
signing_options.force_advanced_signature_details = false

signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
signers_1.role = "Client"
Expand Down Expand Up @@ -1609,6 +1611,7 @@ signing_options.draw = true
signing_options.phone = false
signing_options.type = true
signing_options.upload = true
signing_options.force_advanced_signature_details = false

signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
signers_1.name = "Jack"
Expand Down Expand Up @@ -1723,6 +1726,7 @@ signing_options.draw = true
signing_options.phone = false
signing_options.type = true
signing_options.upload = true
signing_options.force_advanced_signature_details = false

signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
signers_1.role = "Client"
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestEditRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
| `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
| `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` | |
| `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] |
| `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.&lt;br&gt;<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] |
| `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.&lt;br&gt;<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] |
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
| `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&#39;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. | |
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestEditWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
| `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
| `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. | |
| `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. | |
| `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.&lt;br&gt;<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] |
| `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.&lt;br&gt;<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] |
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
| `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&#39;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. | |
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestSendRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
| `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` | |
| `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] |
| `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&#39;s identity.&lt;br&gt;<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] |
| `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.&lt;br&gt;<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] |
| `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.&lt;br&gt;<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] |
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
| `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&#39;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. | |
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestSendWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
| `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. | |
| `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. | |
| `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&#39;s identity.&lt;br&gt;<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] |
| `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.&lt;br&gt;<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] |
| `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.&lt;br&gt;<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] |
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
| `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&#39;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. | |
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
5 changes: 4 additions & 1 deletion docs/SubSigningOptions.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Dropbox::Sign::SubSigningOptions

This allows the requester to specify the types allowed for creating a signature.
This allows the requester to specify the types allowed for creating a signature and specify another signing options.

**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.

**NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.

## Properties

| Name | Type | Description | Notes |
Expand All @@ -13,4 +15,5 @@ This allows the requester to specify the types allowed for creating a signature.
| `phone` | ```Boolean``` | Allows using a smartphone to email the signature | [default to false] |
| `type` | ```Boolean``` | Allows typing the signature | [default to false] |
| `upload` | ```Boolean``` | Allows uploading the signature | [default to false] |
| `force_advanced_signature_details` | ```Boolean``` | Turning on advanced signature details for the signature request | [default to false] |

2 changes: 1 addition & 1 deletion docs/TemplateApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ end

Create Template

Creates a template that can then be used.
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.

### Examples

Expand Down
10 changes: 0 additions & 10 deletions docs/TemplateEditResponse.md

This file was deleted.

1 change: 1 addition & 0 deletions examples/SignatureRequestCreateEmbeddedExample.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
signing_options.phone = false
signing_options.type = true
signing_options.upload = true
signing_options.force_advanced_signature_details = false

signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
signers_1.name = "Jack"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
signing_options.phone = false
signing_options.type = true
signing_options.upload = true
signing_options.force_advanced_signature_details = false

signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
signers_1.role = "Client"
Expand Down
1 change: 1 addition & 0 deletions examples/SignatureRequestSendExample.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
signing_options.phone = false
signing_options.type = true
signing_options.upload = true
signing_options.force_advanced_signature_details = false

signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
signers_1.name = "Jack"
Expand Down
1 change: 1 addition & 0 deletions examples/SignatureRequestSendWithTemplateExample.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
signing_options.phone = false
signing_options.type = true
signing_options.upload = true
signing_options.force_advanced_signature_details = false

signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
signers_1.role = "Client"
Expand Down
Loading
Loading