docusign_esign 3.8.0.rc1 → 3.9.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +24 -53
- data/lib/docusign_esign.rb +3 -1
- data/lib/docusign_esign/api/accounts_api.rb +49 -0
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +4 -0
- data/lib/docusign_esign/api/connect_api.rb +1 -54
- data/lib/docusign_esign/api/envelopes_api.rb +202 -9
- data/lib/docusign_esign/api/signature_api.rb +256 -0
- data/lib/docusign_esign/api/templates_api.rb +4 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +21 -1
- data/lib/docusign_esign/models/account_role_settings.rb +20 -1
- data/lib/docusign_esign/models/account_settings_information.rb +108 -1
- data/lib/docusign_esign/models/account_ui_settings.rb +30 -1
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +41 -1
- data/lib/docusign_esign/models/carbon_copy.rb +11 -1
- data/lib/docusign_esign/models/currency.rb +1201 -0
- data/lib/docusign_esign/models/linked_external_primary_account.rb +234 -0
- data/lib/docusign_esign/models/locale_policy_tab.rb +11 -1
- data/lib/docusign_esign/models/notary_recipient.rb +11 -1
- data/lib/docusign_esign/models/report_in_product_run_response_row_fields.rb +31 -1
- data/lib/docusign_esign/models/tab_metadata.rb +20 -1
- data/lib/docusign_esign/models/tabs.rb +13 -1
- data/lib/docusign_esign/models/template_role.rb +13 -1
- data/lib/docusign_esign/models/template_tabs.rb +13 -1
- data/lib/docusign_esign/models/user_settings_information.rb +20 -1
- data/lib/docusign_esign/version.rb +1 -1
- data/tests/Gemfile.lock +1 -5
- metadata +5 -3
- data/docusign_esign-2.8.0.rc1.gem +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '084cff2f571312d0f898545746a130b74ec93773dcb7a95c384d9f9956e7c1aa'
|
4
|
+
data.tar.gz: 8b5f4cdbb48ed66e085f27876ae3e90cf03246abc98928fecfeb7b3147c7cdc5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b01b33f4617f95e88ae471af0bbf1a940b30f12b7b4a6723726804d3c3f2fc86e66d138c4b02eca816b510cf0103e3157938079be98e6487b7480c89aca07130
|
7
|
+
data.tar.gz: c9d496714a622ff8ce87ebc596781d75ea8ae647e44f9d083bc6b2a85f883afdeb31f540f438953cfd0084ea870cccc1c40f204b56ec3aba8ebb1d93e8920e2d
|
data/README.md
CHANGED
@@ -1,80 +1,51 @@
|
|
1
|
-
# The Official DocuSign Ruby Client
|
1
|
+
# The Official DocuSign eSignature Ruby Client SDK
|
2
2
|
|
3
3
|
[![RubyGems version][rubygems-image]][rubygems-url]
|
4
4
|
[![RubyGems downloads][downloads-image]][downloads-url]
|
5
5
|
[![Build status][travis-image]][travis-url]
|
6
6
|
|
7
7
|
## Requirements
|
8
|
-
|
9
|
-
|
10
|
-
- Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
|
8
|
+
* Ruby 1.9+
|
9
|
+
* Free [developer account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
|
11
10
|
|
12
11
|
## Compatibility
|
13
|
-
|
14
|
-
- Ruby 1.9+
|
15
|
-
|
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.
|
12
|
+
* Ruby 1.9+
|
19
13
|
|
20
14
|
## Installation
|
15
|
+
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.
|
21
16
|
|
22
|
-
###
|
23
|
-
|
24
|
-
|
25
|
-
**gem 'docusign_esign'**
|
17
|
+
### Installation via your application's Gemfile:
|
18
|
+
1. In your application's Gemfile, add:
|
19
|
+
`gem 'docusign_esign'`
|
26
20
|
2. Open your preferred console.
|
27
|
-
3. In your project directory, execute the installer by typing:
|
28
|
-
**bundle install**
|
29
|
-
|
30
|
-
### Manual install:
|
21
|
+
3. In your project directory, execute the installer by typing: **bundle install**
|
31
22
|
|
23
|
+
### Manual installation:
|
32
24
|
1. Open your preferred console.
|
33
|
-
2. In the console, type:
|
34
|
-
**gem install docusign_esign**
|
25
|
+
2. In the console, type: **gem install docusign_esign**
|
35
26
|
|
36
27
|
### Dependencies
|
37
|
-
|
38
28
|
This client has the following external dependencies:
|
29
|
+
* Jwt>=1.5.2
|
30
|
+
* Json>=2.1.0
|
31
|
+
* Typhoeus>=1.0.1
|
39
32
|
|
40
|
-
|
41
|
-
-
|
42
|
-
- Typhoeus>=1.0.1
|
43
|
-
|
44
|
-
## Code Examples
|
45
|
-
|
46
|
-
### Launchers
|
33
|
+
## Code examples
|
34
|
+
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.
|
47
35
|
|
48
|
-
|
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).
|
36
|
+
## OAuth implementations
|
37
|
+
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/).
|
57
38
|
|
58
39
|
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
|
59
40
|
|
60
|
-
|
61
41
|
## Support
|
62
|
-
|
63
42
|
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
|
64
43
|
|
65
44
|
## License
|
45
|
+
The DocuSign eSignature Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
|
66
46
|
|
67
|
-
|
68
|
-
|
69
|
-
[
|
70
|
-
[
|
71
|
-
[
|
72
|
-
[downloads-url]: https://rubygems.org/gems/docusign_esign
|
73
|
-
[travis-image]: https://img.shields.io/travis/docusign/docusign-ruby-client.svg?style=flat
|
74
|
-
[travis-url]: https://travis-ci.org/docusign/docusign-ruby-client
|
75
|
-
|
76
|
-
### Additional Resources
|
77
|
-
* [DocuSign Developer Center](https://developers.docusign.com)
|
78
|
-
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
|
79
|
-
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
|
80
|
-
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
|
47
|
+
### Additional resources
|
48
|
+
* [DocuSign Developer Center](https://developers.docusign.com/)
|
49
|
+
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
|
50
|
+
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
|
51
|
+
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
|
data/lib/docusign_esign.rb
CHANGED
@@ -171,6 +171,7 @@ require 'docusign_esign/models/country'
|
|
171
171
|
require 'docusign_esign/models/credential'
|
172
172
|
require 'docusign_esign/models/credit_card_information'
|
173
173
|
require 'docusign_esign/models/credit_card_types'
|
174
|
+
require 'docusign_esign/models/currency'
|
174
175
|
require 'docusign_esign/models/currency_feature_set_price'
|
175
176
|
require 'docusign_esign/models/currency_plan_price'
|
176
177
|
require 'docusign_esign/models/custom_field'
|
@@ -279,6 +280,7 @@ require 'docusign_esign/models/integrated_user_info_list'
|
|
279
280
|
require 'docusign_esign/models/intermediary'
|
280
281
|
require 'docusign_esign/models/jurisdiction'
|
281
282
|
require 'docusign_esign/models/last_name'
|
283
|
+
require 'docusign_esign/models/linked_external_primary_account'
|
282
284
|
require 'docusign_esign/models/list'
|
283
285
|
require 'docusign_esign/models/list_custom_field'
|
284
286
|
require 'docusign_esign/models/list_item'
|
@@ -516,9 +518,9 @@ require 'docusign_esign/api/groups_api'
|
|
516
518
|
require 'docusign_esign/api/notary_api'
|
517
519
|
require 'docusign_esign/api/organizations_api'
|
518
520
|
require 'docusign_esign/api/power_forms_api'
|
521
|
+
require 'docusign_esign/api/signature_api'
|
519
522
|
require 'docusign_esign/api/signing_groups_api'
|
520
523
|
require 'docusign_esign/api/templates_api'
|
521
|
-
require 'docusign_esign/api/trust_service_providers_api'
|
522
524
|
require 'docusign_esign/api/users_api'
|
523
525
|
require 'docusign_esign/api/workspaces_api'
|
524
526
|
|
@@ -2522,6 +2522,55 @@ module DocuSign_eSign
|
|
2522
2522
|
return data, status_code, headers
|
2523
2523
|
end
|
2524
2524
|
|
2525
|
+
# Returns Account available seals for specified account.
|
2526
|
+
#
|
2527
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2528
|
+
# @return [AccountSeals]
|
2529
|
+
def get_seal_providers(account_id)
|
2530
|
+
data, _status_code, _headers = get_seal_providers_with_http_info(account_id)
|
2531
|
+
return data
|
2532
|
+
end
|
2533
|
+
|
2534
|
+
# Returns Account available seals for specified account.
|
2535
|
+
#
|
2536
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2537
|
+
# @return [Array<(AccountSeals, Fixnum, Hash)>] AccountSeals data, response status code and response headers
|
2538
|
+
def get_seal_providers_with_http_info(account_id)
|
2539
|
+
if @api_client.config.debugging
|
2540
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_seal_providers ..."
|
2541
|
+
end
|
2542
|
+
# verify the required parameter 'account_id' is set
|
2543
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_seal_providers" if account_id.nil?
|
2544
|
+
# resource path
|
2545
|
+
local_var_path = "/v2.1/accounts/{accountId}/seals".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2546
|
+
|
2547
|
+
# query parameters
|
2548
|
+
query_params = {}
|
2549
|
+
|
2550
|
+
# header parameters
|
2551
|
+
header_params = {}
|
2552
|
+
# HTTP header 'Accept' (if needed)
|
2553
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2554
|
+
|
2555
|
+
# form parameters
|
2556
|
+
form_params = {}
|
2557
|
+
|
2558
|
+
# http body (model)
|
2559
|
+
post_body = nil
|
2560
|
+
auth_names = []
|
2561
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2562
|
+
:header_params => header_params,
|
2563
|
+
:query_params => query_params,
|
2564
|
+
:form_params => form_params,
|
2565
|
+
:body => post_body,
|
2566
|
+
:auth_names => auth_names,
|
2567
|
+
:return_type => 'AccountSeals')
|
2568
|
+
if @api_client.config.debugging
|
2569
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_seal_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2570
|
+
end
|
2571
|
+
return data, status_code, headers
|
2572
|
+
end
|
2573
|
+
|
2525
2574
|
# Gets list of supported languages for recipient language setting.
|
2526
2575
|
#
|
2527
2576
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -20,6 +20,9 @@ module DocuSign_eSign
|
|
20
20
|
#
|
21
21
|
attr_accessor :count
|
22
22
|
|
23
|
+
#
|
24
|
+
attr_accessor :search_text
|
25
|
+
|
23
26
|
#
|
24
27
|
attr_accessor :start_position
|
25
28
|
|
@@ -334,6 +337,7 @@ module DocuSign_eSign
|
|
334
337
|
query_params = {}
|
335
338
|
query_params[:'batch_ids'] = options.batch_ids if !options.batch_ids.nil?
|
336
339
|
query_params[:'count'] = options.count if !options.count.nil?
|
340
|
+
query_params[:'search_text'] = options.search_text if !options.search_text.nil?
|
337
341
|
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
338
342
|
query_params[:'status'] = options.status if !options.status.nil?
|
339
343
|
|
@@ -253,7 +253,7 @@ module DocuSign_eSign
|
|
253
253
|
# verify the required parameter 'key_id' is set
|
254
254
|
fail ArgumentError, "Missing the required parameter 'key_id' when calling ConnectApi.delete_connect_secret" if key_id.nil?
|
255
255
|
# resource path
|
256
|
-
local_var_path = "/v2.1/accounts/{accountId}/connect/secret/{keyId}
|
256
|
+
local_var_path = "/v2.1/accounts/{accountId}/connect/secret/{keyId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
|
257
257
|
|
258
258
|
# query parameters
|
259
259
|
query_params = {}
|
@@ -893,59 +893,6 @@ module DocuSign_eSign
|
|
893
893
|
return data, status_code, headers
|
894
894
|
end
|
895
895
|
|
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.1/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
|
-
|
949
896
|
# Returns users from the configured Connect service.
|
950
897
|
# Returns users from the configured Connect service.
|
951
898
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -61,6 +61,36 @@ module DocuSign_eSign
|
|
61
61
|
end
|
62
62
|
end
|
63
63
|
|
64
|
+
class GetApplianceEnvelopeInfoOptions
|
65
|
+
#
|
66
|
+
attr_accessor :before_sign
|
67
|
+
|
68
|
+
#
|
69
|
+
attr_accessor :document_id
|
70
|
+
|
71
|
+
#
|
72
|
+
attr_accessor :entity_type
|
73
|
+
|
74
|
+
#
|
75
|
+
attr_accessor :in_person
|
76
|
+
|
77
|
+
#
|
78
|
+
attr_accessor :recipient_id
|
79
|
+
|
80
|
+
#
|
81
|
+
attr_accessor :tab_locale_policy
|
82
|
+
|
83
|
+
#
|
84
|
+
attr_accessor :tab_type
|
85
|
+
|
86
|
+
#
|
87
|
+
attr_accessor :use_date_signed_tab_val_exclusively
|
88
|
+
|
89
|
+
def self.default
|
90
|
+
@@default ||= GetApplianceEnvelopeInfoOptions.new
|
91
|
+
end
|
92
|
+
end
|
93
|
+
|
64
94
|
class GetChunkedUploadOptions
|
65
95
|
#
|
66
96
|
attr_accessor :include
|
@@ -2297,6 +2327,58 @@ module DocuSign_eSign
|
|
2297
2327
|
return data, status_code, headers
|
2298
2328
|
end
|
2299
2329
|
|
2330
|
+
# Delete custom fields information for Display Appliance
|
2331
|
+
#
|
2332
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2333
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
2334
|
+
# @return [nil]
|
2335
|
+
def delete_custom_fields_v2(account_id, envelope_id)
|
2336
|
+
delete_custom_fields_v2_with_http_info(account_id, envelope_id)
|
2337
|
+
return nil
|
2338
|
+
end
|
2339
|
+
|
2340
|
+
# Delete custom fields information for Display Appliance
|
2341
|
+
#
|
2342
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2343
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
2344
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
2345
|
+
def delete_custom_fields_v2_with_http_info(account_id, envelope_id)
|
2346
|
+
if @api_client.config.debugging
|
2347
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.delete_custom_fields_v2 ..."
|
2348
|
+
end
|
2349
|
+
# verify the required parameter 'account_id' is set
|
2350
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_custom_fields_v2" if account_id.nil?
|
2351
|
+
# verify the required parameter 'envelope_id' is set
|
2352
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_custom_fields_v2" if envelope_id.nil?
|
2353
|
+
# resource path
|
2354
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
2355
|
+
|
2356
|
+
# query parameters
|
2357
|
+
query_params = {}
|
2358
|
+
|
2359
|
+
# header parameters
|
2360
|
+
header_params = {}
|
2361
|
+
# HTTP header 'Accept' (if needed)
|
2362
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2363
|
+
|
2364
|
+
# form parameters
|
2365
|
+
form_params = {}
|
2366
|
+
|
2367
|
+
# http body (model)
|
2368
|
+
post_body = nil
|
2369
|
+
auth_names = []
|
2370
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
2371
|
+
:header_params => header_params,
|
2372
|
+
:query_params => query_params,
|
2373
|
+
:form_params => form_params,
|
2374
|
+
:body => post_body,
|
2375
|
+
:auth_names => auth_names)
|
2376
|
+
if @api_client.config.debugging
|
2377
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#delete_custom_fields_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2378
|
+
end
|
2379
|
+
return data, status_code, headers
|
2380
|
+
end
|
2381
|
+
|
2300
2382
|
# Delete document information for Display Appliance
|
2301
2383
|
#
|
2302
2384
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -2902,6 +2984,58 @@ module DocuSign_eSign
|
|
2902
2984
|
return data, status_code, headers
|
2903
2985
|
end
|
2904
2986
|
|
2987
|
+
# Delete page information for Display Appliance
|
2988
|
+
#
|
2989
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2990
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
2991
|
+
# @return [nil]
|
2992
|
+
def delete_page_info_v2(account_id, envelope_id)
|
2993
|
+
delete_page_info_v2_with_http_info(account_id, envelope_id)
|
2994
|
+
return nil
|
2995
|
+
end
|
2996
|
+
|
2997
|
+
# Delete page information for Display Appliance
|
2998
|
+
#
|
2999
|
+
# @param account_id The external account number (int) or account ID Guid.
|
3000
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3001
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
3002
|
+
def delete_page_info_v2_with_http_info(account_id, envelope_id)
|
3003
|
+
if @api_client.config.debugging
|
3004
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.delete_page_info_v2 ..."
|
3005
|
+
end
|
3006
|
+
# verify the required parameter 'account_id' is set
|
3007
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_page_info_v2" if account_id.nil?
|
3008
|
+
# verify the required parameter 'envelope_id' is set
|
3009
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_page_info_v2" if envelope_id.nil?
|
3010
|
+
# resource path
|
3011
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
3012
|
+
|
3013
|
+
# query parameters
|
3014
|
+
query_params = {}
|
3015
|
+
|
3016
|
+
# header parameters
|
3017
|
+
header_params = {}
|
3018
|
+
# HTTP header 'Accept' (if needed)
|
3019
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3020
|
+
|
3021
|
+
# form parameters
|
3022
|
+
form_params = {}
|
3023
|
+
|
3024
|
+
# http body (model)
|
3025
|
+
post_body = nil
|
3026
|
+
auth_names = []
|
3027
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
3028
|
+
:header_params => header_params,
|
3029
|
+
:query_params => query_params,
|
3030
|
+
:form_params => form_params,
|
3031
|
+
:body => post_body,
|
3032
|
+
:auth_names => auth_names)
|
3033
|
+
if @api_client.config.debugging
|
3034
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#delete_page_info_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3035
|
+
end
|
3036
|
+
return data, status_code, headers
|
3037
|
+
end
|
3038
|
+
|
2905
3039
|
# Deletes a recipient from an envelope.
|
2906
3040
|
# Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
|
2907
3041
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -3342,6 +3476,69 @@ module DocuSign_eSign
|
|
3342
3476
|
return data, status_code, headers
|
3343
3477
|
end
|
3344
3478
|
|
3479
|
+
# Returns Display Appliance envelope information
|
3480
|
+
#
|
3481
|
+
# @param account_id The external account number (int) or account ID Guid.
|
3482
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3483
|
+
# @param DocuSign_eSign::GetApplianceEnvelopeInfoOptions Options for modifying the behavior of the function.
|
3484
|
+
# @return [DisplayApplianceInfo]
|
3485
|
+
def get_appliance_envelope_info(account_id, envelope_id, options = DocuSign_eSign::GetApplianceEnvelopeInfoOptions.default)
|
3486
|
+
data, _status_code, _headers = get_appliance_envelope_info_with_http_info(account_id, envelope_id, options)
|
3487
|
+
return data
|
3488
|
+
end
|
3489
|
+
|
3490
|
+
# Returns Display Appliance envelope information
|
3491
|
+
#
|
3492
|
+
# @param account_id The external account number (int) or account ID Guid.
|
3493
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3494
|
+
# @param DocuSign_eSign::GetApplianceEnvelopeInfoOptions Options for modifying the behavior of the function.
|
3495
|
+
# @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
|
3496
|
+
def get_appliance_envelope_info_with_http_info(account_id, envelope_id, options = DocuSign_eSign::GetApplianceEnvelopeInfoOptions.default)
|
3497
|
+
if @api_client.config.debugging
|
3498
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.get_appliance_envelope_info ..."
|
3499
|
+
end
|
3500
|
+
# verify the required parameter 'account_id' is set
|
3501
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_appliance_envelope_info" if account_id.nil?
|
3502
|
+
# verify the required parameter 'envelope_id' is set
|
3503
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_appliance_envelope_info" if envelope_id.nil?
|
3504
|
+
# resource path
|
3505
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info_v2".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
3506
|
+
|
3507
|
+
# query parameters
|
3508
|
+
query_params = {}
|
3509
|
+
query_params[:'beforeSign'] = options.before_sign if !options.before_sign.nil?
|
3510
|
+
query_params[:'document_id'] = options.document_id if !options.document_id.nil?
|
3511
|
+
query_params[:'entity_type'] = options.entity_type if !options.entity_type.nil?
|
3512
|
+
query_params[:'inPerson'] = options.in_person if !options.in_person.nil?
|
3513
|
+
query_params[:'recipient_id'] = options.recipient_id if !options.recipient_id.nil?
|
3514
|
+
query_params[:'tabLocalePolicy'] = options.tab_locale_policy if !options.tab_locale_policy.nil?
|
3515
|
+
query_params[:'tabType'] = options.tab_type if !options.tab_type.nil?
|
3516
|
+
query_params[:'useDateSignedTabValExclusively'] = options.use_date_signed_tab_val_exclusively if !options.use_date_signed_tab_val_exclusively.nil?
|
3517
|
+
|
3518
|
+
# header parameters
|
3519
|
+
header_params = {}
|
3520
|
+
# HTTP header 'Accept' (if needed)
|
3521
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3522
|
+
|
3523
|
+
# form parameters
|
3524
|
+
form_params = {}
|
3525
|
+
|
3526
|
+
# http body (model)
|
3527
|
+
post_body = nil
|
3528
|
+
auth_names = []
|
3529
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
3530
|
+
:header_params => header_params,
|
3531
|
+
:query_params => query_params,
|
3532
|
+
:form_params => form_params,
|
3533
|
+
:body => post_body,
|
3534
|
+
:auth_names => auth_names,
|
3535
|
+
:return_type => 'DisplayApplianceInfo')
|
3536
|
+
if @api_client.config.debugging
|
3537
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#get_appliance_envelope_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3538
|
+
end
|
3539
|
+
return data, status_code, headers
|
3540
|
+
end
|
3541
|
+
|
3345
3542
|
# Returns envelope and recipient information for Display Appliance
|
3346
3543
|
#
|
3347
3544
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -5318,28 +5515,24 @@ module DocuSign_eSign
|
|
5318
5515
|
# Returns if template was encrypted by Display Appliance
|
5319
5516
|
#
|
5320
5517
|
# @param account_id The external account number (int) or account ID Guid.
|
5321
|
-
# @param template_id The ID of the template being accessed.
|
5322
5518
|
# @return [DisplayApplianceInfo]
|
5323
|
-
def get_template_info(account_id
|
5324
|
-
data, _status_code, _headers = get_template_info_with_http_info(account_id
|
5519
|
+
def get_template_info(account_id)
|
5520
|
+
data, _status_code, _headers = get_template_info_with_http_info(account_id)
|
5325
5521
|
return data
|
5326
5522
|
end
|
5327
5523
|
|
5328
5524
|
# Returns if template was encrypted by Display Appliance
|
5329
5525
|
#
|
5330
5526
|
# @param account_id The external account number (int) or account ID Guid.
|
5331
|
-
# @param template_id The ID of the template being accessed.
|
5332
5527
|
# @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
|
5333
|
-
def get_template_info_with_http_info(account_id
|
5528
|
+
def get_template_info_with_http_info(account_id)
|
5334
5529
|
if @api_client.config.debugging
|
5335
5530
|
@api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_info ..."
|
5336
5531
|
end
|
5337
5532
|
# verify the required parameter 'account_id' is set
|
5338
5533
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_info" if account_id.nil?
|
5339
|
-
# verify the required parameter 'template_id' is set
|
5340
|
-
fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_info" if template_id.nil?
|
5341
5534
|
# resource path
|
5342
|
-
local_var_path = "/v2.1/accounts/{accountId}/
|
5535
|
+
local_var_path = "/v2.1/accounts/{accountId}/display_appliance_info/templateInfo".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
5343
5536
|
|
5344
5537
|
# query parameters
|
5345
5538
|
query_params = {}
|
@@ -5355,7 +5548,7 @@ module DocuSign_eSign
|
|
5355
5548
|
# http body (model)
|
5356
5549
|
post_body = nil
|
5357
5550
|
auth_names = []
|
5358
|
-
data, status_code, headers = @api_client.call_api(:
|
5551
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
5359
5552
|
:header_params => header_params,
|
5360
5553
|
:query_params => query_params,
|
5361
5554
|
:form_params => form_params,
|