docusign_esign 3.20.0 → 3.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (150) 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/billing_api.rb +2 -2
  5. data/lib/docusign_esign/api/connect_api.rb +51 -0
  6. data/lib/docusign_esign/api/envelopes_api.rb +132 -65
  7. data/lib/docusign_esign/api/folders_api.rb +8 -0
  8. data/lib/docusign_esign/api/templates_api.rb +0 -130
  9. data/lib/docusign_esign/client/api_client.rb +1 -1
  10. data/lib/docusign_esign/models/account_information.rb +2 -1
  11. data/lib/docusign_esign/models/account_role_settings.rb +2 -0
  12. data/lib/docusign_esign/models/account_settings_information.rb +205 -3
  13. data/lib/docusign_esign/models/account_shared_access.rb +1 -1
  14. data/lib/docusign_esign/models/account_signature.rb +1 -1
  15. data/lib/docusign_esign/models/account_ui_settings.rb +2 -0
  16. data/lib/docusign_esign/models/agent.rb +13 -3
  17. data/lib/docusign_esign/models/approve.rb +2 -1
  18. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  19. data/lib/docusign_esign/models/brand.rb +1 -1
  20. data/lib/docusign_esign/models/bulk_envelope.rb +1 -1
  21. data/lib/docusign_esign/models/bulk_sending_copy.rb +13 -1
  22. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +12 -2
  23. data/lib/docusign_esign/models/bulksending_copy_doc_gen_form_field.rb +194 -0
  24. data/lib/docusign_esign/models/captive_recipient.rb +1 -1
  25. data/lib/docusign_esign/models/carbon_copy.rb +13 -3
  26. data/lib/docusign_esign/models/certified_delivery.rb +13 -3
  27. data/lib/docusign_esign/models/checkbox.rb +2 -1
  28. data/lib/docusign_esign/models/cloud_storage_provider.rb +1 -1
  29. data/lib/docusign_esign/models/comment_thread.rb +2 -1
  30. data/lib/docusign_esign/models/commission_county.rb +2 -1
  31. data/lib/docusign_esign/models/commission_expiration.rb +2 -1
  32. data/lib/docusign_esign/models/commission_number.rb +2 -1
  33. data/lib/docusign_esign/models/commission_state.rb +2 -1
  34. data/lib/docusign_esign/models/company.rb +2 -1
  35. data/lib/docusign_esign/models/connect_custom_configuration.rb +11 -1
  36. data/lib/docusign_esign/models/connect_debug_log.rb +1 -1
  37. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +1 -0
  38. data/lib/docusign_esign/models/contact.rb +12 -2
  39. data/lib/docusign_esign/models/custom_field.rb +1 -1
  40. data/lib/docusign_esign/models/date.rb +2 -1
  41. data/lib/docusign_esign/models/date_signed.rb +2 -1
  42. data/lib/docusign_esign/models/decline.rb +2 -1
  43. data/lib/docusign_esign/models/delayed_routing.rb +1 -1
  44. data/lib/docusign_esign/models/doc_gen_form_field_request.rb +186 -0
  45. data/lib/docusign_esign/models/doc_gen_form_field_response.rb +196 -0
  46. data/lib/docusign_esign/models/doc_gen_form_fields.rb +218 -0
  47. data/lib/docusign_esign/models/document_template.rb +1 -1
  48. data/lib/docusign_esign/models/document_visibility.rb +1 -1
  49. data/lib/docusign_esign/models/draw.rb +2 -1
  50. data/lib/docusign_esign/models/editor.rb +13 -3
  51. data/lib/docusign_esign/models/email.rb +2 -1
  52. data/lib/docusign_esign/models/email_address.rb +2 -1
  53. data/lib/docusign_esign/models/envelope.rb +13 -3
  54. data/lib/docusign_esign/models/envelope_attachment.rb +1 -1
  55. data/lib/docusign_esign/models/envelope_definition.rb +13 -3
  56. data/lib/docusign_esign/models/envelope_document.rb +1 -1
  57. data/lib/docusign_esign/models/envelope_id.rb +2 -1
  58. data/lib/docusign_esign/models/envelope_publish_transaction.rb +1 -0
  59. data/lib/docusign_esign/models/envelope_summary.rb +1 -1
  60. data/lib/docusign_esign/models/envelope_template.rb +13 -3
  61. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -1
  62. data/lib/docusign_esign/models/envelope_update_summary.rb +1 -1
  63. data/lib/docusign_esign/models/event_notification.rb +11 -1
  64. data/lib/docusign_esign/models/external_folder.rb +1 -1
  65. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -1
  66. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -1
  67. data/lib/docusign_esign/models/first_name.rb +2 -1
  68. data/lib/docusign_esign/models/folder.rb +1 -1
  69. data/lib/docusign_esign/models/folder_item_v2.rb +1 -1
  70. data/lib/docusign_esign/models/folder_shared_item.rb +1 -1
  71. data/lib/docusign_esign/models/form_data_item.rb +12 -2
  72. data/lib/docusign_esign/models/formula_tab.rb +2 -1
  73. data/lib/docusign_esign/models/full_name.rb +2 -1
  74. data/lib/docusign_esign/models/group.rb +1 -1
  75. data/lib/docusign_esign/models/id_evidence_view_link.rb +3 -3
  76. data/lib/docusign_esign/models/in_person_signer.rb +13 -3
  77. data/lib/docusign_esign/models/initial_here.rb +3 -2
  78. data/lib/docusign_esign/models/inline_template.rb +2 -2
  79. data/lib/docusign_esign/models/intermediary.rb +13 -3
  80. data/lib/docusign_esign/models/jurisdiction_summary.rb +214 -0
  81. data/lib/docusign_esign/models/last_name.rb +2 -1
  82. data/lib/docusign_esign/models/list.rb +2 -1
  83. data/lib/docusign_esign/models/list_custom_field.rb +1 -1
  84. data/lib/docusign_esign/models/locale_policy_tab.rb +14 -4
  85. data/lib/docusign_esign/models/lock_information.rb +1 -1
  86. data/lib/docusign_esign/models/member_group_shared_item.rb +1 -1
  87. data/lib/docusign_esign/models/member_shared_items.rb +1 -1
  88. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -1
  89. data/lib/docusign_esign/models/name_value.rb +1 -1
  90. data/lib/docusign_esign/models/new_account_definition.rb +2 -2
  91. data/lib/docusign_esign/models/new_user.rb +1 -1
  92. data/lib/docusign_esign/models/notarize.rb +2 -1
  93. data/lib/docusign_esign/models/notary_contact_details.rb +196 -0
  94. data/lib/docusign_esign/models/notary_host.rb +13 -3
  95. data/lib/docusign_esign/models/notary_jurisdiction.rb +1 -1
  96. data/lib/docusign_esign/models/notary_recipient.rb +13 -3
  97. data/lib/docusign_esign/models/notary_seal.rb +2 -1
  98. data/lib/docusign_esign/models/note.rb +2 -1
  99. data/lib/docusign_esign/models/number.rb +2 -1
  100. data/lib/docusign_esign/models/numerical.rb +1346 -0
  101. data/lib/docusign_esign/models/page.rb +1 -1
  102. data/lib/docusign_esign/models/participant.rb +33 -1
  103. data/lib/docusign_esign/models/phone_number.rb +2 -1
  104. data/lib/docusign_esign/models/poly_line_overlay.rb +2 -1
  105. data/lib/docusign_esign/models/power_form.rb +1 -1
  106. data/lib/docusign_esign/models/radio.rb +13 -2
  107. data/lib/docusign_esign/models/recipient_identity_verification.rb +14 -4
  108. data/lib/docusign_esign/models/recipient_update_response.rb +1 -1
  109. data/lib/docusign_esign/models/recipients.rb +1 -1
  110. data/lib/docusign_esign/models/scheduled_sending.rb +1 -1
  111. data/lib/docusign_esign/models/seal_sign.rb +13 -3
  112. data/lib/docusign_esign/models/sender_company.rb +2 -1
  113. data/lib/docusign_esign/models/sender_name.rb +2 -1
  114. data/lib/docusign_esign/models/shared_item.rb +1 -1
  115. data/lib/docusign_esign/models/sign_here.rb +2 -1
  116. data/lib/docusign_esign/models/signer.rb +13 -3
  117. data/lib/docusign_esign/models/signer_attachment.rb +2 -1
  118. data/lib/docusign_esign/models/signing_group.rb +1 -1
  119. data/lib/docusign_esign/models/signing_group_user.rb +1 -1
  120. data/lib/docusign_esign/models/smart_section.rb +4 -3
  121. data/lib/docusign_esign/models/social_account_information.rb +1 -1
  122. data/lib/docusign_esign/models/ssn.rb +2 -1
  123. data/lib/docusign_esign/models/stamp.rb +1 -1
  124. data/lib/docusign_esign/models/tab_account_settings.rb +21 -21
  125. data/lib/docusign_esign/models/tab_group.rb +2 -1
  126. data/lib/docusign_esign/models/tab_metadata.rb +11 -1
  127. data/lib/docusign_esign/models/tabs.rb +13 -13
  128. data/lib/docusign_esign/models/template_recipients.rb +1 -1
  129. data/lib/docusign_esign/models/template_role.rb +12 -2
  130. data/lib/docusign_esign/models/template_shared_item.rb +1 -1
  131. data/lib/docusign_esign/models/template_summary.rb +1 -1
  132. data/lib/docusign_esign/models/template_tabs.rb +13 -13
  133. data/lib/docusign_esign/models/template_update_summary.rb +1 -1
  134. data/lib/docusign_esign/models/text.rb +2 -1
  135. data/lib/docusign_esign/models/text_custom_field.rb +1 -1
  136. data/lib/docusign_esign/models/title.rb +2 -1
  137. data/lib/docusign_esign/models/user_account_management_granular_information.rb +22 -1
  138. data/lib/docusign_esign/models/user_info.rb +12 -2
  139. data/lib/docusign_esign/models/user_information.rb +2 -2
  140. data/lib/docusign_esign/models/user_settings_information.rb +2 -0
  141. data/lib/docusign_esign/models/user_shared_item.rb +1 -1
  142. data/lib/docusign_esign/models/user_signature.rb +1 -1
  143. data/lib/docusign_esign/models/view.rb +2 -1
  144. data/lib/docusign_esign/models/witness.rb +13 -3
  145. data/lib/docusign_esign/models/workspace_user.rb +1 -1
  146. data/lib/docusign_esign/models/workspace_user_authorization.rb +1 -1
  147. data/lib/docusign_esign/models/zip.rb +2 -1
  148. data/lib/docusign_esign/version.rb +1 -1
  149. data/lib/docusign_esign.rb +7 -6
  150. metadata +9 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 477e5213535e6c2f998d01072c446759562edb20431bd323c6219baf5c650109
