docusign_esign 3.7.0.rc1 → 3.8.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (55) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +8 -9
  3. data/docusign_esign-2.8.0.rc1.gem +0 -0
  4. data/lib/docusign_esign.rb +29 -1
  5. data/lib/docusign_esign/api/accounts_api.rb +65 -8
  6. data/lib/docusign_esign/api/bulk_envelopes_api.rb +22 -298
  7. data/lib/docusign_esign/api/connect_api.rb +196 -0
  8. data/lib/docusign_esign/api/envelopes_api.rb +1502 -78
  9. data/lib/docusign_esign/api/groups_api.rb +9 -9
  10. data/lib/docusign_esign/api/trust_service_providers_api.rb +232 -0
  11. data/lib/docusign_esign/api/users_api.rb +52 -0
  12. data/lib/docusign_esign/models/account_billing_plan.rb +11 -1
  13. data/lib/docusign_esign/models/account_information.rb +34 -4
  14. data/lib/docusign_esign/models/account_settings_information.rb +134 -1
  15. data/lib/docusign_esign/models/account_ui_settings.rb +20 -1
  16. data/lib/docusign_esign/models/bulk_send_batch_request.rb +184 -0
  17. data/lib/docusign_esign/models/bulk_send_batch_status.rb +21 -1
  18. data/lib/docusign_esign/models/complete_sign_hash_response.rb +7 -11
  19. data/lib/docusign_esign/models/complete_sign_request.rb +7 -11
  20. data/lib/docusign_esign/models/credential.rb +7 -11
  21. data/lib/docusign_esign/models/display_appliance_account.rb +224 -0
  22. data/lib/docusign_esign/models/display_appliance_info.rb +174 -0
  23. data/lib/docusign_esign/models/display_appliance_pdf.rb +174 -0
  24. data/lib/docusign_esign/models/display_appliance_signer_attachment.rb +174 -0
  25. data/lib/docusign_esign/models/document.rb +11 -1
  26. data/lib/docusign_esign/models/document_security_store.rb +7 -11
  27. data/lib/docusign_esign/models/document_update_info.rb +7 -11
  28. data/lib/docusign_esign/models/envelope_form_data.rb +13 -1
  29. data/lib/docusign_esign/models/external_claim.rb +7 -11
  30. data/lib/docusign_esign/models/group_brands.rb +207 -0
  31. data/lib/docusign_esign/models/payment_details.rb +10 -1
  32. data/lib/docusign_esign/models/payment_signer_values.rb +184 -0
  33. data/lib/docusign_esign/models/prefill_tabs.rb +222 -0
  34. data/lib/docusign_esign/models/revision.rb +7 -11
  35. data/lib/docusign_esign/models/seal.rb +8 -12
  36. data/lib/docusign_esign/models/sender.rb +7 -11
  37. data/lib/docusign_esign/models/sign_hash_document.rb +7 -11
  38. data/lib/docusign_esign/models/sign_hash_session_info_response.rb +7 -11
  39. data/lib/docusign_esign/models/sign_session_info_request.rb +7 -11
  40. data/lib/docusign_esign/models/signature_data_info.rb +7 -11
  41. data/lib/docusign_esign/models/signature_properties.rb +7 -11
  42. data/lib/docusign_esign/models/tab_account_settings.rb +20 -1
  43. data/lib/docusign_esign/models/tabs.rb +10 -1
  44. data/lib/docusign_esign/models/template_tabs.rb +10 -1
  45. data/lib/docusign_esign/models/time_stamp_field.rb +7 -11
  46. data/lib/docusign_esign/models/tsp_health_check_request.rb +7 -11
  47. data/lib/docusign_esign/models/tsp_health_check_status_description.rb +7 -11
  48. data/lib/docusign_esign/models/update_transaction_request.rb +7 -11
  49. data/lib/docusign_esign/models/update_transaction_response.rb +7 -11
  50. data/lib/docusign_esign/models/user.rb +7 -11
  51. data/lib/docusign_esign/models/user_info_response.rb +7 -11
  52. data/lib/docusign_esign/models/user_information.rb +11 -1
  53. data/lib/docusign_esign/version.rb +1 -1
  54. data/tests/Gemfile.lock +9 -5
  55. metadata +11 -2
@@ -129,6 +129,54 @@ module DocuSign_eSign
129
129
  return data, status_code, headers
130
130
  end
131
131
 
132
+ # Generates a new connect HMAC Secret.
133
+ #
134
+ # @param account_id The external account number (int) or account ID Guid.
135
+ # @return [nil]
136
+ def create_connect_secret(account_id)
137
+ create_connect_secret_with_http_info(account_id)
138
+ return nil
139
+ end
140
+
141
+ # Generates a new connect HMAC Secret.
142
+ #
143
+ # @param account_id The external account number (int) or account ID Guid.
144
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
145
+ def create_connect_secret_with_http_info(account_id)
146
+ if @api_client.config.debugging
147
+ @api_client.config.logger.debug "Calling API: ConnectApi.create_connect_secret ..."
148
+ end
149
+ # verify the required parameter 'account_id' is set
150
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.create_connect_secret" if account_id.nil?
151
+ # resource path
152
+ local_var_path = "/v2.1/accounts/{accountId}/connect/secret".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
153
+
154
+ # query parameters
155
+ query_params = {}
156
+
157
+ # header parameters
158
+ header_params = {}
159
+ # HTTP header 'Accept' (if needed)
160
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
161
+
162
+ # form parameters
163
+ form_params = {}
164
+
165
+ # http body (model)
166
+ post_body = nil
167
+ auth_names = []
168
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
169
+ :header_params => header_params,
170
+ :query_params => query_params,
171
+ :form_params => form_params,
172
+ :body => post_body,
173
+ :auth_names => auth_names)
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug "API called: ConnectApi#create_connect_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
176
+ end
177
+ return data, status_code, headers
178
+ end
179
+
132
180
  # Deletes the specified connect configuration.
133
181
  # Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.
134
182
  # @param account_id The external account number (int) or account ID Guid.
@@ -181,6 +229,58 @@ module DocuSign_eSign
181
229
  return data, status_code, headers
182
230
  end
183
231
 
232
+ # Delete the connect HMAC Secret for AccountID
233
+ #
234
+ # @param account_id The external account number (int) or account ID Guid.
235
+ # @param key_id
236
+ # @return [nil]
237
+ def delete_connect_secret(account_id, key_id)
238
+ delete_connect_secret_with_http_info(account_id, key_id)
239
+ return nil
240
+ end
241
+
242
+ # Delete the connect HMAC Secret for AccountID
243
+ #
244
+ # @param account_id The external account number (int) or account ID Guid.
245
+ # @param key_id
246
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
247
+ def delete_connect_secret_with_http_info(account_id, key_id)
248
+ if @api_client.config.debugging
249
+ @api_client.config.logger.debug "Calling API: ConnectApi.delete_connect_secret ..."
250
+ end
251
+ # verify the required parameter 'account_id' is set
252
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.delete_connect_secret" if account_id.nil?
253
+ # verify the required parameter 'key_id' is set
254
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling ConnectApi.delete_connect_secret" if key_id.nil?
255
+ # resource path
256
+ local_var_path = "/v2.1/accounts/{accountId}/connect/secret/{keyId}/delete".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
257
+
258
+ # query parameters
259
+ query_params = {}
260
+
261
+ # header parameters
262
+ header_params = {}
263
+ # HTTP header 'Accept' (if needed)
264
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
265
+
266
+ # form parameters
267
+ form_params = {}
268
+
269
+ # http body (model)
270
+ post_body = nil
271
+ auth_names = []
272
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
273
+ :header_params => header_params,
274
+ :query_params => query_params,
275
+ :form_params => form_params,
276
+ :body => post_body,
277
+ :auth_names => auth_names)
278
+ if @api_client.config.debugging
279
+ @api_client.config.logger.debug "API called: ConnectApi#delete_connect_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
280
+ end
281
+ return data, status_code, headers
282
+ end
283
+
184
284
  # Deletes a Connect failure log entry.
185
285
  # Deletes the Connect failure log information for the specified entry.
186
286
  # @param account_id The external account number (int) or account ID Guid.
@@ -384,6 +484,54 @@ module DocuSign_eSign
384
484
  return data, status_code, headers
385
485
  end
386
486
 
487
+ # Generates a new connect HMAC Secret.
488
+ #
489
+ # @param account_id The external account number (int) or account ID Guid.
490
+ # @return [nil]
491
+ def generate_connect_secret(account_id)
492
+ generate_connect_secret_with_http_info(account_id)
493
+ return nil
494
+ end
495
+
496
+ # Generates a new connect HMAC Secret.
497
+ #
498
+ # @param account_id The external account number (int) or account ID Guid.
499
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
500
+ def generate_connect_secret_with_http_info(account_id)
501
+ if @api_client.config.debugging
502
+ @api_client.config.logger.debug "Calling API: ConnectApi.generate_connect_secret ..."
503
+ end
504
+ # verify the required parameter 'account_id' is set
505
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.generate_connect_secret" if account_id.nil?
506
+ # resource path
507
+ local_var_path = "/v2.1/accounts/{accountId}/connect/secret".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
508
+
509
+ # query parameters
510
+ query_params = {}
511
+
512
+ # header parameters
513
+ header_params = {}
514
+ # HTTP header 'Accept' (if needed)
515
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
516
+
517
+ # form parameters
518
+ form_params = {}
519
+
520
+ # http body (model)
521
+ post_body = nil
522
+ auth_names = []
523
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
524
+ :header_params => header_params,
525
+ :query_params => query_params,
526
+ :form_params => form_params,
527
+ :body => post_body,
528
+ :auth_names => auth_names)
529
+ if @api_client.config.debugging
530
+ @api_client.config.logger.debug "API called: ConnectApi#generate_connect_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
531
+ end
532
+ return data, status_code, headers
533
+ end
534
+
387
535
  # Get a Connect Configuration Information
