docusign_esign 3.15.0 → 3.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +21 -0
- data/lib/docusign_esign/api/accounts_api.rb +15 -66
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +12 -4
- data/lib/docusign_esign/api/envelopes_api.rb +116 -140
- data/lib/docusign_esign/api/power_forms_api.rb +8 -0
- data/lib/docusign_esign/api/templates_api.rb +0 -59
- data/lib/docusign_esign/api/users_api.rb +4 -0
- data/lib/docusign_esign/client/api_client.rb +1 -1
- data/lib/docusign_esign/models/account_information.rb +10 -1
- data/lib/docusign_esign/models/account_role_settings.rb +42 -4
- data/lib/docusign_esign/models/account_settings_information.rb +222 -19
- data/lib/docusign_esign/models/account_ui_settings.rb +13 -13
- data/lib/docusign_esign/models/agent.rb +13 -1
- data/lib/docusign_esign/models/approve.rb +20 -1
- data/lib/docusign_esign/models/billing_invoice_item.rb +21 -1
- data/lib/docusign_esign/models/billing_invoices_summary.rb +21 -1
- data/lib/docusign_esign/models/billing_plan_information.rb +21 -1
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +11 -1
- data/lib/docusign_esign/models/bulk_send_envelopes_info.rb +101 -1
- data/lib/docusign_esign/models/bulk_send_error_status.rb +11 -1
- data/lib/docusign_esign/models/carbon_copy.rb +13 -1
- data/lib/docusign_esign/models/certified_delivery.rb +13 -1
- data/lib/docusign_esign/models/checkbox.rb +20 -1
- data/lib/docusign_esign/models/comment_thread.rb +20 -1
- data/lib/docusign_esign/models/commission_county.rb +20 -1
- data/lib/docusign_esign/models/commission_expiration.rb +20 -1
- data/lib/docusign_esign/models/commission_number.rb +20 -1
- data/lib/docusign_esign/models/commission_state.rb +20 -1
- data/lib/docusign_esign/models/company.rb +20 -1
- data/lib/docusign_esign/models/connect_custom_configuration.rb +33 -1
- data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +195 -0
- data/lib/docusign_esign/models/consent_details.rb +204 -0
- data/lib/docusign_esign/models/currency.rb +20 -1
- data/lib/docusign_esign/models/date.rb +20 -1
- data/lib/docusign_esign/models/date_signed.rb +20 -1
- data/lib/docusign_esign/models/decline.rb +20 -1
- data/lib/docusign_esign/models/delayed_routing.rb +206 -0
- data/lib/docusign_esign/models/draw.rb +20 -1
- data/lib/docusign_esign/models/editor.rb +13 -1
- data/lib/docusign_esign/models/email.rb +20 -1
- data/lib/docusign_esign/models/email_address.rb +20 -1
- data/lib/docusign_esign/models/envelope_delay_rule.rb +194 -0
- data/lib/docusign_esign/models/envelope_id.rb +20 -1
- data/lib/docusign_esign/models/envelope_publish_transaction.rb +307 -0
- data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -0
- data/lib/docusign_esign/models/first_name.rb +20 -1
- data/lib/docusign_esign/models/formula_tab.rb +20 -1
- data/lib/docusign_esign/models/full_name.rb +20 -1
- data/lib/docusign_esign/models/id_evidence_resource_token.rb +194 -0
- data/lib/docusign_esign/models/id_evidence_view_link.rb +184 -0
- data/lib/docusign_esign/models/initial_here.rb +20 -1
- data/lib/docusign_esign/models/intermediary.rb +13 -1
- data/lib/docusign_esign/models/last_name.rb +20 -1
- data/lib/docusign_esign/models/linked_external_primary_account.rb +11 -1
- data/lib/docusign_esign/models/list.rb +20 -1
- data/lib/docusign_esign/models/new_account_definition.rb +21 -1
- data/lib/docusign_esign/models/notarize.rb +20 -1
- data/lib/docusign_esign/models/notary_recipient.rb +23 -1
- data/lib/docusign_esign/models/notary_seal.rb +20 -1
- data/lib/docusign_esign/models/note.rb +20 -1
- data/lib/docusign_esign/models/number.rb +20 -1
- data/lib/docusign_esign/models/participant.rb +908 -0
- data/lib/docusign_esign/models/phone_number.rb +20 -1
- data/lib/docusign_esign/models/poly_line_overlay.rb +20 -1
- data/lib/docusign_esign/models/prefill_tabs.rb +64 -4
- data/lib/docusign_esign/models/radio.rb +20 -1
- data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +102 -2
- data/lib/docusign_esign/models/recipients.rb +13 -1
- data/lib/docusign_esign/models/scheduled_sending.rb +216 -0
- data/lib/docusign_esign/models/sender_company.rb +20 -1
- data/lib/docusign_esign/models/sender_name.rb +20 -1
- data/lib/docusign_esign/models/sign_here.rb +20 -1
- data/lib/docusign_esign/models/signer.rb +13 -1
- data/lib/docusign_esign/models/signer_attachment.rb +20 -1
- data/lib/docusign_esign/models/smart_section.rb +20 -1
- data/lib/docusign_esign/models/ssn.rb +20 -1
- data/lib/docusign_esign/models/tab_group.rb +20 -1
- data/lib/docusign_esign/models/template_recipients.rb +13 -1
- data/lib/docusign_esign/models/text.rb +20 -1
- data/lib/docusign_esign/models/title.rb +20 -1
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +20 -1
- data/lib/docusign_esign/models/user_information.rb +11 -1
- data/lib/docusign_esign/models/user_settings_information.rb +42 -4
- data/lib/docusign_esign/models/view.rb +20 -1
- data/lib/docusign_esign/models/witness.rb +13 -1
- data/lib/docusign_esign/models/workflow.rb +12 -2
- data/lib/docusign_esign/models/workflow_step.rb +1 -1
- data/lib/docusign_esign/models/zip.rb +20 -1
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +10 -8
- data/tests/spec/unit_tests_using_jwt_spec.rb +4 -4
- metadata +16 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ac37b3dd62a7b89612ba72e9499fb918108ec08abc59009f4a3cdc39f4e2710b
|
4
|
+
data.tar.gz: 951ce4fb442366a1a778b313e0aff49300a364a53972b2d7c9dc812259ab3539
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 613d3b01341e1fb8f3d62c28487e95a28afa4b88318e37a77aa8f2c69dd8f32755dac5773825e813dd4e6282dcb2e8b3271cf03c43703556f78c2e48331b2c48
|
7
|
+
data.tar.gz: ff77bf692231013b2b94d50f205d1d4abb01f7eeb4945c11f6920370e8d5d2a9d43071cf9c59eac4aa4bc3bb177019a4214a0ac2456af2b971fd3d8328ef67f8
|
data/CHANGELOG.md
CHANGED
@@ -3,6 +3,27 @@ All notable changes to this project will be documented in this file.
|
|
3
3
|
|
4
4
|
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
|
5
5
|
|
6
|
+
## [v3.18.0] - eSignature API v2.1-22.2.00.00 - 2022-06-17
|
7
|
+
### Changed
|
8
|
+
- Added support for version v2.1-22.2.00.00 of the DocuSign ESignature API.
|
9
|
+
- Updated the SDK release version.
|
10
|
+
|
11
|
+
## [v3.17.0] - eSignature API v2.1-22.1.02.00 - 2022-05-18
|
12
|
+
### Changed
|
13
|
+
- Added support for version v2.1-22.1.02.00 of the DocuSign ESignature API.
|
14
|
+
- Updated the SDK release version.
|
15
|
+
|
16
|
+
## [v3.16.0] - eSignature API v2.1-22.1.01.00 - 2022-04-07
|
17
|
+
### Changed
|
18
|
+
- Added support for version v2.1-22.1.01.00 of the DocuSign ESignature API.
|
19
|
+
- Updated the SDK release version.
|
20
|
+
|
21
|
+
### Breaking
|
22
|
+
- Following types are renamed
|
23
|
+
|
24
|
+
- `ScheduledSendingApiModel` is renamed to `ScheduledSending`
|
25
|
+
- `DelayedRoutingApiModel` is renamed to `DelayedRouting`
|
26
|
+
|
6
27
|
## [v3.15.0] - eSignature API v2.1-21.4.02.00 - 2022-02-08
|
7
28
|
### Changed
|
8
29
|
- Added support for version v2.1-21.4.02.00 of the DocuSign ESignature API.
|
@@ -151,15 +151,6 @@ module DocuSign_eSign
|
|
151
151
|
end
|
152
152
|
end
|
153
153
|
|
154
|
-
class GetReservedDomainExistenceOptions
|
155
|
-
#
|
156
|
-
attr_accessor :email_domain
|
157
|
-
|
158
|
-
def self.default
|
159
|
-
@@default ||= GetReservedDomainExistenceOptions.new
|
160
|
-
end
|
161
|
-
end
|
162
|
-
|
163
154
|
class ListBrandsOptions
|
164
155
|
# When set to **true**, excludes distributor brand information from the response set.
|
165
156
|
attr_accessor :exclude_distributor_brand
|
@@ -238,6 +229,15 @@ module DocuSign_eSign
|
|
238
229
|
end
|
239
230
|
end
|
240
231
|
|
232
|
+
class UpdateBrandOptions
|
233
|
+
#
|
234
|
+
attr_accessor :replace_brand
|
235
|
+
|
236
|
+
def self.default
|
237
|
+
@@default ||= UpdateBrandOptions.new
|
238
|
+
end
|
239
|
+
end
|
240
|
+
|
241
241
|
class UpdateConsumerDisclosureOptions
|
242
242
|
#
|
243
243
|
attr_accessor :include_metadata
|
@@ -2273,60 +2273,6 @@ module DocuSign_eSign
|
|
2273
2273
|
return data, status_code, headers
|
2274
2274
|
end
|
2275
2275
|
|
2276
|
-
# Returns whether or not the specified email domain is reserved/claimed.
|
2277
|
-
#
|
2278
|
-
# @param account_id The external account number (int) or account ID Guid.
|
2279
|
-
# @param DocuSign_eSign::GetReservedDomainExistenceOptions Options for modifying the behavior of the function.
|
2280
|
-
# @return [ReservedDomainExistence]
|
2281
|
-
def get_reserved_domain_existence(account_id, options = DocuSign_eSign::GetReservedDomainExistenceOptions.default)
|
2282
|
-
data, _status_code, _headers = get_reserved_domain_existence_with_http_info(account_id, options)
|
2283
|
-
return data
|
2284
|
-
end
|
2285
|
-
|
2286
|
-
# Returns whether or not the specified email domain is reserved/claimed.
|
2287
|
-
#
|
2288
|
-
# @param account_id The external account number (int) or account ID Guid.
|
2289
|
-
# @param DocuSign_eSign::GetReservedDomainExistenceOptions Options for modifying the behavior of the function.
|
2290
|
-
# @return [Array<(ReservedDomainExistence, Fixnum, Hash)>] ReservedDomainExistence data, response status code and response headers
|
2291
|
-
def get_reserved_domain_existence_with_http_info(account_id, options = DocuSign_eSign::GetReservedDomainExistenceOptions.default)
|
2292
|
-
if @api_client.config.debugging
|
2293
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.get_reserved_domain_existence ..."
|
2294
|
-
end
|
2295
|
-
# verify the required parameter 'account_id' is set
|
2296
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_reserved_domain_existence" if account_id.nil?
|
2297
|
-
# verify the required parameter 'email_domain' is set
|
2298
|
-
fail ArgumentError, "Missing the required parameter 'email_domain' when calling AccountsApi.get_reserved_domain_existence" if email_domain.nil?
|
2299
|
-
# resource path
|
2300
|
-
local_var_path = "/v2.1/accounts/{accountId}/reserved_domains".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2301
|
-
|
2302
|
-
# query parameters
|
2303
|
-
query_params = {}
|
2304
|
-
query_params[:'email_domain'] = email_domain
|
2305
|
-
|
2306
|
-
# header parameters
|
2307
|
-
header_params = {}
|
2308
|
-
# HTTP header 'Accept' (if needed)
|
2309
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2310
|
-
|
2311
|
-
# form parameters
|
2312
|
-
form_params = {}
|
2313
|
-
|
2314
|
-
# http body (model)
|
2315
|
-
post_body = nil
|
2316
|
-
auth_names = []
|
2317
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2318
|
-
:header_params => header_params,
|
2319
|
-
:query_params => query_params,
|
2320
|
-
:form_params => form_params,
|
2321
|
-
:body => post_body,
|
2322
|
-
:auth_names => auth_names,
|
2323
|
-
:return_type => 'ReservedDomainExistence')
|
2324
|
-
if @api_client.config.debugging
|
2325
|
-
@api_client.config.logger.debug "API called: AccountsApi#get_reserved_domain_existence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2326
|
-
end
|
2327
|
-
return data, status_code, headers
|
2328
|
-
end
|
2329
|
-
|
2330
2276
|
# Gets list of supported languages for recipient language setting.
|
2331
2277
|
#
|
2332
2278
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -3166,9 +3112,10 @@ module DocuSign_eSign
|
|
3166
3112
|
# @param account_id The external account number (int) or account ID Guid.
|
3167
3113
|
# @param brand_id The unique identifier of a brand.
|
3168
3114
|
# @param brand (optional parameter)
|
3115
|
+
# @param DocuSign_eSign::UpdateBrandOptions Options for modifying the behavior of the function.
|
3169
3116
|
# @return [Brand]
|
3170
|
-
def update_brand(account_id, brand_id, brand)
|
3171
|
-
data, _status_code, _headers = update_brand_with_http_info(account_id, brand_id, brand)
|
3117
|
+
def update_brand(account_id, brand_id, brand, options = DocuSign_eSign::UpdateBrandOptions.default)
|
3118
|
+
data, _status_code, _headers = update_brand_with_http_info(account_id, brand_id, brand, options)
|
3172
3119
|
return data
|
3173
3120
|
end
|
3174
3121
|
|
@@ -3177,8 +3124,9 @@ module DocuSign_eSign
|
|
3177
3124
|
# @param account_id The external account number (int) or account ID Guid.
|
3178
3125
|
# @param brand_id The unique identifier of a brand.
|
3179
3126
|
# @param brand (optional parameter)
|
3127
|
+
# @param DocuSign_eSign::UpdateBrandOptions Options for modifying the behavior of the function.
|
3180
3128
|
# @return [Array<(Brand, Fixnum, Hash)>] Brand data, response status code and response headers
|
3181
|
-
def update_brand_with_http_info(account_id, brand_id, brand)
|
3129
|
+
def update_brand_with_http_info(account_id, brand_id, brand, options = DocuSign_eSign::UpdateBrandOptions.default)
|
3182
3130
|
if @api_client.config.debugging
|
3183
3131
|
@api_client.config.logger.debug "Calling API: AccountsApi.update_brand ..."
|
3184
3132
|
end
|
@@ -3191,6 +3139,7 @@ module DocuSign_eSign
|
|
3191
3139
|
|
3192
3140
|
# query parameters
|
3193
3141
|
query_params = {}
|
3142
|
+
query_params[:'replace_brand'] = options.replace_brand if !options.replace_brand.nil?
|
3194
3143
|
|
3195
3144
|
# header parameters
|
3196
3145
|
header_params = {}
|
@@ -35,9 +35,6 @@ module DocuSign_eSign
|
|
35
35
|
#
|
36
36
|
attr_accessor :status
|
37
37
|
|
38
|
-
#
|
39
|
-
attr_accessor :user_id
|
40
|
-
|
41
38
|
def self.default
|
42
39
|
@@default ||= GetBulkSendBatchEnvelopesOptions.new
|
43
40
|
end
|
@@ -50,6 +47,9 @@ module DocuSign_eSign
|
|
50
47
|
#
|
51
48
|
attr_accessor :count
|
52
49
|
|
50
|
+
#
|
51
|
+
attr_accessor :from_date
|
52
|
+
|
53
53
|
#
|
54
54
|
attr_accessor :search_text
|
55
55
|
|
@@ -59,6 +59,12 @@ module DocuSign_eSign
|
|
59
59
|
#
|
60
60
|
attr_accessor :status
|
61
61
|
|
62
|
+
#
|
63
|
+
attr_accessor :to_date
|
64
|
+
|
65
|
+
#
|
66
|
+
attr_accessor :user_id
|
67
|
+
|
62
68
|
def self.default
|
63
69
|
@@default ||= GetBulkSendBatchesOptions.new
|
64
70
|
end
|
@@ -323,7 +329,6 @@ module DocuSign_eSign
|
|
323
329
|
query_params[:'search_text'] = options.search_text if !options.search_text.nil?
|
324
330
|
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
325
331
|
query_params[:'status'] = options.status if !options.status.nil?
|
326
|
-
query_params[:'user_id'] = options.user_id if !options.user_id.nil?
|
327
332
|
|
328
333
|
# header parameters
|
329
334
|
header_params = {}
|
@@ -430,9 +435,12 @@ module DocuSign_eSign
|
|
430
435
|
query_params = {}
|
431
436
|
query_params[:'batch_ids'] = options.batch_ids if !options.batch_ids.nil?
|
432
437
|
query_params[:'count'] = options.count if !options.count.nil?
|
438
|
+
query_params[:'from_date'] = options.from_date if !options.from_date.nil?
|
433
439
|
query_params[:'search_text'] = options.search_text if !options.search_text.nil?
|
434
440
|
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
435
441
|
query_params[:'status'] = options.status if !options.status.nil?
|
442
|
+
query_params[:'to_date'] = options.to_date if !options.to_date.nil?
|
443
|
+
query_params[:'user_id'] = options.user_id if !options.user_id.nil?
|
436
444
|
|
437
445
|
# header parameters
|
438
446
|
header_params = {}
|
@@ -148,15 +148,6 @@ module DocuSign_eSign
|
|
148
148
|
end
|
149
149
|
end
|
150
150
|
|
151
|
-
class GetDocumentResponsiveHtmlOptions
|
152
|
-
#
|
153
|
-
attr_accessor :include_anchor_tab_locations
|
154
|
-
|
155
|
-
def self.default
|
156
|
-
@@default ||= GetDocumentResponsiveHtmlOptions.new
|
157
|
-
end
|
158
|
-
end
|
159
|
-
|
160
151
|
class GetDocumentTabsOptions
|
161
152
|
#
|
162
153
|
attr_accessor :include_metadata
|
@@ -238,15 +229,6 @@ module DocuSign_eSign
|
|
238
229
|
end
|
239
230
|
end
|
240
231
|
|
241
|
-
class GetResponsiveHtmlOptions
|
242
|
-
#
|
243
|
-
attr_accessor :include_anchor_tab_locations
|
244
|
-
|
245
|
-
def self.default
|
246
|
-
@@default ||= GetResponsiveHtmlOptions.new
|
247
|
-
end
|
248
|
-
end
|
249
|
-
|
250
232
|
class ListDocumentsOptions
|
251
233
|
#
|
252
234
|
attr_accessor :documents_by_userid
|
@@ -1394,6 +1376,57 @@ module DocuSign_eSign
|
|
1394
1376
|
return data, status_code, headers
|
1395
1377
|
end
|
1396
1378
|
|
1379
|
+
# Submits a batch of historical envelopes for republish to an adhoc config.
|
1380
|
+
#
|
1381
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1382
|
+
# @param connect_historical_envelope_republish (optional parameter)
|
1383
|
+
# @return [EnvelopePublishTransaction]
|
1384
|
+
def create_historical_envelope_publish_transaction(account_id, connect_historical_envelope_republish)
|
1385
|
+
data, _status_code, _headers = create_historical_envelope_publish_transaction_with_http_info(account_id, connect_historical_envelope_republish)
|
1386
|
+
return data
|
1387
|
+
end
|
1388
|
+
|
1389
|
+
# Submits a batch of historical envelopes for republish to an adhoc config.
|
1390
|
+
#
|
1391
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1392
|
+
# @param connect_historical_envelope_republish (optional parameter)
|
1393
|
+
# @return [Array<(EnvelopePublishTransaction, Fixnum, Hash)>] EnvelopePublishTransaction data, response status code and response headers
|
1394
|
+
def create_historical_envelope_publish_transaction_with_http_info(account_id, connect_historical_envelope_republish)
|
1395
|
+
if @api_client.config.debugging
|
1396
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.create_historical_envelope_publish_transaction ..."
|
1397
|
+
end
|
1398
|
+
# verify the required parameter 'account_id' is set
|
1399
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_historical_envelope_publish_transaction" if account_id.nil?
|
1400
|
+
# resource path
|
1401
|
+
local_var_path = "/v2.1/accounts/{accountId}/connect/envelopes/publish/historical".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1402
|
+
|
1403
|
+
# query parameters
|
1404
|
+
query_params = {}
|
1405
|
+
|
1406
|
+
# header parameters
|
1407
|
+
header_params = {}
|
1408
|
+
# HTTP header 'Accept' (if needed)
|
1409
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1410
|
+
|
1411
|
+
# form parameters
|
1412
|
+
form_params = {}
|
1413
|
+
|
1414
|
+
# http body (model)
|
1415
|
+
post_body = @api_client.object_to_http_body(connect_historical_envelope_republish)
|
1416
|
+
auth_names = []
|
1417
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1418
|
+
:header_params => header_params,
|
1419
|
+
:query_params => query_params,
|
1420
|
+
:form_params => form_params,
|
1421
|
+
:body => post_body,
|
1422
|
+
:auth_names => auth_names,
|
1423
|
+
:return_type => 'EnvelopePublishTransaction')
|
1424
|
+
if @api_client.config.debugging
|
1425
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#create_historical_envelope_publish_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1426
|
+
end
|
1427
|
+
return data, status_code, headers
|
1428
|
+
end
|
1429
|
+
|
1397
1430
|
# Lock an envelope.
|
1398
1431
|
# Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
|
1399
1432
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -1569,7 +1602,7 @@ module DocuSign_eSign
|
|
1569
1602
|
# @param account_id The external account number (int) or account ID Guid.
|
1570
1603
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
1571
1604
|
# @param recipient_id The ID of the recipient being accessed.
|
1572
|
-
# @return [
|
1605
|
+
# @return [IdEvidenceViewLink]
|
1573
1606
|
def create_recipient_proof_file_link(account_id, envelope_id, recipient_id)
|
1574
1607
|
data, _status_code, _headers = create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id)
|
1575
1608
|
return data
|
@@ -1580,7 +1613,7 @@ module DocuSign_eSign
|
|
1580
1613
|
# @param account_id The external account number (int) or account ID Guid.
|
1581
1614
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
1582
1615
|
# @param recipient_id The ID of the recipient being accessed.
|
1583
|
-
# @return [Array<(
|
1616
|
+
# @return [Array<(IdEvidenceViewLink, Fixnum, Hash)>] IdEvidenceViewLink data, response status code and response headers
|
1584
1617
|
def create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id)
|
1585
1618
|
if @api_client.config.debugging
|
1586
1619
|
@api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_proof_file_link ..."
|
@@ -1614,7 +1647,7 @@ module DocuSign_eSign
|
|
1614
1647
|
:form_params => form_params,
|
1615
1648
|
:body => post_body,
|
1616
1649
|
:auth_names => auth_names,
|
1617
|
-
:return_type => '
|
1650
|
+
:return_type => 'IdEvidenceViewLink')
|
1618
1651
|
if @api_client.config.debugging
|
1619
1652
|
@api_client.config.logger.debug "API called: EnvelopesApi#create_recipient_proof_file_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1620
1653
|
end
|
@@ -1627,7 +1660,7 @@ module DocuSign_eSign
|
|
1627
1660
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
1628
1661
|
# @param recipient_id The ID of the recipient being accessed.
|
1629
1662
|
# @param token_scopes
|
1630
|
-
# @return [
|
1663
|
+
# @return [IdEvidenceResourceToken]
|
1631
1664
|
def create_recipient_proof_file_resource_token(account_id, envelope_id, recipient_id, token_scopes)
|
1632
1665
|
data, _status_code, _headers = create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes)
|
1633
1666
|
return data
|
@@ -1639,7 +1672,7 @@ module DocuSign_eSign
|
|
1639
1672
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
1640
1673
|
# @param recipient_id The ID of the recipient being accessed.
|
1641
1674
|
# @param token_scopes
|
1642
|
-
# @return [Array<(
|
1675
|
+
# @return [Array<(IdEvidenceResourceToken, Fixnum, Hash)>] IdEvidenceResourceToken data, response status code and response headers
|
1643
1676
|
def create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes)
|
1644
1677
|
if @api_client.config.debugging
|
1645
1678
|
@api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_proof_file_resource_token ..."
|
@@ -1675,7 +1708,7 @@ module DocuSign_eSign
|
|
1675
1708
|
:form_params => form_params,
|
1676
1709
|
:body => post_body,
|
1677
1710
|
:auth_names => auth_names,
|
1678
|
-
:return_type => '
|
1711
|
+
:return_type => 'IdEvidenceResourceToken')
|
1679
1712
|
if @api_client.config.debugging
|
1680
1713
|
@api_client.config.logger.debug "API called: EnvelopesApi#create_recipient_proof_file_resource_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1681
1714
|
end
|
@@ -3329,66 +3362,6 @@ module DocuSign_eSign
|
|
3329
3362
|
return data, status_code, headers
|
3330
3363
|
end
|
3331
3364
|
|
3332
|
-
# Get Responsive HTML for a document in an envelope.
|
3333
|
-
#
|
3334
|
-
# @param account_id The external account number (int) or account ID Guid.
|
3335
|
-
# @param document_id The ID of the document being accessed.
|
3336
|
-
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3337
|
-
# @param DocuSign_eSign::GetDocumentResponsiveHtmlOptions Options for modifying the behavior of the function.
|
3338
|
-
# @return [DocumentHtmlDefinitionOriginals]
|
3339
|
-
def get_document_responsive_html(account_id, document_id, envelope_id, options = DocuSign_eSign::GetDocumentResponsiveHtmlOptions.default)
|
3340
|
-
data, _status_code, _headers = get_document_responsive_html_with_http_info(account_id, document_id, envelope_id, options)
|
3341
|
-
return data
|
3342
|
-
end
|
3343
|
-
|
3344
|
-
# Get Responsive HTML for a document in an envelope.
|
3345
|
-
#
|
3346
|
-
# @param account_id The external account number (int) or account ID Guid.
|
3347
|
-
# @param document_id The ID of the document being accessed.
|
3348
|
-
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3349
|
-
# @param DocuSign_eSign::GetDocumentResponsiveHtmlOptions Options for modifying the behavior of the function.
|
3350
|
-
# @return [Array<(DocumentHtmlDefinitionOriginals, Fixnum, Hash)>] DocumentHtmlDefinitionOriginals data, response status code and response headers
|
3351
|
-
def get_document_responsive_html_with_http_info(account_id, document_id, envelope_id, options = DocuSign_eSign::GetDocumentResponsiveHtmlOptions.default)
|
3352
|
-
if @api_client.config.debugging
|
3353
|
-
@api_client.config.logger.debug "Calling API: EnvelopesApi.get_document_responsive_html ..."
|
3354
|
-
end
|
3355
|
-
# verify the required parameter 'account_id' is set
|
3356
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_document_responsive_html" if account_id.nil?
|
3357
|
-
# verify the required parameter 'document_id' is set
|
3358
|
-
fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.get_document_responsive_html" if document_id.nil?
|
3359
|
-
# verify the required parameter 'envelope_id' is set
|
3360
|
-
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_document_responsive_html" if envelope_id.nil?
|
3361
|
-
# resource path
|
3362
|
-
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
3363
|
-
|
3364
|
-
# query parameters
|
3365
|
-
query_params = {}
|
3366
|
-
query_params[:'include_anchor_tab_locations'] = options.include_anchor_tab_locations if !options.include_anchor_tab_locations.nil?
|
3367
|
-
|
3368
|
-
# header parameters
|
3369
|
-
header_params = {}
|
3370
|
-
# HTTP header 'Accept' (if needed)
|
3371
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3372
|
-
|
3373
|
-
# form parameters
|
3374
|
-
form_params = {}
|
3375
|
-
|
3376
|
-
# http body (model)
|
3377
|
-
post_body = nil
|
3378
|
-
auth_names = []
|
3379
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
3380
|
-
:header_params => header_params,
|
3381
|
-
:query_params => query_params,
|
3382
|
-
:form_params => form_params,
|
3383
|
-
:body => post_body,
|
3384
|
-
:auth_names => auth_names,
|
3385
|
-
:return_type => 'DocumentHtmlDefinitionOriginals')
|
3386
|
-
if @api_client.config.debugging
|
3387
|
-
@api_client.config.logger.debug "API called: EnvelopesApi#get_document_responsive_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3388
|
-
end
|
3389
|
-
return data, status_code, headers
|
3390
|
-
end
|
3391
|
-
|
3392
3365
|
# Returns tabs on the document.
|
3393
3366
|
#
|
3394
3367
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -4296,62 +4269,6 @@ module DocuSign_eSign
|
|
4296
4269
|
return data, status_code, headers
|
4297
4270
|
end
|
4298
4271
|
|
4299
|
-
# Get Responsive HTML for all documents in an envelope.
|
4300
|
-
#
|
4301
|
-
# @param account_id The external account number (int) or account ID Guid.
|
4302
|
-
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
4303
|
-
# @param DocuSign_eSign::GetResponsiveHtmlOptions Options for modifying the behavior of the function.
|
4304
|
-
# @return [DocumentHtmlDefinitionOriginals]
|
4305
|
-
def get_responsive_html(account_id, envelope_id, options = DocuSign_eSign::GetResponsiveHtmlOptions.default)
|
4306
|
-
data, _status_code, _headers = get_responsive_html_with_http_info(account_id, envelope_id, options)
|
4307
|
-
return data
|
4308
|
-
end
|
4309
|
-
|
4310
|
-
# Get Responsive HTML for all documents in an envelope.
|
4311
|
-
#
|
4312
|
-
# @param account_id The external account number (int) or account ID Guid.
|
4313
|
-
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
4314
|
-
# @param DocuSign_eSign::GetResponsiveHtmlOptions Options for modifying the behavior of the function.
|
4315
|
-
# @return [Array<(DocumentHtmlDefinitionOriginals, Fixnum, Hash)>] DocumentHtmlDefinitionOriginals data, response status code and response headers
|
4316
|
-
def get_responsive_html_with_http_info(account_id, envelope_id, options = DocuSign_eSign::GetResponsiveHtmlOptions.default)
|
4317
|
-
if @api_client.config.debugging
|
4318
|
-
@api_client.config.logger.debug "Calling API: EnvelopesApi.get_responsive_html ..."
|
4319
|
-
end
|
4320
|
-
# verify the required parameter 'account_id' is set
|
4321
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_responsive_html" if account_id.nil?
|
4322
|
-
# verify the required parameter 'envelope_id' is set
|
4323
|
-
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_responsive_html" if envelope_id.nil?
|
4324
|
-
# resource path
|
4325
|
-
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
4326
|
-
|
4327
|
-
# query parameters
|
4328
|
-
query_params = {}
|
4329
|
-
query_params[:'include_anchor_tab_locations'] = options.include_anchor_tab_locations if !options.include_anchor_tab_locations.nil?
|
4330
|
-
|
4331
|
-
# header parameters
|
4332
|
-
header_params = {}
|
4333
|
-
# HTTP header 'Accept' (if needed)
|
4334
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4335
|
-
|
4336
|
-
# form parameters
|
4337
|
-
form_params = {}
|
4338
|
-
|
4339
|
-
# http body (model)
|
4340
|
-
post_body = nil
|
4341
|
-
auth_names = []
|
4342
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
4343
|
-
:header_params => header_params,
|
4344
|
-
:query_params => query_params,
|
4345
|
-
:form_params => form_params,
|
4346
|
-
:body => post_body,
|
4347
|
-
:auth_names => auth_names,
|
4348
|
-
:return_type => 'DocumentHtmlDefinitionOriginals')
|
4349
|
-
if @api_client.config.debugging
|
4350
|
-
@api_client.config.logger.debug "API called: EnvelopesApi#get_responsive_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4351
|
-
end
|
4352
|
-
return data, status_code, headers
|
4353
|
-
end
|
4354
|
-
|
4355
4272
|
# Get encrypted tabs for envelope.
|
4356
4273
|
#
|
4357
4274
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -6371,6 +6288,65 @@ module DocuSign_eSign
|
|
6371
6288
|
return data, status_code, headers
|
6372
6289
|
end
|
6373
6290
|
|
6291
|
+
# Retrieves a PDF document from the envelope with no CoC.
|
6292
|
+
#
|
6293
|
+
# @param account_id The external account number (int) or account ID Guid.
|
6294
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
6295
|
+
# @param regen_document_id
|
6296
|
+
# @param document (optional parameter)
|
6297
|
+
# @return [File]
|
6298
|
+
def update_regen_document(account_id, envelope_id, regen_document_id, document)
|
6299
|
+
data, _status_code, _headers = update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document)
|
6300
|
+
return data
|
6301
|
+
end
|
6302
|
+
|
6303
|
+
# Retrieves a PDF document from the envelope with no CoC.
|
6304
|
+
#
|
6305
|
+
# @param account_id The external account number (int) or account ID Guid.
|
6306
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
6307
|
+
# @param regen_document_id
|
6308
|
+
# @param document (optional parameter)
|
6309
|
+
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
6310
|
+
def update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document)
|
6311
|
+
if @api_client.config.debugging
|
6312
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.update_regen_document ..."
|
6313
|
+
end
|
6314
|
+
# verify the required parameter 'account_id' is set
|
6315
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_regen_document" if account_id.nil?
|
6316
|
+
# verify the required parameter 'envelope_id' is set
|
6317
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_regen_document" if envelope_id.nil?
|
6318
|
+
# verify the required parameter 'regen_document_id' is set
|
6319
|
+
fail ArgumentError, "Missing the required parameter 'regen_document_id' when calling EnvelopesApi.update_regen_document" if regen_document_id.nil?
|
6320
|
+
# resource path
|
6321
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{regenDocumentId}/regen".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'regenDocumentId' + '}', regen_document_id.to_s)
|
6322
|
+
|
6323
|
+
# query parameters
|
6324
|
+
query_params = {}
|
6325
|
+
|
6326
|
+
# header parameters
|
6327
|
+
header_params = {}
|
6328
|
+
# HTTP header 'Accept' (if needed)
|
6329
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
|
6330
|
+
|
6331
|
+
# form parameters
|
6332
|
+
form_params = {}
|
6333
|
+
|
6334
|
+
# http body (model)
|
6335
|
+
post_body = @api_client.object_to_http_body(document)
|
6336
|
+
auth_names = []
|
6337
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
6338
|
+
:header_params => header_params,
|
6339
|
+
:query_params => query_params,
|
6340
|
+
:form_params => form_params,
|
6341
|
+
:body => post_body,
|
6342
|
+
:auth_names => auth_names,
|
6343
|
+
:return_type => 'File')
|
6344
|
+
if @api_client.config.debugging
|
6345
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#update_regen_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6346
|
+
end
|
6347
|
+
return data, status_code, headers
|
6348
|
+
end
|
6349
|
+
|
6374
6350
|
# Updates the tabs for a recipient.
|
6375
6351
|
# Updates one or more tabs for a recipient in a draft envelope.
|
6376
6352
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -47,6 +47,12 @@ module DocuSign_eSign
|
|
47
47
|
#
|
48
48
|
attr_accessor :order_by
|
49
49
|
|
50
|
+
#
|
51
|
+
attr_accessor :search_fields
|
52
|
+
|
53
|
+
#
|
54
|
+
attr_accessor :search_text
|
55
|
+
|
50
56
|
#
|
51
57
|
attr_accessor :to_date
|
52
58
|
|
@@ -409,6 +415,8 @@ module DocuSign_eSign
|
|
409
415
|
query_params[:'from_date'] = options.from_date if !options.from_date.nil?
|
410
416
|
query_params[:'order'] = options.order if !options.order.nil?
|
411
417
|
query_params[:'order_by'] = options.order_by if !options.order_by.nil?
|
418
|
+
query_params[:'search_fields'] = options.search_fields if !options.search_fields.nil?
|
419
|
+
query_params[:'search_text'] = options.search_text if !options.search_text.nil?
|
412
420
|
query_params[:'to_date'] = options.to_date if !options.to_date.nil?
|
413
421
|
|
414
422
|
# header parameters
|
@@ -2624,65 +2624,6 @@ module DocuSign_eSign
|
|
2624
2624
|
return data, status_code, headers
|
2625
2625
|
end
|
2626
2626
|
|
2627
|
-
# Adds or replaces the bulk recipients list in a template.
|
2628
|
-
# Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
|
2629
|
-
# @param account_id The external account number (int) or account ID Guid.
|
2630
|
-
# @param recipient_id The ID of the recipient being accessed.
|
2631
|
-
# @param template_id The ID of the template being accessed.
|
2632
|
-
# @param bulk_recipients_request (optional parameter)
|
2633
|
-
# @return [BulkRecipientsSummaryResponse]
|
2634
|
-
def update_bulk_recipients(account_id, recipient_id, template_id, bulk_recipients_request)
|
2635
|
-
data, _status_code, _headers = update_bulk_recipients_with_http_info(account_id, recipient_id, template_id, bulk_recipients_request)
|
2636
|
-
return data
|
2637
|
-
end
|
2638
|
-
|
2639
|
-
# Adds or replaces the bulk recipients list in a template.
|
2640
|
-
# Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
|
2641
|
-
# @param account_id The external account number (int) or account ID Guid.
|
2642
|
-
# @param recipient_id The ID of the recipient being accessed.
|
2643
|
-
# @param template_id The ID of the template being accessed.
|
2644
|
-
# @param bulk_recipients_request (optional parameter)
|
2645
|
-
# @return [Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>] BulkRecipientsSummaryResponse data, response status code and response headers
|
2646
|
-
def update_bulk_recipients_with_http_info(account_id, recipient_id, template_id, bulk_recipients_request)
|
2647
|
-
if @api_client.config.debugging
|
2648
|
-
@api_client.config.logger.debug "Calling API: TemplatesApi.update_bulk_recipients ..."
|
2649
|
-
end
|
2650
|
-
# verify the required parameter 'account_id' is set
|
2651
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_bulk_recipients" if account_id.nil?
|
2652
|
-
# verify the required parameter 'recipient_id' is set
|
2653
|
-
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.update_bulk_recipients" if recipient_id.nil?
|
2654
|
-
# verify the required parameter 'template_id' is set
|
2655
|
-
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_bulk_recipients" if template_id.nil?
|
2656
|
-
# resource path
|
2657
|
-
local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
2658
|
-
|
2659
|
-
# query parameters
|
2660
|
-
query_params = {}
|
2661
|
-
|
2662
|
-
# header parameters
|
2663
|
-
header_params = {}
|
2664
|
-
# HTTP header 'Accept' (if needed)
|
2665
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2666
|
-
|
2667
|
-
# form parameters
|
2668
|
-
form_params = {}
|
2669
|
-
|
2670
|
-
# http body (model)
|
2671
|
-
post_body = @api_client.object_to_http_body(bulk_recipients_request)
|
2672
|
-
auth_names = []
|
2673
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2674
|
-
:header_params => header_params,
|
2675
|
-
:query_params => query_params,
|
2676
|
-
:form_params => form_params,
|
2677
|
-
:body => post_body,
|
2678
|
-
:auth_names => auth_names,
|
2679
|
-
:return_type => 'BulkRecipientsSummaryResponse')
|
2680
|
-
if @api_client.config.debugging
|
2681
|
-
@api_client.config.logger.debug "API called: TemplatesApi#update_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2682
|
-
end
|
2683
|
-
return data, status_code, headers
|
2684
|
-
end
|
2685
|
-
|
2686
2627
|
# Updates envelope custom fields in a template.
|
2687
2628
|
# Updates the custom fields in a template. Each custom field used in a template must have a unique name.
|
2688
2629
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -65,6 +65,9 @@ module DocuSign_eSign
|
|
65
65
|
# When set to **true**, the full list of user information is returned for each user in the account.
|
66
66
|
attr_accessor :additional_info
|
67
67
|
|
68
|
+
#
|
69
|
+
attr_accessor :alternate_admins_only
|
70
|
+
|
68
71
|
# Number of records to return. The number must be greater than 0 and less than or equal to 100.
|
69
72
|
attr_accessor :count
|
70
73
|
|
@@ -1076,6 +1079,7 @@ module DocuSign_eSign
|
|
1076
1079
|
# query parameters
|
1077
1080
|
query_params = {}
|
1078
1081
|
query_params[:'additional_info'] = options.additional_info if !options.additional_info.nil?
|
1082
|
+
query_params[:'alternate_admins_only'] = options.alternate_admins_only if !options.alternate_admins_only.nil?
|
1079
1083
|
query_params[:'count'] = options.count if !options.count.nil?
|
1080
1084
|
query_params[:'domain_users_only'] = options.domain_users_only if !options.domain_users_only.nil?
|
1081
1085
|
query_params[:'email'] = options.email if !options.email.nil?
|