Release 1.5.0 (#12)

hellosign · Aug 22, 2024 · 7016194 · 7016194
1 parent 9c9e88d
commit 7016194
Show file tree

Hide file tree

Showing 228 changed files with 1,575 additions and 1,077 deletions.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -0,0 +1,26 @@
+.ruby: &ruby
+  variables:
+    LANG: "C.UTF-8"
+  before_script:
+    - ruby -v
+    - bundle config set --local deployment true
+    - bundle install -j $(nproc)
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0', '3.1']
+  image: "ruby:$RUBY_VERSION"
+  cache:
+    paths:
+      - vendor/ruby
+    key: 'ruby-$RUBY_VERSION'
+
+gem:
+  extends: .ruby
+  script:
+    - bundle exec rspec
+    - bundle exec rake build
+    - bundle exec rake install
+  artifacts:
+    paths:
+      - pkg/*.gem
+
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -1,4 +1,5 @@
 .gitignore
+.gitlab-ci.yml
 .rspec
 .rubocop.yml
 .travis.yml
@@ -12,6 +13,7 @@ docs/AccountCreateResponse.md
 docs/AccountGetResponse.md
 docs/AccountResponse.md
 docs/AccountResponseQuotas.md
+docs/AccountResponseUsage.md
 docs/AccountUpdateRequest.md
 docs/AccountVerifyRequest.md
 docs/AccountVerifyResponse.md
@@ -208,6 +210,7 @@ lib/dropbox-sign/models/account_create_response.rb
 lib/dropbox-sign/models/account_get_response.rb
 lib/dropbox-sign/models/account_response.rb
 lib/dropbox-sign/models/account_response_quotas.rb
+lib/dropbox-sign/models/account_response_usage.rb
 lib/dropbox-sign/models/account_update_request.rb
 lib/dropbox-sign/models/account_verify_request.rb
 lib/dropbox-sign/models/account_verify_response.rb
@@ -375,6 +378,4 @@ lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb
 lib/dropbox-sign/models/unclaimed_draft_response.rb
 lib/dropbox-sign/models/warning_response.rb
 lib/dropbox-sign/version.rb
-spec/api_client_spec.rb
-spec/configuration_spec.rb
 spec/spec_helper.rb
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -1 +1 @@
-5.3.0
+7.7.0
diff --git a/.travis.yml b/.travis.yml
@@ -1,14 +1,11 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
   - 2.7
   - 3.0
+  - 3.1
 script:
   - bundle install --path vendor/bundle
   - bundle exec rspec
   - gem build dropbox-sign.gemspec
-  - gem install ./dropbox-sign-1.4.1.gem
+  - gem install ./dropbox-sign-1.5.0.gem
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dropbox-sign (1.4.1)
+    dropbox-sign (1.5.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -10,45 +10,47 @@ GEM
     ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     ethon (0.16.0)
       ffi (>= 1.15.0)
     ffi (1.17.0-aarch64-linux-gnu)
     ffi (1.17.0-arm64-darwin)
     ffi (1.17.0-x86_64-darwin)
     ffi (1.17.0-x86_64-linux-gnu)
-    jaro_winkler (1.5.4)
+    jaro_winkler (1.5.6)
     json_spec (1.1.5)
       multi_json (~> 1.0)
       rspec (>= 2.0, < 4.0)
-    method_source (1.0.0)
+    method_source (1.1.0)
     multi_json (1.15.0)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    parallel (1.26.3)
+    parser (3.3.4.2)
       ast (~> 2.4.1)
-    pry (0.13.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
-    psych (4.0.3)
+      pry (>= 0.13, < 0.15)
+    psych (5.1.2)
       stringio
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -57,8 +59,8 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.11.0)
-    stringio (3.0.1)
+    ruby-progressbar (1.13.0)
+    stringio (3.1.1)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     unicode-display_width (1.5.0)
@@ -79,4 +81,4 @@ DEPENDENCIES
   rubocop (~> 0.66.0)
 
 BUNDLED WITH
-   2.3.5
+   2.3.26
diff --git a/README.md b/README.md
@@ -25,7 +25,8 @@ 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.4.1
+- Package version: 1.5.0
+- Generator version: 7.7.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -46,14 +47,14 @@ gem build dropbox-sign.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./dropbox-sign-1.4.1.gem
+gem install ./dropbox-sign-1.5.0.gem
 ```
 
-(for development, run `gem install --dev ./dropbox-sign-1.4.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dropbox-sign-1.5.0.gem` to install the development dependencies)
 
 Finally add this to the Gemfile:
 
-    gem 'dropbox-sign', '~> 1.4.1'
+    gem 'dropbox-sign', '~> 1.5.0'
 
 ### Install from Git
 
@@ -172,6 +173,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::AccountResponseUsage](docs/AccountResponseUsage.md)
  - [Dropbox::Sign::AccountUpdateRequest](docs/AccountUpdateRequest.md)
  - [Dropbox::Sign::AccountVerifyRequest](docs/AccountVerifyRequest.md)
  - [Dropbox::Sign::AccountVerifyResponse](docs/AccountVerifyResponse.md)

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.4.1
+1.5.0
diff --git a/docs/AccountResponse.md b/docs/AccountResponse.md
@@ -16,4 +16,5 @@
 | `role_code` | ```String``` |  The membership role for the team.  |  |
 | `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) |    |  |
 
diff --git a/docs/AccountResponseQuotas.md b/docs/AccountResponseQuotas.md
@@ -11,4 +11,5 @@ Details concerning remaining monthly quotas.
 | `templates_total` | ```Integer``` |  Total API templates allowed.  |  |
 | `templates_left` | ```Integer``` |  API templates remaining.  |  |
 | `sms_verifications_left` | ```Integer``` |  SMS verifications  remaining.  |  |
+| `num_fax_pages_left` | ```Integer``` |  Number of fax pages left  |  |
 
diff --git a/docs/AccountResponseUsage.md b/docs/AccountResponseUsage.md
@@ -0,0 +1,10 @@
+# Dropbox::Sign::AccountResponseUsage
+
+Details concerning monthly usage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `fax_pages_sent` | ```Integer``` |  Number of fax pages sent  |  |
+
diff --git a/dropbox-sign.gemspec b/dropbox-sign.gemspec
@@ -8,7 +8,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
   s.description = "Official Dropbox Sign APIv3 OpenAPI Ruby SDK"
   s.license     = "MIT"
   s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
 

diff --git a/lib/dropbox-sign.rb b/lib/dropbox-sign.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -22,6 +22,7 @@
 require 'dropbox-sign/models/account_get_response'
 require 'dropbox-sign/models/account_response'
 require 'dropbox-sign/models/account_response_quotas'
+require 'dropbox-sign/models/account_response_usage'
 require 'dropbox-sign/models/account_update_request'
 require 'dropbox-sign/models/account_verify_request'
 require 'dropbox-sign/models/account_verify_response'

diff --git a/lib/dropbox-sign/api/account_api.rb b/lib/dropbox-sign/api/account_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/dropbox-sign/api/api_app_api.rb b/lib/dropbox-sign/api/api_app_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -306,8 +306,8 @@ def api_app_list(opts = {})
     # List API Apps
     # Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Which page number of the API App List to return. Defaults to &#x60;1&#x60;.
-    # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;.
+    # @option opts [Integer] :page Which page number of the API App List to return. Defaults to &#x60;1&#x60;. (default to 1)
+    # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;. (default to 20)
     # @return [Array<(ApiAppListResponse, Integer, Hash)>] ApiAppListResponse data, response status code and response headers
     def api_app_list_with_http_info(opts = {})
       if @api_client.config.debugging

diff --git a/lib/dropbox-sign/api/bulk_send_job_api.rb b/lib/dropbox-sign/api/bulk_send_job_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -38,8 +38,8 @@ def bulk_send_job_get(bulk_send_job_id, opts = {})
     # Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
     # @param bulk_send_job_id [String] The id of the BulkSendJob to retrieve.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;.
-    # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20.
+    # @option opts [Integer] :page Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (default to 1)
+    # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (default to 20)
     # @return [Array<(BulkSendJobGetResponse, Integer, Hash)>] BulkSendJobGetResponse data, response status code and response headers
     def bulk_send_job_get_with_http_info(bulk_send_job_id, opts = {})
       if @api_client.config.debugging
@@ -136,8 +136,8 @@ def bulk_send_job_list(opts = {})
     # List Bulk Send Jobs
     # Returns a list of BulkSendJob that you can access.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;.
-    # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20.
+    # @option opts [Integer] :page Which page number of the BulkSendJob List to return. Defaults to &#x60;1&#x60;. (default to 1)
+    # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (default to 20)
     # @return [Array<(BulkSendJobListResponse, Integer, Hash)>] BulkSendJobListResponse data, response status code and response headers
     def bulk_send_job_list_with_http_info(opts = {})
       if @api_client.config.debugging

diff --git a/lib/dropbox-sign/api/embedded_api.rb b/lib/dropbox-sign/api/embedded_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/dropbox-sign/api/o_auth_api.rb b/lib/dropbox-sign/api/o_auth_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/dropbox-sign/api/report_api.rb b/lib/dropbox-sign/api/report_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/dropbox-sign/api/signature_request_api.rb b/lib/dropbox-sign/api/signature_request_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.7.0
 
 =end
 
@@ -540,7 +540,7 @@ def signature_request_files(signature_request_id, opts = {})
     # Obtain a copy of the current documents specified by the &#x60;signature_request_id&#x60; parameter. Returns a PDF or ZIP file.  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 [String] :file_type Set to &#x60;pdf&#x60; for a single merged document or &#x60;zip&#x60; for a collection of individual documents.
+    # @option opts [String] :file_type Set to &#x60;pdf&#x60; for a single merged document or &#x60;zip&#x60; for a collection of individual documents. (default to 'pdf')
     # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
     def signature_request_files_with_http_info(signature_request_id, opts = {})
       if @api_client.config.debugging
@@ -735,7 +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.
+    # @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 [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
@@ -928,8 +928,8 @@ def signature_request_list(opts = {})
     # Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on.  Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :account_id Which account to return SignatureRequests for. Must be a team member. Use &#x60;all&#x60; to indicate all team members. Defaults to your account.
-    # @option opts [Integer] :page Which page number of the SignatureRequest List to return. Defaults to &#x60;1&#x60;.
-    # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;.
+    # @option opts [Integer] :page Which page number of the SignatureRequest List to return. Defaults to &#x60;1&#x60;. (default to 1)
+    # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;. (default to 20)
     # @option opts [String] :query String that includes search terms and/or fields to be used to filter the SignatureRequest objects.
     # @return [Array<(SignatureRequestListResponse, Integer, Hash)>] SignatureRequestListResponse data, response status code and response headers
     def signature_request_list_with_http_info(opts = {})