docusign_esign 3.19.0 → 3.21.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/lib/docusign_esign/api/accounts_api.rb +4 -4
  4. data/lib/docusign_esign/api/connect_api.rb +51 -0
  5. data/lib/docusign_esign/api/envelopes_api.rb +16 -65
  6. data/lib/docusign_esign/api/folders_api.rb +8 -0
  7. data/lib/docusign_esign/api/templates_api.rb +0 -73
  8. data/lib/docusign_esign/client/api_client.rb +1 -1
  9. data/lib/docusign_esign/models/account_identity_verification_workflow.rb +11 -1
  10. data/lib/docusign_esign/models/account_settings_information.rb +338 -15
  11. data/lib/docusign_esign/models/account_ui_settings.rb +20 -1
  12. data/lib/docusign_esign/models/bulk_sending_copy.rb +13 -1
  13. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +10 -1
  14. data/lib/docusign_esign/models/bulksending_copy_doc_gen_form_field.rb +194 -0
  15. data/lib/docusign_esign/models/connect_custom_configuration.rb +21 -1
  16. data/lib/docusign_esign/models/connect_o_auth_config.rb +11 -1
  17. data/lib/docusign_esign/models/contact.rb +10 -1
  18. data/lib/docusign_esign/models/delayed_routing.rb +3 -3
  19. data/lib/docusign_esign/models/delegation_info.rb +12 -12
  20. data/lib/docusign_esign/models/doc_gen_form_field.rb +224 -0
  21. data/lib/docusign_esign/models/doc_gen_syntax_error.rb +204 -0
  22. data/lib/docusign_esign/models/document.rb +23 -1
  23. data/lib/docusign_esign/models/envelope.rb +11 -1
  24. data/lib/docusign_esign/models/envelope_definition.rb +11 -1
  25. data/lib/docusign_esign/models/envelope_delay_rule.rb +3 -2
  26. data/lib/docusign_esign/models/envelope_document.rb +45 -1
  27. data/lib/docusign_esign/models/envelope_template.rb +21 -1
  28. data/lib/docusign_esign/models/event_notification.rb +21 -1
  29. data/lib/docusign_esign/models/id_evidence_view_link.rb +3 -3
  30. data/lib/docusign_esign/models/initial_here.rb +1 -1
  31. data/lib/docusign_esign/models/jurisdiction_summary.rb +214 -0
  32. data/lib/docusign_esign/models/locale_policy_tab.rb +14 -4
  33. data/lib/docusign_esign/models/notary_contact_details.rb +196 -0
  34. data/lib/docusign_esign/models/numerical.rb +1279 -0
  35. data/lib/docusign_esign/models/recipient_form_data.rb +12 -12
  36. data/lib/docusign_esign/models/recipient_identity_verification.rb +14 -4
  37. data/lib/docusign_esign/models/scheduled_sending.rb +3 -3
  38. data/lib/docusign_esign/models/tab_metadata.rb +11 -1
  39. data/lib/docusign_esign/models/tabs.rb +13 -1
  40. data/lib/docusign_esign/models/template_role.rb +11 -1
  41. data/lib/docusign_esign/models/template_tabs.rb +13 -1
  42. data/lib/docusign_esign/models/user_account_management_granular_information.rb +20 -1
  43. data/lib/docusign_esign/version.rb +1 -1
  44. data/lib/docusign_esign.rb +6 -4
  45. metadata +8 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c1c1b8886a92734a08dc9d2698f97dcfa6a9b80f40da2d3293a96d2a64980a06
4
- data.tar.gz: 35f540755c2de0d34cf55ddf50aea6cdcf64c8fb930e516d624539e463a008a3
3
+ metadata.gz: 2d87bcd4f4a605609fa81a94eba9ca07eaf48d975798ec98ece2bd8d65bbf502
4
+ data.tar.gz: fe921298587fcfa02bae98fc4ddef4480981ec4fe8d4b2263401e906153d211c
5
5
  SHA512:
