docusign_esign 2.7.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8ba909cc8ba2be524616359439e96e1a130c0ee2b9f8122f12d325d8cc0ebdf
-  data.tar.gz: 96d2a9cd27b09f38d399372d6a3f4cfa77e0b6c9456fac1fc54f1905b23b4a10
+  metadata.gz: c8c8527868947d076f350d3452425555d53984b8c6f8d0badde3d1596e3fd82e
+  data.tar.gz: b29aa96d9e52b49d23c325ef48f864757d7380137a4024a616430f7897006579
 SHA512:
-  metadata.gz: b2ff3bf05431ae2cfaef3f3c7e2a24f792fb76f24415ec413319be7bce7a40c6cfb58aedac47e01cc157ba02d34159aaa9eb9a5b5b5aa5b10ef3f9626d071f50
-  data.tar.gz: 15ebc9ed032f264e4cb7b8c575e0c61acc25e2889f35bf049dce72af7ad7ec3dd796cf9a1b76fae73bfceb441ca7afe20195da815d05677a96790a3fda5bd3f4
+  metadata.gz: 312110d5cbde42550cc776c6821b1aa4bdc4ba55c0db443c350145aa2e88b5c6ceb1f5d2d9d6241da27c56a11211cd360e3ea79f0178e80ab349efd1764b3b93
+  data.tar.gz: 318c36b5560b2f200c2936a47c85ce9eea4c3d8ccf165b06c5e37120b571bddf829ec2268adc583e5fd9e8b4acba24970fec20856d7d06c07647a32e3f6a5888

data/CHANGELOG.md

@@ -3,6 +3,23 @@ All notable changes to this project will be documented in this file.
 
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v2.10.0.rc1] - eSignature API v2-21.1.02.00 - 2021-05-20
+### Breaking
+- Removed methods `get_account_settings_export`,`get_seal_providers` from Accounts.
+- Removed methods `create_connect_secret`,`delete_connect_secret`,`generate_connect_secret`,`get_connect_secrets` from Connect.
+- Removed methods `complete_sign_hash`,`get_user_info`,`health_check`,`sign_hash_session_info`,`update_transaction` from TrustServiceProviders.
+- Removed method `get_user_list_export` from Users.
+### Changed
+- Added support for version v2-21.1.02.00 of the DocuSign eSignature API.
+- Updated the SDK release version.
+
+## [v2.9.0] - eSignature API v2-21.1.01.03 - 2021-04-25
+### Added
+- Added new method `delete_connect_secret` to connect.
+### Changed
+- Added support for version v2-21.1.01.03 of the DocuSign eSignature API.
+- Updated the SDK release version.
+
 ## [v2.4.0] - eSignature API v2-20.1.02 - 2020-05-31
 ### Changed
 - Added support for version v2-20.1.02 of the DocuSign eSignature API.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docusign_esign (3.6.0.rc1)
+    docusign_esign (3.10.0)
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -14,37 +14,37 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
-    autotest-fsevent (0.2.17)
+    autotest-fsevent (0.2.18)
       sys-uname
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.13.1)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.1)
     hashdiff (1.0.1)
-    json (2.3.1)
-    jwt (2.2.1)
-    public_suffix (4.0.5)
+    json (2.5.1)
+    jwt (2.2.3)
+    public_suffix (4.0.6)
     rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    safe_yaml (1.0.5)
