docusign_esign 3.5.0 → 3.6.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/docusign_esign-2.6.0.gem +0 -0
  4. data/docusign_esign-2.7.0.rc1.gem +0 -0
  5. data/docusign_esign-3.5.0.gem +0 -0
  6. data/lib/docusign_esign.rb +10 -0
  7. data/lib/docusign_esign/api/accounts_api.rb +556 -4
  8. data/lib/docusign_esign/api/envelopes_api.rb +56 -2
  9. data/lib/docusign_esign/models/account_settings_information.rb +20 -1
  10. data/lib/docusign_esign/models/account_signature.rb +497 -0
  11. data/lib/docusign_esign/models/account_signature_definition.rb +338 -0
  12. data/lib/docusign_esign/models/account_signatures_information.rb +187 -0
  13. data/lib/docusign_esign/models/correct_view_request.rb +14 -4
  14. data/lib/docusign_esign/models/in_person_signer.rb +11 -1
  15. data/lib/docusign_esign/models/notary_certificate.rb +869 -0
  16. data/lib/docusign_esign/models/notary_recipient.rb +1097 -0
  17. data/lib/docusign_esign/models/notary_seal.rb +983 -0
  18. data/lib/docusign_esign/models/recipients.rb +13 -1
  19. data/lib/docusign_esign/models/signature_group.rb +205 -0
  20. data/lib/docusign_esign/models/signature_group_def.rb +195 -0
  21. data/lib/docusign_esign/models/signature_user.rb +215 -0
  22. data/lib/docusign_esign/models/signature_user_def.rb +205 -0
  23. data/lib/docusign_esign/models/signer.rb +11 -1
  24. data/lib/docusign_esign/models/tabs.rb +25 -1
  25. data/lib/docusign_esign/models/template_recipients.rb +13 -1
  26. data/lib/docusign_esign/models/template_tabs.rb +25 -1
  27. data/lib/docusign_esign/models/user_account_management_granular_information.rb +20 -1
  28. data/lib/docusign_esign/models/witness.rb +11 -1
  29. data/lib/docusign_esign/version.rb +1 -1
  30. data/tests/Gemfile.lock +1 -1
  31. metadata +17 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f1eab7285104d2b6ceadddde033b8488fea84cdf4d47e29813f9d8e20a855bd8
4
- data.tar.gz: c6b9fd1fa4d15f40b00e5a69d0d68d0fb356193002552082dade455816e6990e
3
+ metadata.gz: 958291d45204cdc5fc8747fe710cbca7e142bfe6c9650fec53edb51087e9dc9d
4
+ data.tar.gz: 7a1d63390ac4b24115b1fd168de71b5cb0a3f5ae33d9284d67789ce5d7ff43a6
5
5
  SHA512:
6
- metadata.gz: 97e38f67086b5d640181112258b3fcda04d62a5993c9b737ed8ae1ac42945175cebc958ef3be0a34b38affc14143b49ae5c928f6274d431f93d91d233ff47589
7
- data.tar.gz: a456a29d57cbd6df0c20c32c6908c9a2922a5e51c807d9b4335c376d7fe634fc4692aff4c07d1194ddc27e6db67af8d0bf11bd303153621d3e0f96be9f1dbc26
6
+ metadata.gz: b9831bce0abd218ab45870f9451e65dbe44afcaef4388648ccf4fd18cf8693ab0163c36f47bca329ec77f3b34b6bc407f63fd3779a83bd6d6b1af1d7b4ac554a
7
+ data.tar.gz: 3eb9aaeeca0550e738984b6f02132b43ded007528d47e2c164d3b267931c29ae268ea9e4e17bec6b0a6715b2437f2d3b6b25012b83d789552b699c687b8e69bf
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- docusign_esign (3.4.0)
4
+ docusign_esign (3.6.0.rc1)
5
5
  json (~> 2.1, >= 2.1.0)
6
6
  jwt (~> 2.2, >= 2.2.1)
7
7
  typhoeus (~> 1.0, >= 1.0.1)
Binary file
Binary file
@@ -43,9 +43,12 @@ require 'docusign_esign/models/account_role_settings'
43
43
  require 'docusign_esign/models/account_seals'
44
44
  require 'docusign_esign/models/account_settings_information'
45
45
  require 'docusign_esign/models/account_shared_access'
