docusign_esign 3.21.0 → 3.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -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/envelopes_api.rb +123 -3
  6. data/lib/docusign_esign/api/templates_api.rb +0 -57
  7. data/lib/docusign_esign/client/api_client.rb +1 -1
  8. data/lib/docusign_esign/models/account_information.rb +2 -1
  9. data/lib/docusign_esign/models/account_role_settings.rb +2 -0
  10. data/lib/docusign_esign/models/account_settings_information.rb +103 -15
  11. data/lib/docusign_esign/models/account_shared_access.rb +1 -1
  12. data/lib/docusign_esign/models/account_signature.rb +1 -1
  13. data/lib/docusign_esign/models/account_ui_settings.rb +2 -0
  14. data/lib/docusign_esign/models/agent.rb +13 -3
  15. data/lib/docusign_esign/models/approve.rb +2 -1
  16. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  17. data/lib/docusign_esign/models/brand.rb +1 -1
  18. data/lib/docusign_esign/models/bulk_envelope.rb +1 -1
  19. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +2 -1
  20. data/lib/docusign_esign/models/bulksending_copy_doc_gen_form_field.rb +7 -7
  21. data/lib/docusign_esign/models/captive_recipient.rb +1 -1
  22. data/lib/docusign_esign/models/carbon_copy.rb +13 -3
  23. data/lib/docusign_esign/models/certified_delivery.rb +13 -3
  24. data/lib/docusign_esign/models/checkbox.rb +2 -1
  25. data/lib/docusign_esign/models/cloud_storage_provider.rb +1 -1
  26. data/lib/docusign_esign/models/comment_thread.rb +2 -1
  27. data/lib/docusign_esign/models/commission_county.rb +2 -1
  28. data/lib/docusign_esign/models/commission_expiration.rb +2 -1
  29. data/lib/docusign_esign/models/commission_number.rb +2 -1
  30. data/lib/docusign_esign/models/commission_state.rb +2 -1
  31. data/lib/docusign_esign/models/company.rb +2 -1
  32. data/lib/docusign_esign/models/connect_debug_log.rb +1 -1
  33. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +1 -0
  34. data/lib/docusign_esign/models/contact.rb +2 -1
  35. data/lib/docusign_esign/models/custom_field.rb +1 -1
  36. data/lib/docusign_esign/models/date.rb +2 -1
  37. data/lib/docusign_esign/models/date_signed.rb +2 -1
  38. data/lib/docusign_esign/models/decline.rb +2 -1
  39. data/lib/docusign_esign/models/delayed_routing.rb +1 -1
  40. data/lib/docusign_esign/models/delegation_info.rb +12 -12
  41. data/lib/docusign_esign/models/doc_gen_form_field_request.rb +186 -0
  42. data/lib/docusign_esign/models/doc_gen_form_field_response.rb +196 -0
  43. data/lib/docusign_esign/models/doc_gen_form_fields.rb +218 -0
  44. data/lib/docusign_esign/models/document_template.rb +1 -1
  45. data/lib/docusign_esign/models/document_visibility.rb +1 -1
  46. data/lib/docusign_esign/models/draw.rb +2 -1
  47. data/lib/docusign_esign/models/editor.rb +13 -3
  48. data/lib/docusign_esign/models/email.rb +2 -1
  49. data/lib/docusign_esign/models/email_address.rb +2 -1
  50. data/lib/docusign_esign/models/envelope.rb +2 -2
  51. data/lib/docusign_esign/models/envelope_attachment.rb +1 -1
  52. data/lib/docusign_esign/models/envelope_definition.rb +2 -2
  53. data/lib/docusign_esign/models/envelope_document.rb +1 -1
  54. data/lib/docusign_esign/models/envelope_id.rb +2 -1
  55. data/lib/docusign_esign/models/envelope_publish_transaction.rb +1 -0
  56. data/lib/docusign_esign/models/envelope_summary.rb +1 -1
  57. data/lib/docusign_esign/models/envelope_template.rb +2 -2
  58. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -1
  59. data/lib/docusign_esign/models/envelope_update_summary.rb +1 -1
  60. data/lib/docusign_esign/models/external_folder.rb +1 -1
  61. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -1
  62. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -1
  63. data/lib/docusign_esign/models/first_name.rb +2 -1
  64. data/lib/docusign_esign/models/folder.rb +1 -1
  65. data/lib/docusign_esign/models/folder_item_v2.rb +1 -1
  66. data/lib/docusign_esign/models/folder_shared_item.rb +1 -1
  67. data/lib/docusign_esign/models/form_data_item.rb +12 -2
  68. data/lib/docusign_esign/models/formula_tab.rb +2 -1
  69. data/lib/docusign_esign/models/full_name.rb +2 -1
  70. data/lib/docusign_esign/models/group.rb +1 -1
  71. data/lib/docusign_esign/models/in_person_signer.rb +13 -3
  72. data/lib/docusign_esign/models/initial_here.rb +3 -2
  73. data/lib/docusign_esign/models/inline_template.rb +2 -2
  74. data/lib/docusign_esign/models/intermediary.rb +13 -3
  75. data/lib/docusign_esign/models/last_name.rb +2 -1
  76. data/lib/docusign_esign/models/list.rb +2 -1
  77. data/lib/docusign_esign/models/list_custom_field.rb +1 -1
  78. data/lib/docusign_esign/models/lock_information.rb +1 -1
  79. data/lib/docusign_esign/models/member_group_shared_item.rb +1 -1
  80. data/lib/docusign_esign/models/member_shared_items.rb +1 -1
  81. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -1
  82. data/lib/docusign_esign/models/name_value.rb +1 -1
  83. data/lib/docusign_esign/models/new_account_definition.rb +2 -2
  84. data/lib/docusign_esign/models/new_user.rb +1 -1
  85. data/lib/docusign_esign/models/notarize.rb +2 -1
  86. data/lib/docusign_esign/models/notary_host.rb +13 -3
  87. data/lib/docusign_esign/models/notary_jurisdiction.rb +1 -1
  88. data/lib/docusign_esign/models/notary_recipient.rb +13 -3
  89. data/lib/docusign_esign/models/notary_seal.rb +2 -1
  90. data/lib/docusign_esign/models/note.rb +2 -1
  91. data/lib/docusign_esign/models/number.rb +2 -1
  92. data/lib/docusign_esign/models/numerical.rb +68 -1
  93. data/lib/docusign_esign/models/page.rb +1 -1
  94. data/lib/docusign_esign/models/participant.rb +33 -1
  95. data/lib/docusign_esign/models/phone_number.rb +2 -1
  96. data/lib/docusign_esign/models/poly_line_overlay.rb +2 -1
  97. data/lib/docusign_esign/models/power_form.rb +1 -1
  98. data/lib/docusign_esign/models/radio.rb +13 -2
  99. data/lib/docusign_esign/models/recipient_form_data.rb +12 -12
  100. data/lib/docusign_esign/models/recipient_update_response.rb +1 -1
  101. data/lib/docusign_esign/models/recipients.rb +1 -1
  102. data/lib/docusign_esign/models/scheduled_sending.rb +1 -1
  103. data/lib/docusign_esign/models/seal_sign.rb +13 -3
  104. data/lib/docusign_esign/models/sender_company.rb +2 -1
  105. data/lib/docusign_esign/models/sender_name.rb +2 -1
  106. data/lib/docusign_esign/models/shared_item.rb +1 -1
  107. data/lib/docusign_esign/models/sign_here.rb +2 -1
  108. data/lib/docusign_esign/models/signer.rb +13 -3
  109. data/lib/docusign_esign/models/signer_attachment.rb +2 -1
  110. data/lib/docusign_esign/models/signing_group.rb +1 -1
  111. data/lib/docusign_esign/models/signing_group_user.rb +1 -1
  112. data/lib/docusign_esign/models/smart_section.rb +4 -3
  113. data/lib/docusign_esign/models/social_account_information.rb +1 -1
  114. data/lib/docusign_esign/models/ssn.rb +2 -1
  115. data/lib/docusign_esign/models/stamp.rb +1 -1
  116. data/lib/docusign_esign/models/tab_account_settings.rb +21 -21
  117. data/lib/docusign_esign/models/tab_group.rb +2 -1
  118. data/lib/docusign_esign/models/tabs.rb +1 -13
  119. data/lib/docusign_esign/models/template_recipients.rb +1 -1
  120. data/lib/docusign_esign/models/template_role.rb +1 -1
  121. data/lib/docusign_esign/models/template_shared_item.rb +1 -1
  122. data/lib/docusign_esign/models/template_summary.rb +1 -1
  123. data/lib/docusign_esign/models/template_tabs.rb +1 -13
  124. data/lib/docusign_esign/models/template_update_summary.rb +1 -1
  125. data/lib/docusign_esign/models/text.rb +2 -1
  126. data/lib/docusign_esign/models/text_custom_field.rb +1 -1
  127. data/lib/docusign_esign/models/title.rb +2 -1
  128. data/lib/docusign_esign/models/user_account_management_granular_information.rb +2 -0
  129. data/lib/docusign_esign/models/user_info.rb +12 -2
  130. data/lib/docusign_esign/models/user_information.rb +2 -2
  131. data/lib/docusign_esign/models/user_settings_information.rb +2 -0
  132. data/lib/docusign_esign/models/user_shared_item.rb +1 -1
  133. data/lib/docusign_esign/models/user_signature.rb +1 -1
  134. data/lib/docusign_esign/models/view.rb +2 -1
  135. data/lib/docusign_esign/models/witness.rb +13 -3
  136. data/lib/docusign_esign/models/workspace_user.rb +1 -1
  137. data/lib/docusign_esign/models/workspace_user_authorization.rb +1 -1
  138. data/lib/docusign_esign/models/zip.rb +2 -1
  139. data/lib/docusign_esign/version.rb +1 -1
  140. data/lib/docusign_esign.rb +3 -2
  141. metadata +5 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2d87bcd4f4a605609fa81a94eba9ca07eaf48d975798ec98ece2bd8d65bbf502