388
536
  # Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.
389
537
  # @param account_id The external account number (int) or account ID Guid.
@@ -437,6 +585,54 @@ module DocuSign_eSign
437
585
  return data, status_code, headers
438
586
  end
439
587
 
588
+ # Get the connect HMAC Secrets for AccountID
589
+ #
590
+ # @param account_id The external account number (int) or account ID Guid.
591
+ # @return [nil]
592
+ def get_connect_secrets(account_id)
593
+ get_connect_secrets_with_http_info(account_id)
594
+ return nil
595
+ end
596
+
597
+ # Get the connect HMAC Secrets for AccountID
598
+ #
599
+ # @param account_id The external account number (int) or account ID Guid.
600
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
601
+ def get_connect_secrets_with_http_info(account_id)
602
+ if @api_client.config.debugging
603
+ @api_client.config.logger.debug "Calling API: ConnectApi.get_connect_secrets ..."
604
+ end
605
+ # verify the required parameter 'account_id' is set
606
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.get_connect_secrets" if account_id.nil?
607
+ # resource path
608
+ local_var_path = "/v2.1/accounts/{accountId}/connect/secrets".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
609
+
610
+ # query parameters
611
+ query_params = {}
612
+
613
+ # header parameters
614
+ header_params = {}
615
+ # HTTP header 'Accept' (if needed)
616
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
617
+
618
+ # form parameters
619
+ form_params = {}
620
+
621
+ # http body (model)
622
+ post_body = nil
623
+ auth_names = []
624
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
625
+ :header_params => header_params,
626
+ :query_params => query_params,
627
+ :form_params => form_params,
628
+ :body => post_body,
629
+ :auth_names => auth_names)
630
+ if @api_client.config.debugging
631
+ @api_client.config.logger.debug "API called: ConnectApi#get_connect_secrets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
632
+ end
633
+ return data, status_code, headers
634
+ end
635
+
440
636
  # Get the specified Connect log entry.
441
637
  # Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.
442
638
  # @param account_id The external account number (int) or account ID Guid.
@@ -149,6 +149,9 @@ module DocuSign_eSign
149
149
  end
150
150
 
151
151
  class GetDocumentTabsOptions
152
+ #
153
+ attr_accessor :include_metadata
154
+
152
155
  #
153
156
  attr_accessor :page_numbers
154
157
 
@@ -1373,6 +1376,50 @@ module DocuSign_eSign
1373
1376
  return data, status_code, headers
1374
1377
  end
1375
1378
 
1379
+ # Uploads Kazmon error for Display Appliance
1380
+ #
1381
+ # @return [nil]
1382
+ def create_error()
1383
+ create_error_with_http_info()
1384
+ return nil
1385
+ end
1386
+
1387
+ # Uploads Kazmon error for Display Appliance
1388
+ #
1389
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1390
+ def create_error_with_http_info()
1391
+ if @api_client.config.debugging
1392
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_error ..."
1393
+ end
1394
+ # resource path
1395
+ local_var_path = "/v2.1/display_appliance_info/error".sub('{format}','json')
1396
+
1397
+ # query parameters
1398
+ query_params = {}
1399
+
1400
+ # header parameters
1401
+ header_params = {}
1402
+ # HTTP header 'Accept' (if needed)
1403
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1404
+
1405
+ # form parameters
1406
+ form_params = {}
1407
+
1408
+ # http body (model)
1409
+ post_body = nil
1410
+ auth_names = []
1411
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1412
+ :header_params => header_params,
1413
+ :query_params => query_params,
1414
+ :form_params => form_params,
1415
+ :body => post_body,
1416
+ :auth_names => auth_names)
1417
+ if @api_client.config.debugging
1418
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_error\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1419
+ end
1420
+ return data, status_code, headers
1421
+ end
1422
+
1376
1423
  # Lock an envelope.
1377
1424
  # 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).
1378
1425
  # @param account_id The external account number (int) or account ID Guid.
@@ -1428,6 +1475,111 @@ module DocuSign_eSign
1428
1475
  return data, status_code, headers
1429
1476
  end
1430
1477
 
1478
+ # Create page information for Display Appliance
1479
+ #
1480
+ # @param account_id The external account number (int) or account ID Guid.
1481
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1482
+ # @return [nil]
1483
+ def create_page_info(account_id, envelope_id)
1484
+ create_page_info_with_http_info(account_id, envelope_id)
1485
+ return nil
1486
+ end
1487
+
1488
+ # Create page information for Display Appliance
1489
+ #
1490
+ # @param account_id The external account number (int) or account ID Guid.
1491
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1492
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1493
+ def create_page_info_with_http_info(account_id, envelope_id)
1494
+ if @api_client.config.debugging
1495
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_page_info ..."
1496
+ end
1497
+ # verify the required parameter 'account_id' is set
1498
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_page_info" if account_id.nil?
1499
+ # verify the required parameter 'envelope_id' is set
1500
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_page_info" if envelope_id.nil?
1501
+ # resource path
1502
+ 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)
1503
+
1504
+ # query parameters
1505
+ query_params = {}
1506
+
1507
+ # header parameters
1508
+ header_params = {}
1509
+ # HTTP header 'Accept' (if needed)
1510
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1511
+
1512
+ # form parameters
1513
+ form_params = {}
1514
+
1515
+ # http body (model)
1516
+ post_body = nil
1517
+ auth_names = []
1518
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1519
+ :header_params => header_params,
1520
+ :query_params => query_params,
1521
+ :form_params => form_params,
1522
+ :body => post_body,
1523
+ :auth_names => auth_names)
1524
+ if @api_client.config.debugging
1525
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_page_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1526
+ end
1527
+ return data, status_code, headers
1528
+ end
1529
+
1530
+ # Add pdf blobs for Display Appliance
1531
+ #
1532
+ # @param account_id The external account number (int) or account ID Guid.
1533
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1534
+ # @return [DisplayAppliancePdf]
1535
+ def create_pdf_blob(account_id, envelope_id)
1536
+ data, _status_code, _headers = create_pdf_blob_with_http_info(account_id, envelope_id)
1537
+ return data
1538
+ end
1539
+
1540
+ # Add pdf blobs for Display Appliance
1541
+ #
1542
+ # @param account_id The external account number (int) or account ID Guid.
1543
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1544
+ # @return [Array<(DisplayAppliancePdf, Fixnum, Hash)>] DisplayAppliancePdf data, response status code and response headers
1545
+ def create_pdf_blob_with_http_info(account_id, envelope_id)
1546
+ if @api_client.config.debugging
1547
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_pdf_blob ..."
1548
+ end
1549
+ # verify the required parameter 'account_id' is set
1550
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_pdf_blob" if account_id.nil?
1551
+ # verify the required parameter 'envelope_id' is set
1552
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_pdf_blob" if envelope_id.nil?
1553
+ # resource path
1554
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1555
+
1556
+ # query parameters
1557
+ query_params = {}
1558
+
1559
+ # header parameters
1560
+ header_params = {}
1561
+ # HTTP header 'Accept' (if needed)
1562
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1563
+
1564
+ # form parameters
1565
+ form_params = {}
1566
+
1567
+ # http body (model)
1568
+ post_body = nil
1569
+ auth_names = []
1570
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1571
+ :header_params => header_params,
1572
+ :query_params => query_params,
1573
+ :form_params => form_params,
1574
+ :body => post_body,
1575
+ :auth_names => auth_names,
1576
+ :return_type => 'DisplayAppliancePdf')
1577
+ if @api_client.config.debugging
1578
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_pdf_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1579
+ end
1580
+ return data, status_code, headers
1581
+ end
1582
+
1431
1583
  # Adds one or more recipients to an envelope.
1432
1584
  # Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
1433
1585
  # @param account_id The external account number (int) or account ID Guid.
@@ -1486,6 +1638,63 @@ module DocuSign_eSign
1486
1638
  return data, status_code, headers
1487
1639
  end
1488
1640
 
1641
+ # Provides a link to access the Identity manual review related to a recipient.
1642
+ #
1643
+ # @param account_id The external account number (int) or account ID Guid.
1644
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1645
+ # @param recipient_id The ID of the recipient being accessed.
1646
+ # @return [ViewUrl]
1647
+ def create_recipient_manual_review_view(account_id, envelope_id, recipient_id)
1648
+ data, _status_code, _headers = create_recipient_manual_review_view_with_http_info(account_id, envelope_id, recipient_id)
1649
+ return data
1650
+ end
1651
+
1652
+ # Provides a link to access the Identity manual review related to a recipient.
1653
+ #
1654
+ # @param account_id The external account number (int) or account ID Guid.
1655
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1656
+ # @param recipient_id The ID of the recipient being accessed.
1657
+ # @return [Array<(ViewUrl, Fixnum, Hash)>] ViewUrl data, response status code and response headers
1658
+ def create_recipient_manual_review_view_with_http_info(account_id, envelope_id, recipient_id)
1659
+ if @api_client.config.debugging
1660
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_manual_review_view ..."
1661
+ end
1662
+ # verify the required parameter 'account_id' is set
1663
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_recipient_manual_review_view" if account_id.nil?
1664
+ # verify the required parameter 'envelope_id' is set
1665
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_recipient_manual_review_view" if envelope_id.nil?
1666
+ # verify the required parameter 'recipient_id' is set
1667
+ fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.create_recipient_manual_review_view" if recipient_id.nil?
1668
+ # resource path
1669
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
1670
+
1671
+ # query parameters
1672
+ query_params = {}
1673
+
1674
+ # header parameters
1675
+ header_params = {}
1676
+ # HTTP header 'Accept' (if needed)
1677
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1678
+
1679
+ # form parameters
1680
+ form_params = {}
1681
+
1682
+ # http body (model)
1683
+ post_body = nil
1684
+ auth_names = []
1685
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1686
+ :header_params => header_params,
1687
+ :query_params => query_params,
1688
+ :form_params => form_params,
1689
+ :body => post_body,
1690
+ :auth_names => auth_names,
1691
+ :return_type => 'ViewUrl')
1692
+ if @api_client.config.debugging
1693
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient_manual_review_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1694
+ end
1695
+ return data, status_code, headers
1696
+ end
1697
+
1489
1698
  # Returns a link to access to the identity events stored in the proof service related to this recipient.