6
- metadata.gz: 41c2766dae091d888046f17f35881dca27f854c8644e8e9f43c28cff176c5ce2282b4c1cc0fb890187295d9884d66b3775e201bb4f797eddcb5a9c99c278796b
7
- data.tar.gz: a35312d7f1f9e21b8f9e56563cfa5057a43c82e3e199eb6faa9b63f25b025dc1059af10e64af782d037b3ddb94d91b542496bf8fb2084c58301cd3d20a2ed056
6
+ metadata.gz: 0f074758ac67625662bf7d420b64c314dc07d7a75d19fb2eb3d135f89582023f562929eefe813cf491f575e722c88ff75e571bcf43e0fd4d6092fae7d882886f
7
+ data.tar.gz: '09910623ccb46a5b49224835c2d4baaadc5e40b278c2d4c4502c0c9e2668a2504a4eae1ec55a2128201b2173cecbfcb44fd5677eb40edc472c3e3d841fdf245b'
data/CHANGELOG.md CHANGED
@@ -3,6 +3,16 @@ All notable changes to this project will be documented in this file.
3
3
 
4
4
  See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
5
5
 
6
+ ## [v3.21.0] - eSignature API v2.1-22.4.02.00 - 2023-02-02
7
+ ### Changed
8
+ - Added support for version v2.1-22.4.02.00 of the DocuSign ESignature API.
9
+ - Updated the SDK release version.
10
+
11
+ ## [v3.20.0] - eSignature API v2.1-22.3.01.00 - 2022-11-18
12
+ ### Changed
13
+ - Added support for version v2.1-22.3.01.00 of the DocuSign ESignature API.
14
+ - Updated the SDK release version.
15
+
6
16
  ## [v3.19.0] - eSignature API v2.1-22.3.00.00 - 2022-09-08
7
17
  ### Changed
8
18
  - Added support for version v2.1-22.3.00.00 of the DocuSign ESignature API.
@@ -1780,7 +1780,7 @@ module DocuSign_eSign
1780
1780
  # Gets the Electronic Record and Signature Disclosure.
1781
1781
  # 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.
1782
1782
  # @param account_id The external account number (int) or account ID Guid.
1783
- # @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.
1783
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
1784
1784
  # @return [ConsumerDisclosure]
1785
1785
  def get_consumer_disclosure(account_id, lang_code)
1786
1786
  data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
@@ -1790,7 +1790,7 @@ module DocuSign_eSign
1790
1790
  # Gets the Electronic Record and Signature Disclosure.
1791
1791
  # 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.
1792
1792
  # @param account_id The external account number (int) or account ID Guid.
1793
- # @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.
1793
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
1794
1794
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
1795
1795
  def get_consumer_disclosure_with_http_info(account_id, lang_code)
1796
1796
  if @api_client.config.debugging
@@ -3292,7 +3292,7 @@ module DocuSign_eSign
3292
3292
  # Update Consumer Disclosure.
3293
3293
  # Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter. **Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - `accountEsignId`: This property is read-only. - `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure. - `esignAgreement`: This property is read-only. - `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`. - Metadata properties: These properties are read-only. **Note:** The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. You can also edit all of the other properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating. **Important:** When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.
3294
3294
  # @param account_id The external account number (int) or account ID Guid.
3295
- # @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.
3295
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3296
3296
  # @param consumer_disclosure (optional parameter)
3297
3297
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
3298
3298
  # @return [ConsumerDisclosure]
@@ -3304,7 +3304,7 @@ module DocuSign_eSign
3304
3304
  # Update Consumer Disclosure.
3305
3305
  # Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional &#x60;langCode&#x60; query parameter. **Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;custom&#x60;: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure. - &#x60;esignAgreement&#x60;: This property is read-only. - &#x60;esignText&#x60;: You cannot edit this property when &#x60;custom&#x60; is set to **false.** The API returns a 200 OK HTTP response, but does not update the &#x60;esignText&#x60;. - Metadata properties: These properties are read-only. **Note:** The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the &#x60;custom&#x60; property to **true** and customize the value for the &#x60;eSignText&#x60; property. You can also edit all of the other properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: This property is read-only. - Metadata properties: These properties are read-only. **Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the &#x60;langCode&#x60; parameter to specify the signer language version that you are updating. **Important:** When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: This property is read-only. - Metadata properties: These properties are read-only. **Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.
3306
3306
  # @param account_id The external account number (int) or account ID Guid.
3307
- # @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.
3307
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3308
3308
  # @param consumer_disclosure (optional parameter)
3309
3309
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
3310
3310
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
@@ -1147,6 +1147,57 @@ module DocuSign_eSign
1147
1147
  return data, status_code, headers
1148
1148
  end
1149
1149
 
