Skip to content

Commit

Permalink
Release 1.3.0 (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
jtreminio-dropbox authored Jan 29, 2024
1 parent 16acba5 commit d0027fb
Show file tree
Hide file tree
Showing 16 changed files with 163 additions and 122 deletions.
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.2.0.gem
- gem install ./dropbox-sign-1.3.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.2.0)
dropbox-sign (1.3.0)
typhoeus (~> 1.0, >= 1.0.1)

GEM
Expand Down Expand Up @@ -56,7 +56,7 @@ GEM
unicode-display_width (>= 1.4.0, < 1.6)
ruby-progressbar (1.11.0)
stringio (3.0.1)
typhoeus (1.4.0)
typhoeus (1.4.1)
ethon (>= 0.9.0)
unicode-display_width (1.5.0)

Expand Down
8 changes: 4 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.2.0
- Package version: 1.3.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.2.0.gem
gem install ./dropbox-sign-1.3.0.gem
```

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

Finally add this to the Gemfile:

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

### Install from Git

Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.2.0
1.3.0
7 changes: 4 additions & 3 deletions docs/SignatureRequestApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,7 @@ end

## `signature_request_files_as_file_url`

> `<FileResponse> signature_request_files_as_file_url(signature_request_id)`
> `<FileResponse> signature_request_files_as_file_url(signature_request_id, opts)`
Download Files as File Url

Expand Down Expand Up @@ -687,12 +687,12 @@ end

This returns an Array which contains the response data, status code and headers.

> `<Array(<FileResponse>, Integer, Hash)> signature_request_files_as_file_url_with_http_info(signature_request_id)`
> `<Array(<FileResponse>, Integer, Hash)> signature_request_files_as_file_url_with_http_info(signature_request_id, opts)`
```ruby
begin
# Download Files as File Url
data, status_code, headers = api_instance.signature_request_files_as_file_url_with_http_info(signature_request_id)
data, status_code, headers = api_instance.signature_request_files_as_file_url_with_http_info(signature_request_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <FileResponse>
Expand All @@ -706,6 +706,7 @@ end
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `signature_request_id` | **String** | The id of the SignatureRequest to retrieve. | |
| `force_download` | **Integer** | By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional][default to 1] |

### Return type

Expand Down
7 changes: 4 additions & 3 deletions docs/TemplateApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@ end

## `template_files_as_file_url`

> `<FileResponse> template_files_as_file_url(template_id)`
> `<FileResponse> template_files_as_file_url(template_id, opts)`
Get Template Files as File Url

Expand Down Expand Up @@ -550,12 +550,12 @@ end

This returns an Array which contains the response data, status code and headers.

