docusign_esign 3.0.0 → 3.1.0.pre.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +2 -2
  3. data/lib/docusign_esign.rb +464 -447
  4. data/{tests → lib/docusign_esign/api}/.DS_Store +0 -0
  5. data/lib/docusign_esign/api/accounts_api.rb +69 -8
  6. data/lib/docusign_esign/api/authentication_api.rb +8 -8
  7. data/lib/docusign_esign/api/bulk_envelopes_api.rb +335 -0
  8. data/lib/docusign_esign/api/connect_api.rb +400 -0
  9. data/lib/docusign_esign/api/envelopes_api.rb +77 -588
  10. data/lib/docusign_esign/api/notary_api.rb +439 -0
  11. data/lib/docusign_esign/api/organizations_api.rb +232 -0
  12. data/lib/docusign_esign/api/tsps_api.rb +256 -0
  13. data/lib/docusign_esign/models/account_settings_information.rb +125 -10
  14. data/lib/docusign_esign/models/account_ui_settings.rb +60 -4
  15. data/lib/docusign_esign/models/admin_message.rb +198 -0
  16. data/lib/docusign_esign/models/agent.rb +21 -1
  17. data/lib/docusign_esign/models/approve.rb +29 -1
  18. data/lib/docusign_esign/models/ask_an_admin.rb +218 -0
  19. data/lib/docusign_esign/models/carbon_copy.rb +39 -1
  20. data/lib/docusign_esign/models/certified_delivery.rb +39 -1
  21. data/lib/docusign_esign/models/checkbox.rb +29 -1
  22. data/lib/docusign_esign/models/comment_thread.rb +29 -1
  23. data/lib/docusign_esign/models/company.rb +29 -1
  24. data/lib/docusign_esign/models/complete_sign_request.rb +22 -2
  25. data/lib/docusign_esign/models/connect_custom_configuration.rb +19 -19
  26. data/lib/docusign_esign/models/credential.rb +12 -2
  27. data/lib/docusign_esign/models/date.rb +29 -1
  28. data/lib/docusign_esign/models/date_signed.rb +29 -1
  29. data/lib/docusign_esign/models/decline.rb +29 -1
  30. data/lib/docusign_esign/models/document.rb +53 -1
  31. data/lib/docusign_esign/models/document_fields_information.rb +1 -1
  32. data/lib/docusign_esign/models/document_html_display_settings.rb +11 -1
  33. data/lib/docusign_esign/models/document_security_store.rb +1 -1
  34. data/lib/docusign_esign/models/document_update_info.rb +1 -1
  35. data/lib/docusign_esign/models/editor.rb +21 -1
  36. data/lib/docusign_esign/models/email.rb +29 -1
  37. data/lib/docusign_esign/models/email_address.rb +29 -1
  38. data/lib/docusign_esign/models/envelope_document.rb +11 -1
  39. data/lib/docusign_esign/models/envelope_id.rb +29 -1
  40. data/lib/docusign_esign/models/envelope_template.rb +1 -11
  41. data/lib/docusign_esign/models/first_name.rb +29 -1
  42. data/lib/docusign_esign/models/formula_tab.rb +29 -1
  43. data/lib/docusign_esign/models/full_name.rb +29 -1
  44. data/lib/docusign_esign/models/in_person_signer.rb +21 -1
  45. data/lib/docusign_esign/models/initial_here.rb +29 -1
  46. data/lib/docusign_esign/models/intermediary.rb +21 -1
  47. data/lib/docusign_esign/models/last_name.rb +29 -1
  48. data/lib/docusign_esign/models/list.rb +29 -1
  49. data/lib/docusign_esign/models/notarize.rb +29 -1
  50. data/lib/docusign_esign/models/notary.rb +217 -0
  51. data/lib/docusign_esign/models/notary_host.rb +21 -1
  52. data/lib/docusign_esign/models/notary_jurisdiction.rb +246 -0
  53. data/lib/docusign_esign/models/notary_jurisdiction_list.rb +250 -0
  54. data/lib/docusign_esign/models/notary_result.rb +199 -0
  55. data/lib/docusign_esign/models/note.rb +29 -1
  56. data/lib/docusign_esign/models/number.rb +29 -1
  57. data/lib/docusign_esign/models/ocr_request.rb +238 -0
  58. data/lib/docusign_esign/models/offline_attributes.rb +238 -0
  59. data/lib/docusign_esign/models/poly_line_overlay.rb +29 -1
  60. data/lib/docusign_esign/models/proof_service_resource_token.rb +188 -0
  61. data/lib/docusign_esign/models/proof_service_view_link.rb +188 -0
  62. data/lib/docusign_esign/models/radio.rb +20 -1
  63. data/lib/docusign_esign/models/recipient_email_notification.rb +1 -1
  64. data/lib/docusign_esign/models/recipient_proof_file.rb +188 -0
  65. data/lib/docusign_esign/models/revision.rb +11 -2
  66. data/lib/docusign_esign/models/seal_sign.rb +21 -1
  67. data/lib/docusign_esign/models/sender.rb +1 -1
  68. data/lib/docusign_esign/models/sign_hash_document.rb +12 -3
  69. data/lib/docusign_esign/models/sign_hash_session_info_response.rb +12 -3
  70. data/lib/docusign_esign/models/sign_here.rb +38 -1
  71. data/lib/docusign_esign/models/sign_session_info_request.rb +12 -2
  72. data/lib/docusign_esign/models/signature_data_info.rb +1 -1
  73. data/lib/docusign_esign/models/signer.rb +31 -2
  74. data/lib/docusign_esign/models/signer_attachment.rb +29 -1
  75. data/lib/docusign_esign/models/smart_contract_information.rb +198 -0
  76. data/lib/docusign_esign/models/smart_section.rb +29 -1
  77. data/lib/docusign_esign/models/smart_section_display_settings.rb +11 -1
  78. data/lib/docusign_esign/models/ssn.rb +29 -1
  79. data/lib/docusign_esign/models/stamp.rb +336 -0
  80. data/lib/docusign_esign/models/tab_group.rb +29 -1
  81. data/lib/docusign_esign/models/text.rb +29 -1
  82. data/lib/docusign_esign/models/time_stamp_field.rb +1 -1
  83. data/lib/docusign_esign/models/title.rb +29 -1
  84. data/lib/docusign_esign/models/tsp_health_check_request.rb +1 -1
  85. data/lib/docusign_esign/models/tsp_health_check_status_description.rb +1 -1
  86. data/lib/docusign_esign/models/update_transaction_request.rb +1 -1
  87. data/lib/docusign_esign/models/update_transaction_response.rb +1 -1
  88. data/lib/docusign_esign/models/usage_history.rb +1 -1
  89. data/lib/docusign_esign/models/user.rb +27 -5
  90. data/lib/docusign_esign/models/user_info_response.rb +1 -1
  91. data/lib/docusign_esign/models/user_information.rb +1 -1
  92. data/lib/docusign_esign/models/user_signature.rb +14 -4
  93. data/lib/docusign_esign/models/view.rb +29 -1
  94. data/lib/docusign_esign/models/witness.rb +30 -1
  95. data/lib/docusign_esign/models/zip.rb +29 -1
  96. data/lib/docusign_esign/version.rb +1 -1
  97. data/tests/Gemfile.lock +1 -1
  98. metadata +20 -7
  99. data/Gemfile.lock +0 -73
  100. data/docusign_esign-2.1.0.gem +0 -0