1150
+ # Updates the existing Connect OAuth Config for the account.
1151
+ #
1152
+ # @param account_id The external account number (int) or account ID Guid.
1153
+ # @param connect_o_auth_config (optional parameter)
1154
+ # @return [ConnectOAuthConfig]
1155
+ def update_connect_o_auth_config(account_id, connect_o_auth_config)
1156
+ data, _status_code, _headers = update_connect_o_auth_config_with_http_info(account_id, connect_o_auth_config)
1157
+ return data
1158
+ end
1159
+
1160
+ # Updates the existing Connect OAuth Config for the account.
1161
+ #
1162
+ # @param account_id The external account number (int) or account ID Guid.
1163
+ # @param connect_o_auth_config (optional parameter)
1164
+ # @return [Array<(ConnectOAuthConfig, Fixnum, Hash)>] ConnectOAuthConfig data, response status code and response headers
1165
+ def update_connect_o_auth_config_with_http_info(account_id, connect_o_auth_config)
1166
+ if @api_client.config.debugging
1167
+ @api_client.config.logger.debug "Calling API: ConnectApi.update_connect_o_auth_config ..."
1168
+ end
1169
+ # verify the required parameter 'account_id' is set
1170
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.update_connect_o_auth_config" if account_id.nil?
1171
+ # resource path
1172
+ local_var_path = "/v2.1/accounts/{accountId}/connect/oauth".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1173
+
1174
+ # query parameters
1175
+ query_params = {}
1176
+
1177
+ # header parameters
1178
+ header_params = {}
1179
+ # HTTP header 'Accept' (if needed)
1180
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1181
+
1182
+ # form parameters
1183
+ form_params = {}
1184
+
1185
+ # http body (model)
1186
+ post_body = @api_client.object_to_http_body(connect_o_auth_config)
1187
+ auth_names = []
1188
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1189
+ :header_params => header_params,
1190
+ :query_params => query_params,
1191
+ :form_params => form_params,
1192
+ :body => post_body,
1193
+ :auth_names => auth_names,
1194
+ :return_type => 'ConnectOAuthConfig')
1195
+ if @api_client.config.debugging
1196
+ @api_client.config.logger.debug "API called: ConnectApi#update_connect_o_auth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1197
+ end
1198
+ return data, status_code, headers
1199
+ end
1200
+
1150
1201
  # Reserved
1151
1202
  # Reserved:
1152
1203
  # @param account_id The external account number (int) or account ID Guid.
@@ -233,6 +233,9 @@ module DocuSign_eSign
233
233
  #
234
234
  attr_accessor :documents_by_userid
235
235
 
236
+ #
237
+ attr_accessor :include_docgen_formfields
238
+
236
239
  #
237
240
  attr_accessor :include_document_size
238
241
 
@@ -3545,7 +3548,7 @@ module DocuSign_eSign
3545
3548
  # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
3546
3549
  # @param account_id The external account number (int) or account ID Guid.
3547
3550
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3548
- # @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.
3551
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3549
3552
  # @param recipient_id The ID of the recipient being accessed.
3550
3553
  # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
3551
3554
  # @return [ConsumerDisclosure]
@@ -3558,7 +3561,7 @@ module DocuSign_eSign
3558
3561
  # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
3559
3562
  # @param account_id The external account number (int) or account ID Guid.
3560
3563
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3561
- # @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.
3564
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3562
3565
  # @param recipient_id The ID of the recipient being accessed.
3563
3566
  # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
3564
3567
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
@@ -5397,6 +5400,7 @@ module DocuSign_eSign
5397
5400
  # query parameters
5398
5401
  query_params = {}
5399
5402
  query_params[:'documents_by_userid'] = options.documents_by_userid if !options.documents_by_userid.nil?
5403
+ query_params[:'include_docgen_formfields'] = options.include_docgen_formfields if !options.include_docgen_formfields.nil?
5400
5404
  query_params[:'include_document_size'] = options.include_document_size if !options.include_document_size.nil?
5401
5405
  query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
5402
5406
  query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
@@ -6219,9 +6223,10 @@ module DocuSign_eSign
6219
6223
  # @param account_id The external account number (int) or account ID Guid.
6220
6224
  # @param document_id The ID of the document being accessed.
6221
6225
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6226
+ # @param document_file_bytes Updated document content.
6222
6227
  # @return [EnvelopeDocument]