46
+ require 'docusign_esign/models/account_signature'
47
+ require 'docusign_esign/models/account_signature_definition'
46
48
  require 'docusign_esign/models/account_signature_provider'
47
49
  require 'docusign_esign/models/account_signature_provider_option'
48
50
  require 'docusign_esign/models/account_signature_providers'
51
+ require 'docusign_esign/models/account_signatures_information'
49
52
  require 'docusign_esign/models/account_ui_settings'
50
53
  require 'docusign_esign/models/add_on'
51
54
  require 'docusign_esign/models/address_information'
@@ -286,6 +289,7 @@ require 'docusign_esign/models/new_users_definition'
286
289
  require 'docusign_esign/models/new_users_summary'
287
290
  require 'docusign_esign/models/notarize'
288
291
  require 'docusign_esign/models/notary'
292
+ require 'docusign_esign/models/notary_certificate'
289
293
  require 'docusign_esign/models/notary_host'
290
294
  require 'docusign_esign/models/notary_journal'
291
295
  require 'docusign_esign/models/notary_journal_credible_witness'
@@ -293,7 +297,9 @@ require 'docusign_esign/models/notary_journal_list'
293
297
  require 'docusign_esign/models/notary_journal_meta_data'
294
298
  require 'docusign_esign/models/notary_jurisdiction'
295
299
  require 'docusign_esign/models/notary_jurisdiction_list'
300
+ require 'docusign_esign/models/notary_recipient'
296
301
  require 'docusign_esign/models/notary_result'
302
+ require 'docusign_esign/models/notary_seal'
297
303
  require 'docusign_esign/models/note'
298
304
  require 'docusign_esign/models/notification'
299
305
  require 'docusign_esign/models/notification_default_settings'
@@ -385,8 +391,12 @@ require 'docusign_esign/models/service_version'
385
391
  require 'docusign_esign/models/settings_metadata'
386
392
  require 'docusign_esign/models/shared_item'
387
393
  require 'docusign_esign/models/sign_here'
394
+ require 'docusign_esign/models/signature_group'
395
+ require 'docusign_esign/models/signature_group_def'
388
396
  require 'docusign_esign/models/signature_provider_required_option'
389
397
  require 'docusign_esign/models/signature_type'
398
+ require 'docusign_esign/models/signature_user'
399
+ require 'docusign_esign/models/signature_user_def'
390
400
  require 'docusign_esign/models/signer'
391
401
  require 'docusign_esign/models/signer_attachment'
392
402
  require 'docusign_esign/models/signer_email_notifications'
@@ -23,6 +23,15 @@ module DocuSign_eSign
23
23
  end
24
24
  end
25
25
 
26
+ class CreateAccountSignaturesOptions
27
+ #
28
+ attr_accessor :decode_only
29
+
30
+ def self.default
31
+ @@default ||= CreateAccountSignaturesOptions.new
32
+ end
33
+ end
34
+
26
35
  class CreateCustomFieldOptions
27
36
  #
28
37
  attr_accessor :apply_to_templates
@@ -68,6 +77,30 @@ module DocuSign_eSign
68
77
  end
69
78
  end
70
79
 
80
+ class GetAccountSignatureImageOptions
81
+ #
82
+ attr_accessor :include_chrome
83
+
84
+ def self.default
85
+ @@default ||= GetAccountSignatureImageOptions.new
86
+ end
87
+ end
88
+
89
+ class GetAccountSignaturesOptions
90
+ #
91
+ attr_accessor :stamp_format
92
+
93
+ #
94
+ attr_accessor :stamp_name
95
+
96
+ #
97
+ attr_accessor :stamp_type
98
+
99
+ def self.default
100
+ @@default ||= GetAccountSignaturesOptions.new
101
+ end
102
+ end
103
+
71
104
  class GetBillingChargesOptions
72
105
  # Specifies which billing charges to return. Valid values are: * envelopes * seats
73
106
  attr_accessor :include_charges
@@ -179,6 +212,24 @@ module DocuSign_eSign
179
212
  end
180
213
  end
181
214
 
