Skip to content

Commit 332c517

Browse files
authored
Version 2.9.0.rc1-v2-21.1.01 release (#80)
1 parent 0854af0 commit 332c517

File tree

7 files changed

+351
-97
lines changed

7 files changed

+351
-97
lines changed

README.md

Lines changed: 22 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# The Official DocuSign Ruby Client
1+
# The Official DocuSign eSignature Ruby Client SDK
22

33
[![RubyGems version][rubygems-image]][rubygems-url]
44
[![RubyGems downloads][downloads-image]][downloads-url]
@@ -13,66 +13,48 @@
1313

1414
- Ruby 1.9+
1515

16-
## Note
17-
18-
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.
19-
2016
## Installation
17+
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.
2118

22-
### Install via your application's **Gemfile**:
23-
24-
1. In your application's **Gemfile**, add:
25-
**gem 'docusign_esign'**
19+
### Installation via your application's Gemfile:
20+
1. In your application's Gemfile, add:
21+
`gem 'docusign_esign'`
2622
2. Open your preferred console.
27-
3. In your project directory, execute the installer by typing:
28-
**bundle install**
29-
30-
### Manual install:
23+
3. In your project directory, execute the installer by typing: **bundle install**
3124

25+
### Manual installation:
3226
1. Open your preferred console.
33-
2. In the console, type:
34-
**gem install docusign_esign**
27+
2. In the console, type: **gem install docusign_esign**
3528

3629
### Dependencies
37-
3830
This client has the following external dependencies:
31+
* Jwt>=1.5.2
32+
* Json>=2.1.0
33+
* Typhoeus>=1.0.1
3934

40-
- Jwt>=1.5.2
41-
- Json>=2.1.0
42-
- Typhoeus>=1.0.1
43-
44-
## Code Examples
45-
46-
### Launchers
35+
## Code examples
36+
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.
4737

48-
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.
49-
50-
### Proof-of-concept applications
51-
52-
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.
53-
54-
## OAuth Implementations
55-
56-
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).
38+
## OAuth implementations
39+
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/).
5740

5841
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
5942