@@ -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
@@ -797,9 +806,10 @@ module DocuSign_eSign
797
806
  #
798
807
  # @param account_id The external account number (int) or account ID Guid.
799
808
  # @param permission_profile_id
809
+ # @param DocuSign_eSign::DeletePermissionProfileOptions Options for modifying the behavior of the function.
800
810
  # @return [nil]
801
- def delete_permission_profile(account_id, permission_profile_id)
802
- delete_permission_profile_with_http_info(account_id, permission_profile_id)
811
+ def delete_permission_profile(account_id, permission_profile_id, options = DocuSign_eSign::DeletePermissionProfileOptions.default)
812
+ delete_permission_profile_with_http_info(account_id, permission_profile_id, options)
803
813
  return nil
804
814
  end
805
815
 
@@ -807,8 +817,9 @@ module DocuSign_eSign
807
817
  #
808
818
  # @param account_id The external account number (int) or account ID Guid.
809
819
  # @param permission_profile_id
820
+ # @param DocuSign_eSign::DeletePermissionProfileOptions Options for modifying the behavior of the function.
810
821
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
811
- def delete_permission_profile_with_http_info(account_id, permission_profile_id)
822
+ def delete_permission_profile_with_http_info(account_id, permission_profile_id, options = DocuSign_eSign::DeletePermissionProfileOptions.default)
812
823
  if @api_client.config.debugging