1490
1699
  #
1491
1700
  # @param account_id The external account number (int) or account ID Guid.
@@ -1659,6 +1868,51 @@ module DocuSign_eSign
1659
1868
  return data, status_code, headers
1660
1869
  end
1661
1870
 
1871
+ # Returns signing url for Display Appliance
1872
+ #
1873
+ # @return [DisplayApplianceInfo]
1874
+ def create_redeem()
1875
+ data, _status_code, _headers = create_redeem_with_http_info()
1876
+ return data
1877
+ end
1878
+
1879
+ # Returns signing url for Display Appliance
1880
+ #
1881
+ # @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
1882
+ def create_redeem_with_http_info()
1883
+ if @api_client.config.debugging
1884
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_redeem ..."
1885
+ end
1886
+ # resource path
1887
+ local_var_path = "/v2.1/display_appliance_info/redeem".sub('{format}','json')
1888
+
1889
+ # query parameters
1890
+ query_params = {}
1891
+
1892
+ # header parameters
1893
+ header_params = {}
1894
+ # HTTP header 'Accept' (if needed)
1895
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1896
+
1897
+ # form parameters
1898
+ form_params = {}
1899
+
1900
+ # http body (model)
1901
+ post_body = nil
1902
+ auth_names = []
1903
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1904
+ :header_params => header_params,
1905
+ :query_params => query_params,
1906
+ :form_params => form_params,
1907
+ :body => post_body,
1908
+ :auth_names => auth_names,
1909
+ :return_type => 'DisplayApplianceInfo')
1910
+ if @api_client.config.debugging
1911
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_redeem\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1912
+ end
1913
+ return data, status_code, headers
1914
+ end
1915
+
1662
1916
  # Get Responsive HTML Preview for all documents in an envelope.
1663
1917
  #
1664
1918
  # @param account_id The external account number (int) or account ID Guid.
@@ -1991,37 +2245,31 @@ module DocuSign_eSign
1991
2245
  return data, status_code, headers
1992
2246
  end
1993
2247
 
1994
- # Deletes custom document fields from an existing envelope document.
1995
- # Deletes custom document fields from an existing envelope document.
2248
+ # Delete custom fields information for Display Appliance
2249
+ #
1996
2250
  # @param account_id The external account number (int) or account ID Guid.
1997
- # @param document_id The ID of the document being accessed.
1998
2251
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1999
- # @param document_fields_information (optional parameter)
2000
- # @return [DocumentFieldsInformation]
2001
- def delete_document_fields(account_id, document_id, envelope_id, document_fields_information)
2002
- data, _status_code, _headers = delete_document_fields_with_http_info(account_id, document_id, envelope_id, document_fields_information)
2003
- return data
2252
+ # @return [nil]
2253
+ def delete_custom_fields_0(account_id, envelope_id)
2254
+ delete_custom_fields_0_with_http_info(account_id, envelope_id)
2255
+ return nil
2004
2256
  end
2005
2257
 
2006
- # Deletes custom document fields from an existing envelope document.
2007
- # Deletes custom document fields from an existing envelope document.
2258
+ # Delete custom fields information for Display Appliance
2259
+ #
2008
2260
  # @param account_id The external account number (int) or account ID Guid.
2009
- # @param document_id The ID of the document being accessed.
2010
2261
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2011
- # @param document_fields_information (optional parameter)
2012
- # @return [Array<(DocumentFieldsInformation, Fixnum, Hash)>] DocumentFieldsInformation data, response status code and response headers
2013
- def delete_document_fields_with_http_info(account_id, document_id, envelope_id, document_fields_information)
2262
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2263
+ def delete_custom_fields_0_with_http_info(account_id, envelope_id)
2014
2264
  if @api_client.config.debugging
2015
- @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_document_fields ..."
2265
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_custom_fields_0 ..."
2016
2266
  end
2017
2267
  # verify the required parameter 'account_id' is set
2018
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_document_fields" if account_id.nil?
2019
- # verify the required parameter 'document_id' is set
2020
- fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.delete_document_fields" if document_id.nil?
2268
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_custom_fields_0" if account_id.nil?
2021
2269
  # verify the required parameter 'envelope_id' is set
2022
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_document_fields" if envelope_id.nil?
2270
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_custom_fields_0" if envelope_id.nil?
2023
2271
  # resource path
2024
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2272
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/custom_fields/delete".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2025
2273
 
2026
2274
  # query parameters
2027
2275
  query_params = {}
@@ -2035,54 +2283,49 @@ module DocuSign_eSign
2035
2283
  form_params = {}
2036
2284
 
2037
2285
  # http body (model)
2038
- post_body = @api_client.object_to_http_body(document_fields_information)
2286
+ post_body = nil
2039
2287
  auth_names = []
2040
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2288
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2041
2289
  :header_params => header_params,
2042
2290
  :query_params => query_params,
2043
2291
  :form_params => form_params,
2044
2292
  :body => post_body,
2045
- :auth_names => auth_names,
2046
- :return_type => 'DocumentFieldsInformation')
2293
+ :auth_names => auth_names)
2047
2294
  if @api_client.config.debugging
2048
- @api_client.config.logger.debug "API called: EnvelopesApi#delete_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2295
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_custom_fields_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2049
2296
  end
2050
2297
  return data, status_code, headers
2051
2298
  end
2052
2299
 
2053
- # Deletes a page from a document in an envelope.
2054
- # Deletes a page from a document in an envelope based on the page number.
2300
+ # Delete document information for Display Appliance
2301
+ #
2055
2302
  # @param account_id The external account number (int) or account ID Guid.
2056
2303
  # @param document_id The ID of the document being accessed.
2057
2304
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2058
- # @param page_number The page number being accessed.
2059
2305
  # @return [nil]
2060
- def delete_document_page(account_id, document_id, envelope_id, page_number)
2061
- delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number)
2306
+ def delete_document(account_id, document_id, envelope_id)
2307
+ delete_document_with_http_info(account_id, document_id, envelope_id)
2062
2308
  return nil
2063
2309
  end
2064
2310
 
2065
- # Deletes a page from a document in an envelope.
2066
- # Deletes a page from a document in an envelope based on the page number.
2311
+ # Delete document information for Display Appliance
2312
+ #
2067
2313
  # @param account_id The external account number (int) or account ID Guid.
2068
2314
  # @param document_id The ID of the document being accessed.
2069
2315
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2070
- # @param page_number The page number being accessed.
2071
2316
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2072
- def delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number)
2317
+ def delete_document_with_http_info(account_id, document_id, envelope_id)
2073
2318
  if @api_client.config.debugging
2074
- @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_document_page ..."
2319
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_document ..."
2075
2320
  end
2076
2321
  # verify the required parameter 'account_id' is set
2077
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_document_page" if account_id.nil?
2322
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_document" if account_id.nil?
2078
2323
  # verify the required parameter 'document_id' is set
2079
- fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.delete_document_page" if document_id.nil?
2324
+ fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.delete_document" if document_id.nil?
2080
2325
  # verify the required parameter 'envelope_id' is set
2081
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_document_page" if envelope_id.nil?
2082
- # verify the required parameter 'page_number' is set
2083
- fail ArgumentError, "Missing the required parameter 'page_number' when calling EnvelopesApi.delete_document_page" if page_number.nil?
2326
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_document" if envelope_id.nil?
2084
2327
  # resource path
2085
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
2328
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2086
2329
 
2087
2330
  # query parameters
2088
2331
  query_params = {}
@@ -2105,14 +2348,133 @@ module DocuSign_eSign
2105
2348
  :body => post_body,
2106
2349
  :auth_names => auth_names)
2107
2350
  if @api_client.config.debugging
2108
- @api_client.config.logger.debug "API called: EnvelopesApi#delete_document_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2351
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2109
2352
  end
2110
2353
  return data, status_code, headers
2111
2354
  end
2112
2355
 
