docusign_esign 2.1.0 → 2.2.0.pre.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (94) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1 -1
  3. data/docusign_esign-3.1.0.pre.rc1.gem +0 -0
  4. data/lib/docusign_esign.rb +450 -383
  5. data/{tests → lib/docusign_esign/api}/.DS_Store +0 -0
  6. data/lib/docusign_esign/api/accounts_api.rb +69 -8
  7. data/lib/docusign_esign/api/connect_api.rb +400 -0
  8. data/lib/docusign_esign/api/envelopes_api.rb +18 -6
  9. data/lib/docusign_esign/api/organizations_api.rb +232 -0
  10. data/lib/docusign_esign/api/tsps_api.rb +256 -0
  11. data/lib/docusign_esign/models/access_code_format.rb +273 -0
  12. data/lib/docusign_esign/models/account_notification.rb +206 -0
  13. data/lib/docusign_esign/models/account_ui_settings.rb +330 -0
  14. data/lib/docusign_esign/models/bcc_email_archive.rb +276 -0
  15. data/lib/docusign_esign/models/bcc_email_archive_history.rb +237 -0
  16. data/lib/docusign_esign/models/bcc_email_archive_history_list.rb +250 -0
  17. data/lib/docusign_esign/models/bcc_email_archive_list.rb +250 -0
  18. data/lib/docusign_esign/models/bulk_send_request.rb +188 -0
  19. data/lib/docusign_esign/models/bulk_send_response.rb +222 -0
  20. data/lib/docusign_esign/models/bulk_send_test_response.rb +212 -0
  21. data/lib/docusign_esign/models/bulk_sending_copy.rb +222 -0
  22. data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +198 -0
  23. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +382 -0
  24. data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +198 -0
  25. data/lib/docusign_esign/models/bulk_sending_list.rb +210 -0
  26. data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +190 -0
  27. data/lib/docusign_esign/models/bulk_sending_list_summary.rb +218 -0
  28. data/lib/docusign_esign/models/carbon_copy.rb +19 -1
  29. data/lib/docusign_esign/models/certified_delivery.rb +19 -1
  30. data/lib/docusign_esign/models/comment.rb +392 -0
  31. data/lib/docusign_esign/models/comment_history_result.rb +220 -0
  32. data/lib/docusign_esign/models/comment_publish.rb +244 -0
  33. data/lib/docusign_esign/models/comment_thread.rb +961 -0
  34. data/lib/docusign_esign/models/comments_publish.rb +190 -0
  35. data/lib/docusign_esign/models/connect_salesforce_field.rb +258 -0
  36. data/lib/docusign_esign/models/connect_salesforce_object.rb +272 -0
  37. data/lib/docusign_esign/models/connect_user_object.rb +230 -0
  38. data/lib/docusign_esign/models/direct_debit_processor_information.rb +298 -0
  39. data/lib/docusign_esign/models/display_appliance_document.rb +258 -0
  40. data/lib/docusign_esign/models/display_appliance_document_page.rb +278 -0
  41. data/lib/docusign_esign/models/display_appliance_envelope.rb +328 -0
  42. data/lib/docusign_esign/models/display_appliance_info.rb +235 -0
  43. data/lib/docusign_esign/models/display_appliance_page.rb +278 -0
  44. data/lib/docusign_esign/models/display_appliance_pdf.rb +267 -0
  45. data/lib/docusign_esign/models/display_appliance_recipient.rb +388 -0
  46. data/lib/docusign_esign/models/display_appliance_signer_attachment.rb +248 -0
  47. data/lib/docusign_esign/models/document_fields_information.rb +1 -1
  48. data/lib/docusign_esign/models/document_html_display_settings.rb +11 -1
  49. data/lib/docusign_esign/models/envelope_document.rb +11 -1
  50. data/lib/docusign_esign/models/envelope_metadata.rb +208 -0
  51. data/lib/docusign_esign/models/envelope_purge_configuration.rb +218 -0
  52. data/lib/docusign_esign/models/envelope_transfer_rule.rb +273 -0
  53. data/lib/docusign_esign/models/envelope_transfer_rule_information.rb +250 -0
  54. data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +279 -0
  55. data/lib/docusign_esign/models/external_claim.rb +218 -0
  56. data/lib/docusign_esign/models/external_document_sources.rb +273 -0
  57. data/lib/docusign_esign/models/favorite_templates_content_item.rb +207 -0
  58. data/lib/docusign_esign/models/favorite_templates_info.rb +209 -0
  59. data/lib/docusign_esign/models/feature_available_metadata.rb +198 -0
  60. data/lib/docusign_esign/models/folder_shared_item.rb +289 -0
  61. data/lib/docusign_esign/models/form_data_item.rb +227 -0
  62. data/lib/docusign_esign/models/graphics_context.rb +208 -0
  63. data/lib/docusign_esign/models/id_check_configuration.rb +210 -0
  64. data/lib/docusign_esign/models/id_check_security_step.rb +188 -0
  65. data/lib/docusign_esign/models/locale_policy.rb +595 -0
  66. data/lib/docusign_esign/models/locale_policy_tab.rb +298 -0
  67. data/lib/docusign_esign/models/new_account_definition.rb +11 -1
  68. data/lib/docusign_esign/models/notification_default_settings.rb +196 -0
  69. data/lib/docusign_esign/models/notification_defaults.rb +196 -0
  70. data/lib/docusign_esign/models/offline_attributes.rb +238 -0
  71. data/lib/docusign_esign/models/page_size.rb +198 -0
  72. data/lib/docusign_esign/models/path_extended_element.rb +208 -0
  73. data/lib/docusign_esign/models/pay_pal_legacy_settings.rb +228 -0
  74. data/lib/docusign_esign/models/payment_gateway_account_setting.rb +218 -0
  75. data/lib/docusign_esign/models/payment_method_with_options.rb +200 -0
  76. data/lib/docusign_esign/models/poly_line.rb +218 -0
  77. data/lib/docusign_esign/models/poly_line_overlay.rb +885 -0
  78. data/lib/docusign_esign/models/recipient_email_notification.rb +1 -1
  79. data/lib/docusign_esign/models/recipient_preview_request.rb +278 -0
  80. data/lib/docusign_esign/models/recipient_proof_file.rb +188 -0
  81. data/lib/docusign_esign/models/signature_properties.rb +198 -0
  82. data/lib/docusign_esign/models/signer.rb +11 -2
  83. data/lib/docusign_esign/models/smart_section_display_settings.rb +11 -1
  84. data/lib/docusign_esign/models/tab_group.rb +911 -0
  85. data/lib/docusign_esign/models/usage_history.rb +1 -1
  86. data/lib/docusign_esign/models/user_information.rb +1 -1
  87. data/lib/docusign_esign/models/witness.rb +10 -1
  88. data/lib/docusign_esign/models/workspace_settings.rb +188 -0
  89. data/lib/docusign_esign/version.rb +1 -1
  90. data/tests/Gemfile.lock +1 -1
  91. data/tests/spec/unit_tests_using_jwt_spec.rb +6 -3
  92. metadata +74 -7
  93. data/Gemfile.lock +0 -73
  94. data/lib/docusign_esign/api/trust_service_providers_api.rb +0 -73