4
- data.tar.gz: 915073908f3294a0ca4b315c182dfb71c53d12b0d21276ac65004cddd6159d0e
3
+ metadata.gz: 66c42c585fce371eb5dc319f05d6d493f6a36bb9bcd23afe1537f7832817eed7
4
+ data.tar.gz: 0a2a90f1acf14622a7c0613edc9ce88f069e77e90d5273817813ec5a0284bcb5
5
5
  SHA512:
6
- metadata.gz: 75e63c7b8a4c5a24e71adb5bd3b45c35e05914eefe4f549a3cf479771303f630c6ee266ad9d7ef6814dbe2834aa45b6860db9d8f3d07223de02b261620471f03
7
- data.tar.gz: 80fefa370f1ac3329f739cd23549a108c0c7fbfcec0c3748527f86478b1d08af7a9cede21ab830008d1d83900711da626eae8d85f94c7fb00aef1f33f6a31b66
6
+ metadata.gz: 8df425d194f9cc4ee111103f55fcafdb85eef61e5f5b0b1fbf6623d12352cfb96db6859f4819334186abda98ca0375fe8a247488395979d74274935860d79e62
7
+ data.tar.gz: 1d6f7256fa83053c2cb5d5036cb4fd8b323d333ec7fb0f3f458638bc049b6a1e1155ab535bafeedb2a3ff4f718fbd66c5353ca16f67d8cfaa7cbbbbdfb9182dd
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.22.0] - eSignature API v2.1-23.1.01.00 - 2023-03-17
7
+ ### Changed
8
+ - Added support for version v2.1-23.1.01.00 of the DocuSign ESignature API.
9
+ - Updated the SDK release version.
10
+
11
+ ## [v3.21.0] - eSignature API v2.1-22.4.02.00 - 2023-02-02
12
+ ### Changed
13
+ - Added support for version v2.1-22.4.02.00 of the DocuSign ESignature API.
14
+ - Updated the SDK release version.
15
+
6
16
  ## [v3.20.0] - eSignature API v2.1-22.3.01.00 - 2022-11-18