813
824
  @api_client.config.logger.debug "Calling API: AccountsApi.delete_permission_profile ..."
814
825
  end
@@ -821,6 +832,7 @@ module DocuSign_eSign
821
832
 
822
833
  # query parameters
823
834
  query_params = {}
835
+ query_params[:'move_users_to'] = options.move_users_to if !options.move_users_to.nil?
824
836
 
825
837
  # header parameters
826
838
  header_params = {}
@@ -1378,7 +1390,7 @@ module DocuSign_eSign
1378
1390
  # Gets the Electronic Record and Signature Disclosure.
1379
1391
  # 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.
1380
1392
  # @param account_id The external account number (int) or account ID Guid.
1381
- # @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.
1393
+ # @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.
1382
1394
  # @return [ConsumerDisclosure]
1383
1395
  def get_consumer_disclosure(account_id, lang_code)
1384
1396
  data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
@@ -1388,7 +1400,7 @@ module DocuSign_eSign
1388
1400
  # Gets the Electronic Record and Signature Disclosure.
1389
1401
  # 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.
1390
1402
  # @param account_id The external account number (int) or account ID Guid.
1391
- # @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.
1403
+ # @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.
1392
1404
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
1393
1405
  def get_consumer_disclosure_with_http_info(account_id, lang_code)
1394
1406
  if @api_client.config.debugging
@@ -1871,6 +1883,55 @@ module DocuSign_eSign
1871
1883
  return data, status_code, headers
1872
1884
  end
1873
1885
 
1886
+ # Returns Account available seals for specified account.
1887
+ #
1888
+ # @param account_id The external account number (int) or account ID Guid.
1889
+ # @return [AccountSeals]
1890
+ def get_seal_providers(account_id)
1891
+ data, _status_code, _headers = get_seal_providers_with_http_info(account_id)
1892
+ return data
1893
+ end
1894
+
1895
+ # Returns Account available seals for specified account.
1896
+ #
1897
+ # @param account_id The external account number (int) or account ID Guid.
1898
+ # @return [Array<(AccountSeals, Fixnum, Hash)>] AccountSeals data, response status code and response headers
1899
+ def get_seal_providers_with_http_info(account_id)
1900
+ if @api_client.config.debugging
1901
+ @api_client.config.logger.debug "Calling API: AccountsApi.get_seal_providers ..."
1902
+ end
1903
+ # verify the required parameter 'account_id' is set
1904
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_seal_providers" if account_id.nil?
1905
+ # resource path
1906
+ local_var_path = "/v2.1/accounts/{accountId}/seals".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1907
+
1908
+ # query parameters
1909
+ query_params = {}
1910
+
1911
+ # header parameters
1912
+ header_params = {}
1913
+ # HTTP header 'Accept' (if needed)
1914
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1915
+
1916
+ # form parameters
1917
+ form_params = {}
1918
+
1919
+ # http body (model)
1920
+ post_body = nil
1921
+ auth_names = []
1922
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1923
+ :header_params => header_params,
1924
+ :query_params => query_params,
1925
+ :form_params => form_params,
1926
+ :body => post_body,
1927
+ :auth_names => auth_names,
1928
+ :return_type => 'AccountSeals')
1929
+ if @api_client.config.debugging
1930
+ @api_client.config.logger.debug "API called: AccountsApi#get_seal_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1931
+ end
1932
+ return data, status_code, headers
1933
+ end
1934
+
1874
1935
  # Gets list of supported languages for recipient language setting.
1875
1936
  #
1876
1937
  # @param account_id The external account number (int) or account ID Guid.
@@ -2711,7 +2772,7 @@ module DocuSign_eSign
2711
2772
  # Update Consumer Disclosure.
2712
2773
  #
2713
2774
  # @param account_id The external account number (int) or account ID Guid.
2714
- # @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.
2775
+ # @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.
2715
2776
  # @param consumer_disclosure (optional parameter)