2113
- # Deletes tabs from an envelope document
2114
- #
2115
- # @param account_id The external account number (int) or account ID Guid.
2356
+ # Deletes custom document fields from an existing envelope document.
2357
+ # Deletes custom document fields from an existing envelope document.
2358
+ # @param account_id The external account number (int) or account ID Guid.
2359
+ # @param document_id The ID of the document being accessed.
2360
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2361
+ # @param document_fields_information (optional parameter)
2362
+ # @return [DocumentFieldsInformation]
2363
+ def delete_document_fields(account_id, document_id, envelope_id, document_fields_information)
2364
+ data, _status_code, _headers = delete_document_fields_with_http_info(account_id, document_id, envelope_id, document_fields_information)
2365
+ return data
2366
+ end
2367
+
2368
+ # Deletes custom document fields from an existing envelope document.
2369
+ # Deletes custom document fields from an existing envelope document.
2370
+ # @param account_id The external account number (int) or account ID Guid.
2371
+ # @param document_id The ID of the document being accessed.
2372
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2373
+ # @param document_fields_information (optional parameter)
2374
+ # @return [Array<(DocumentFieldsInformation, Fixnum, Hash)>] DocumentFieldsInformation data, response status code and response headers
2375
+ def delete_document_fields_with_http_info(account_id, document_id, envelope_id, document_fields_information)
2376
+ if @api_client.config.debugging
2377
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_document_fields ..."
2378
+ end
2379
+ # verify the required parameter 'account_id' is set
2380
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_document_fields" if account_id.nil?
2381
+ # verify the required parameter 'document_id' is set
2382
+ fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.delete_document_fields" if document_id.nil?
2383
+ # verify the required parameter 'envelope_id' is set
2384
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_document_fields" if envelope_id.nil?
2385
+ # resource path
2386
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2387
+
2388
+ # query parameters
2389
+ query_params = {}
2390
+
2391
+ # header parameters
2392
+ header_params = {}
2393
+ # HTTP header 'Accept' (if needed)
2394
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2395
+
2396
+ # form parameters
2397
+ form_params = {}
2398
+
2399
+ # http body (model)
2400
+ post_body = @api_client.object_to_http_body(document_fields_information)
2401
+ auth_names = []
2402
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2403
+ :header_params => header_params,
2404
+ :query_params => query_params,
2405
+ :form_params => form_params,
2406
+ :body => post_body,
2407
+ :auth_names => auth_names,
2408
+ :return_type => 'DocumentFieldsInformation')
2409
+ if @api_client.config.debugging
2410
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2411
+ end
2412
+ return data, status_code, headers
2413
+ end
2414
+
2415
+ # Deletes a page from a document in an envelope.
2416
+ # Deletes a page from a document in an envelope based on the page number.
2417
+ # @param account_id The external account number (int) or account ID Guid.
2418
+ # @param document_id The ID of the document being accessed.
2419
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2420
+ # @param page_number The page number being accessed.
2421
+ # @return [nil]
2422
+ def delete_document_page(account_id, document_id, envelope_id, page_number)
2423
+ delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number)
2424
+ return nil
2425
+ end
2426
+
2427
+ # Deletes a page from a document in an envelope.
2428
+ # Deletes a page from a document in an envelope based on the page number.
2429
+ # @param account_id The external account number (int) or account ID Guid.
2430
+ # @param document_id The ID of the document being accessed.
2431
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2432
+ # @param page_number The page number being accessed.
2433
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2434
+ def delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number)
2435
+ if @api_client.config.debugging
2436
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_document_page ..."
2437
+ end
2438
+ # verify the required parameter 'account_id' is set
2439
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_document_page" if account_id.nil?
2440
+ # verify the required parameter 'document_id' is set
2441
+ fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.delete_document_page" if document_id.nil?
2442
+ # verify the required parameter 'envelope_id' is set
2443
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_document_page" if envelope_id.nil?
2444
+ # verify the required parameter 'page_number' is set
2445
+ fail ArgumentError, "Missing the required parameter 'page_number' when calling EnvelopesApi.delete_document_page" if page_number.nil?
2446
+ # resource path
2447
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
2448
+
2449
+ # query parameters
2450
+ query_params = {}
2451
+
2452
+ # header parameters
2453
+ header_params = {}
2454
+ # HTTP header 'Accept' (if needed)
2455
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2456
+
2457
+ # form parameters
2458
+ form_params = {}
2459
+
2460
+ # http body (model)
2461
+ post_body = nil
2462
+ auth_names = []
2463
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2464
+ :header_params => header_params,
2465
+ :query_params => query_params,
2466
+ :form_params => form_params,
2467
+ :body => post_body,
2468
+ :auth_names => auth_names)
2469
+ if @api_client.config.debugging
2470
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_document_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2471
+ end
2472
+ return data, status_code, headers
2473
+ end
2474
+
2475
+ # Deletes tabs from an envelope document
2476
+ #
2477
+ # @param account_id The external account number (int) or account ID Guid.
2116
2478
  # @param document_id The ID of the document being accessed.
2117
2479
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2118
2480
  # @param tabs (optional parameter)
@@ -2488,6 +2850,58 @@ module DocuSign_eSign
2488
2850
  return data, status_code, headers
2489
2851
  end
2490
2852
 
2853
+ # Delete page information for Display Appliance
2854
+ #
2855
+ # @param account_id The external account number (int) or account ID Guid.
2856
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2857
+ # @return [nil]
2858
+ def delete_page_info(account_id, envelope_id)
2859
+ delete_page_info_with_http_info(account_id, envelope_id)
2860
+ return nil
2861
+ end
2862
+
2863
+ # Delete page information for Display Appliance
2864
+ #
2865
+ # @param account_id The external account number (int) or account ID Guid.
2866
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2867
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2868
+ def delete_page_info_with_http_info(account_id, envelope_id)
2869
+ if @api_client.config.debugging
2870
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_page_info ..."
2871
+ end
2872
+ # verify the required parameter 'account_id' is set
2873
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_page_info" if account_id.nil?
2874
+ # verify the required parameter 'envelope_id' is set
2875
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_page_info" if envelope_id.nil?
2876
+ # resource path
2877
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info/delete".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2878
+
2879
+ # query parameters
2880
+ query_params = {}
2881
+
2882
+ # header parameters
2883
+ header_params = {}
2884
+ # HTTP header 'Accept' (if needed)
2885
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2886
+
2887
+ # form parameters
2888
+ form_params = {}
2889
+
2890
+ # http body (model)
2891
+ post_body = nil
2892
+ auth_names = []
2893
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2894
+ :header_params => header_params,
2895
+ :query_params => query_params,
2896
+ :form_params => form_params,
2897
+ :body => post_body,
2898
+ :auth_names => auth_names)
2899
+ if @api_client.config.debugging
2900
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_page_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2901
+ end
2902
+ return data, status_code, headers
2903
+ end
2904
+
2491
2905
  # Deletes a recipient from an envelope.
2492
2906
  # Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
2493
2907
  # @param account_id The external account number (int) or account ID Guid.
@@ -2545,6 +2959,58 @@ module DocuSign_eSign
2545
2959
  return data, status_code, headers
2546
2960
  end
2547
2961
 
2962
+ # Delete RecipientDeniedDocumentCopy for Display Appliance
2963
+ #
2964
+ # @param account_id The external account number (int) or account ID Guid.
2965
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2966
+ # @return [nil]
2967
+ def delete_recipient_denied_document_copy(account_id, envelope_id)
2968
+ delete_recipient_denied_document_copy_with_http_info(account_id, envelope_id)
2969
+ return nil
2970
+ end
2971
+
2972
+ # Delete RecipientDeniedDocumentCopy for Display Appliance
2973
+ #
2974
+ # @param account_id The external account number (int) or account ID Guid.
2975
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2976
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2977
+ def delete_recipient_denied_document_copy_with_http_info(account_id, envelope_id)
2978
+ if @api_client.config.debugging
2979
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_recipient_denied_document_copy ..."
2980
+ end
2981
+ # verify the required parameter 'account_id' is set
2982
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_recipient_denied_document_copy" if account_id.nil?
2983
+ # verify the required parameter 'envelope_id' is set
2984
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_recipient_denied_document_copy" if envelope_id.nil?
2985
+ # resource path
2986
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/recipient_denied_copy".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2987
+
2988
+ # query parameters
2989
+ query_params = {}
2990
+
2991
+ # header parameters
2992
+ header_params = {}
2993
+ # HTTP header 'Accept' (if needed)
2994
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2995
+
2996
+ # form parameters
2997
+ form_params = {}
2998
+
2999
+ # http body (model)
3000
+ post_body = nil
3001
+ auth_names = []
3002
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3003
+ :header_params => header_params,
3004
+ :query_params => query_params,
3005
+ :form_params => form_params,
3006
+ :body => post_body,
3007
+ :auth_names => auth_names)
3008
+ if @api_client.config.debugging
3009
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_recipient_denied_document_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3010
+ end
3011
+ return data, status_code, headers
3012
+ end
3013
+
2548
3014
  # Deletes recipients from an envelope.
2549
3015
  # Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
2550
3016
  # @param account_id The external account number (int) or account ID Guid.
@@ -2600,6 +3066,58 @@ module DocuSign_eSign
2600
3066
  return data, status_code, headers
2601
3067
  end
2602
3068
 
3069
+ # Delete signer attachment information for Display Appliance
3070
+ #
3071
+ # @param account_id The external account number (int) or account ID Guid.
3072
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3073
+ # @return [nil]
3074
+ def delete_signer_attachment(account_id, envelope_id)
3075
+ delete_signer_attachment_with_http_info(account_id, envelope_id)
3076
+ return nil
3077
+ end
3078
+
3079
+ # Delete signer attachment information for Display Appliance
3080
+ #
3081
+ # @param account_id The external account number (int) or account ID Guid.
3082
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3083
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3084
+ def delete_signer_attachment_with_http_info(account_id, envelope_id)
3085
+ if @api_client.config.debugging
3086
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_signer_attachment ..."
3087
+ end
3088
+ # verify the required parameter 'account_id' is set
3089
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_signer_attachment" if account_id.nil?
3090
+ # verify the required parameter 'envelope_id' is set
3091
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_signer_attachment" if envelope_id.nil?
3092
+ # resource path
3093
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/signer_attachment_info".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3094
+
3095
+ # query parameters
3096
+ query_params = {}
3097
+
3098
+ # header parameters
3099
+ header_params = {}
3100
+ # HTTP header 'Accept' (if needed)
3101
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3102
+
3103
+ # form parameters
3104
+ form_params = {}
3105
+
3106
+ # http body (model)
3107
+ post_body = nil
3108
+ auth_names = []
3109
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3110
+ :header_params => header_params,
3111
+ :query_params => query_params,
3112
+ :form_params => form_params,
3113
+ :body => post_body,
3114
+ :auth_names => auth_names)
3115
+ if @api_client.config.debugging
3116
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_signer_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3117
+ end
3118
+ return data, status_code, headers
3119
+ end
3120
+
2603
3121
  # Deletes the tabs associated with a recipient.
2604
3122
  # Deletes one or more tabs associated with a recipient in a draft envelope.
2605
3123
  # @param account_id The external account number (int) or account ID Guid.
@@ -2771,6 +3289,112 @@ module DocuSign_eSign
2771
3289
  return data, status_code, headers
2772
3290
  end
2773
3291
 