215
+ class UpdateAccountSignatureByIdOptions
216
+ #
217
+ attr_accessor :close_existing_signature
218
+
219
+ def self.default
220
+ @@default ||= UpdateAccountSignatureByIdOptions.new
221
+ end
222
+ end
223
+
224
+ class UpdateAccountSignatureImageOptions
225
+ #
226
+ attr_accessor :transparent_png
227
+
228
+ def self.default
229
+ @@default ||= UpdateAccountSignatureImageOptions.new
230
+ end
231
+ end
232
+
182
233
  class UpdateConsumerDisclosureOptions
183
234
  #
184
235
  attr_accessor :include_metadata
@@ -279,6 +330,60 @@ module DocuSign_eSign
279
330
  return data, status_code, headers
280
331
  end
281
332
 
333
+ # Adds/updates one or more account signatures. This request may include images in multi-part format.
334
+ #
335
+ # @param account_id The external account number (int) or account ID Guid.
336
+ # @param account_signatures_information (optional parameter)
337
+ # @param DocuSign_eSign::CreateAccountSignaturesOptions Options for modifying the behavior of the function.
338
+ # @return [AccountSignaturesInformation]
339
+ def create_account_signatures(account_id, account_signatures_information, options = DocuSign_eSign::CreateAccountSignaturesOptions.default)
340
+ data, _status_code, _headers = create_account_signatures_with_http_info(account_id, account_signatures_information, options)
341
+ return data
342
+ end
343
+
344
+ # Adds/updates one or more account signatures. This request may include images in multi-part format.
345
+ #
346
+ # @param account_id The external account number (int) or account ID Guid.
347
+ # @param account_signatures_information (optional parameter)
348
+ # @param DocuSign_eSign::CreateAccountSignaturesOptions Options for modifying the behavior of the function.
349
+ # @return [Array<(AccountSignaturesInformation, Fixnum, Hash)>] AccountSignaturesInformation data, response status code and response headers
350
+ def create_account_signatures_with_http_info(account_id, account_signatures_information, options = DocuSign_eSign::CreateAccountSignaturesOptions.default)
351
+ if @api_client.config.debugging
352
+ @api_client.config.logger.debug "Calling API: AccountsApi.create_account_signatures ..."
353
+ end
354
+ # verify the required parameter 'account_id' is set
355
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_account_signatures" if account_id.nil?
356
+ # resource path
357
+ local_var_path = "/v2.1/accounts/{accountId}/signatures".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
358
+
359
+ # query parameters
360
+ query_params = {}
361
+ query_params[:'decode_only'] = options.decode_only if !options.decode_only.nil?
362
+
363
+ # header parameters
364
+ header_params = {}
365
+ # HTTP header 'Accept' (if needed)
366
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
367
+
368
+ # form parameters
369
+ form_params = {}
370
+
371
+ # http body (model)
372
+ post_body = @api_client.object_to_http_body(account_signatures_information)
373
+ auth_names = []
374
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
375
+ :header_params => header_params,
376
+ :query_params => query_params,
377
+ :form_params => form_params,
378
+ :body => post_body,
379
+ :auth_names => auth_names,
380
+ :return_type => 'AccountSignaturesInformation')
381
+ if @api_client.config.debugging
382
+ @api_client.config.logger.debug "API called: AccountsApi#create_account_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
383
+ end
384
+ return data, status_code, headers
385
+ end
386
+
282
387
  # Creates one or more brand profile files for the account.
283
388
  # Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
284
389
  # @param account_id The external account number (int) or account ID Guid.
@@ -537,6 +642,115 @@ module DocuSign_eSign
537
642
  return data, status_code, headers
538
643
  end
539
644
 