2716
2777
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
2717
2778
  # @return [ConsumerDisclosure]
@@ -2723,7 +2784,7 @@ module DocuSign_eSign
2723
2784
  # Update Consumer Disclosure.
2724
2785
  #
2725
2786
  # @param account_id The external account number (int) or account ID Guid.
2726
- # @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.
2787
+ # @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.
2727
2788
  # @param consumer_disclosure (optional parameter)
2728
2789
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
2729
2790
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
5
 
6
- OpenAPI spec version: v2
6
+ OpenAPI spec version: v2.1
7
7
  Contact: devcenter@docusign.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
@@ -65,7 +65,7 @@ module DocuSign_eSign
65
65
  # verify the required parameter 'user_id' is set
66
66
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthenticationApi.delete_social_login" if user_id.nil?
67
67
  # resource path
68
- local_var_path = "/v2/accounts/{accountId}/users/{userId}/social".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
68
+ local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/social".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
69
69
 
70
70
  # query parameters
71
71
  query_params = {}
@@ -109,7 +109,7 @@ module DocuSign_eSign
109
109
  @api_client.config.logger.debug "Calling API: AuthenticationApi.get_o_auth_token ..."
110
110
  end
111
111
  # resource path
112
- local_var_path = "/v2/oauth2/token".sub('{format}','json')
112
+ local_var_path = "/v2.1/oauth2/token".sub('{format}','json')
113
113
 
114
114
  # query parameters
115
115
  query_params = {}
@@ -162,7 +162,7 @@ module DocuSign_eSign
162
162
  # verify the required parameter 'user_id' is set
163
163
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthenticationApi.list_social_logins" if user_id.nil?
164
164
  # resource path
165
- local_var_path = "/v2/accounts/{accountId}/users/{userId}/social".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
165
+ local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/social".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
166
166
 
167
167
  # query parameters
168
168
  query_params = {}
@@ -209,7 +209,7 @@ module DocuSign_eSign
209
209
  @api_client.config.logger.debug "Calling API: AuthenticationApi.login ..."
210
210
  end
211
211
  # resource path
212
- local_var_path = "/v2/login_information".sub('{format}','json')
212
+ local_var_path = "/v2.1/login_information".sub('{format}','json')
213
213
 
214
214
  # query parameters
215
215
  query_params = {}
@@ -258,7 +258,7 @@ module DocuSign_eSign
258
258
  @api_client.config.logger.debug "Calling API: AuthenticationApi.revoke_o_auth_token ..."
259
259
  end
260
260
  # resource path
261
- local_var_path = "/v2/oauth2/revoke".sub('{format}','json')
261
+ local_var_path = "/v2.1/oauth2/revoke".sub('{format}','json')
262
262
 
263
263
  # query parameters
264
264
  query_params = {}
@@ -308,7 +308,7 @@ module DocuSign_eSign
308
308
  # verify the required parameter 'login_part' is set
309
309
  fail ArgumentError, "Missing the required parameter 'login_part' when calling AuthenticationApi.update_password" if login_part.nil?
310
310
  # resource path
311
- local_var_path = "/v2/login_information/{loginPart}".sub('{format}','json').sub('{' + 'loginPart' + '}', login_part.to_s)
311
+ local_var_path = "/v2.1/login_information/{loginPart}".sub('{format}','json').sub('{' + 'loginPart' + '}', login_part.to_s)
312
312
 
313
313
  # query parameters
314
314
  query_params = {}
@@ -362,7 +362,7 @@ module DocuSign_eSign
362
362
  # verify the required parameter 'user_id' is set
363
363
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthenticationApi.update_social_login" if user_id.nil?
364
364
  # resource path
365
- local_var_path = "/v2/accounts/{accountId}/users/{userId}/social".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
365
+ local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/social".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
366
366
 
367
367
  # query parameters
368
368
  query_params = {}
@@ -13,6 +13,48 @@ require "uri"
13
13
 
14
14
  module DocuSign_eSign
15
15
 