> `<Array(<FileResponse>, Integer, Hash)> template_files_as_file_url_with_http_info(template_id)`
> `<Array(<FileResponse>, Integer, Hash)> template_files_as_file_url_with_http_info(template_id, opts)`
```ruby
begin
# Get Template Files as File Url
data, status_code, headers = api_instance.template_files_as_file_url_with_http_info(template_id)
data, status_code, headers = api_instance.template_files_as_file_url_with_http_info(template_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <FileResponse>
Expand All @@ -569,6 +569,7 @@ end
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `template_id` | **String** | The id of the template files to retrieve. | |
| `force_download` | **Integer** | By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional][default to 1] |

### Return type

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

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| `template` | [```TemplateCreateResponse```](TemplateCreateResponse.md) | | |
| `template` | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | |
| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |

1 change: 1 addition & 0 deletions docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,5 @@
| `test_mode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
| `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
| `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer&#39;s information during signing.<br><br>⚠️ **Note** ⚠️: Keep your signer&#39;s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
| `allow_ccs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to false] |

3 changes: 3 additions & 0 deletions lib/dropbox-sign/api/signature_request_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -724,6 +724,7 @@ def signature_request_files_as_data_uri_with_http_info(signature_request_id, opt
# Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
# @param signature_request_id [String] The id of the SignatureRequest to retrieve.
# @param [Hash] opts the optional parameters
# @option opts [Integer] :force_download By default when opening the &#x60;file_url&#x60; a browser will download the PDF and save it locally. When set to &#x60;0&#x60; the PDF file will be displayed in the browser. (default to 1)
# @return [FileResponse]
def signature_request_files_as_file_url(signature_request_id, opts = {})
data, _status_code, _headers = signature_request_files_as_file_url_with_http_info(signature_request_id, opts)
Expand All @@ -734,6 +735,7 @@ def signature_request_files_as_file_url(signature_request_id, opts = {})
# Obtain a copy of the current documents specified by the &#x60;signature_request_id&#x60; parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of &#x60;409&#x60; will be returned instead.
# @param signature_request_id [String] The id of the SignatureRequest to retrieve.
# @param [Hash] opts the optional parameters
# @option opts [Integer] :force_download By default when opening the &#x60;file_url&#x60; a browser will download the PDF and save it locally. When set to &#x60;0&#x60; the PDF file will be displayed in the browser.
# @return [Array<(FileResponse, Integer, Hash)>] FileResponse data, response status code and response headers
def signature_request_files_as_file_url_with_http_info(signature_request_id, opts = {})
if @api_client.config.debugging
Expand All @@ -748,6 +750,7 @@ def signature_request_files_as_file_url_with_http_info(signature_request_id, opt

# query parameters
query_params = opts[:query_params] || {}
query_params[:'force_download'] = opts[:'force_download'] if !opts[:'force_download'].nil?

# header parameters
header_params = opts[:header_params] || {}
Expand Down
3 changes: 3 additions & 0 deletions lib/dropbox-sign/api/template_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -621,6 +621,7 @@ def template_files_as_data_uri_with_http_info(template_id, opts = {})
# Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
# @param template_id [String] The id of the template files to retrieve.
# @param [Hash] opts the optional parameters
# @option opts [Integer] :force_download By default when opening the &#x60;file_url&#x60; a browser will download the PDF and save it locally. When set to &#x60;0&#x60; the PDF file will be displayed in the browser. (default to 1)
# @return [FileResponse]
def template_files_as_file_url(template_id, opts = {})
data, _status_code, _headers = template_files_as_file_url_with_http_info(template_id, opts)
Expand All @@ -631,6 +632,7 @@ def template_files_as_file_url(template_id, opts = {})
# Obtain a copy of the current documents specified by the &#x60;template_id&#x60; parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of &#x60;409&#x60; will be returned instead. In this case please wait for the &#x60;template_created&#x60; callback event.
# @param template_id [String] The id of the template files to retrieve.
# @param [Hash] opts the optional parameters
# @option opts [Integer] :force_download By default when opening the &#x60;file_url&#x60; a browser will download the PDF and save it locally. When set to &#x60;0&#x60; the PDF file will be displayed in the browser.
# @return [Array<(FileResponse, Integer, Hash)>] FileResponse data, response status code and response headers
def template_files_as_file_url_with_http_info(template_id, opts = {})
if @api_client.config.debugging
Expand All @@ -645,6 +647,7 @@ def template_files_as_file_url_with_http_info(template_id, opts = {})

# query parameters
query_params = opts[:query_params] || {}
query_params[:'force_download'] = opts[:'force_download'] if !opts[:'force_download'].nil?

# header parameters
header_params = opts[:header_params] || {}
Expand Down
4 changes: 2 additions & 2 deletions lib/dropbox-sign/models/template_create_response.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ module Dropbox

module Dropbox::Sign
class TemplateCreateResponse
# @return [TemplateCreateResponse]
# @return [TemplateCreateResponseTemplate]
attr_accessor :template

# A list of warnings.
Expand Down Expand Up @@ -46,7 +46,7 @@ def self.merged_attributes
# Attribute type mapping.
def self.openapi_types
{
:'template' => :'TemplateCreateResponse',
:'template' => :'TemplateCreateResponseTemplate',
:'warnings' => :'Array<WarningResponse>'
}
end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,10 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest
# @return [Boolean]
attr_accessor :populate_auto_fill_fields

# This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
# @return [Boolean]
attr_accessor :allow_ccs

# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
Expand Down Expand Up @@ -162,7 +166,8 @@ def self.attribute_map
:'subject' => :'subject',
:'test_mode' => :'test_mode',
:'title' => :'title',
:'populate_auto_fill_fields' => :'populate_auto_fill_fields'
:'populate_auto_fill_fields' => :'populate_auto_fill_fields',
:'allow_ccs' => :'allow_ccs'
}
end

Expand Down Expand Up @@ -207,7 +212,8 @@ def self.openapi_types
:'subject' => :'String',
:'test_mode' => :'Boolean',
:'title' => :'String',
:'populate_auto_fill_fields' => :'Boolean'
:'populate_auto_fill_fields' => :'Boolean',
:'allow_ccs' => :'Boolean'
}
end

Expand Down Expand Up @@ -405,6 +411,12 @@ def initialize(attributes = {})
else
self.populate_auto_fill_fields = false
end

if attributes.key?(:'allow_ccs')
self.allow_ccs = attributes[:'allow_ccs']
else
self.allow_ccs = false
end
end

# Show invalid properties with the reasons. Usually used together with valid?
Expand Down Expand Up @@ -519,7 +531,8 @@ def ==(o)
subject == o.subject &&
test_mode == o.test_mode &&
title == o.title &&
populate_auto_fill_fields == o.populate_auto_fill_fields
populate_auto_fill_fields == o.populate_auto_fill_fields &&
allow_ccs == o.allow_ccs
end

# @see the `==` method
Expand All @@ -531,7 +544,7 @@ def eql?(o)
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[client_id, requester_email_address, template_ids, allow_decline, allow_reassign, ccs, custom_fields, editor_options, field_options, files, file_urls, force_signer_roles, force_subject_message, hold_request, is_for_embedded_signing, message, metadata, preview_only, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, title, populate_auto_fill_fields].hash
[client_id, requester_email_address, template_ids, allow_decline, allow_reassign, ccs, custom_fields, editor_options, field_options, files, file_urls, force_signer_roles, force_subject_message, hold_request, is_for_embedded_signing, message, metadata, preview_only, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, title, populate_auto_fill_fields, allow_ccs].hash
end

# Builds the object from hash
Expand Down
2 changes: 1 addition & 1 deletion lib/dropbox-sign/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ module Dropbox
end

module Dropbox::Sign
VERSION = '1.2.0'
VERSION = '1.3.0'
end
2 changes: 1 addition & 1 deletion openapi-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ additionalProperties:
gemName: dropbox-sign
gemRequiredRubyVersion: '>= 2.7'
moduleName: "Dropbox::Sign"
gemVersion: 1.2.0
gemVersion: 1.3.0
sortModelPropertiesByRequiredFlag: true
legacyDiscriminatorBehavior: true
gitUserId: hellosign
Expand Down
Loading

0 comments on commit d0027fb

Please sign in to comment.