File without changes
@@ -49,6 +49,15 @@ module DocuSign_eSign
49
49
  end
50
50
  end
51
51
 
52
+ class DeletePermissionProfileOptions
53
+ #
54
+ attr_accessor :move_users_to
55
+
56
+ def self.default
57
+ @@default ||= DeletePermissionProfileOptions.new
58
+ end
59
+ end
60
+
52
61
  class GetAccountInformationOptions
53
62
  # When set to **true**, includes the account settings for the account in the response.
54
63
  attr_accessor :include_account_settings
@@ -92,7 +101,7 @@ module DocuSign_eSign
92
101
  end
93
102
 
94
103
  class GetConsumerDisclosureDefaultOptions
95
- # Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), 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.
104
+ # Specifies 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.
96
105
  attr_accessor :lang_code
97
106
 
98
107
  def self.default
@@ -794,9 +803,10 @@ module DocuSign_eSign
794
803
  #
795
804
  # @param account_id The external account number (int) or account ID Guid.
796
805
  # @param permission_profile_id
806
+ # @param DocuSign_eSign::DeletePermissionProfileOptions Options for modifying the behavior of the function.
797
807
  # @return [nil]
798
- def delete_permission_profile(account_id, permission_profile_id)
799
- delete_permission_profile_with_http_info(account_id, permission_profile_id)
808
+ def delete_permission_profile(account_id, permission_profile_id, options = DocuSign_eSign::DeletePermissionProfileOptions.default)
809
+ delete_permission_profile_with_http_info(account_id, permission_profile_id, options)
800
810
  return nil