16
+ class GetOptions
17
+ # Specifies the number of entries to return.
18
+ attr_accessor :count
19
+
20
+ # Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=”failed,queued”) Valid values are: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - This only returns entries with a failed status. * queued - This only returns entries with a queued status. * sent – This only returns entries with a sent status.
21
+ attr_accessor :include
22
+
23
+ # Specifies the location in the list of envelopes from which to start.
24
+ attr_accessor :start_position
25
+
26
+ def self.default
27
+ @@default ||= GetOptions.new
28
+ end
29
+ end
30
+
31
+ class GetRecipientsOptions
32
+ #
33
+ attr_accessor :include_tabs
34
+
35
+ #
36
+ attr_accessor :start_position
37
+
38
+ def self.default
39
+ @@default ||= GetRecipientsOptions.new
40
+ end
41
+ end
42
+
43
+ class ListOptions
44
+ # The number of results to return. This can be 1 to 20.
45
+ attr_accessor :count
46
+
47
+ #
48
+ attr_accessor :include
49
+
50
+ # The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0.
51
+ attr_accessor :start_position
52
+
53
+ def self.default
54
+ @@default ||= ListOptions.new
55
+ end
56
+ end
57
+
16
58
 
17
59
  class BulkEnvelopesApi
18
60
  attr_accessor :api_client
@@ -235,6 +277,121 @@ module DocuSign_eSign
235
277
  return data, status_code, headers
236
278
  end
237
279
 