-    sys-uname (1.2.1)
-      ffi (>= 1.0.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     vcr (3.0.3)

data/README.md

@@ -1,4 +1,4 @@
-# The Official DocuSign Ruby Client
+# The Official DocuSign eSignature Ruby Client SDK
 
 [![RubyGems version][rubygems-image]][rubygems-url]
 [![RubyGems downloads][downloads-image]][downloads-url]
@@ -13,66 +13,48 @@
 
 - Ruby 1.9+
 
-## Note
-
-This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the [Developer Center](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below.
-
 ## Installation
+This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our [code examples](https://developers.docusign.com/docs/esign-rest-api/how-to/) from the [DocuSign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.
 
-### Install via your application's **Gemfile**:
-
-1. In your application's **Gemfile**, add:  
-   **gem 'docusign_esign'**
+### Installation via your application's Gemfile:
+1. In your application's Gemfile, add:  
+    `gem 'docusign_esign'`
 2. Open your preferred console.
-3. In your project directory, execute the installer by typing:  
-   **bundle install**
-
-### Manual install:
+3. In your project directory, execute the installer by typing: **bundle install**
 
+### Manual installation:
 1. Open your preferred console.
-2. In the console, type:  
-   **gem install docusign_esign**
+2. In the console, type: **gem install docusign_esign**
 
 ### Dependencies
-
 This client has the following external dependencies:
+*   Jwt>=1.5.2
+*   Json>=2.1.0
+*   Typhoeus>=1.0.1
 
-- Jwt>=1.5.2
-- Json>=2.1.0
-- Typhoeus>=1.0.1
-
-## Code Examples
-
-### Launchers
+## Code examples
+You can find on our GitHub a self-executing package of code examples for the eSignature C# SDK, called a [Launcher](https://github.com/docusign/code-examples-ruby/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows.
 
-DocuSign provides a sample application referred to as a [Launcher](https://github.com/docusign/eg-03-ruby-auth-code-grant). The Launcher contains a set of 14 common use cases and associated source files. These examples use  DocuSign's [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
-
-### Proof-of-concept applications
-
-If your goal is to create a proof-of-concept application, DocuSign provides a set of [Quick Start](https://github.com/docusign/qs-ruby) examples. The Quick Start examples are meant to be used with DocuSign's [OAuth Token Generator](https://developers.docusign.com/oauth-token-generator), which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.
-
-## OAuth Implementations
-
-For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/esign-rest-api/guides/authentication).
+## OAuth implementations
+For details regarding which type of OAuth grant will work best for your DocuSign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [DocuSign Developer Center](https://developers.docusign.com/).
 
 For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
 
-There are other use-case scenarios, such as **single-page applications** (SPA) that use **Cross-Origin Resource Sharing** (CORS), or where there may not be a user to interact with your Service Account. For these use cases, DocuSign also supports [JWT](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) and [Implicit](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-implicit) grants. For code examples, see the links below:
-
-- [JWT (JSON Web Token)](https://github.com/docusign/eg-03-ruby-auth-code-grant)
-- Implicit Grant (coming soon)
-
 ## Support
-
 Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
 
 ## License
+The DocuSign eSignature Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
 
-The DocuSign Ruby Client is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
+### Additional resources
+*   [DocuSign Developer Center](https://developers.docusign.com/)
+*   [DocuSign API on Twitter](https://twitter.com/docusignapi)
+*   [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
+*   [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
 
 [rubygems-image]: https://img.shields.io/gem/v/docusign_esign.svg?style=flat
 [rubygems-url]: https://rubygems.org/gems/docusign_esign
 [downloads-image]: https://img.shields.io/gem/dt/docusign_esign.svg?style=flat
 [downloads-url]: https://rubygems.org/gems/docusign_esign
 [travis-image]: https://img.shields.io/travis/docusign/docusign-ruby-client.svg?style=flat
-[travis-url]: https://travis-ci.org/docusign/docusign-ruby-client
+[travis-url]: https://travis-ci.org/docusign/docusign-ruby-client

data/docusign_esign.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'jwt', '~> 2.2', '>= 2.2.1'
+  s.add_runtime_dependency 'addressable', '~> 2.7', '>= 2.7.0'
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
 

data/lib/docusign_esign.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: v2
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.13-SNAPSHOT
 
 =end
 
@@ -88,7 +87,6 @@ require 'docusign_esign/models/brands_request'
 require 'docusign_esign/models/brands_response'
 require 'docusign_esign/models/bulk_envelope'
 require 'docusign_esign/models/bulk_envelope_status'
-require 'docusign_esign/models/bulk_envelopes_response'
 require 'docusign_esign/models/bulk_recipient'
 require 'docusign_esign/models/bulk_recipient_signature_provider'
 require 'docusign_esign/models/bulk_recipient_tab_label'
@@ -169,6 +167,7 @@ require 'docusign_esign/models/envelope_document'
 require 'docusign_esign/models/envelope_documents_result'
 require 'docusign_esign/models/envelope_event'
 require 'docusign_esign/models/envelope_form_data'
+require 'docusign_esign/models/envelope_form_data_prefill_form_data'
 require 'docusign_esign/models/envelope_id'
 require 'docusign_esign/models/envelope_ids_request'
 require 'docusign_esign/models/envelope_notification_request'
@@ -203,6 +202,7 @@ require 'docusign_esign/models/forgotten_password_information'
 require 'docusign_esign/models/formula_tab'
 require 'docusign_esign/models/full_name'
 require 'docusign_esign/models/group'
+require 'docusign_esign/models/group_brands'
 require 'docusign_esign/models/group_information'
 require 'docusign_esign/models/id_check_information_input'
 require 'docusign_esign/models/in_person_signer'
@@ -251,6 +251,7 @@ require 'docusign_esign/models/payment_gateway_account'
 require 'docusign_esign/models/payment_gateway_accounts_info'
 require 'docusign_esign/models/payment_line_item'
 require 'docusign_esign/models/payment_processor_information'
+require 'docusign_esign/models/payment_signer_values'
 require 'docusign_esign/models/permission_profile'
 require 'docusign_esign/models/permission_profile_information'
 require 'docusign_esign/models/plan_information'
@@ -374,7 +375,6 @@ require 'docusign_esign/models/zip'
 require 'docusign_esign/api/accounts_api'
 require 'docusign_esign/api/authentication_api'
 require 'docusign_esign/api/billing_api'
-require 'docusign_esign/api/bulk_envelopes_api'
 require 'docusign_esign/api/cloud_storage_api'
 require 'docusign_esign/api/connect_api'
 require 'docusign_esign/api/custom_tabs_api'

data/lib/docusign_esign/api/accounts_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: v2
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.13-SNAPSHOT
 
 =end
 
@@ -278,7 +277,7 @@ module DocuSign_eSign
 
     # Creates one or more brand profile files for the account.
     # Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call.  An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version.  When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
-    # @param account_id The external account number (int) or account ID Guid.
+    # @param account_id The external account number (int) or account id GUID.
     # @param brand  (optional parameter)
     # @return [BrandsResponse]
     def create_brand(account_id, brand)
@@ -288,7 +287,7 @@ module DocuSign_eSign
 
     # Creates one or more brand profile files for the account.
     # Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call.  An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version.  When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
-    # @param account_id The external account number (int) or account ID Guid.
+    # @param account_id The external account number (int) or account id GUID.
     # @param brand  (optional parameter)
     # @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
     def create_brand_with_http_info(account_id, brand)
@@ -2465,7 +2464,7 @@ module DocuSign_eSign
 
     # Uploads a branding resource file.
     # 
-    # @param account_id The external account number (int) or account ID Guid.
+    # @param account_id The external account number (int) or account id GUID.
     # @param brand_id The unique identifier of a brand.
     # @param resource_content_type 
     # @return [BrandResources]
@@ -2476,7 +2475,7 @@ module DocuSign_eSign
 
     # Uploads a branding resource file.
     # 
-    # @param account_id The external account number (int) or account ID Guid.
+    # @param account_id The external account number (int) or account id GUID.
     # @param brand_id The unique identifier of a brand.
     # @param resource_content_type 
     # @return [Array<(BrandResources, Fixnum, Hash)>] BrandResources data, response status code and response headers
@@ -2490,6 +2489,8 @@ module DocuSign_eSign
       fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_resources_by_content_type" if brand_id.nil?
       # verify the required parameter 'resource_content_type' is set
       fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.update_brand_resources_by_content_type" if resource_content_type.nil?
+      # verify the required parameter 'file_xml' is set
+      fail ArgumentError, "Missing the required parameter 'file_xml' when calling AccountsApi.update_brand_resources_by_content_type" if file_xml.nil?
       # resource path
       local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s)
 
@@ -2500,9 +2501,12 @@ module DocuSign_eSign
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
 
       # form parameters
       form_params = {}
+      form_params["file.xml"] = file_xml
 
       # http body (model)
       post_body = nil

data/lib/docusign_esign/api/authentication_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: v2
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.13-SNAPSHOT
 
 =end
 

data/lib/docusign_esign/api/billing_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: v2
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.13-SNAPSHOT
 
 =end
 

data/lib/docusign_esign/api/bulk_envelopes_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: v2
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.13-SNAPSHOT
 
 =end
 

data/lib/docusign_esign/api/cloud_storage_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: v2
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.13-SNAPSHOT
 
 =end
 

data/lib/docusign_esign/api/connect_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: v2
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.13-SNAPSHOT
 
 =end
 
@@ -698,59 +697,6 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
-    # Test connect configuration.
-    # 
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param connect_id The ID of the custom Connect configuration being accessed.
-    # @return [ResourceInformation]
-    def list_tests(account_id, connect_id)
-      data, _status_code, _headers = list_tests_with_http_info(account_id, connect_id)
-      return data
-    end
-
-    # Test connect configuration.
-    # 
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param connect_id The ID of the custom Connect configuration being accessed.
-    # @return [Array<(ResourceInformation, Fixnum, Hash)>] ResourceInformation data, response status code and response headers
-    def list_tests_with_http_info(account_id, connect_id)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ConnectApi.list_tests ..."
-      end
-      # verify the required parameter 'account_id' is set
-      fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.list_tests" if account_id.nil?
-      # verify the required parameter 'connect_id' is set
-      fail ArgumentError, "Missing the required parameter 'connect_id' when calling ConnectApi.list_tests" if connect_id.nil?
-      # resource path
-      local_var_path = "/v2/accounts/{accountId}/connect/{connectId}/tests".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'connectId' + '}', connect_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'ResourceInformation')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ConnectApi#list_tests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Returns users from the configured Connect service.
     # Returns users from the configured Connect service.
     # @param account_id The external account number (int) or account ID Guid.

data/lib/docusign_esign/api/custom_tabs_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: v2
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.13-SNAPSHOT
 
 =end
 

data/lib/docusign_esign/api/diagnostics_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: v2
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.13-SNAPSHOT
 
 =end