801
811
  end
802
812
 
@@ -804,8 +814,9 @@ module DocuSign_eSign
804
814
  #
805
815
  # @param account_id The external account number (int) or account ID Guid.
806
816
  # @param permission_profile_id
817
+ # @param DocuSign_eSign::DeletePermissionProfileOptions Options for modifying the behavior of the function.
807
818
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
808
- def delete_permission_profile_with_http_info(account_id, permission_profile_id)
819
+ def delete_permission_profile_with_http_info(account_id, permission_profile_id, options = DocuSign_eSign::DeletePermissionProfileOptions.default)
809
820
  if @api_client.config.debugging
810
821
  @api_client.config.logger.debug "Calling API: AccountsApi.delete_permission_profile ..."
811
822
  end
@@ -818,6 +829,7 @@ module DocuSign_eSign
818
829
 
819
830
  # query parameters
820
831
  query_params = {}
832
+ query_params[:'move_users_to'] = options.move_users_to if !options.move_users_to.nil?
821
833
 
822
834
  # header parameters
823
835
  header_params = {}
@@ -1375,7 +1387,7 @@ module DocuSign_eSign
1375
1387
  # Gets the Electronic Record and Signature Disclosure.
1376
1388
  # 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.
1377
1389
  # @param account_id The external account number (int) or account ID Guid.
1378
- # @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), 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.
1390
+ # @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.
1379
1391
  # @return [ConsumerDisclosure]
1380
1392
  def get_consumer_disclosure(account_id, lang_code)
1381
1393
  data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
@@ -1385,7 +1397,7 @@ module DocuSign_eSign
1385
1397
  # Gets the Electronic Record and Signature Disclosure.
1386
1398
  # 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.
1387
1399
  # @param account_id The external account number (int) or account ID Guid.
1388
- # @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), 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.
1400
+ # @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.
1389
1401
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
1390
1402
  def get_consumer_disclosure_with_http_info(account_id, lang_code)
1391
1403
  if @api_client.config.debugging
@@ -1721,6 +1733,55 @@ module DocuSign_eSign
1721
1733
  return data, status_code, headers
1722
1734
  end
1723
1735
 