280
+ # Deletes the bulk recipient file from an envelope.
281
+ # Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the `bulkRecipientsUri` property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.
282
+ # @param account_id The external account number (int) or account ID Guid.
283
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
284
+ # @param recipient_id The ID of the recipient being accessed.
285
+ # @return [BulkRecipientsUpdateResponse]
286
+ def delete_recipients(account_id, envelope_id, recipient_id)
287
+ data, _status_code, _headers = delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
288
+ return data
289
+ end
290
+
291
+ # Deletes the bulk recipient file from an envelope.
292
+ # Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the &#x60;bulkRecipientsUri&#x60; property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.
293
+ # @param account_id The external account number (int) or account ID Guid.
294
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
295
+ # @param recipient_id The ID of the recipient being accessed.
296
+ # @return [Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>] BulkRecipientsUpdateResponse data, response status code and response headers
297
+ def delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
298
+ if @api_client.config.debugging
299
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.delete_recipients ..."
300
+ end
301
+ # verify the required parameter 'account_id' is set
302
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.delete_recipients" if account_id.nil?
303
+ # verify the required parameter 'envelope_id' is set
304
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.delete_recipients" if envelope_id.nil?
305
+ # verify the required parameter 'recipient_id' is set
306
+ fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.delete_recipients" if recipient_id.nil?
307
+ # resource path
308
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
309
+
310
+ # query parameters
311
+ query_params = {}
312
+
313
+ # header parameters
314
+ header_params = {}
315
+ # HTTP header 'Accept' (if needed)
316
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
317
+
318
+ # form parameters
319
+ form_params = {}
320
+
321
+ # http body (model)
322
+ post_body = nil
323
+ auth_names = []
324
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
325
+ :header_params => header_params,
326
+ :query_params => query_params,
327
+ :form_params => form_params,
328
+ :body => post_body,
329
+ :auth_names => auth_names,
330
+ :return_type => 'BulkRecipientsUpdateResponse')
331
+ if @api_client.config.debugging
332
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#delete_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
333
+ end
334
+ return data, status_code, headers
335
+ end
336
+
337
+ # Gets the status of a specified bulk send operation.
338
+ # Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.
339
+ # @param account_id The external account number (int) or account ID Guid.
340
+ # @param batch_id
341
+ # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
342
+ # @return [BulkEnvelopeStatus]
343
+ def get(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
344
+ data, _status_code, _headers = get_with_http_info(account_id, batch_id, options)
345
+ return data
346
+ end
347
+
348
+ # Gets the status of a specified bulk send operation.
349
+ # Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.
350
+ # @param account_id The external account number (int) or account ID Guid.
351
+ # @param batch_id
352
+ # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
353
+ # @return [Array<(BulkEnvelopeStatus, Fixnum, Hash)>] BulkEnvelopeStatus data, response status code and response headers
354
+ def get_with_http_info(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
355
+ if @api_client.config.debugging
356
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get ..."
357
+ end
358
+ # verify the required parameter 'account_id' is set
359
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get" if account_id.nil?
360
+ # verify the required parameter 'batch_id' is set
361
+ fail ArgumentError, "Missing the required parameter 'batch_id' when calling BulkEnvelopesApi.get" if batch_id.nil?
362
+ # resource path
363
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_envelopes/{batchId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'batchId' + '}', batch_id.to_s)
364
+
365
+ # query parameters
366
+ query_params = {}
367
+ query_params[:'count'] = options.count if !options.count.nil?
368
+ query_params[:'include'] = options.include if !options.include.nil?
369
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
370
+
371
+ # header parameters
372
+ header_params = {}
373
+ # HTTP header 'Accept' (if needed)
374
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
375
+
376
+ # form parameters
377
+ form_params = {}
378
+
379
+ # http body (model)
380
+ post_body = nil
381
+ auth_names = []
382
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
383
+ :header_params => header_params,
384
+ :query_params => query_params,
385
+ :form_params => form_params,
386
+ :body => post_body,
387
+ :auth_names => auth_names,
388
+ :return_type => 'BulkEnvelopeStatus')
389
+ if @api_client.config.debugging
390
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
391
+ end
392
+ return data, status_code, headers
393
+ end
394
+
238
395
  # Gets a specific bulk send list
239
396
  #
240
397
  # @param account_id The external account number (int) or account ID Guid.
@@ -337,6 +494,121 @@ module DocuSign_eSign
337
494
  return data, status_code, headers
338
495
  end
339
496
 
497
+ # Gets the bulk recipient file from an envelope.
498
+ # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
499
+ # @param account_id The external account number (int) or account ID Guid.
500
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
501
+ # @param recipient_id The ID of the recipient being accessed.
502
+ # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
503
+ # @return [BulkRecipientsResponse]
504
+ def get_recipients(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
505
+ data, _status_code, _headers = get_recipients_with_http_info(account_id, envelope_id, recipient_id, options)
506
+ return data
507
+ end
508
+
509
+ # Gets the bulk recipient file from an envelope.
510
+ # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
511
+ # @param account_id The external account number (int) or account ID Guid.
512
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
513
+ # @param recipient_id The ID of the recipient being accessed.
514
+ # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
515
+ # @return [Array<(BulkRecipientsResponse, Fixnum, Hash)>] BulkRecipientsResponse data, response status code and response headers
516
+ def get_recipients_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
517
+ if @api_client.config.debugging
518
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_recipients ..."
519
+ end
520
+ # verify the required parameter 'account_id' is set
521
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_recipients" if account_id.nil?
522
+ # verify the required parameter 'envelope_id' is set
523
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.get_recipients" if envelope_id.nil?
524
+ # verify the required parameter 'recipient_id' is set
525
+ fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.get_recipients" if recipient_id.nil?
526
+ # resource path
527
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
528
+
529
+ # query parameters
530
+ query_params = {}
531
+ query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
532
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
533
+
534
+ # header parameters
535
+ header_params = {}
536
+ # HTTP header 'Accept' (if needed)
537
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
538
+
539
+ # form parameters
540
+ form_params = {}
541
+
542
+ # http body (model)
543
+ post_body = nil
544
+ auth_names = []
545
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
546
+ :header_params => header_params,
547
+ :query_params => query_params,
548
+ :form_params => form_params,
549
+ :body => post_body,
550
+ :auth_names => auth_names,
551
+ :return_type => 'BulkRecipientsResponse')
552
+ if @api_client.config.debugging
553
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
554
+ end
555
+ return data, status_code, headers
556
+ end
557
+
558
+ # Gets status information about bulk recipient batches.
559
+ # Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the `batchId` property, which can be used to retrieve a more detailed status of individual bulk recipient batches.
560
+ # @param account_id The external account number (int) or account ID Guid.
561
+ # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
562
+ # @return [BulkEnvelopesResponse]
563
+ def list(account_id, options = DocuSign_eSign::ListOptions.default)
564
+ data, _status_code, _headers = list_with_http_info(account_id, options)
565
+ return data
566
+ end
567
+
568
+ # Gets status information about bulk recipient batches.
569
+ # Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the &#x60;batchId&#x60; property, which can be used to retrieve a more detailed status of individual bulk recipient batches.
570
+ # @param account_id The external account number (int) or account ID Guid.
571
+ # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
572
+ # @return [Array<(BulkEnvelopesResponse, Fixnum, Hash)>] BulkEnvelopesResponse data, response status code and response headers
573
+ def list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default)
574
+ if @api_client.config.debugging
575
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.list ..."
576
+ end
577
+ # verify the required parameter 'account_id' is set
578
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.list" if account_id.nil?
579
+ # resource path
580
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
581
+
582
+ # query parameters
583
+ query_params = {}
584
+ query_params[:'count'] = options.count if !options.count.nil?
585
+ query_params[:'include'] = options.include if !options.include.nil?
586
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
587
+
588
+ # header parameters
589
+ header_params = {}
590
+ # HTTP header 'Accept' (if needed)
591
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
592
+
593
+ # form parameters
594
+ form_params = {}
595
+
596
+ # http body (model)
597
+ post_body = nil
598
+ auth_names = []
599
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
600
+ :header_params => header_params,
601
+ :query_params => query_params,
602
+ :form_params => form_params,
603
+ :body => post_body,
604
+ :auth_names => auth_names,
605
+ :return_type => 'BulkEnvelopesResponse')
606
+ if @api_client.config.debugging
607
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
608
+ end
609
+ return data, status_code, headers
610
+ end
611
+
340
612
  # Updates an existing bulk send list. If send_envelope query string value is provided, will accept an empty payload and try to send the specified envelope