3292
+ # Returns envelope account information for Display Appliance
3293
+ #
3294
+ # @param account_id The external account number (int) or account ID Guid.
3295
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3296
+ # @return [DisplayApplianceAccount]
3297
+ def get_account(account_id, envelope_id)
3298
+ data, _status_code, _headers = get_account_with_http_info(account_id, envelope_id)
3299
+ return data
3300
+ end
3301
+
3302
+ # Returns envelope account information for Display Appliance
3303
+ #
3304
+ # @param account_id The external account number (int) or account ID Guid.
3305
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3306
+ # @return [Array<(DisplayApplianceAccount, Fixnum, Hash)>] DisplayApplianceAccount data, response status code and response headers
3307
+ def get_account_with_http_info(account_id, envelope_id)
3308
+ if @api_client.config.debugging
3309
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_account ..."
3310
+ end
3311
+ # verify the required parameter 'account_id' is set
3312
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_account" if account_id.nil?
3313
+ # verify the required parameter 'envelope_id' is set
3314
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_account" if envelope_id.nil?
3315
+ # resource path
3316
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/account_info".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3317
+
3318
+ # query parameters
3319
+ query_params = {}
3320
+
3321
+ # header parameters
3322
+ header_params = {}
3323
+ # HTTP header 'Accept' (if needed)
3324
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3325
+
3326
+ # form parameters
3327
+ form_params = {}
3328
+
3329
+ # http body (model)
3330
+ post_body = nil
3331
+ auth_names = []
3332
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3333
+ :header_params => header_params,
3334
+ :query_params => query_params,
3335
+ :form_params => form_params,
3336
+ :body => post_body,
3337
+ :auth_names => auth_names,
3338
+ :return_type => 'DisplayApplianceAccount')
3339
+ if @api_client.config.debugging
3340
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3341
+ end
3342
+ return data, status_code, headers
3343
+ end
3344
+
3345
+ # Returns envelope and recipient information for Display Appliance
3346
+ #
3347
+ # @param account_id The external account number (int) or account ID Guid.
3348
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3349
+ # @return [DisplayApplianceInfo]
3350
+ def get_appliance_info(account_id, envelope_id)
3351
+ data, _status_code, _headers = get_appliance_info_with_http_info(account_id, envelope_id)
3352
+ return data
3353
+ end
3354
+
3355
+ # Returns envelope and recipient information for Display Appliance
3356
+ #
3357
+ # @param account_id The external account number (int) or account ID Guid.
3358
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3359
+ # @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
3360
+ def get_appliance_info_with_http_info(account_id, envelope_id)
3361
+ if @api_client.config.debugging
3362
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_appliance_info ..."
3363
+ end
3364
+ # verify the required parameter 'account_id' is set
3365
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_appliance_info" if account_id.nil?
3366
+ # verify the required parameter 'envelope_id' is set
3367
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_appliance_info" if envelope_id.nil?
3368
+ # resource path
3369
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3370
+
3371
+ # query parameters
3372
+ query_params = {}
3373
+
3374
+ # header parameters
3375
+ header_params = {}
3376
+ # HTTP header 'Accept' (if needed)
3377
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3378
+
3379
+ # form parameters
3380
+ form_params = {}
3381
+
3382
+ # http body (model)
3383
+ post_body = nil
3384
+ auth_names = []
3385
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3386
+ :header_params => header_params,
3387
+ :query_params => query_params,
3388
+ :form_params => form_params,
3389
+ :body => post_body,
3390
+ :auth_names => auth_names,
3391
+ :return_type => 'DisplayApplianceInfo')
3392
+ if @api_client.config.debugging
3393
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_appliance_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3394
+ end
3395
+ return data, status_code, headers
3396
+ end
3397
+
2774
3398
  # Retrieves an attachment from the envelope.
2775
3399
  #
2776
3400
  # @param account_id The external account number (int) or account ID Guid.
@@ -3116,6 +3740,112 @@ module DocuSign_eSign
3116
3740
  return data, status_code, headers
3117
3741
  end
3118
3742
 
3743
+ # Return custom fields information for Display Appliance
3744
+ #
3745
+ # @param account_id The external account number (int) or account ID Guid.
3746
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3747
+ # @return [DisplayApplianceInfo]
3748
+ def get_custom_fields(account_id, envelope_id)
3749
+ data, _status_code, _headers = get_custom_fields_with_http_info(account_id, envelope_id)
3750
+ return data
3751
+ end
3752
+
3753
+ # Return custom fields information for Display Appliance
3754
+ #
3755
+ # @param account_id The external account number (int) or account ID Guid.
3756
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3757
+ # @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
3758
+ def get_custom_fields_with_http_info(account_id, envelope_id)
3759
+ if @api_client.config.debugging
3760
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_custom_fields ..."
3761
+ end
3762
+ # verify the required parameter 'account_id' is set
3763
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_custom_fields" if account_id.nil?
3764
+ # verify the required parameter 'envelope_id' is set
3765
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_custom_fields" if envelope_id.nil?
3766
+ # resource path
3767
+ 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)
3768
+
3769
+ # query parameters
3770
+ query_params = {}
3771
+
3772
+ # header parameters
3773
+ header_params = {}
3774
+ # HTTP header 'Accept' (if needed)
3775
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3776
+
3777
+ # form parameters
3778
+ form_params = {}
3779
+
3780
+ # http body (model)
3781
+ post_body = nil
3782
+ auth_names = []
3783
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3784
+ :header_params => header_params,
3785
+ :query_params => query_params,
3786
+ :form_params => form_params,
3787
+ :body => post_body,
3788
+ :auth_names => auth_names,
3789
+ :return_type => 'DisplayApplianceInfo')
3790
+ if @api_client.config.debugging
3791
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3792
+ end
3793
+ return data, status_code, headers
3794
+ end
3795
+
3796
+ # Gets date signed information for Display Appliance
3797
+ #
3798
+ # @param account_id The external account number (int) or account ID Guid.
3799
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3800
+ # @return [DisplayApplianceInfo]
3801
+ def get_date_signed(account_id, envelope_id)
3802
+ data, _status_code, _headers = get_date_signed_with_http_info(account_id, envelope_id)
3803
+ return data
3804
+ end
3805
+
3806
+ # Gets date signed information for Display Appliance
3807
+ #
3808
+ # @param account_id The external account number (int) or account ID Guid.
3809
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3810
+ # @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
3811
+ def get_date_signed_with_http_info(account_id, envelope_id)
3812
+ if @api_client.config.debugging
3813
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_date_signed ..."
3814
+ end
3815
+ # verify the required parameter 'account_id' is set
3816
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_date_signed" if account_id.nil?
3817
+ # verify the required parameter 'envelope_id' is set
3818
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_date_signed" if envelope_id.nil?
3819
+ # resource path
3820
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/date_signed".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3821
+
3822
+ # query parameters
3823
+ query_params = {}
3824
+
3825
+ # header parameters
3826
+ header_params = {}
3827
+ # HTTP header 'Accept' (if needed)
3828
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3829
+
3830
+ # form parameters
3831
+ form_params = {}
3832
+
3833
+ # http body (model)
3834
+ post_body = nil
3835
+ auth_names = []
3836
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3837
+ :header_params => header_params,
3838
+ :query_params => query_params,
3839
+ :form_params => form_params,
3840
+ :body => post_body,
3841
+ :auth_names => auth_names,
3842
+ :return_type => 'DisplayApplianceInfo')
3843
+ if @api_client.config.debugging
3844
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_date_signed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3845
+ end
3846
+ return data, status_code, headers
3847
+ end
3848
+
3119
3849
  # Gets a document from an envelope.
3120
3850
  # Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
3121
3851
  # @param account_id The external account number (int) or account ID Guid.
@@ -3251,6 +3981,59 @@ module DocuSign_eSign
3251
3981
  return data, status_code, headers
3252
3982
  end
3253
3983
 
3984
+ # Return document pages for Display Appliance
3985
+ #
3986
+ # @param account_id The external account number (int) or account ID Guid.
3987
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3988
+ # @return [DisplayApplianceInfo]
3989
+ def get_document_pages(account_id, envelope_id)
3990
+ data, _status_code, _headers = get_document_pages_with_http_info(account_id, envelope_id)
3991
+ return data
3992
+ end
3993
+
3994
+ # Return document pages for Display Appliance
3995
+ #
3996
+ # @param account_id The external account number (int) or account ID Guid.
3997
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3998
+ # @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
3999
+ def get_document_pages_with_http_info(account_id, envelope_id)
4000
+ if @api_client.config.debugging
4001
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_document_pages ..."
4002
+ end
4003
+ # verify the required parameter 'account_id' is set
4004
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_document_pages" if account_id.nil?
4005
+ # verify the required parameter 'envelope_id' is set
4006
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_document_pages" if envelope_id.nil?
4007
+ # resource path
4008
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document_page_list".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4009
+
4010
+ # query parameters
4011
+ query_params = {}
4012
+
4013
+ # header parameters
4014
+ header_params = {}
4015
+ # HTTP header 'Accept' (if needed)
4016
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4017
+
4018
+ # form parameters
4019
+ form_params = {}
4020
+
4021
+ # http body (model)
4022
+ post_body = nil
4023
+ auth_names = []
4024
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4025
+ :header_params => header_params,
4026
+ :query_params => query_params,
4027
+ :form_params => form_params,
4028
+ :body => post_body,
4029
+ :auth_names => auth_names,
4030
+ :return_type => 'DisplayApplianceInfo')
4031
+ if @api_client.config.debugging
4032
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_document_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4033
+ end
4034
+ return data, status_code, headers
4035
+ end
4036
+
3254
4037
  # Returns tabs on the document.
3255
4038
  #
3256
4039
  # @param account_id The external account number (int) or account ID Guid.
@@ -3285,7 +4068,57 @@ module DocuSign_eSign
3285
4068
 
3286
4069
  # query parameters
3287
4070
  query_params = {}