7
17
  ### Changed
8
18
  - Added support for version v2.1-22.3.01.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), 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), 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), 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), 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), 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), 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), 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), 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
@@ -223,7 +223,7 @@ module DocuSign_eSign
223
223
  end
224
224
 
225
225
  # Retrieves a billing invoice.
226
- # Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
226
+ # Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
227
227
  # @param account_id The external account number (int) or account ID Guid.
228
228
  # @param invoice_id
229
229
  # @return [BillingInvoice]
@@ -233,7 +233,7 @@ module DocuSign_eSign
233
233
  end
234
234
 
235
235
  # Retrieves a billing invoice.
236
- # Retrieves the specified invoice. ###### Note: If the &#x60;pdfAvailable&#x60; property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the &#x60;Accept&#x60; property in the header to &#x60;Accept: application/pdf&#x60;. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as &#39;unlimited&#39; or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different &#x60;chargeName&#x60; property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
236
+ # Retrieves the specified invoice. ###### Note: If the &#x60;pdfAvailable&#x60; property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the &#x60;Accept&#x60; property in the header to &#x60;Accept: application/pdf&#x60;. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as &#39;unlimited&#39; or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different &#x60;chargeName&#x60; property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
237
237
  # @param account_id The external account number (int) or account ID Guid.
238
238
  # @param invoice_id