1736
+ # Returns Account available seals for specified account.
1737
+ #
1738
+ # @param account_id The external account number (int) or account ID Guid.
1739
+ # @return [AccountSeals]
1740
+ def get_seal_providers(account_id)
1741
+ data, _status_code, _headers = get_seal_providers_with_http_info(account_id)
1742
+ return data
1743
+ end
1744
+
1745
+ # Returns Account available seals for specified account.
1746
+ #
1747
+ # @param account_id The external account number (int) or account ID Guid.
1748
+ # @return [Array<(AccountSeals, Fixnum, Hash)>] AccountSeals data, response status code and response headers
1749
+ def get_seal_providers_with_http_info(account_id)
1750
+ if @api_client.config.debugging
1751
+ @api_client.config.logger.debug "Calling API: AccountsApi.get_seal_providers ..."
1752
+ end
1753
+ # verify the required parameter 'account_id' is set
1754
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_seal_providers" if account_id.nil?
1755
+ # resource path
1756
+ local_var_path = "/v2/accounts/{accountId}/seals".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1757
+
1758
+ # query parameters
1759
+ query_params = {}
1760
+
1761
+ # header parameters
1762
+ header_params = {}
1763
+ # HTTP header 'Accept' (if needed)
1764
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1765
+
1766
+ # form parameters
1767
+ form_params = {}
1768
+
1769
+ # http body (model)
1770
+ post_body = nil
1771
+ auth_names = []
1772
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1773
+ :header_params => header_params,
1774
+ :query_params => query_params,
1775
+ :form_params => form_params,
1776
+ :body => post_body,
1777
+ :auth_names => auth_names,
1778
+ :return_type => 'AccountSeals')
1779
+ if @api_client.config.debugging
1780
+ @api_client.config.logger.debug "API called: AccountsApi#get_seal_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1781
+ end
1782
+ return data, status_code, headers
1783
+ end
1784
+
1724
1785
  # Gets list of supported languages for recipient language setting.
1725
1786
  #
1726
1787
  # @param account_id The external account number (int) or account ID Guid.
@@ -2510,7 +2571,7 @@ module DocuSign_eSign
2510
2571
  # Update Consumer Disclosure.
2511
2572
  #
2512
2573
  # @param account_id The external account number (int) or account ID Guid.
2513
- # @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), 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.
2574
+ # @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.
2514
2575
  # @param consumer_disclosure (optional parameter)
2515
2576
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
2516
2577
  # @return [ConsumerDisclosure]
@@ -2522,7 +2583,7 @@ module DocuSign_eSign
2522
2583
  # Update Consumer Disclosure.
2523
2584
  #
2524
2585
  # @param account_id The external account number (int) or account ID Guid.
2525
- # @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), 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.
2586
+ # @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.
2526
2587
  # @param consumer_disclosure (optional parameter)
2527
2588
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
2528
2589
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
@@ -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/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/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.
@@ -333,6 +433,105 @@ module DocuSign_eSign
333
433
  return data, status_code, headers
334
434
  end
335
435
 
436
+ # Reserved
437
+ # Reserved:
438
+ # @param account_id The external account number (int) or account ID Guid.
439
+ # @param mobile_notifier_configuration_information (optional parameter)
440
+ # @return [MobileNotifierConfigurationInformation]
441
+ def delete_mobile_notifiers(account_id, mobile_notifier_configuration_information)
442
+ data, _status_code, _headers = delete_mobile_notifiers_with_http_info(account_id, mobile_notifier_configuration_information)
443
+ return data
444
+ end
445
+
446
+ # Reserved
447
+ # Reserved:
448
+ # @param account_id The external account number (int) or account ID Guid.
449
+ # @param mobile_notifier_configuration_information (optional parameter)
450
+ # @return [Array<(MobileNotifierConfigurationInformation, Fixnum, Hash)>] MobileNotifierConfigurationInformation data, response status code and response headers
451
+ def delete_mobile_notifiers_with_http_info(account_id, mobile_notifier_configuration_information)
452
+ if @api_client.config.debugging
453
+ @api_client.config.logger.debug "Calling API: ConnectApi.delete_mobile_notifiers ..."
454
+ end
455
+ # verify the required parameter 'account_id' is set
456
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.delete_mobile_notifiers" if account_id.nil?
457
+ # resource path
458
+ local_var_path = "/v2/accounts/{accountId}/connect/mobile_notifiers".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
459
+
460
+ # query parameters
461
+ query_params = {}
462
+
463
+ # header parameters
464
+ header_params = {}
465
+ # HTTP header 'Accept' (if needed)
466
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
467
+
468
+ # form parameters
469
+ form_params = {}
470
+
471
+ # http body (model)
472
+ post_body = @api_client.object_to_http_body(mobile_notifier_configuration_information)
473
+ auth_names = []
474
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
475
+ :header_params => header_params,
476
+ :query_params => query_params,
477
+ :form_params => form_params,
478
+ :body => post_body,
479
+ :auth_names => auth_names,
480
+ :return_type => 'MobileNotifierConfigurationInformation')
481
+ if @api_client.config.debugging
482
+ @api_client.config.logger.debug "API called: ConnectApi#delete_mobile_notifiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
483
+ end
484
+ return data, status_code, headers
485
+ end
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/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
+
336
535
  # Get a Connect Configuration Information