3288
- query_params[:'page_numbers'] = options.page_numbers if !options.page_numbers.nil?
4071
+ query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
4072
+ query_params[:'page_numbers'] = options.page_numbers if !options.page_numbers.nil?
4073
+
4074
+ # header parameters
4075
+ header_params = {}
4076
+ # HTTP header 'Accept' (if needed)
4077
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4078
+
4079
+ # form parameters
4080
+ form_params = {}
4081
+
4082
+ # http body (model)
4083
+ post_body = nil
4084
+ auth_names = []
4085
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4086
+ :header_params => header_params,
4087
+ :query_params => query_params,
4088
+ :form_params => form_params,
4089
+ :body => post_body,
4090
+ :auth_names => auth_names,
4091
+ :return_type => 'Tabs')
4092
+ if @api_client.config.debugging
4093
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4094
+ end
4095
+ return data, status_code, headers
4096
+ end
4097
+
4098
+ # Return document pages for Display Appliance
4099
+ #
4100
+ # @param account_id The external account number (int) or account ID Guid.
4101
+ # @return [DisplayApplianceInfo]
4102
+ def get_dynamic_system_settings(account_id)
4103
+ data, _status_code, _headers = get_dynamic_system_settings_with_http_info(account_id)
4104
+ return data
4105
+ end
4106
+
4107
+ # Return document pages for Display Appliance
4108
+ #
4109
+ # @param account_id The external account number (int) or account ID Guid.
4110
+ # @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
4111
+ def get_dynamic_system_settings_with_http_info(account_id)
4112
+ if @api_client.config.debugging
4113
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_dynamic_system_settings ..."
4114
+ end
4115
+ # verify the required parameter 'account_id' is set
4116
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_dynamic_system_settings" if account_id.nil?
4117
+ # resource path
4118
+ local_var_path = "/v2.1/accounts/{accountId}/display_appliance_info/dynamicsystemsettings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
4119
+
4120
+ # query parameters
4121
+ query_params = {}
3289
4122
 
3290
4123
  # header parameters
3291
4124
  header_params = {}
@@ -3304,9 +4137,9 @@ module DocuSign_eSign
3304
4137
  :form_params => form_params,
3305
4138
  :body => post_body,
3306
4139
  :auth_names => auth_names,
3307
- :return_type => 'Tabs')
4140
+ :return_type => 'DisplayApplianceInfo')
3308
4141
  if @api_client.config.debugging
3309
- @api_client.config.logger.debug "API called: EnvelopesApi#get_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4142
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_dynamic_system_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3310
4143
  end
3311
4144
  return data, status_code, headers
3312
4145
  end
@@ -3690,6 +4523,116 @@ module DocuSign_eSign
3690
4523
  return data, status_code, headers
3691
4524
  end
3692
4525
 
4526
+ # Returns images for Display Appliance
4527
+ #
4528
+ # @param account_id The external account number (int) or account ID Guid.
4529
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4530
+ # @return [DisplayApplianceInfo]
4531
+ def get_image(account_id, envelope_id)
4532
+ data, _status_code, _headers = get_image_with_http_info(account_id, envelope_id)
4533
+ return data
4534
+ end
4535
+
4536
+ # Returns images for Display Appliance
4537
+ #
4538
+ # @param account_id The external account number (int) or account ID Guid.
4539
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4540
+ # @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
4541
+ def get_image_with_http_info(account_id, envelope_id)
4542
+ if @api_client.config.debugging
4543
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_image ..."
4544
+ end
4545
+ # verify the required parameter 'account_id' is set
4546
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_image" if account_id.nil?
4547
+ # verify the required parameter 'envelope_id' is set
4548
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_image" if envelope_id.nil?
4549
+ # resource path
4550
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4551
+
4552
+ # query parameters
4553
+ query_params = {}
4554
+
4555
+ # header parameters
4556
+ header_params = {}
4557
+ # HTTP header 'Accept' (if needed)
4558
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4559
+
4560
+ # form parameters
4561
+ form_params = {}
4562
+
4563
+ # http body (model)
4564
+ post_body = nil
4565
+ auth_names = []
4566
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
4567
+ :header_params => header_params,
4568
+ :query_params => query_params,
4569
+ :form_params => form_params,
4570
+ :body => post_body,
4571
+ :auth_names => auth_names,
4572
+ :return_type => 'DisplayApplianceInfo')
4573
+ if @api_client.config.debugging
4574
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4575
+ end
4576
+ return data, status_code, headers
4577
+ end
4578
+
4579
+ # Returns locale policy information for Display Appliance
4580
+ #
4581
+ # @param account_id The external account number (int) or account ID Guid.
4582
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4583
+ # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
4584
+ # @return [DisplayApplianceInfo]
4585
+ def get_locale_policy(account_id, envelope_id, user_id)
4586
+ data, _status_code, _headers = get_locale_policy_with_http_info(account_id, envelope_id, user_id)
4587
+ return data
4588
+ end
4589
+
4590
+ # Returns locale policy information for Display Appliance
4591
+ #
4592
+ # @param account_id The external account number (int) or account ID Guid.
4593
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4594
+ # @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
4595
+ # @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
4596
+ def get_locale_policy_with_http_info(account_id, envelope_id, user_id)
4597
+ if @api_client.config.debugging
4598
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_locale_policy ..."
4599
+ end
4600
+ # verify the required parameter 'account_id' is set
4601
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_locale_policy" if account_id.nil?
4602
+ # verify the required parameter 'envelope_id' is set
4603
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_locale_policy" if envelope_id.nil?
4604
+ # verify the required parameter 'user_id' is set
4605
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling EnvelopesApi.get_locale_policy" if user_id.nil?
4606
+ # resource path
4607
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/localepolicy/{userId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
4608
+
4609
+ # query parameters
4610
+ query_params = {}
4611
+
4612
+ # header parameters
4613
+ header_params = {}
4614
+ # HTTP header 'Accept' (if needed)
4615
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4616
+
4617
+ # form parameters
4618
+ form_params = {}
4619
+
4620
+ # http body (model)
4621
+ post_body = nil
4622
+ auth_names = []
4623
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
4624
+ :header_params => header_params,
4625
+ :query_params => query_params,
4626
+ :form_params => form_params,
4627
+ :body => post_body,
4628
+ :auth_names => auth_names,
4629
+ :return_type => 'DisplayApplianceInfo')
4630
+ if @api_client.config.debugging
4631
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_locale_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4632
+ end
4633
+ return data, status_code, headers
4634
+ end
4635
+
3693
4636
  # Gets envelope lock information.
3694
4637
  # Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
3695
4638
  # @param account_id The external account number (int) or account ID Guid.
@@ -3923,6 +4866,116 @@ module DocuSign_eSign
3923
4866
  return data, status_code, headers
3924
4867
  end
3925
4868
 
4869
+ # Return pdf for Display Appliance
4870
+ #
4871
+ # @param account_id The external account number (int) or account ID Guid.
4872
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4873
+ # @param pdf_id
4874
+ # @return [DisplayAppliancePdf]
4875
+ def get_pdf(account_id, envelope_id, pdf_id)
4876
+ data, _status_code, _headers = get_pdf_with_http_info(account_id, envelope_id, pdf_id)
4877
+ return data
4878
+ end
4879
+
4880
+ # Return pdf for Display Appliance
4881
+ #
4882
+ # @param account_id The external account number (int) or account ID Guid.
4883
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4884
+ # @param pdf_id
4885
+ # @return [Array<(DisplayAppliancePdf, Fixnum, Hash)>] DisplayAppliancePdf data, response status code and response headers
4886
+ def get_pdf_with_http_info(account_id, envelope_id, pdf_id)
4887
+ if @api_client.config.debugging
4888
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_pdf ..."
4889
+ end
4890
+ # verify the required parameter 'account_id' is set
4891
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_pdf" if account_id.nil?
4892
+ # verify the required parameter 'envelope_id' is set
4893
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_pdf" if envelope_id.nil?
4894
+ # verify the required parameter 'pdf_id' is set
4895
+ fail ArgumentError, "Missing the required parameter 'pdf_id' when calling EnvelopesApi.get_pdf" if pdf_id.nil?
4896
+ # resource path
4897
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf/{pdfId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pdfId' + '}', pdf_id.to_s)
4898
+
4899
+ # query parameters
4900
+ query_params = {}
4901
+
4902
+ # header parameters
4903
+ header_params = {}
4904
+ # HTTP header 'Accept' (if needed)
4905
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4906
+
4907
+ # form parameters
4908
+ form_params = {}
4909
+
4910
+ # http body (model)
4911
+ post_body = nil
4912
+ auth_names = []
4913
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4914
+ :header_params => header_params,
4915
+ :query_params => query_params,
4916
+ :form_params => form_params,
4917
+ :body => post_body,
4918
+ :auth_names => auth_names,
4919
+ :return_type => 'DisplayAppliancePdf')
4920
+ if @api_client.config.debugging
4921
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4922
+ end
4923
+ return data, status_code, headers
4924
+ end
4925
+
4926
+ # Return pdf blobs for Display Appliance
4927
+ #
4928
+ # @param account_id The external account number (int) or account ID Guid.
4929
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4930
+ # @return [DisplayAppliancePdf]
4931
+ def get_pdf_blob(account_id, envelope_id)
4932
+ data, _status_code, _headers = get_pdf_blob_with_http_info(account_id, envelope_id)
4933
+ return data
4934
+ end
4935
+
4936
+ # Return pdf blobs for Display Appliance
4937
+ #
4938
+ # @param account_id The external account number (int) or account ID Guid.
4939
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4940
+ # @return [Array<(DisplayAppliancePdf, Fixnum, Hash)>] DisplayAppliancePdf data, response status code and response headers
4941
+ def get_pdf_blob_with_http_info(account_id, envelope_id)
4942
+ if @api_client.config.debugging
4943
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_pdf_blob ..."
4944
+ end
4945
+ # verify the required parameter 'account_id' is set
4946
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_pdf_blob" if account_id.nil?
4947
+ # verify the required parameter 'envelope_id' is set
4948
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_pdf_blob" if envelope_id.nil?
4949
+ # resource path
4950
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4951
+
4952
+ # query parameters
4953
+ query_params = {}
4954
+
4955
+ # header parameters
4956
+ header_params = {}
4957
+ # HTTP header 'Accept' (if needed)
4958
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4959
+
4960
+ # form parameters
4961
+ form_params = {}
4962
+
4963
+ # http body (model)
4964
+ post_body = nil
4965
+ auth_names = []
4966
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4967
+ :header_params => header_params,
4968
+ :query_params => query_params,
4969
+ :form_params => form_params,
4970
+ :body => post_body,
4971
+ :auth_names => auth_names,
4972
+ :return_type => 'DisplayAppliancePdf')
4973
+ if @api_client.config.debugging
4974
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_pdf_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4975
+ end
4976
+ return data, status_code, headers
4977
+ end
4978
+
3926
4979
  # Returns document visibility for the recipients