645
+ # Close the specified signature by Id.
646
+ #
647
+ # @param account_id The external account number (int) or account ID Guid.
648
+ # @param signature_id The ID of the signature being accessed.
649
+ # @return [nil]
650
+ def delete_account_signature(account_id, signature_id)
651
+ delete_account_signature_with_http_info(account_id, signature_id)
652
+ return nil
653
+ end
654
+
655
+ # Close the specified signature by Id.
656
+ #
657
+ # @param account_id The external account number (int) or account ID Guid.
658
+ # @param signature_id The ID of the signature being accessed.
659
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
660
+ def delete_account_signature_with_http_info(account_id, signature_id)
661
+ if @api_client.config.debugging
662
+ @api_client.config.logger.debug "Calling API: AccountsApi.delete_account_signature ..."
663
+ end
664
+ # verify the required parameter 'account_id' is set
665
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_account_signature" if account_id.nil?
666
+ # verify the required parameter 'signature_id' is set
667
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.delete_account_signature" if signature_id.nil?
668
+ # resource path
669
+ local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s)
670
+
671
+ # query parameters
672
+ query_params = {}
673
+
674
+ # header parameters
675
+ header_params = {}
676
+ # HTTP header 'Accept' (if needed)
677
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
678
+
679
+ # form parameters
680
+ form_params = {}
681
+
682
+ # http body (model)
683
+ post_body = nil
684
+ auth_names = []
685
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
686
+ :header_params => header_params,
687
+ :query_params => query_params,
688
+ :form_params => form_params,
689
+ :body => post_body,
690
+ :auth_names => auth_names)
691
+ if @api_client.config.debugging
692
+ @api_client.config.logger.debug "API called: AccountsApi#delete_account_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
693
+ end
694
+ return data, status_code, headers
695
+ end
696
+
697
+ # Deletes a signature, initials, or stamps image.
698
+ #
699
+ # @param account_id The external account number (int) or account ID Guid.
700
+ # @param image_type One of **signature_image** or **initials_image**.
701
+ # @param signature_id The ID of the signature being accessed.
702
+ # @return [AccountSignature]
703
+ def delete_account_signature_image(account_id, image_type, signature_id)
704
+ data, _status_code, _headers = delete_account_signature_image_with_http_info(account_id, image_type, signature_id)
705
+ return data
706
+ end
707
+
708
+ # Deletes a signature, initials, or stamps image.
709
+ #
710
+ # @param account_id The external account number (int) or account ID Guid.
711
+ # @param image_type One of **signature_image** or **initials_image**.
712
+ # @param signature_id The ID of the signature being accessed.
713
+ # @return [Array<(AccountSignature, Fixnum, Hash)>] AccountSignature data, response status code and response headers
714
+ def delete_account_signature_image_with_http_info(account_id, image_type, signature_id)
715
+ if @api_client.config.debugging
716
+ @api_client.config.logger.debug "Calling API: AccountsApi.delete_account_signature_image ..."
717
+ end
718
+ # verify the required parameter 'account_id' is set
719
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_account_signature_image" if account_id.nil?
720
+ # verify the required parameter 'image_type' is set
721
+ fail ArgumentError, "Missing the required parameter 'image_type' when calling AccountsApi.delete_account_signature_image" if image_type.nil?
722
+ # verify the required parameter 'signature_id' is set
723
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.delete_account_signature_image" if signature_id.nil?
724
+ # resource path
725
+ local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s)
726
+
727
+ # query parameters
728
+ query_params = {}
729
+
730
+ # header parameters
731
+ header_params = {}
732
+ # HTTP header 'Accept' (if needed)
733
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
734
+
735
+ # form parameters
736
+ form_params = {}
737
+
738
+ # http body (model)
739
+ post_body = nil
740
+ auth_names = []
741
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
742
+ :header_params => header_params,
743
+ :query_params => query_params,
744
+ :form_params => form_params,
745
+ :body => post_body,
746
+ :auth_names => auth_names,
747
+ :return_type => 'AccountSignature')
748
+ if @api_client.config.debugging
749
+ @api_client.config.logger.debug "API called: AccountsApi#delete_account_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
750
+ end
751
+ return data, status_code, headers
752
+ end
753
+
540
754
  # Removes a brand.
541
755
  #
542
756
  # @param account_id The external account number (int) or account ID Guid.
@@ -1063,6 +1277,173 @@ module DocuSign_eSign
1063
1277
  return data, status_code, headers
1064
1278
  end
1065
1279
 