4
- data.tar.gz: fe921298587fcfa02bae98fc4ddef4480981ec4fe8d4b2263401e906153d211c
3
+ metadata.gz: 66c42c585fce371eb5dc319f05d6d493f6a36bb9bcd23afe1537f7832817eed7
4
+ data.tar.gz: 0a2a90f1acf14622a7c0613edc9ce88f069e77e90d5273817813ec5a0284bcb5
5
5
  SHA512:
6
- metadata.gz: 0f074758ac67625662bf7d420b64c314dc07d7a75d19fb2eb3d135f89582023f562929eefe813cf491f575e722c88ff75e571bcf43e0fd4d6092fae7d882886f
7
- data.tar.gz: '09910623ccb46a5b49224835c2d4baaadc5e40b278c2d4c4502c0c9e2668a2504a4eae1ec55a2128201b2173cecbfcb44fd5677eb40edc472c3e3d841fdf245b'
6
+ metadata.gz: 8df425d194f9cc4ee111103f55fcafdb85eef61e5f5b0b1fbf6623d12352cfb96db6859f4819334186abda98ca0375fe8a247488395979d74274935860d79e62
7
+ data.tar.gz: 1d6f7256fa83053c2cb5d5036cb4fd8b323d333ec7fb0f3f458638bc049b6a1e1155ab535bafeedb2a3ff4f718fbd66c5353ca16f67d8cfaa7cbbbbdfb9182dd
data/CHANGELOG.md CHANGED
@@ -3,6 +3,11 @@ 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
+
6
11
  ## [v3.21.0] - eSignature API v2.1-22.4.02.00 - 2023-02-02