337
536
  # Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.
338
537
  # @param account_id The external account number (int) or account ID Guid.
@@ -386,6 +585,54 @@ module DocuSign_eSign
386
585
  return data, status_code, headers
387
586
  end
388
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/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
+
389
636
  # Get the specified Connect log entry.
390
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.
391
638
  # @param account_id The external account number (int) or account ID Guid.
@@ -597,6 +844,108 @@ module DocuSign_eSign
597
844
  return data, status_code, headers
598
845
  end
599
846
 
847
+ # Reserved
848
+ # Reserved:
849
+ # @param account_id The external account number (int) or account ID Guid.
850
+ # @return [MobileNotifierConfigurationInformation]
851
+ def list_mobile_notifiers(account_id)
852
+ data, _status_code, _headers = list_mobile_notifiers_with_http_info(account_id)
853
+ return data
854
+ end
855
+
856
+ # Reserved
857
+ # Reserved:
858
+ # @param account_id The external account number (int) or account ID Guid.
859
+ # @return [Array<(MobileNotifierConfigurationInformation, Fixnum, Hash)>] MobileNotifierConfigurationInformation data, response status code and response headers
860
+ def list_mobile_notifiers_with_http_info(account_id)
861
+ if @api_client.config.debugging
862
+ @api_client.config.logger.debug "Calling API: ConnectApi.list_mobile_notifiers ..."
863
+ end
864
+ # verify the required parameter 'account_id' is set
865
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.list_mobile_notifiers" if account_id.nil?
866
+ # resource path
867
+ local_var_path = "/v2/accounts/{accountId}/connect/mobile_notifiers".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
868
+
869
+ # query parameters
870
+ query_params = {}
871
+
872
+ # header parameters
873
+ header_params = {}
874
+ # HTTP header 'Accept' (if needed)
875
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
876
+
877
+ # form parameters
878
+ form_params = {}
879
+
880
+ # http body (model)
881
+ post_body = nil
882
+ auth_names = []
883
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
884
+ :header_params => header_params,
885
+ :query_params => query_params,
886
+ :form_params => form_params,
887
+ :body => post_body,
888
+ :auth_names => auth_names,
889
+ :return_type => 'MobileNotifierConfigurationInformation')
890
+ if @api_client.config.debugging
891
+ @api_client.config.logger.debug "API called: ConnectApi#list_mobile_notifiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
892
+ end
893
+ return data, status_code, headers
894
+ end
895
+
896
+ # Test connect configuration.
897
+ #
898
+ # @param account_id The external account number (int) or account ID Guid.
899
+ # @param connect_id The ID of the custom Connect configuration being accessed.
900
+ # @return [ResourceInformation]
901
+ def list_tests(account_id, connect_id)
902
+ data, _status_code, _headers = list_tests_with_http_info(account_id, connect_id)
903
+ return data
904
+ end
905
+
906
+ # Test connect configuration.
907
+ #
908
+ # @param account_id The external account number (int) or account ID Guid.
909
+ # @param connect_id The ID of the custom Connect configuration being accessed.
910
+ # @return [Array<(ResourceInformation, Fixnum, Hash)>] ResourceInformation data, response status code and response headers
911
+ def list_tests_with_http_info(account_id, connect_id)
912
+ if @api_client.config.debugging
913
+ @api_client.config.logger.debug "Calling API: ConnectApi.list_tests ..."
914
+ end
915
+ # verify the required parameter 'account_id' is set
916
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.list_tests" if account_id.nil?
917
+ # verify the required parameter 'connect_id' is set
918
+ fail ArgumentError, "Missing the required parameter 'connect_id' when calling ConnectApi.list_tests" if connect_id.nil?
919
+ # resource path
920
+ local_var_path = "/v2/accounts/{accountId}/connect/{connectId}/tests".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'connectId' + '}', connect_id.to_s)
921
+
922
+ # query parameters
923
+ query_params = {}
924
+
925
+ # header parameters
926
+ header_params = {}
927
+ # HTTP header 'Accept' (if needed)
928
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
929
+
930
+ # form parameters
931
+ form_params = {}
932
+
933
+ # http body (model)
934
+ post_body = nil
935
+ auth_names = []
936
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
937
+ :header_params => header_params,
938
+ :query_params => query_params,
939
+ :form_params => form_params,
940
+ :body => post_body,
941
+ :auth_names => auth_names,
942
+ :return_type => 'ResourceInformation')
943
+ if @api_client.config.debugging
944
+ @api_client.config.logger.debug "API called: ConnectApi#list_tests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
945
+ end
946
+ return data, status_code, headers
947
+ end
948
+
600
949
  # Returns users from the configured Connect service.