6223
- def update_document(account_id, document_id, envelope_id)
6224
- data, _status_code, _headers = update_document_with_http_info(account_id, document_id, envelope_id)
6228
+ def update_document(account_id, document_id, envelope_id, document_file_bytes)
6229
+ data, _status_code, _headers = update_document_with_http_info(account_id, document_id, envelope_id, document_file_bytes)
6225
6230
  return data
6226
6231
  end
6227
6232
 
@@ -6230,8 +6235,9 @@ module DocuSign_eSign
6230
6235
  # @param account_id The external account number (int) or account ID Guid.
6231
6236
  # @param document_id The ID of the document being accessed.
6232
6237
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6238
+ # @param document_file_bytes Updated document content.
6233
6239
  # @return [Array<(EnvelopeDocument, Fixnum, Hash)>] EnvelopeDocument data, response status code and response headers
6234
- def update_document_with_http_info(account_id, document_id, envelope_id)
6240
+ def update_document_with_http_info(account_id, document_id, envelope_id, document_file_bytes)
6235
6241
  if @api_client.config.debugging
6236
6242
  @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document ..."
6237
6243
  end
@@ -6241,6 +6247,8 @@ module DocuSign_eSign
6241
6247
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document" if document_id.nil?
6242
6248
  # verify the required parameter 'envelope_id' is set
6243
6249
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document" if envelope_id.nil?
6250
+ # verify the required parameter 'document_file_bytes' is set
6251
+ fail ArgumentError, "Missing the required parameter 'document_file_bytes' when calling EnvelopesApi.update_document" if document_file_bytes.nil?
6244
6252
  # resource path
6245
6253
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
6246
6254
 
@@ -6251,12 +6259,14 @@ module DocuSign_eSign
6251
6259
  header_params = {}
6252
6260
  # HTTP header 'Accept' (if needed)
6253
6261
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6262
+ # HTTP header 'Content-Type'
6263
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/pdf'])
6254
6264
 
6255
6265
  # form parameters
6256
6266
  form_params = {}
6257
6267
 
6258
6268
  # http body (model)
6259
- post_body = nil
6269
+ post_body = @api_client.object_to_http_body(document_file_bytes)
6260
6270
  auth_names = []
6261
6271
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6262
6272
  :header_params => header_params,
@@ -7233,65 +7243,6 @@ module DocuSign_eSign
7233
7243
  return data, status_code, headers
7234
7244
  end
7235
7245
 
7236
- # Retrieves a PDF document from the envelope with no CoC.
7237
- #
7238
- # @param account_id The external account number (int) or account ID Guid.
7239
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
7240
- # @param regen_document_id
7241
- # @param document (optional parameter)
7242
- # @return [File]
7243
- def update_regen_document(account_id, envelope_id, regen_document_id, document)
7244
- data, _status_code, _headers = update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document)
7245
- return data
7246
- end
7247
-
7248
- # Retrieves a PDF document from the envelope with no CoC.
7249
- #
7250
- # @param account_id The external account number (int) or account ID Guid.
7251
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
7252
- # @param regen_document_id
7253
- # @param document (optional parameter)
7254
- # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
7255
- def update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document)
7256
- if @api_client.config.debugging
7257
- @api_client.config.logger.debug "Calling API: EnvelopesApi.update_regen_document ..."
7258
- end
7259
- # verify the required parameter 'account_id' is set
7260
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_regen_document" if account_id.nil?
7261
- # verify the required parameter 'envelope_id' is set
7262
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_regen_document" if envelope_id.nil?
7263
- # verify the required parameter 'regen_document_id' is set
7264
- fail ArgumentError, "Missing the required parameter 'regen_document_id' when calling EnvelopesApi.update_regen_document" if regen_document_id.nil?
7265
- # resource path
7266
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{regenDocumentId}/regen".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'regenDocumentId' + '}', regen_document_id.to_s)
7267
-
7268
- # query parameters
7269
- query_params = {}
7270
-
7271
- # header parameters
7272
- header_params = {}
7273
- # HTTP header 'Accept' (if needed)
7274
- header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
7275
-
7276
- # form parameters
7277
- form_params = {}
7278
-
7279
- # http body (model)
7280
- post_body = @api_client.object_to_http_body(document)
7281
- auth_names = []
7282
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7283
- :header_params => header_params,
7284
- :query_params => query_params,
7285
- :form_params => form_params,
7286
- :body => post_body,
7287
- :auth_names => auth_names,
7288
- :return_type => 'File')
7289
- if @api_client.config.debugging
7290
- @api_client.config.logger.debug "API called: EnvelopesApi#update_regen_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7291
- end
7292
- return data, status_code, headers
7293
- end
7294
-
7295
7246
  # Updates the tabs for a recipient.