7
12
  ### Changed
8
13
  - Added support for version v2.1-22.4.02.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
@@ -80,7 +80,7 @@ module DocuSign_eSign
80
80
  end
81
81
 
82
82
  class GetConsumerDisclosureOptions
83
- # 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.
83
+ # 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.
84
84
  attr_accessor :lang_code2
85
85
 
86
86
  def self.default
@@ -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.
@@ -6568,6 +6630,64 @@ module DocuSign_eSign
6568
6630
  return data, status_code, headers
6569
6631
  end
6570
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
+
6571
6691
  # Updates the scheduled sending rules for an envelope's workflow definition.
6572
6692
  #
6573
6693
  # @param account_id The external account number (int) or account ID Guid.
@@ -854,63 +854,6 @@ module DocuSign_eSign
854
854
  return data, status_code, headers
855
855
  end
856
856
 
857
- # Deletes the bulk recipient list on a template.
858
- # Deletes the bulk recipient list on a template.
859
- # @param account_id The external account number (int) or account ID Guid.
860
- # @param recipient_id The ID of the recipient being accessed.
861
- # @param template_id The ID of the template being accessed.
862
- # @return [BulkRecipientsUpdateResponse]
863
- def delete_bulk_recipients(account_id, recipient_id, template_id)
864
- data, _status_code, _headers = delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id)
865
- return data
866
- end
867
-
868
- # Deletes the bulk recipient list on a template.
869
- # Deletes the bulk recipient list on a template.
870
- # @param account_id The external account number (int) or account ID Guid.
871
- # @param recipient_id The ID of the recipient being accessed.
872
- # @param template_id The ID of the template being accessed.
873
- # @return [Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>] BulkRecipientsUpdateResponse data, response status code and response headers
874
- def delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id)
875
- if @api_client.config.debugging
876
- @api_client.config.logger.debug "Calling API: TemplatesApi.delete_bulk_recipients ..."
877
- end
878
- # verify the required parameter 'account_id' is set
879
- fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_bulk_recipients" if account_id.nil?
880
- # verify the required parameter 'recipient_id' is set
881
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.delete_bulk_recipients" if recipient_id.nil?
882
- # verify the required parameter 'template_id' is set
883
- fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_bulk_recipients" if template_id.nil?
884
- # resource path
885
- 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)
886
-
887
- # query parameters
888
- query_params = {}
889
-
890
- # header parameters
891
- header_params = {}
892
- # HTTP header 'Accept' (if needed)
893
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
894
-
895
- # form parameters
896
- form_params = {}
897
-
898
- # http body (model)
899
- post_body = nil
900
- auth_names = []
901
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
902
- :header_params => header_params,
903
- :query_params => query_params,
904
- :form_params => form_params,
905
- :body => post_body,
906
- :auth_names => auth_names,
907
- :return_type => 'BulkRecipientsUpdateResponse')
908
- if @api_client.config.debugging
909
- @api_client.config.logger.debug "API called: TemplatesApi#delete_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
910
- end
911
- return data, status_code, headers
912
- end
913
-
914
857
  # Deletes envelope custom fields in a template.