3927
4980
  #
3928
4981
  # @param account_id The external account number (int) or account ID Guid.
@@ -4131,12 +5184,118 @@ module DocuSign_eSign
4131
5184
 
4132
5185
  # query parameters
4133
5186
  query_params = {}
4134
- query_params[:'include_chrome'] = options.include_chrome if !options.include_chrome.nil?
5187
+ query_params[:'include_chrome'] = options.include_chrome if !options.include_chrome.nil?
5188
+
5189
+ # header parameters
5190
+ header_params = {}
5191
+ # HTTP header 'Accept' (if needed)
5192
+ header_params['Accept'] = @api_client.select_header_accept(['image/gif'])
5193
+
5194
+ # form parameters
5195
+ form_params = {}
5196
+
5197
+ # http body (model)
5198
+ post_body = nil
5199
+ auth_names = []
5200
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
5201
+ :header_params => header_params,
5202
+ :query_params => query_params,
5203
+ :form_params => form_params,
5204
+ :body => post_body,
5205
+ :auth_names => auth_names,
5206
+ :return_type => 'File')
5207
+ if @api_client.config.debugging
5208
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_recipient_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5209
+ end
5210
+ return data, status_code, headers
5211
+ end
5212
+
5213
+ # Return signer attachment information for Display Appliance
5214
+ #
5215
+ # @param account_id The external account number (int) or account ID Guid.
5216
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5217
+ # @return [DisplayApplianceSignerAttachment]
5218
+ def get_signer_attachment(account_id, envelope_id)
5219
+ data, _status_code, _headers = get_signer_attachment_with_http_info(account_id, envelope_id)
5220
+ return data
5221
+ end
5222
+
5223
+ # Return signer attachment information for Display Appliance
5224
+ #
5225
+ # @param account_id The external account number (int) or account ID Guid.
5226
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5227
+ # @return [Array<(DisplayApplianceSignerAttachment, Fixnum, Hash)>] DisplayApplianceSignerAttachment data, response status code and response headers
5228
+ def get_signer_attachment_with_http_info(account_id, envelope_id)
5229
+ if @api_client.config.debugging
5230
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_signer_attachment ..."
5231
+ end
5232
+ # verify the required parameter 'account_id' is set
5233
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_signer_attachment" if account_id.nil?
5234
+ # verify the required parameter 'envelope_id' is set
5235
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_signer_attachment" if envelope_id.nil?
5236
+ # resource path
5237
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/signer_attachment_info".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5238
+
5239
+ # query parameters
5240
+ query_params = {}
5241
+
5242
+ # header parameters
5243
+ header_params = {}
5244
+ # HTTP header 'Accept' (if needed)
5245
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5246
+
5247
+ # form parameters
5248
+ form_params = {}
5249
+
5250
+ # http body (model)
5251
+ post_body = nil
5252
+ auth_names = []
5253
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
5254
+ :header_params => header_params,
5255
+ :query_params => query_params,
5256
+ :form_params => form_params,
5257
+ :body => post_body,
5258
+ :auth_names => auth_names,
5259
+ :return_type => 'DisplayApplianceSignerAttachment')
5260
+ if @api_client.config.debugging
5261
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_signer_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5262
+ end
5263
+ return data, status_code, headers
5264
+ end
5265
+
5266
+ # Get encrypted tabs for envelope.
5267
+ #
5268
+ # @param account_id The external account number (int) or account ID Guid.
5269
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5270
+ # @return [nil]
5271
+ def get_tabs_blob(account_id, envelope_id)
5272
+ get_tabs_blob_with_http_info(account_id, envelope_id)
5273
+ return nil
5274
+ end
5275
+
5276
+ # Get encrypted tabs for envelope.
5277
+ #
5278
+ # @param account_id The external account number (int) or account ID Guid.
5279
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5280
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
5281
+ def get_tabs_blob_with_http_info(account_id, envelope_id)
5282
+ if @api_client.config.debugging
5283
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_tabs_blob ..."
5284
+ end
5285
+ # verify the required parameter 'account_id' is set
5286
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_tabs_blob" if account_id.nil?
5287
+ # verify the required parameter 'envelope_id' is set
5288
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_tabs_blob" if envelope_id.nil?
5289
+ # resource path
5290
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5291
+
5292
+ # query parameters
5293
+ query_params = {}
4135
5294
 
4136
5295
  # header parameters
4137
5296
  header_params = {}
4138
5297
  # HTTP header 'Accept' (if needed)
4139
- header_params['Accept'] = @api_client.select_header_accept(['image/gif'])
5298
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4140
5299
 
4141
5300
  # form parameters
4142
5301
  form_params = {}
@@ -4149,39 +5308,38 @@ module DocuSign_eSign
4149
5308
  :query_params => query_params,
4150
5309
  :form_params => form_params,
4151
5310
  :body => post_body,
4152
- :auth_names => auth_names,
4153
- :return_type => 'File')
5311
+ :auth_names => auth_names)
4154
5312
  if @api_client.config.debugging
4155
- @api_client.config.logger.debug "API called: EnvelopesApi#get_recipient_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5313
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_tabs_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4156
5314
  end
4157
5315
  return data, status_code, headers
4158
5316
  end
4159
5317
 
4160
- # Get encrypted tabs for envelope.
5318
+ # Returns if template was encrypted by Display Appliance
4161
5319
  #
4162
5320
  # @param account_id The external account number (int) or account ID Guid.
4163
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
4164
- # @return [nil]
4165
- def get_tabs_blob(account_id, envelope_id)
4166
- get_tabs_blob_with_http_info(account_id, envelope_id)
4167
- return nil
5321
+ # @param template_id The ID of the template being accessed.
5322
+ # @return [DisplayApplianceInfo]
5323
+ def get_template_info(account_id, template_id)
5324
+ data, _status_code, _headers = get_template_info_with_http_info(account_id, template_id)
5325
+ return data
4168
5326
  end
4169
5327
 
4170
- # Get encrypted tabs for envelope.
5328
+ # Returns if template was encrypted by Display Appliance
4171
5329
  #
4172
5330
  # @param account_id The external account number (int) or account ID Guid.
4173
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
4174
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
4175
- def get_tabs_blob_with_http_info(account_id, envelope_id)
5331
+ # @param template_id The ID of the template being accessed.
5332
+ # @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
5333
+ def get_template_info_with_http_info(account_id, template_id)
4176
5334
  if @api_client.config.debugging
4177
- @api_client.config.logger.debug "Calling API: EnvelopesApi.get_tabs_blob ..."
5335
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_info ..."
4178
5336
  end
4179
5337
  # verify the required parameter 'account_id' is set
4180
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_tabs_blob" if account_id.nil?
4181
- # verify the required parameter 'envelope_id' is set
4182
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_tabs_blob" if envelope_id.nil?
5338
+ 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?
4183
5341
  # resource path
4184
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5342
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{templateId}/display_appliance_info/templateInfo".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
4185
5343
 
4186
5344
  # query parameters
4187
5345
  query_params = {}
@@ -4202,9 +5360,10 @@ module DocuSign_eSign
4202
5360
  :query_params => query_params,
4203
5361
  :form_params => form_params,
4204
5362
  :body => post_body,
4205
- :auth_names => auth_names)
5363
+ :auth_names => auth_names,
5364
+ :return_type => 'DisplayApplianceInfo')
4206
5365
  if @api_client.config.debugging
4207
- @api_client.config.logger.debug "API called: EnvelopesApi#get_tabs_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5366
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_template_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4208
5367
  end
4209
5368
  return data, status_code, headers
4210
5369
  end
@@ -5330,14 +6489,70 @@ module DocuSign_eSign
5330
6489
  return data, status_code, headers
5331
6490
  end
5332
6491
 
6492
+ # Update document information for Display Appliance
6493
+ #
6494
+ # @param account_id The external account number (int) or account ID Guid.
6495
+ # @param document_id The ID of the document being accessed.
6496
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6497
+ # @return [nil]
6498
+ def update_document(account_id, document_id, envelope_id)
6499
+ update_document_with_http_info(account_id, document_id, envelope_id)
6500
+ return nil
6501
+ end
6502
+
6503
+ # Update document information for Display Appliance
6504
+ #
6505
+ # @param account_id The external account number (int) or account ID Guid.
6506
+ # @param document_id The ID of the document being accessed.
6507
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6508
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
6509
+ def update_document_with_http_info(account_id, document_id, envelope_id)
6510
+ if @api_client.config.debugging
6511
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document ..."
6512
+ end
6513
+ # verify the required parameter 'account_id' is set
6514
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_document" if account_id.nil?
6515
+ # verify the required parameter 'document_id' is set
6516
+ fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document" if document_id.nil?
6517
+ # verify the required parameter 'envelope_id' is set
6518
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document" if envelope_id.nil?
6519
+ # resource path
6520
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
6521
+
6522
+ # query parameters
6523
+ query_params = {}
6524
+
6525
+ # header parameters
6526
+ header_params = {}
6527
+ # HTTP header 'Accept' (if needed)
6528
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6529
+
6530
+ # form parameters
6531
+ form_params = {}
6532
+
6533
+ # http body (model)
6534
+ post_body = nil
6535
+ auth_names = []
6536
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6537
+ :header_params => header_params,
6538
+ :query_params => query_params,
6539
+ :form_params => form_params,
6540
+ :body => post_body,
6541
+ :auth_names => auth_names)
6542
+ if @api_client.config.debugging
6543
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6544
+ end
6545
+ return data, status_code, headers
6546
+ end
6547
+
5333
6548
  # Adds a document to an existing draft envelope.