7296
7247
  # Updates one or more tabs for a recipient in a draft envelope.
7297
7248
  # @param account_id The external account number (int) or account ID Guid.
@@ -14,6 +14,9 @@ require "uri"
14
14
  module DocuSign_eSign
15
15
 
16
16
  class ListOptions
17
+ #
18
+ attr_accessor :count
19
+
17
20
  #
18
21
  attr_accessor :include
19
22
 
@@ -23,6 +26,9 @@ module DocuSign_eSign
23
26
  #
24
27
  attr_accessor :start_position
25
28
 
29
+ #
30
+ attr_accessor :sub_folder_depth
31
+
26
32
  # Specifies the items that are returned. Valid values are: * include - The folder list will return normal folders plus template folders. * only - Only the list of template folders are returned.
27
33
  attr_accessor :template
28
34
 
@@ -128,9 +134,11 @@ module DocuSign_eSign
128
134
 
129
135
  # query parameters
130
136
  query_params = {}
137
+ query_params[:'count'] = options.count if !options.count.nil?
131
138
  query_params[:'include'] = options.include if !options.include.nil?
132
139
  query_params[:'include_items'] = options.include_items if !options.include_items.nil?
133
140
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
141
+ query_params[:'sub_folder_depth'] = options.sub_folder_depth if !options.sub_folder_depth.nil?
134
142
  query_params[:'template'] = options.template if !options.template.nil?
135
143
  query_params[:'user_filter'] = options.user_filter if !options.user_filter.nil?
136
144
 
@@ -97,18 +97,6 @@ module DocuSign_eSign
97
97
  end
98
98
  end
99
99
 
100
- class ListBulkRecipientsOptions
101
- #
102
- attr_accessor :include_tabs
103
-
104
- #
105
- attr_accessor :start_position
106
-
107
- def self.default
108
- @@default ||= ListBulkRecipientsOptions.new
109
- end
110
- end
111
-
112
100
  class ListDocumentsOptions
113
101
  #
114
102
  attr_accessor :include_tabs
@@ -2087,67 +2075,6 @@ module DocuSign_eSign
2087
2075
  return data, status_code, headers
2088
2076
  end
2089
2077
 
2090
- # Gets the bulk recipient file from a template.
2091
- # Retrieves the bulk recipient file information from a template that has a bulk recipient.
2092
- # @param account_id The external account number (int) or account ID Guid.
2093
- # @param recipient_id The ID of the recipient being accessed.
2094
- # @param template_id The ID of the template being accessed.
2095
- # @param DocuSign_eSign::ListBulkRecipientsOptions Options for modifying the behavior of the function.
2096
- # @return [BulkRecipientsResponse]
2097
- def list_bulk_recipients(account_id, recipient_id, template_id, options = DocuSign_eSign::ListBulkRecipientsOptions.default)
2098
- data, _status_code, _headers = list_bulk_recipients_with_http_info(account_id, recipient_id, template_id, options)
2099
- return data
2100
- end
2101
-
2102
- # Gets the bulk recipient file from a template.
2103
- # Retrieves the bulk recipient file information from a template that has a bulk recipient.
2104
- # @param account_id The external account number (int) or account ID Guid.
2105
- # @param recipient_id The ID of the recipient being accessed.
2106
- # @param template_id The ID of the template being accessed.
2107
- # @param DocuSign_eSign::ListBulkRecipientsOptions Options for modifying the behavior of the function.
2108
- # @return [Array<(BulkRecipientsResponse, Fixnum, Hash)>] BulkRecipientsResponse data, response status code and response headers
2109
- def list_bulk_recipients_with_http_info(account_id, recipient_id, template_id, options = DocuSign_eSign::ListBulkRecipientsOptions.default)
2110
- if @api_client.config.debugging
2111
- @api_client.config.logger.debug "Calling API: TemplatesApi.list_bulk_recipients ..."
2112
- end
2113
- # verify the required parameter 'account_id' is set
2114
- fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_bulk_recipients" if account_id.nil?
2115
- # verify the required parameter 'recipient_id' is set
2116
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.list_bulk_recipients" if recipient_id.nil?
2117
- # verify the required parameter 'template_id' is set
2118
- fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_bulk_recipients" if template_id.nil?
2119
- # resource path
2120
- local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
2121
-
2122
- # query parameters
2123
- query_params = {}
2124
- query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
2125
- query_params[:'start_position'] = options.start_position if !options.start_position.nil?
2126
-
2127
- # header parameters
2128
- header_params = {}
2129
- # HTTP header 'Accept' (if needed)
2130
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2131
-
2132
- # form parameters
2133
- form_params = {}
2134
-
2135
- # http body (model)
2136
- post_body = nil
2137
- auth_names = []
2138
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2139
- :header_params => header_params,
2140
- :query_params => query_params,
2141
- :form_params => form_params,
2142
- :body => post_body,
2143
- :auth_names => auth_names,
2144
- :return_type => 'BulkRecipientsResponse')
2145
- if @api_client.config.debugging
2146
- @api_client.config.logger.debug "API called: TemplatesApi#list_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2147
- end
2148
- return data, status_code, headers
2149
- end
2150
-
2151
2078
  # Gets the custom document fields from a template.