601
950
  # Returns users from the configured Connect service.
602
951
  # @param account_id The external account number (int) or account ID Guid.
@@ -812,5 +1161,56 @@ module DocuSign_eSign
812
1161
  end
813
1162
  return data, status_code, headers
814
1163
  end
1164
+
1165
+ # Reserved
1166
+ # Reserved:
1167
+ # @param account_id The external account number (int) or account ID Guid.
1168
+ # @param mobile_notifier_configuration_information (optional parameter)
1169
+ # @return [MobileNotifierConfigurationInformation]
1170
+ def update_mobile_notifiers(account_id, mobile_notifier_configuration_information)
1171
+ data, _status_code, _headers = update_mobile_notifiers_with_http_info(account_id, mobile_notifier_configuration_information)
1172
+ return data
1173
+ end
1174
+
1175
+ # Reserved
1176
+ # Reserved:
1177
+ # @param account_id The external account number (int) or account ID Guid.
1178
+ # @param mobile_notifier_configuration_information (optional parameter)
1179
+ # @return [Array<(MobileNotifierConfigurationInformation, Fixnum, Hash)>] MobileNotifierConfigurationInformation data, response status code and response headers
1180
+ def update_mobile_notifiers_with_http_info(account_id, mobile_notifier_configuration_information)
1181
+ if @api_client.config.debugging
1182
+ @api_client.config.logger.debug "Calling API: ConnectApi.update_mobile_notifiers ..."
1183
+ end
1184
+ # verify the required parameter 'account_id' is set
1185
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.update_mobile_notifiers" if account_id.nil?
1186
+ # resource path
1187
+ local_var_path = "/v2/accounts/{accountId}/connect/mobile_notifiers".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1188
+
1189
+ # query parameters
1190
+ query_params = {}
1191
+
1192
+ # header parameters
1193
+ header_params = {}
1194
+ # HTTP header 'Accept' (if needed)
1195
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1196
+
1197
+ # form parameters
1198
+ form_params = {}
1199
+
1200
+ # http body (model)
1201
+ post_body = @api_client.object_to_http_body(mobile_notifier_configuration_information)
1202
+ auth_names = []
1203
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1204
+ :header_params => header_params,
1205
+ :query_params => query_params,
1206
+ :form_params => form_params,
1207
+ :body => post_body,
1208
+ :auth_names => auth_names,
1209
+ :return_type => 'MobileNotifierConfigurationInformation')
1210
+ if @api_client.config.debugging
1211
+ @api_client.config.logger.debug "API called: ConnectApi#update_mobile_notifiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1212
+ end
1213
+ return data, status_code, headers
1214
+ end
815
1215
  end
816
1216
  end