5334
6549
  # Adds a document to an existing draft envelope.
5335
6550
  # @param account_id The external account number (int) or account ID Guid.
5336
6551
  # @param document_id The ID of the document being accessed.
5337
6552
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5338
6553
  # @return [EnvelopeDocument]
5339
- def update_document(account_id, document_id, envelope_id)
5340
- data, _status_code, _headers = update_document_with_http_info(account_id, document_id, envelope_id)
6554
+ def update_document_0(account_id, document_id, envelope_id)
6555
+ data, _status_code, _headers = update_document_0_with_http_info(account_id, document_id, envelope_id)
5341
6556
  return data
5342
6557
  end
5343
6558
 
@@ -5347,16 +6562,16 @@ module DocuSign_eSign
5347
6562
  # @param document_id The ID of the document being accessed.
5348
6563
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5349
6564
  # @return [Array<(EnvelopeDocument, Fixnum, Hash)>] EnvelopeDocument data, response status code and response headers
5350
- def update_document_with_http_info(account_id, document_id, envelope_id)
6565
+ def update_document_0_with_http_info(account_id, document_id, envelope_id)
5351
6566
  if @api_client.config.debugging
5352
- @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document ..."
6567
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document_0 ..."
5353
6568
  end
5354
6569
  # verify the required parameter 'account_id' is set
5355
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_document" if account_id.nil?
6570
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_document_0" if account_id.nil?
5356
6571
  # verify the required parameter 'document_id' is set
5357
- fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document" if document_id.nil?
6572
+ fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document_0" if document_id.nil?
5358
6573
  # verify the required parameter 'envelope_id' is set
5359
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document" if envelope_id.nil?
6574
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document_0" if envelope_id.nil?
5360
6575
  # resource path
5361
6576
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5362
6577
 
@@ -5382,7 +6597,7 @@ module DocuSign_eSign
5382
6597
  :auth_names => auth_names,
5383
6598
  :return_type => 'EnvelopeDocument')
5384
6599
  if @api_client.config.debugging
5385
- @api_client.config.logger.debug "API called: EnvelopesApi#update_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6600
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_document_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5386
6601
  end
5387
6602
  return data, status_code, headers
5388
6603
  end
@@ -5886,6 +7101,215 @@ module DocuSign_eSign
5886
7101
  return data, status_code, headers
5887
7102
  end
5888
7103
 
7104
+ # Update page information for Display Appliance
7105
+ #
7106
+ # @param account_id The external account number (int) or account ID Guid.
7107
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
7108
+ # @return [nil]
7109
+ def update_page_info(account_id, envelope_id)
7110
+ update_page_info_with_http_info(account_id, envelope_id)
7111
+ return nil
7112
+ end
7113
+
7114
+ # Update page information for Display Appliance
7115
+ #
7116
+ # @param account_id The external account number (int) or account ID Guid.
7117
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
7118
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
7119
+ def update_page_info_with_http_info(account_id, envelope_id)
7120
+ if @api_client.config.debugging
7121
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_page_info ..."
7122
+ end
7123
+ # verify the required parameter 'account_id' is set
7124
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_page_info" if account_id.nil?
7125
+ # verify the required parameter 'envelope_id' is set
7126
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_page_info" if envelope_id.nil?
7127
+ # resource path
7128
+ 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)
7129
+
7130
+ # query parameters
7131
+ query_params = {}
7132
+
7133
+ # header parameters
7134
+ header_params = {}
7135
+ # HTTP header 'Accept' (if needed)
7136
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7137
+
7138
+ # form parameters
7139
+ form_params = {}
7140
+
7141
+ # http body (model)
7142
+ post_body = nil
7143
+ auth_names = []
7144
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7145
+ :header_params => header_params,
7146
+ :query_params => query_params,
7147
+ :form_params => form_params,
7148
+ :body => post_body,
7149
+ :auth_names => auth_names)
7150
+ if @api_client.config.debugging
7151
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_page_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7152
+ end
7153
+ return data, status_code, headers
7154
+ end
7155
+
7156
+ # Set latest pdf for Display Appliance
7157
+ #
7158
+ # @param account_id The external account number (int) or account ID Guid.
7159
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
7160
+ # @return [DisplayAppliancePdf]
7161
+ def update_pdf(account_id, envelope_id)
7162
+ data, _status_code, _headers = update_pdf_with_http_info(account_id, envelope_id)
7163
+ return data
7164
+ end
7165
+
7166
+ # Set latest pdf for Display Appliance
7167
+ #
7168
+ # @param account_id The external account number (int) or account ID Guid.
7169
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
7170
+ # @return [Array<(DisplayAppliancePdf, Fixnum, Hash)>] DisplayAppliancePdf data, response status code and response headers
7171
+ def update_pdf_with_http_info(account_id, envelope_id)
7172
+ if @api_client.config.debugging
7173
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_pdf ..."
7174
+ end
7175
+ # verify the required parameter 'account_id' is set
7176
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_pdf" if account_id.nil?
7177
+ # verify the required parameter 'envelope_id' is set
7178
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_pdf" if envelope_id.nil?
7179
+ # resource path
7180
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
7181
+
7182
+ # query parameters
7183
+ query_params = {}
7184
+
7185
+ # header parameters
7186
+ header_params = {}
7187
+ # HTTP header 'Accept' (if needed)
7188
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7189
+
7190
+ # form parameters
7191
+ form_params = {}
7192
+
7193
+ # http body (model)
7194
+ post_body = nil
7195
+ auth_names = []
7196
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7197
+ :header_params => header_params,
7198
+ :query_params => query_params,
7199
+ :form_params => form_params,
7200
+ :body => post_body,
7201
+ :auth_names => auth_names,
7202
+ :return_type => 'DisplayAppliancePdf')
7203
+ if @api_client.config.debugging
7204
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7205
+ end
7206
+ return data, status_code, headers
7207
+ end
7208
+
7209
+ # Update pdf blobs for Display Appliance
7210
+ #
7211
+ # @param account_id The external account number (int) or account ID Guid.
7212
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
7213
+ # @return [nil]
7214
+ def update_pdf_blob(account_id, envelope_id)
7215
+ update_pdf_blob_with_http_info(account_id, envelope_id)
7216
+ return nil
7217
+ end
7218
+
7219
+ # Update pdf blobs for Display Appliance
7220
+ #
7221
+ # @param account_id The external account number (int) or account ID Guid.
7222
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
7223
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
7224
+ def update_pdf_blob_with_http_info(account_id, envelope_id)
7225
+ if @api_client.config.debugging
7226
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_pdf_blob ..."
7227
+ end
7228
+ # verify the required parameter 'account_id' is set
7229
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_pdf_blob" if account_id.nil?
7230
+ # verify the required parameter 'envelope_id' is set
7231
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_pdf_blob" if envelope_id.nil?
7232
+ # resource path
7233
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
7234
+
7235
+ # query parameters
7236
+ query_params = {}
7237
+
7238
+ # header parameters
7239
+ header_params = {}
7240
+ # HTTP header 'Accept' (if needed)
7241
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7242
+
7243
+ # form parameters
7244
+ form_params = {}
7245
+
7246
+ # http body (model)
7247
+ post_body = nil
7248
+ auth_names = []
7249
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7250
+ :header_params => header_params,
7251
+ :query_params => query_params,
7252
+ :form_params => form_params,
7253
+ :body => post_body,
7254
+ :auth_names => auth_names)
7255
+ if @api_client.config.debugging
7256
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_pdf_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7257
+ end
7258
+ return data, status_code, headers
7259
+ end
7260
+
7261
+ # Update RecipientDeniedDocumentCopy for Display Appliance
7262
+ #
7263
+ # @param account_id The external account number (int) or account ID Guid.
7264
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
7265
+ # @return [nil]
7266
+ def update_recipient_denied_document_copy(account_id, envelope_id)
7267
+ update_recipient_denied_document_copy_with_http_info(account_id, envelope_id)
7268
+ return nil
7269
+ end
7270
+
7271
+ # Update RecipientDeniedDocumentCopy for Display Appliance
7272
+ #
7273
+ # @param account_id The external account number (int) or account ID Guid.
7274
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
7275
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
7276
+ def update_recipient_denied_document_copy_with_http_info(account_id, envelope_id)
7277
+ if @api_client.config.debugging
7278
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_recipient_denied_document_copy ..."
7279
+ end
7280
+ # verify the required parameter 'account_id' is set
7281
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_recipient_denied_document_copy" if account_id.nil?
7282
+ # verify the required parameter 'envelope_id' is set
7283
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_recipient_denied_document_copy" if envelope_id.nil?
7284
+ # resource path
7285
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/recipient_denied_copy".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
7286
+
7287
+ # query parameters
7288
+ query_params = {}
7289
+
7290
+ # header parameters
7291
+ header_params = {}
7292
+ # HTTP header 'Accept' (if needed)
7293
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7294
+
7295
+ # form parameters
7296
+ form_params = {}
7297
+
7298
+ # http body (model)
7299
+ post_body = nil
7300
+ auth_names = []
7301
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7302
+ :header_params => header_params,
7303
+ :query_params => query_params,
7304
+ :form_params => form_params,
7305
+ :body => post_body,
7306
+ :auth_names => auth_names)
7307
+ if @api_client.config.debugging
7308
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_recipient_denied_document_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7309
+ end
7310
+ return data, status_code, headers
7311
+ end
7312
+
5889
7313
  # Updates document visibility for the recipients
5890
7314
  #
5891
7315
  # @param account_id The external account number (int) or account ID Guid.