915
858
  # Deletes envelope custom fields in a template.
916
859
  # @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.21.0/ruby"
38
+ @user_agent = "Swagger-Codegen/3.22.0/ruby"
39
39
  @default_headers = {
40
40
  'Content-Type' => "application/json",
41
41
  'User-Agent' => @user_agent
@@ -20,7 +20,7 @@ module DocuSign_eSign
20
20
  # The name of the current account.
21
21
  attr_accessor :account_name
22
22
 
23
- # The list of account settings accountsettings that determine the features available for the account. Note that some features are determined by the plan used to create the account and cannot be overridden.
23
+ # The list of account settings. These determine the features available for the account. Note that some features are determined by the plan used to create the account, and cannot be overridden.
24
24
  attr_accessor :account_settings
25
25
 
26
26
  # When set to **true**, the transaction rooms feature exposed through the Workspaces API is enabled.
@@ -44,6 +44,7 @@ module DocuSign_eSign
44
44
  # Reserved: TBD
45
45
  attr_accessor :billing_profile
46
46
 
47
+ #
47
48
  attr_accessor :brands
48
49
 
49
50
  # When set to **true**, specifies that you can upgrade the account through the API.
@@ -173,6 +173,7 @@ module DocuSign_eSign
173
173
  #
174
174
  attr_accessor :enable_key_terms_suggestions_by_document_type
175
175
 
176
+ #
176
177
  attr_accessor :enable_key_terms_suggestions_by_document_type_metadata
177
178
 
178
179
  #
@@ -247,6 +248,7 @@ module DocuSign_eSign
247
248
  #
248
249
  attr_accessor :web_forms
249
250
 
251
+ #
250
252
  attr_accessor :web_forms_metadata
251
253
 
252
254
  # Attribute mapping from ruby-style variable name to JSON key.