239
239
  # @return [Array<(BillingInvoice, Fixnum, Hash)>] BillingInvoice 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.
@@ -463,6 +463,15 @@ module DocuSign_eSign
463
463
  end
464
464
  end
465
465
 
466
+ class UpdateEnvelopeDocGenFormFieldsOptions
467
+ #
468
+ attr_accessor :update_docgen_formfields_only
469
+
470
+ def self.default
471
+ @@default ||= UpdateEnvelopeDocGenFormFieldsOptions.new
472
+ end
473
+ end
474
+
466
475
  class UpdateRecipientsOptions
467
476
  #
468
477
  attr_accessor :combine_same_order_recipients
@@ -3548,7 +3557,7 @@ module DocuSign_eSign
3548
3557
  # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
3549
3558
  # @param account_id The external account number (int) or account ID Guid.
3550
3559
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
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.
3560
+ # @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.
3552
3561
  # @param recipient_id The ID of the recipient being accessed.
3553
3562
  # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
3554
3563
  # @return [ConsumerDisclosure]
@@ -3561,7 +3570,7 @@ module DocuSign_eSign
3561
3570
  # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
3562
3571
  # @param account_id The external account number (int) or account ID Guid.
3563
3572
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
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.
3573
+ # @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.
3565
3574
  # @param recipient_id The ID of the recipient being accessed.
3566
3575
  # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
3567
3576
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
@@ -4031,6 +4040,59 @@ module DocuSign_eSign
4031
4040
  return data, status_code, headers
4032
4041
  end
4033
4042
 