1280
+ # Returns information about a single signature by specifed signatureId.
1281
+ #
1282
+ # @param account_id The external account number (int) or account ID Guid.
1283
+ # @param signature_id The ID of the signature being accessed.
1284
+ # @return [AccountSignature]
1285
+ def get_account_signature(account_id, signature_id)
1286
+ data, _status_code, _headers = get_account_signature_with_http_info(account_id, signature_id)
1287
+ return data
1288
+ end
1289
+
1290
+ # Returns information about a single signature by specifed signatureId.
1291
+ #
1292
+ # @param account_id The external account number (int) or account ID Guid.
1293
+ # @param signature_id The ID of the signature being accessed.
1294
+ # @return [Array<(AccountSignature, Fixnum, Hash)>] AccountSignature data, response status code and response headers
1295
+ def get_account_signature_with_http_info(account_id, signature_id)
1296
+ if @api_client.config.debugging
1297
+ @api_client.config.logger.debug "Calling API: AccountsApi.get_account_signature ..."
1298
+ end
1299
+ # verify the required parameter 'account_id' is set
1300
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_signature" if account_id.nil?
1301
+ # verify the required parameter 'signature_id' is set
1302
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.get_account_signature" if signature_id.nil?
1303
+ # resource path
1304
+ local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s)
1305
+
1306
+ # query parameters
1307
+ query_params = {}
1308
+
1309
+ # header parameters
1310
+ header_params = {}
1311
+ # HTTP header 'Accept' (if needed)
1312
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1313
+
1314
+ # form parameters
1315
+ form_params = {}
1316
+
1317
+ # http body (model)
1318
+ post_body = nil
1319
+ auth_names = []
1320
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1321
+ :header_params => header_params,
1322
+ :query_params => query_params,
1323
+ :form_params => form_params,
1324
+ :body => post_body,
1325
+ :auth_names => auth_names,
1326
+ :return_type => 'AccountSignature')
1327
+ if @api_client.config.debugging
1328
+ @api_client.config.logger.debug "API called: AccountsApi#get_account_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1329
+ end
1330
+ return data, status_code, headers
1331
+ end
1332
+
1333
+ # Returns a signature, initials, or stamps image.
1334
+ #
1335
+ # @param account_id The external account number (int) or account ID Guid.
1336
+ # @param image_type One of **signature_image** or **initials_image**.
1337
+ # @param signature_id The ID of the signature being accessed.
1338
+ # @param DocuSign_eSign::GetAccountSignatureImageOptions Options for modifying the behavior of the function.
1339
+ # @return [File]
1340
+ def get_account_signature_image(account_id, image_type, signature_id, options = DocuSign_eSign::GetAccountSignatureImageOptions.default)
1341
+ data, _status_code, _headers = get_account_signature_image_with_http_info(account_id, image_type, signature_id, options)
1342
+ return data
1343
+ end
1344
+
1345
+ # Returns a signature, initials, or stamps image.
1346
+ #
1347
+ # @param account_id The external account number (int) or account ID Guid.
1348
+ # @param image_type One of **signature_image** or **initials_image**.
1349
+ # @param signature_id The ID of the signature being accessed.
1350
+ # @param DocuSign_eSign::GetAccountSignatureImageOptions Options for modifying the behavior of the function.
1351
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
1352
+ def get_account_signature_image_with_http_info(account_id, image_type, signature_id, options = DocuSign_eSign::GetAccountSignatureImageOptions.default)
1353
+ if @api_client.config.debugging
1354
+ @api_client.config.logger.debug "Calling API: AccountsApi.get_account_signature_image ..."
1355
+ end
1356
+ # verify the required parameter 'account_id' is set
1357
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_signature_image" if account_id.nil?
1358
+ # verify the required parameter 'image_type' is set
1359
+ fail ArgumentError, "Missing the required parameter 'image_type' when calling AccountsApi.get_account_signature_image" if image_type.nil?
1360
+ # verify the required parameter 'signature_id' is set
1361
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.get_account_signature_image" if signature_id.nil?
1362
+ # resource path
1363
+ local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s)
1364
+
1365
+ # query parameters
1366
+ query_params = {}
1367
+ query_params[:'include_chrome'] = options.include_chrome if !options.include_chrome.nil?
1368
+
1369
+ # header parameters
1370
+ header_params = {}
1371
+ # HTTP header 'Accept' (if needed)
1372
+ header_params['Accept'] = @api_client.select_header_accept(['image/gif'])
1373
+
1374
+ # form parameters
1375
+ form_params = {}
1376
+
1377
+ # http body (model)
1378
+ post_body = nil
1379
+ auth_names = []
1380
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1381
+ :header_params => header_params,
1382
+ :query_params => query_params,
1383
+ :form_params => form_params,
1384
+ :body => post_body,
1385
+ :auth_names => auth_names,
1386
+ :return_type => 'File')
1387
+ if @api_client.config.debugging
1388
+ @api_client.config.logger.debug "API called: AccountsApi#get_account_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1389
+ end
1390
+ return data, status_code, headers
1391
+ end
1392
+
1393
+ # Returns the managed signature definitions for the account
1394
+ #
1395
+ # @param account_id The external account number (int) or account ID Guid.
1396
+ # @param DocuSign_eSign::GetAccountSignaturesOptions Options for modifying the behavior of the function.
1397
+ # @return [AccountSignaturesInformation]
1398
+ def get_account_signatures(account_id, options = DocuSign_eSign::GetAccountSignaturesOptions.default)
1399
+ data, _status_code, _headers = get_account_signatures_with_http_info(account_id, options)
1400
+ return data
1401
+ end
1402
+
1403
+ # Returns the managed signature definitions for the account
1404
+ #
1405
+ # @param account_id The external account number (int) or account ID Guid.
1406
+ # @param DocuSign_eSign::GetAccountSignaturesOptions Options for modifying the behavior of the function.
1407
+ # @return [Array<(AccountSignaturesInformation, Fixnum, Hash)>] AccountSignaturesInformation data, response status code and response headers
1408
+ def get_account_signatures_with_http_info(account_id, options = DocuSign_eSign::GetAccountSignaturesOptions.default)
1409
+ if @api_client.config.debugging
1410
+ @api_client.config.logger.debug "Calling API: AccountsApi.get_account_signatures ..."
1411
+ end
1412
+ # verify the required parameter 'account_id' is set
1413
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_signatures" if account_id.nil?
1414
+ # resource path
1415
+ local_var_path = "/v2.1/accounts/{accountId}/signatures".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1416
+
1417
+ # query parameters
1418
+ query_params = {}
1419
+ query_params[:'stamp_format'] = options.stamp_format if !options.stamp_format.nil?
1420
+ query_params[:'stamp_name'] = options.stamp_name if !options.stamp_name.nil?
1421
+ query_params[:'stamp_type'] = options.stamp_type if !options.stamp_type.nil?
1422
+
1423
+ # header parameters
1424
+ header_params = {}
1425
+ # HTTP header 'Accept' (if needed)
1426
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1427
+
1428
+ # form parameters
1429
+ form_params = {}
1430
+
1431
+ # http body (model)
1432
+ post_body = nil
1433
+ auth_names = []
1434
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1435
+ :header_params => header_params,
1436
+ :query_params => query_params,
1437
+ :form_params => form_params,
1438
+ :body => post_body,
1439
+ :auth_names => auth_names,
1440
+ :return_type => 'AccountSignaturesInformation')
1441
+ if @api_client.config.debugging
1442
+ @api_client.config.logger.debug "API called: AccountsApi#get_account_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1443
+ end
1444
+ return data, status_code, headers
1445
+ end
1446
+
1066
1447
  # Returns tab settings list for specified account
