Skip to content

Commit

Permalink
Release 1.2.0 (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
jtreminio-dropbox authored Oct 11, 2023
1 parent 49e58ee commit 16acba5
Show file tree
Hide file tree
Showing 53 changed files with 2,613 additions and 321 deletions.
8 changes: 8 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ docs/SubFormFieldsPerDocumentCheckbox.md
docs/SubFormFieldsPerDocumentCheckboxMerge.md
docs/SubFormFieldsPerDocumentDateSigned.md
docs/SubFormFieldsPerDocumentDropdown.md
docs/SubFormFieldsPerDocumentFontEnum.md
docs/SubFormFieldsPerDocumentHyperlink.md
docs/SubFormFieldsPerDocumentInitials.md
docs/SubFormFieldsPerDocumentRadio.md
Expand Down Expand Up @@ -138,6 +139,9 @@ docs/TemplateApi.md
docs/TemplateCreateEmbeddedDraftRequest.md
docs/TemplateCreateEmbeddedDraftResponse.md
docs/TemplateCreateEmbeddedDraftResponseTemplate.md
docs/TemplateCreateRequest.md
docs/TemplateCreateResponse.md
docs/TemplateCreateResponseTemplate.md
docs/TemplateEditResponse.md
docs/TemplateGetResponse.md
docs/TemplateListResponse.md
Expand Down Expand Up @@ -285,6 +289,7 @@ lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb
lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb
lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb
lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb
lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb
lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb
lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb
lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb
Expand Down Expand Up @@ -322,6 +327,9 @@ lib/dropbox-sign/models/template_add_user_request.rb
lib/dropbox-sign/models/template_create_embedded_draft_request.rb
lib/dropbox-sign/models/template_create_embedded_draft_response.rb
lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb
lib/dropbox-sign/models/template_create_request.rb
lib/dropbox-sign/models/template_create_response.rb
lib/dropbox-sign/models/template_create_response_template.rb
lib/dropbox-sign/models/template_edit_response.rb
lib/dropbox-sign/models/template_get_response.rb
lib/dropbox-sign/models/template_list_response.rb
Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ script:
- bundle install --path vendor/bundle
- bundle exec rspec
- gem build dropbox-sign.gemspec
- gem install ./dropbox-sign-1.1.2.gem
- gem install ./dropbox-sign-1.2.0.gem
4 changes: 2 additions & 2 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
dropbox-sign (1.1.2)
dropbox-sign (1.2.0)
typhoeus (~> 1.0, >= 1.0.1)

GEM
Expand All @@ -13,7 +13,7 @@ GEM
diff-lcs (1.5.0)
ethon (0.16.0)
ffi (>= 1.15.0)
ffi (1.15.5)
ffi (1.16.3)
jaro_winkler (1.5.4)
json_spec (1.1.5)
multi_json (~> 1.0)
Expand Down
13 changes: 9 additions & 4 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.1.2
- Package version: 1.2.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen

## Installation
Expand All @@ -46,14 +46,14 @@ gem build dropbox-sign.gemspec
Then install the gem locally:

```shell
gem install ./dropbox-sign-1.1.2.gem
gem install ./dropbox-sign-1.2.0.gem
```

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

Finally add this to the Gemfile:

gem 'dropbox-sign', '~> 1.1.2'
gem 'dropbox-sign', '~> 1.2.0'

### Install from Git

Expand Down Expand Up @@ -149,6 +149,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
|*Dropbox::Sign::TeamApi* | [**team_sub_teams**](docs/TeamApi.md#team_sub_teams) | **GET** /team/sub_teams/{team_id} | List Sub Teams |
|*Dropbox::Sign::TeamApi* | [**team_update**](docs/TeamApi.md#team_update) | **PUT** /team | Update Team |
|*Dropbox::Sign::TemplateApi* | [**template_add_user**](docs/TemplateApi.md#template_add_user) | **POST** /template/add_user/{template_id} | Add User to Template |
|*Dropbox::Sign::TemplateApi* | [**template_create**](docs/TemplateApi.md#template_create) | **POST** /template/create | Create Template |
|*Dropbox::Sign::TemplateApi* | [**template_create_embedded_draft**](docs/TemplateApi.md#template_create_embedded_draft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft |
|*Dropbox::Sign::TemplateApi* | [**template_delete**](docs/TemplateApi.md#template_delete) | **POST** /template/delete/{template_id} | Delete Template |
|*Dropbox::Sign::TemplateApi* | [**template_files**](docs/TemplateApi.md#template_files) | **GET** /template/files/{template_id} | Get Template Files |
Expand Down Expand Up @@ -252,6 +253,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
- [Dropbox::Sign::SubFormFieldsPerDocumentCheckboxMerge](docs/SubFormFieldsPerDocumentCheckboxMerge.md)
- [Dropbox::Sign::SubFormFieldsPerDocumentDateSigned](docs/SubFormFieldsPerDocumentDateSigned.md)
- [Dropbox::Sign::SubFormFieldsPerDocumentDropdown](docs/SubFormFieldsPerDocumentDropdown.md)
- [Dropbox::Sign::SubFormFieldsPerDocumentFontEnum](docs/SubFormFieldsPerDocumentFontEnum.md)
- [Dropbox::Sign::SubFormFieldsPerDocumentHyperlink](docs/SubFormFieldsPerDocumentHyperlink.md)
- [Dropbox::Sign::SubFormFieldsPerDocumentInitials](docs/SubFormFieldsPerDocumentInitials.md)
- [Dropbox::Sign::SubFormFieldsPerDocumentRadio](docs/SubFormFieldsPerDocumentRadio.md)
Expand Down Expand Up @@ -289,6 +291,9 @@ All URIs are relative to *https://api.hellosign.com/v3*
- [Dropbox::Sign::TemplateCreateEmbeddedDraftRequest](docs/TemplateCreateEmbeddedDraftRequest.md)
- [Dropbox::Sign::TemplateCreateEmbeddedDraftResponse](docs/TemplateCreateEmbeddedDraftResponse.md)
- [Dropbox::Sign::TemplateCreateEmbeddedDraftResponseTemplate](docs/TemplateCreateEmbeddedDraftResponseTemplate.md)
- [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)
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.1.2
1.2.0
16 changes: 0 additions & 16 deletions docs/OAuthApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,6 @@ Once you have retrieved the code from the user callback, you will need to exchan
```ruby
require "dropbox-sign"

Dropbox::Sign.configure do |config|
# Configure HTTP basic authorization: api_key
config.username = "YOUR_API_KEY"

# or, configure Bearer (JWT) authorization: oauth2
# config.access_token = "YOUR_ACCESS_TOKEN"
end

oauth_api = Dropbox::Sign::OAuthApi.new

data = Dropbox::Sign::OAuthTokenGenerateRequest.new
Expand Down Expand Up @@ -97,14 +89,6 @@ Access tokens are only valid for a given period of time (typically one hour) for
```ruby
require "dropbox-sign"

Dropbox::Sign.configure do |config|
# Configure HTTP basic authorization: api_key
config.username = "YOUR_API_KEY"

# or, configure Bearer (JWT) authorization: oauth2
# config.access_token = "YOUR_ACCESS_TOKEN"
end

oauth_api = Dropbox::Sign::OAuthApi.new

data = Dropbox::Sign::OAuthTokenRefreshRequest.new
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1305,7 +1305,7 @@ end
Update Signature Request

Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. **NOTE**: This action cannot be performed on a signature request with an appended signature page.
Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE**: This action cannot be performed on a signature request with an appended signature page.

### Examples

Expand Down
1 change: 1 addition & 0 deletions docs/SignatureRequestSendRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +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] |
| `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
1 change: 1 addition & 0 deletions docs/SignatureRequestSendWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +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] |
| `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/SignatureRequestUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `signature_id`<sup>*_required_</sup> | ```String``` | The signature ID for the recipient. | |
| `email_address` | ```String``` | The new email address for the recipient.<br><br>**NOTE**: Optional if `name` is provided. | |
| `email_address` | ```String``` | The new email address for the recipient.<br><br>This will generate a new `signature_id` value.<br><br>**NOTE**: Optional if `name` is provided. | |
| `name` | ```String``` | The new name for the recipient.<br><br>**NOTE**: Optional if `email_address` is provided. | |
| `expires_at` | ```Integer``` | The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | |

2 changes: 1 addition & 1 deletion docs/SubFormFieldsPerDocumentBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The fields that should appear on the document, expressed as an array of objects.
| `api_id`<sup>*_required_</sup> | ```String``` | An identifier for the field that is unique across all documents in the request. | |
| `height`<sup>*_required_</sup> | ```Integer``` | Size of the field in pixels. | |
| `required`<sup>*_required_</sup> | ```Boolean``` | Whether this field is required. | |
| `signer`<sup>*_required_</sup> | ```String``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.<br><br>**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | |
| `signer`<sup>*_required_</sup> | ```String``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.<br><br>**NOTE**: To set the value of the field as the preparer you must set this to `me_now`<br><br>**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | |
| `type`<sup>*_required_</sup> | ```String``` | | |
| `width`<sup>*_required_</sup> | ```Integer``` | Size of the field in pixels. | |
| `x`<sup>*_required_</sup> | ```Integer``` | Location coordinates of the field in pixels. | |
Expand Down
2 changes: 2 additions & 0 deletions docs/SubFormFieldsPerDocumentDateSigned.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `type`<sup>*_required_</sup> | ```String``` | A date. Use the `SubFormFieldsPerDocumentDateSigned` class. | [default to 'date_signed'] |
| `font_family` | ```String``` | Font family for the field. | |
| `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |

2 changes: 2 additions & 0 deletions docs/SubFormFieldsPerDocumentDropdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
| `type`<sup>*_required_</sup> | ```String``` | An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class. | [default to 'dropdown'] |
| `options`<sup>*_required_</sup> | ```Array<String>``` | Array of string values representing dropdown values. | |
| `content` | ```String``` | Selected value in `options` array. Value must exist in array. | |
| `font_family` | ```String``` | Font family for the field. | |
| `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |

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



## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |

2 changes: 2 additions & 0 deletions docs/SubFormFieldsPerDocumentHyperlink.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
| `type`<sup>*_required_</sup> | ```String``` | A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class. | [default to 'hyperlink'] |
| `content`<sup>*_required_</sup> | ```String``` | Link Text. | |
| `content_url`<sup>*_required_</sup> | ```String``` | Link URL. | |
| `font_family` | ```String``` | Font family for the field. | |
| `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |

3 changes: 3 additions & 0 deletions docs/SubFormFieldsPerDocumentText.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,7 @@ This class extends `SubFormFieldsPerDocumentBase`.
| `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.<br><br>**NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | |
| `validation_custom_regex` | ```String``` | | |
| `validation_custom_regex_format_label` | ```String``` | | |
| `content` | ```String``` | Content of a `me_now` text field | |
| `font_family` | ```String``` | Font family for the field. | |
| `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |

2 changes: 2 additions & 0 deletions docs/SubFormFieldsPerDocumentTextMerge.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `type`<sup>*_required_</sup> | ```String``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to 'text-merge'] |
| `font_family` | ```String``` | Font family for the field. | |
| `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |

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

An array of elements and values serialized to a string, to be used to customize the app&#39;s signer page. (Only applies to some API plans)

Take a look at our [white labeling guide](/api/reference/white-labeling/) to learn more.
Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.

## Properties

Expand Down
Loading

0 comments on commit 16acba5

Please sign in to comment.