4043
+ # Returns formfields for an envelope
4044
+ #
4045
+ # @param account_id The external account number (int) or account ID Guid.
4046
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4047
+ # @return [DocGenFormFieldResponse]
4048
+ def get_envelope_doc_gen_form_fields(account_id, envelope_id)
4049
+ data, _status_code, _headers = get_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id)
4050
+ return data
4051
+ end
4052
+
4053
+ # Returns formfields for an envelope
4054
+ #
4055
+ # @param account_id The external account number (int) or account ID Guid.
4056
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4057
+ # @return [Array<(DocGenFormFieldResponse, Fixnum, Hash)>] DocGenFormFieldResponse data, response status code and response headers
4058
+ def get_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id)
4059
+ if @api_client.config.debugging
4060
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_doc_gen_form_fields ..."
4061
+ end
4062
+ # verify the required parameter 'account_id' is set
4063
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_doc_gen_form_fields" if account_id.nil?
4064
+ # verify the required parameter 'envelope_id' is set
4065
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_doc_gen_form_fields" if envelope_id.nil?
4066
+ # resource path
4067
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4068
+
4069
+ # query parameters
4070
+ query_params = {}
4071
+
4072
+ # header parameters
4073
+ header_params = {}
4074
+ # HTTP header 'Accept' (if needed)
4075
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4076
+
4077
+ # form parameters
4078
+ form_params = {}
4079
+
4080
+ # http body (model)
4081
+ post_body = nil
4082
+ auth_names = []
4083
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4084
+ :header_params => header_params,
4085
+ :query_params => query_params,
4086
+ :form_params => form_params,
4087
+ :body => post_body,
4088
+ :auth_names => auth_names,
4089
+ :return_type => 'DocGenFormFieldResponse')
4090
+ if @api_client.config.debugging
4091
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_doc_gen_form_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4092
+ end
4093
+ return data, status_code, headers
4094
+ end
4095
+
4034
4096
  # Get the Original HTML Definition used to generate the Responsive HTML for a given document.
4035
4097
  #
4036
4098
  # @param account_id The external account number (int) or account ID Guid.
@@ -6223,9 +6285,10 @@ module DocuSign_eSign
6223
6285
  # @param account_id The external account number (int) or account ID Guid.
6224
6286
  # @param document_id The ID of the document being accessed.
6225
6287
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6288
+ # @param document_file_bytes Updated document content.
6226
6289
  # @return [EnvelopeDocument]
6227
- def update_document(account_id, document_id, envelope_id)
6228
- data, _status_code, _headers = update_document_with_http_info(account_id, document_id, envelope_id)
6290
+ def update_document(account_id, document_id, envelope_id, document_file_bytes)
6291
+ data, _status_code, _headers = update_document_with_http_info(account_id, document_id, envelope_id, document_file_bytes)
6229
6292
  return data
6230
6293
  end
6231
6294
 
@@ -6234,8 +6297,9 @@ module DocuSign_eSign
6234
6297
  # @param account_id The external account number (int) or account ID Guid.
6235
6298
  # @param document_id The ID of the document being accessed.
6236
6299
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6300
+ # @param document_file_bytes Updated document content.
6237
6301
  # @return [Array<(EnvelopeDocument, Fixnum, Hash)>] EnvelopeDocument data, response status code and response headers
6238
- def update_document_with_http_info(account_id, document_id, envelope_id)
6302
+ def update_document_with_http_info(account_id, document_id, envelope_id, document_file_bytes)
6239
6303
  if @api_client.config.debugging
6240
6304
  @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document ..."
6241
6305
  end
@@ -6245,6 +6309,8 @@ module DocuSign_eSign
6245
6309
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document" if document_id.nil?
6246
6310
  # verify the required parameter 'envelope_id' is set
6247
6311
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document" if envelope_id.nil?
6312
+ # verify the required parameter 'document_file_bytes' is set
6313
+ fail ArgumentError, "Missing the required parameter 'document_file_bytes' when calling EnvelopesApi.update_document" if document_file_bytes.nil?
6248
6314
  # resource path
6249
6315
  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)
6250
6316
 
@@ -6255,12 +6321,14 @@ module DocuSign_eSign
6255
6321
  header_params = {}
6256
6322
  # HTTP header 'Accept' (if needed)
6257
6323
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6324
+ # HTTP header 'Content-Type'
6325
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/pdf'])
6258
6326
 
6259
6327
  # form parameters
6260
6328
  form_params = {}
6261
6329
 
6262
6330
  # http body (model)
6263
- post_body = nil
6331
+ post_body = @api_client.object_to_http_body(document_file_bytes)
6264
6332
  auth_names = []