341
613
  #
342
614
  # @param account_id The external account number (int) or account ID Guid.
@@ -391,5 +663,68 @@ module DocuSign_eSign
391
663
  end
392
664
  return data, status_code, headers
393
665
  end
666
+
667
+ # Adds or replaces envelope bulk recipients.
668
+ # Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
669
+ # @param account_id The external account number (int) or account ID GUID.
670
+ # @param envelope_id The envelope's GUID. Example: `93be49ab-afa0-4adf-933c-f752070d71ec`
671
+ # @param recipient_id A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
672
+ # @param bulk_recipients_request
673
+ # @return [BulkRecipientsSummaryResponse]
674
+ def update_recipients(account_id, envelope_id, recipient_id, bulk_recipients_request)
675
+ data, _status_code, _headers = update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request)
676
+ return data
677
+ end
678
+
679
+ # Adds or replaces envelope bulk recipients.
680
+ # Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
681
+ # @param account_id The external account number (int) or account ID GUID.
682
+ # @param envelope_id The envelope's GUID. Example: `93be49ab-afa0-4adf-933c-f752070d71ec`
683
+ # @param recipient_id A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
684
+ # @param bulk_recipients_request
685
+ # @return [Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>] BulkRecipientsSummaryResponse data, response status code and response headers
686
+ def update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request)
687
+ if @api_client.config.debugging
688
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_recipients ..."
689
+ end
690
+ # verify the required parameter 'account_id' is set
691
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_recipients" if account_id.nil?
692
+ # verify the required parameter 'envelope_id' is set
693
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.update_recipients" if envelope_id.nil?
694
+ # verify the required parameter 'recipient_id' is set
695
+ fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.update_recipients" if recipient_id.nil?
696
+ # verify the required parameter 'bulk_recipients_request' is set
697
+ fail ArgumentError, "Missing the required parameter 'bulk_recipients_request' when calling BulkEnvelopesApi.update_recipients" if bulk_recipients_request.nil?
698
+ # resource path
699
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
700
+
701
+ # query parameters
702
+ query_params = {}
703
+
704
+ # header parameters
705
+ header_params = {}
706
+ # HTTP header 'Accept' (if needed)
707
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
708
+ # HTTP header 'Content-Type'
709
+ header_params['Content-Type'] = @api_client.select_header_content_type(['text/csv'])
710
+
711
+ # form parameters
712
+ form_params = {}
713
+
714
+ # http body (model)
715
+ post_body = @api_client.object_to_http_body(bulk_recipients_request)
716
+ auth_names = []
717
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
718
+ :header_params => header_params,
719
+ :query_params => query_params,
720
+ :form_params => form_params,
721
+ :body => post_body,
722
+ :auth_names => auth_names,
723
+ :return_type => 'BulkRecipientsSummaryResponse')
724
+ if @api_client.config.debugging
725
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
726
+ end
727
+ return data, status_code, headers
728
+ end
394
729
  end
395
730
  end