60-
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:
61-
62-
- [JWT (JSON Web Token)](https://github.com/docusign/eg-03-ruby-auth-code-grant)
63-
- Implicit Grant (coming soon)
64-
6543
## Support
66-
6744
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
6845

6946
## License
47+
The DocuSign eSignature Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
7048

71-
The DocuSign Ruby Client is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
49+
### Additional resources
50+
* [DocuSign Developer Center](https://developers.docusign.com/)
51+
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
52+
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
53+
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
7254

7355
[rubygems-image]: https://img.shields.io/gem/v/docusign_esign.svg?style=flat
7456
[rubygems-url]: https://rubygems.org/gems/docusign_esign
7557
[downloads-image]: https://img.shields.io/gem/dt/docusign_esign.svg?style=flat
7658
[downloads-url]: https://rubygems.org/gems/docusign_esign
7759
[travis-image]: https://img.shields.io/travis/docusign/docusign-ruby-client.svg?style=flat
78-
[travis-url]: https://travis-ci.org/docusign/docusign-ruby-client
60+
[travis-url]: https://travis-ci.org/docusign/docusign-ruby-client

lib/docusign_esign.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,9 +403,9 @@
403403
require 'docusign_esign/api/notary_api'
404404
require 'docusign_esign/api/organizations_api'
405405
require 'docusign_esign/api/power_forms_api'
406+
require 'docusign_esign/api/signature_api'
406407
require 'docusign_esign/api/signing_groups_api'
407408
require 'docusign_esign/api/templates_api'
408-
require 'docusign_esign/api/trust_service_providers_api'
409409
require 'docusign_esign/api/users_api'
410410
require 'docusign_esign/api/workspaces_api'
411411

lib/docusign_esign/api/accounts_api.rb

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1785,6 +1785,55 @@ def get_provisioning_with_http_info()
17851785
return data, status_code, headers
17861786
end
17871787

1788+
# Returns Account available seals for specified account.
1789+
#
1790+
# @param account_id The external account number (int) or account ID Guid.
1791+
# @return [AccountSeals]
1792+
def get_seal_providers(account_id)
1793+
data, _status_code, _headers = get_seal_providers_with_http_info(account_id)
1794+
return data
1795+
end
1796+
1797+
# Returns Account available seals for specified account.
1798+
#
1799+
# @param account_id The external account number (int) or account ID Guid.
1800+
# @return [Array<(AccountSeals, Fixnum, Hash)>] AccountSeals data, response status code and response headers
1801+
def get_seal_providers_with_http_info(account_id)
1802+
if @api_client.config.debugging
1803+
@api_client.config.logger.debug "Calling API: AccountsApi.get_seal_providers ..."
1804+
end
1805+
# verify the required parameter 'account_id' is set
1806+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_seal_providers" if account_id.nil?
1807+
# resource path
1808+
local_var_path = "/v2/accounts/{accountId}/seals".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1809+
1810+
# query parameters
1811+
query_params = {}
1812+
1813+
# header parameters
1814+
header_params = {}
1815+
# HTTP header 'Accept' (if needed)
1816+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1817+
1818+
# form parameters
1819+
form_params = {}
1820+
1821+
# http body (model)
1822+
post_body = nil
1823+
auth_names = []
1824+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1825+
:header_params => header_params,
1826+
:query_params => query_params,
1827+
:form_params => form_params,
1828+
:body => post_body,
1829+
:auth_names => auth_names,
1830+
:return_type => 'AccountSeals')
1831+
if @api_client.config.debugging
1832+
@api_client.config.logger.debug "API called: AccountsApi#get_seal_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1833+
end
1834+
return data, status_code, headers
1835+
end
1836+
17881837
# Gets list of supported languages for recipient language setting.
17891838
#
17901839
# @param account_id The external account number (int) or account ID Guid.

lib/docusign_esign/api/connect_api.rb

Lines changed: 1 addition & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ def delete_connect_secret_with_http_info(account_id, key_id)
253253
# verify the required parameter 'key_id' is set
254254
fail ArgumentError, "Missing the required parameter 'key_id' when calling ConnectApi.delete_connect_secret" if key_id.nil?
255255
# resource path
256-
local_var_path = "/v2/accounts/{accountId}/connect/secret/{keyId}/delete".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
256+
local_var_path = "/v2/accounts/{accountId}/connect/secret/{keyId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
257257

258258
# query parameters
259259
query_params = {}
@@ -893,59 +893,6 @@ def list_mobile_notifiers_with_http_info(account_id)
893893
return data, status_code, headers
894894
end
895895

896-
# Test connect configuration.
897-
#
898-
# @param account_id The external account number (int) or account ID Guid.
899-
# @param connect_id The ID of the custom Connect configuration being accessed.
900-
# @return [ResourceInformation]
901-
def list_tests(account_id, connect_id)
902-
data, _status_code, _headers = list_tests_with_http_info(account_id, connect_id)
903-
return data
904-
end
905-
906-
# Test connect configuration.
907-
#
908-
# @param account_id The external account number (int) or account ID Guid.
909-
# @param connect_id The ID of the custom Connect configuration being accessed.
910-
# @return [Array<(ResourceInformation, Fixnum, Hash)>] ResourceInformation data, response status code and response headers
911-
def list_tests_with_http_info(account_id, connect_id)
912-
if @api_client.config.debugging
913-
@api_client.config.logger.debug "Calling API: ConnectApi.list_tests ..."
914-
end
915-
# verify the required parameter 'account_id' is set
916-
fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.list_tests" if account_id.nil?
917-
# verify the required parameter 'connect_id' is set
918-
fail ArgumentError, "Missing the required parameter 'connect_id' when calling ConnectApi.list_tests" if connect_id.nil?
919-
# resource path
920-
local_var_path = "/v2/accounts/{accountId}/connect/{connectId}/tests".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'connectId' + '}', connect_id.to_s)
921-
922-
# query parameters
923-
query_params = {}
924-
925-
# header parameters
926-
header_params = {}
927-
# HTTP header 'Accept' (if needed)
928-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
929-
930-
# form parameters
931-
form_params = {}
932-
933-
# http body (model)
934-
post_body = nil
935-
auth_names = []
936-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
937-
:header_params => header_params,
938-
:query_params => query_params,
939-
:form_params => form_params,
940-
:body => post_body,
941-
:auth_names => auth_names,
942-
:return_type => 'ResourceInformation')
943-
if @api_client.config.debugging
944-
@api_client.config.logger.debug "API called: ConnectApi#list_tests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
945-
end
946-
return data, status_code, headers
947-
end
948-
949896
# Returns users from the configured Connect service.
950897
# Returns users from the configured Connect service.
951898
# @param account_id The external account number (int) or account ID Guid.

0 commit comments

Comments
 (0)