2152
2079
  # Retrieves the custom document field information from an existing template.
2153
2080
  # @param account_id The external account number (int) or account ID Guid.
@@ -35,7 +35,7 @@ module DocuSign_eSign
35
35
  # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
36
36
  def initialize(config = Configuration.default)
37
37
  @config = config
38
- @user_agent = "Swagger-Codegen/3.19.0/ruby"
38
+ @user_agent = "Swagger-Codegen/3.21.0/ruby"
39
39
  @default_headers = {
40
40
  'Content-Type' => "application/json",
41
41
  'User-Agent' => @user_agent
@@ -32,6 +32,9 @@ module DocuSign_eSign
32
32
  #
33
33
  attr_accessor :workflow_id
34
34
 
35
+ #
36
+ attr_accessor :workflow_label
37
+
35
38
  #
36
39
  attr_accessor :workflow_resource_key
37
40
 
@@ -44,6 +47,7 @@ module DocuSign_eSign
44
47
  :'signature_provider' => :'signatureProvider',
45
48
  :'steps' => :'steps',
46
49
  :'workflow_id' => :'workflowId',
50
+ :'workflow_label' => :'workflowLabel',
47
51
  :'workflow_resource_key' => :'workflowResourceKey'
48
52
  }
49
53
  end
@@ -57,6 +61,7 @@ module DocuSign_eSign
57
61
  :'signature_provider' => :'AccountSignatureProvider',
58
62
  :'steps' => :'Array<AccountIdentityVerificationStep>',
59
63
  :'workflow_id' => :'String',
64
+ :'workflow_label' => :'String',
60
65
  :'workflow_resource_key' => :'String'
61
66
  }
62
67
  end
@@ -97,6 +102,10 @@ module DocuSign_eSign
97
102
  self.workflow_id = attributes[:'workflowId']
98
103
  end
99
104
 
105
+ if attributes.has_key?(:'workflowLabel')
106
+ self.workflow_label = attributes[:'workflowLabel']
107
+ end
108
+
100
109
  if attributes.has_key?(:'workflowResourceKey')
101
110
  self.workflow_resource_key = attributes[:'workflowResourceKey']
102
111
  end
@@ -126,6 +135,7 @@ module DocuSign_eSign
126
135
  signature_provider == o.signature_provider &&
127
136
  steps == o.steps &&
128
137
  workflow_id == o.workflow_id &&
138
+ workflow_label == o.workflow_label &&
129
139
  workflow_resource_key == o.workflow_resource_key
130
140
  end
131
141
 
@@ -138,7 +148,7 @@ module DocuSign_eSign
138
148
  # Calculates hash code according to all attributes.
139
149
  # @return [Fixnum] Hash code
140
150
  def hash
141
- [default_description, default_name, input_options, signature_provider, steps, workflow_id, workflow_resource_key].hash
151
+ [default_description, default_name, input_options, signature_provider, steps, workflow_id, workflow_label, workflow_resource_key].hash
142
152
  end
143
153
 
144
154
  # Builds the object from hash