6265
6333
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6266
6334
  :header_params => header_params,
@@ -6562,6 +6630,64 @@ module DocuSign_eSign
6562
6630
  return data, status_code, headers
6563
6631
  end
6564
6632
 
6633
+ # Updates formfields for an envelope
6634
+ #
6635
+ # @param account_id The external account number (int) or account ID Guid.
6636
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6637
+ # @param doc_gen_form_field_request (optional parameter)
6638
+ # @param DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions Options for modifying the behavior of the function.
6639
+ # @return [DocGenFormFieldResponse]
6640
+ def update_envelope_doc_gen_form_fields(account_id, envelope_id, doc_gen_form_field_request, options = DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions.default)
6641
+ data, _status_code, _headers = update_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id, doc_gen_form_field_request, options)
6642
+ return data
6643
+ end
6644
+
6645
+ # Updates formfields for an envelope
6646
+ #
6647
+ # @param account_id The external account number (int) or account ID Guid.
6648
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6649
+ # @param doc_gen_form_field_request (optional parameter)
6650
+ # @param DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions Options for modifying the behavior of the function.
6651
+ # @return [Array<(DocGenFormFieldResponse, Fixnum, Hash)>] DocGenFormFieldResponse data, response status code and response headers
6652
+ def update_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id, doc_gen_form_field_request, options = DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions.default)
6653
+ if @api_client.config.debugging
6654
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_doc_gen_form_fields ..."
6655
+ end
6656
+ # verify the required parameter 'account_id' is set
6657
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_doc_gen_form_fields" if account_id.nil?
6658
+ # verify the required parameter 'envelope_id' is set
6659
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_doc_gen_form_fields" if envelope_id.nil?
6660
+ # resource path
6661
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
6662
+
6663
+ # query parameters
6664
+ query_params = {}
6665
+ query_params[:'update_docgen_formfields_only'] = options.update_docgen_formfields_only if !options.update_docgen_formfields_only.nil?
6666
+
6667
+ # header parameters
6668
+ header_params = {}
6669
+ # HTTP header 'Accept' (if needed)
6670
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6671
+
6672
+ # form parameters
6673
+ form_params = {}
6674
+
6675
+ # http body (model)
6676
+ post_body = @api_client.object_to_http_body(doc_gen_form_field_request)
6677
+ auth_names = []
6678
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6679
+ :header_params => header_params,
6680
+ :query_params => query_params,
6681
+ :form_params => form_params,
6682
+ :body => post_body,
6683
+ :auth_names => auth_names,
6684
+ :return_type => 'DocGenFormFieldResponse')
6685
+ if @api_client.config.debugging
6686
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_doc_gen_form_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6687
+ end
6688
+ return data, status_code, headers
6689
+ end
6690
+
6565
6691
  # Updates the scheduled sending rules for an envelope's workflow definition.
6566
6692
  #
6567
6693
  # @param account_id The external account number (int) or account ID Guid.
@@ -7237,65 +7363,6 @@ module DocuSign_eSign
7237
7363
  return data, status_code, headers
7238
7364
  end
7239
7365
 
7240
- # Retrieves a PDF document from the envelope with no CoC.
7241
- #
7242
- # @param account_id The external account number (int) or account ID Guid.
7243
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
7244
- # @param regen_document_id
7245
- # @param document (optional parameter)
7246
- # @return [File]
7247
- def update_regen_document(account_id, envelope_id, regen_document_id, document)
7248
- data, _status_code, _headers = update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document)
7249
- return data
7250
- end
7251
-
7252
- # Retrieves a PDF document from the envelope with no CoC.
7253
- #
7254
- # @param account_id The external account number (int) or account ID Guid.
7255
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
7256
- # @param regen_document_id
7257
- # @param document (optional parameter)
7258
- # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
7259
- def update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document)
7260
- if @api_client.config.debugging
7261
- @api_client.config.logger.debug "Calling API: EnvelopesApi.update_regen_document ..."
7262
- end
7263
- # verify the required parameter 'account_id' is set
7264
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_regen_document" if account_id.nil?
7265
- # verify the required parameter 'envelope_id' is set
7266
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_regen_document" if envelope_id.nil?
7267
- # verify the required parameter 'regen_document_id' is set
7268
- fail ArgumentError, "Missing the required parameter 'regen_document_id' when calling EnvelopesApi.update_regen_document" if regen_document_id.nil?
7269
- # resource path
7270
- 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)
7271
-
7272
- # query parameters
7273
- query_params = {}
7274
-
7275
- # header parameters
7276
- header_params = {}
7277
- # HTTP header 'Accept' (if needed)
7278
- header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
7279
-
7280
- # form parameters
7281
- form_params = {}
7282
-
7283
- # http body (model)
7284
- post_body = @api_client.object_to_http_body(document)
7285
- auth_names = []
7286
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7287
- :header_params => header_params,
7288
- :query_params => query_params,
7289
- :form_params => form_params,
7290
- :body => post_body,
7291
- :auth_names => auth_names,
7292
- :return_type => 'File')
7293
- if @api_client.config.debugging
7294
- @api_client.config.logger.debug "API called: EnvelopesApi#update_regen_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7295
- end
7296
- return data, status_code, headers
7297
- end
7298
-
7299
7366
  # Updates the tabs for a recipient.
7300
7367
  # Updates one or more tabs for a recipient in a draft envelope.
7301
7368
  # @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
@@ -866,63 +854,6 @@ module DocuSign_eSign
866
854
  return data, status_code, headers
867
855
  end
868
856
 
869
- # Deletes the bulk recipient list on a template.
870
- # Deletes the bulk recipient list on a template.
871
- # @param account_id The external account number (int) or account ID Guid.
872
- # @param recipient_id The ID of the recipient being accessed.
873
- # @param template_id The ID of the template being accessed.
874
- # @return [BulkRecipientsUpdateResponse]
875
- def delete_bulk_recipients(account_id, recipient_id, template_id)
876
- data, _status_code, _headers = delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id)
877
- return data
878
- end
879
-
880
- # Deletes the bulk recipient list on a template.
881
- # Deletes the bulk recipient list on a template.
882
- # @param account_id The external account number (int) or account ID Guid.
883
- # @param recipient_id The ID of the recipient being accessed.
884
- # @param template_id The ID of the template being accessed.
885
- # @return [Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>] BulkRecipientsUpdateResponse data, response status code and response headers
886
- def delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id)
887
- if @api_client.config.debugging
888
- @api_client.config.logger.debug "Calling API: TemplatesApi.delete_bulk_recipients ..."
889
- end
890
- # verify the required parameter 'account_id' is set
891
- fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_bulk_recipients" if account_id.nil?
892
- # verify the required parameter 'recipient_id' is set
893
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.delete_bulk_recipients" if recipient_id.nil?
894
- # verify the required parameter 'template_id' is set
895
- fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_bulk_recipients" if template_id.nil?
896
- # resource path
897
- 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)
898
-
899
- # query parameters
900
- query_params = {}
901
-
902
- # header parameters
903
- header_params = {}
904
- # HTTP header 'Accept' (if needed)
905
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
906
-
907
- # form parameters
908
- form_params = {}
909
-
910
- # http body (model)
911
- post_body = nil
912
- auth_names = []
913
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
914
- :header_params => header_params,
915
- :query_params => query_params,
916
- :form_params => form_params,
917
- :body => post_body,
918
- :auth_names => auth_names,
919
- :return_type => 'BulkRecipientsUpdateResponse')
920
- if @api_client.config.debugging
921
- @api_client.config.logger.debug "API called: TemplatesApi#delete_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
922
- end
923
- return data, status_code, headers
924
- end
925
-
926
857
  # Deletes envelope custom fields in a template.
927
858
  # Deletes envelope custom fields in a template.
928
859
  # @param account_id The external account number (int) or account ID Guid.
@@ -2087,67 +2018,6 @@ module DocuSign_eSign
2087
2018
  return data, status_code, headers
2088
2019
  end
2089
2020
 
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
2021
  # Gets the custom document fields from a template.
2152
2022
  # Retrieves the custom document field information from an existing template.
2153
2023
  # @param account_id The external account number (int) or account ID Guid.