1067
1448
  #
1068
1449
  # @param account_id The external account number (int) or account ID Guid.
@@ -1495,7 +1876,7 @@ module DocuSign_eSign
1495
1876
  # Gets the Electronic Record and Signature Disclosure.
1496
1877
  # Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
1497
1878
  # @param account_id The external account number (int) or account ID Guid.
1498
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
1879
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
1499
1880
  # @return [ConsumerDisclosure]
1500
1881
  def get_consumer_disclosure(account_id, lang_code)
1501
1882
  data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
@@ -1505,7 +1886,7 @@ module DocuSign_eSign
1505
1886
  # Gets the Electronic Record and Signature Disclosure.
1506
1887
  # Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
1507
1888
  # @param account_id The external account number (int) or account ID Guid.
1508
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
1889
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
1509
1890
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
1510
1891
  def get_consumer_disclosure_with_http_info(account_id, lang_code)
1511
1892
  if @api_client.config.debugging
@@ -2702,6 +3083,177 @@ module DocuSign_eSign
2702
3083
  return data, status_code, headers
2703
3084
  end
2704
3085
 
3086
+ # Updates a account signature.
3087
+ #
3088
+ # @param account_id The external account number (int) or account ID Guid.
3089
+ # @param account_signatures_information (optional parameter)
3090
+ # @return [AccountSignaturesInformation]
3091
+ def update_account_signature(account_id, account_signatures_information)
3092
+ data, _status_code, _headers = update_account_signature_with_http_info(account_id, account_signatures_information)
3093
+ return data
3094
+ end
3095
+
3096
+ # Updates a account signature.
3097
+ #
3098
+ # @param account_id The external account number (int) or account ID Guid.
3099
+ # @param account_signatures_information (optional parameter)
3100
+ # @return [Array<(AccountSignaturesInformation, Fixnum, Hash)>] AccountSignaturesInformation data, response status code and response headers
3101
+ def update_account_signature_with_http_info(account_id, account_signatures_information)
3102
+ if @api_client.config.debugging
3103
+ @api_client.config.logger.debug "Calling API: AccountsApi.update_account_signature ..."
3104
+ end
3105
+ # verify the required parameter 'account_id' is set
3106
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account_signature" if account_id.nil?
3107
+ # resource path
3108
+ local_var_path = "/v2.1/accounts/{accountId}/signatures".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
3109
+
3110
+ # query parameters
3111
+ query_params = {}
3112
+
3113
+ # header parameters
3114
+ header_params = {}
3115
+ # HTTP header 'Accept' (if needed)
3116
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3117
+
3118
+ # form parameters
3119
+ form_params = {}
3120
+
3121
+ # http body (model)
3122
+ post_body = @api_client.object_to_http_body(account_signatures_information)
3123
+ auth_names = []
3124
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3125
+ :header_params => header_params,
3126
+ :query_params => query_params,
3127
+ :form_params => form_params,
3128
+ :body => post_body,
3129
+ :auth_names => auth_names,
3130
+ :return_type => 'AccountSignaturesInformation')
3131
+ if @api_client.config.debugging
3132
+ @api_client.config.logger.debug "API called: AccountsApi#update_account_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3133
+ end
3134
+ return data, status_code, headers
3135
+ end
3136
+
3137
+ # Updates a account signature.
3138
+ #
3139
+ # @param account_id The external account number (int) or account ID Guid.
3140
+ # @param signature_id The ID of the signature being accessed.
3141
+ # @param account_signature_definition (optional parameter)
3142
+ # @param DocuSign_eSign::UpdateAccountSignatureByIdOptions Options for modifying the behavior of the function.
3143
+ # @return [AccountSignature]
3144
+ def update_account_signature_by_id(account_id, signature_id, account_signature_definition, options = DocuSign_eSign::UpdateAccountSignatureByIdOptions.default)
3145
+ data, _status_code, _headers = update_account_signature_by_id_with_http_info(account_id, signature_id, account_signature_definition, options)
3146
+ return data
3147
+ end
3148
+
3149
+ # Updates a account signature.
3150
+ #
3151
+ # @param account_id The external account number (int) or account ID Guid.
3152
+ # @param signature_id The ID of the signature being accessed.
3153
+ # @param account_signature_definition (optional parameter)
3154
+ # @param DocuSign_eSign::UpdateAccountSignatureByIdOptions Options for modifying the behavior of the function.
3155
+ # @return [Array<(AccountSignature, Fixnum, Hash)>] AccountSignature data, response status code and response headers
3156
+ def update_account_signature_by_id_with_http_info(account_id, signature_id, account_signature_definition, options = DocuSign_eSign::UpdateAccountSignatureByIdOptions.default)
3157
+ if @api_client.config.debugging
3158
+ @api_client.config.logger.debug "Calling API: AccountsApi.update_account_signature_by_id ..."
3159
+ end
3160
+ # verify the required parameter 'account_id' is set
3161
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account_signature_by_id" if account_id.nil?
3162
+ # verify the required parameter 'signature_id' is set
3163
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.update_account_signature_by_id" if signature_id.nil?
3164
+ # resource path
3165
+ local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s)
3166
+
3167
+ # query parameters
3168
+ query_params = {}
3169
+ query_params[:'close_existing_signature'] = options.close_existing_signature if !options.close_existing_signature.nil?
3170
+
3171
+ # header parameters
3172
+ header_params = {}
3173
+ # HTTP header 'Accept' (if needed)
3174
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3175
+
3176
+ # form parameters
3177
+ form_params = {}
3178
+
3179
+ # http body (model)
3180
+ post_body = @api_client.object_to_http_body(account_signature_definition)
3181
+ auth_names = []
3182
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3183
+ :header_params => header_params,
3184
+ :query_params => query_params,
3185
+ :form_params => form_params,
3186
+ :body => post_body,
3187
+ :auth_names => auth_names,
3188
+ :return_type => 'AccountSignature')
3189
+ if @api_client.config.debugging
3190
+ @api_client.config.logger.debug "API called: AccountsApi#update_account_signature_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3191
+ end
3192
+ return data, status_code, headers
3193
+ end
3194
+
3195
+ # Sets a signature, initials, or stamps image.
3196
+ #
3197
+ # @param account_id The external account number (int) or account ID Guid.
3198
+ # @param image_type One of **signature_image** or **initials_image**.
3199
+ # @param signature_id The ID of the signature being accessed.
3200
+ # @param DocuSign_eSign::UpdateAccountSignatureImageOptions Options for modifying the behavior of the function.
3201
+ # @return [AccountSignature]
3202
+ def update_account_signature_image(account_id, image_type, signature_id, options = DocuSign_eSign::UpdateAccountSignatureImageOptions.default)
3203
+ data, _status_code, _headers = update_account_signature_image_with_http_info(account_id, image_type, signature_id, options)
3204
+ return data
3205
+ end
3206
+
3207
+ # Sets a signature, initials, or stamps image.
3208
+ #
3209
+ # @param account_id The external account number (int) or account ID Guid.
3210
+ # @param image_type One of **signature_image** or **initials_image**.
3211
+ # @param signature_id The ID of the signature being accessed.
3212
+ # @param DocuSign_eSign::UpdateAccountSignatureImageOptions Options for modifying the behavior of the function.
3213
+ # @return [Array<(AccountSignature, Fixnum, Hash)>] AccountSignature data, response status code and response headers
3214
+ def update_account_signature_image_with_http_info(account_id, image_type, signature_id, options = DocuSign_eSign::UpdateAccountSignatureImageOptions.default)
3215
+ if @api_client.config.debugging
3216
+ @api_client.config.logger.debug "Calling API: AccountsApi.update_account_signature_image ..."
3217
+ end
3218
+ # verify the required parameter 'account_id' is set
3219
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account_signature_image" if account_id.nil?
3220
+ # verify the required parameter 'image_type' is set
3221
+ fail ArgumentError, "Missing the required parameter 'image_type' when calling AccountsApi.update_account_signature_image" if image_type.nil?
3222
+ # verify the required parameter 'signature_id' is set
3223
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling AccountsApi.update_account_signature_image" if signature_id.nil?
3224
+ # resource path
3225
+ local_var_path = "/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s)
3226
+
3227
+ # query parameters
3228
+ query_params = {}
3229
+ query_params[:'transparent_png'] = options.transparent_png if !options.transparent_png.nil?
3230
+
3231
+ # header parameters
3232
+ header_params = {}
3233
+ # HTTP header 'Accept' (if needed)
3234
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3235
+ # HTTP header 'Content-Type'
3236
+ header_params['Content-Type'] = @api_client.select_header_content_type(['image/gif'])
3237
+
3238
+ # form parameters
3239
+ form_params = {}
3240
+
3241
+ # http body (model)
3242
+ post_body = nil
3243
+ auth_names = []
3244
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3245
+ :header_params => header_params,
3246
+ :query_params => query_params,
3247
+ :form_params => form_params,
3248
+ :body => post_body,
3249
+ :auth_names => auth_names,
3250
+ :return_type => 'AccountSignature')
3251
+ if @api_client.config.debugging
3252
+ @api_client.config.logger.debug "API called: AccountsApi#update_account_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3253
+ end
3254
+ return data, status_code, headers
3255
+ end
3256
+
2705
3257
  # Modifies tab settings for specified account
2706
3258
  #
2707
3259
  # @param account_id The external account number (int) or account ID Guid.
@@ -2930,7 +3482,7 @@ module DocuSign_eSign
2930
3482
  # Update Consumer Disclosure.
2931
3483
  #
2932
3484
  # @param account_id The external account number (int) or account ID Guid.
2933
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3485
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
2934
3486
  # @param consumer_disclosure (optional parameter)
2935
3487
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
2936
3488
  # @return [ConsumerDisclosure]
@@ -2942,7 +3494,7 @@ module DocuSign_eSign
2942
3494
  # Update Consumer Disclosure.
2943
3495
  #
2944
3496
  # @param account_id The external account number (int) or account ID Guid.
2945
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3497
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
2946
3498
  # @param consumer_disclosure (optional parameter)
2947
3499
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
2948
3500
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers