docusign_esign 3.18.0 → 3.20.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (309) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/lib/docusign_esign/api/accounts_api.rb +64 -64
  4. data/lib/docusign_esign/api/billing_api.rb +2 -2
  5. data/lib/docusign_esign/api/bulk_envelopes_api.rb +22 -22
  6. data/lib/docusign_esign/api/connect_api.rb +148 -0
  7. data/lib/docusign_esign/api/email_archive_api.rb +8 -8
  8. data/lib/docusign_esign/api/envelopes_api.rb +1226 -104
  9. data/lib/docusign_esign/api/notary_api.rb +16 -16
  10. data/lib/docusign_esign/api/power_forms_api.rb +16 -16
  11. data/lib/docusign_esign/api/templates_api.rb +20 -20
  12. data/lib/docusign_esign/api/users_api.rb +14 -14
  13. data/lib/docusign_esign/api/workspaces_api.rb +4 -4
  14. data/lib/docusign_esign/client/api_client.rb +1 -1
  15. data/lib/docusign_esign/models/access_code_format.rb +6 -0
  16. data/lib/docusign_esign/models/account_billing_plan.rb +1 -0
  17. data/lib/docusign_esign/models/account_billing_plan_response.rb +9 -0
  18. data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
  19. data/lib/docusign_esign/models/account_identity_verification_workflow.rb +13 -1
  20. data/lib/docusign_esign/models/account_information.rb +1 -0
  21. data/lib/docusign_esign/models/account_notification.rb +3 -0
  22. data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
  23. data/lib/docusign_esign/models/account_password_rules.rb +7 -0
  24. data/lib/docusign_esign/models/account_role_settings.rb +39 -0
  25. data/lib/docusign_esign/models/account_settings_information.rb +748 -5
  26. data/lib/docusign_esign/models/account_shared_access.rb +1 -0
  27. data/lib/docusign_esign/models/account_signature.rb +2 -0
  28. data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
  29. data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
  30. data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
  31. data/lib/docusign_esign/models/account_ui_settings.rb +35 -1
  32. data/lib/docusign_esign/models/address_information_input.rb +1 -0
  33. data/lib/docusign_esign/models/agent.rb +22 -0
  34. data/lib/docusign_esign/models/approve.rb +45 -0
  35. data/lib/docusign_esign/models/authentication_status.rb +19 -0
  36. data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
  37. data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
  38. data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
  39. data/lib/docusign_esign/models/billing_plan_information.rb +19 -1
  40. data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
  41. data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
  42. data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
  43. data/lib/docusign_esign/models/brand.rb +4 -0
  44. data/lib/docusign_esign/models/brand_email_content.rb +1 -0
  45. data/lib/docusign_esign/models/brand_link.rb +1 -0
  46. data/lib/docusign_esign/models/brand_logos.rb +1 -0
  47. data/lib/docusign_esign/models/brand_request.rb +1 -0
  48. data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
  49. data/lib/docusign_esign/models/brand_resources.rb +3 -0
  50. data/lib/docusign_esign/models/brands_request.rb +1 -0
  51. data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
  52. data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
  53. data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +1 -0
  54. data/lib/docusign_esign/models/bulk_send_batch_status.rb +2 -0
  55. data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +1 -0
  56. data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
  57. data/lib/docusign_esign/models/bulk_send_error_status.rb +1 -0
  58. data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
  59. data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
  60. data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
  61. data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
  62. data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
  63. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
  64. data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
  65. data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
  66. data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
  67. data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
  68. data/lib/docusign_esign/models/captive_recipient.rb +2 -0
  69. data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
  70. data/lib/docusign_esign/models/carbon_copy.rb +25 -0
  71. data/lib/docusign_esign/models/certified_delivery.rb +24 -0
  72. data/lib/docusign_esign/models/checkbox.rb +52 -39
  73. data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
  74. data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
  75. data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
  76. data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
  77. data/lib/docusign_esign/models/comment_thread.rb +43 -0
  78. data/lib/docusign_esign/models/commission_county.rb +52 -0
  79. data/lib/docusign_esign/models/commission_expiration.rb +52 -0
  80. data/lib/docusign_esign/models/commission_number.rb +52 -0
  81. data/lib/docusign_esign/models/commission_state.rb +52 -0
  82. data/lib/docusign_esign/models/company.rb +52 -0
  83. data/lib/docusign_esign/models/composite_template.rb +2 -0
  84. data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
  85. data/lib/docusign_esign/models/connect_config_results.rb +1 -0
  86. data/lib/docusign_esign/models/connect_custom_configuration.rb +13 -1
  87. data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
  88. data/lib/docusign_esign/models/connect_event_data.rb +1 -0
  89. data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
  90. data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
  91. data/lib/docusign_esign/models/connect_log.rb +1 -0
  92. data/lib/docusign_esign/models/connect_o_auth_config.rb +224 -0
  93. data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
  94. data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
  95. data/lib/docusign_esign/models/console_view_request.rb +1 -0
  96. data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
  97. data/lib/docusign_esign/models/contact.rb +1 -0
  98. data/lib/docusign_esign/models/contact_get_response.rb +1 -0
  99. data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
  100. data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
  101. data/lib/docusign_esign/models/contact_update_response.rb +1 -0
  102. data/lib/docusign_esign/models/correct_view_request.rb +12 -1
  103. data/lib/docusign_esign/models/credit_card_information.rb +2 -0
  104. data/lib/docusign_esign/models/currency.rb +55 -0
  105. data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
  106. data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
  107. data/lib/docusign_esign/models/custom_field.rb +2 -0
  108. data/lib/docusign_esign/models/date.rb +59 -0
  109. data/lib/docusign_esign/models/date_signed.rb +46 -0
  110. data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
  111. data/lib/docusign_esign/models/decline.rb +46 -0
  112. data/lib/docusign_esign/models/delayed_routing.rb +3 -3
  113. data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
  114. data/lib/docusign_esign/models/doc_gen_form_field.rb +224 -0
  115. data/lib/docusign_esign/models/doc_gen_syntax_error.rb +204 -0
  116. data/lib/docusign_esign/models/document.rb +26 -1
  117. data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
  118. data/lib/docusign_esign/models/document_html_definition.rb +1 -0
  119. data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
  120. data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
  121. data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
  122. data/lib/docusign_esign/models/document_template.rb +1 -0
  123. data/lib/docusign_esign/models/document_visibility.rb +2 -0
  124. data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
  125. data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
  126. data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
  127. data/lib/docusign_esign/models/draw.rb +40 -0
  128. data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
  129. data/lib/docusign_esign/models/editor.rb +23 -0
  130. data/lib/docusign_esign/models/email.rb +59 -0
  131. data/lib/docusign_esign/models/email_address.rb +46 -0
  132. data/lib/docusign_esign/models/envelope.rb +10 -0
  133. data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
  134. data/lib/docusign_esign/models/envelope_definition.rb +13 -0
  135. data/lib/docusign_esign/models/envelope_delay_rule.rb +3 -2
  136. data/lib/docusign_esign/models/envelope_document.rb +52 -1
  137. data/lib/docusign_esign/models/envelope_event.rb +1 -0
  138. data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
  139. data/lib/docusign_esign/models/envelope_id.rb +45 -0
  140. data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
  141. data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
  142. data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
  143. data/lib/docusign_esign/models/envelope_summary.rb +3 -0
  144. data/lib/docusign_esign/models/envelope_template.rb +23 -1
  145. data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
  146. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
  147. data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
  148. data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
  149. data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
  150. data/lib/docusign_esign/models/envelopes_information.rb +1 -0
  151. data/lib/docusign_esign/models/event_notification.rb +12 -1
  152. data/lib/docusign_esign/models/event_result.rb +1 -0
  153. data/lib/docusign_esign/models/external_document_sources.rb +6 -0
  154. data/lib/docusign_esign/models/external_file.rb +1 -0
  155. data/lib/docusign_esign/models/external_folder.rb +1 -0
  156. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
  157. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
  158. data/lib/docusign_esign/models/feature_set.rb +1 -0
  159. data/lib/docusign_esign/models/filter.rb +1 -0
  160. data/lib/docusign_esign/models/first_name.rb +46 -0
  161. data/lib/docusign_esign/models/folder.rb +4 -0
  162. data/lib/docusign_esign/models/folder_item_response.rb +1 -0
  163. data/lib/docusign_esign/models/folder_item_v2.rb +2 -0
  164. data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
  165. data/lib/docusign_esign/models/folders_request.rb +1 -0
  166. data/lib/docusign_esign/models/form_data_item.rb +1 -0
  167. data/lib/docusign_esign/models/formula_tab.rb +64 -0
  168. data/lib/docusign_esign/models/full_name.rb +46 -0
  169. data/lib/docusign_esign/models/group.rb +2 -0
  170. data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
  171. data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
  172. data/lib/docusign_esign/models/in_person_signer.rb +31 -0
  173. data/lib/docusign_esign/models/initial_here.rb +41 -1
  174. data/lib/docusign_esign/models/inline_template.rb +3 -0
  175. data/lib/docusign_esign/models/intermediary.rb +23 -0
  176. data/lib/docusign_esign/models/jurisdiction.rb +1 -0
  177. data/lib/docusign_esign/models/last_name.rb +46 -0
  178. data/lib/docusign_esign/models/linked_external_primary_account.rb +1 -0
  179. data/lib/docusign_esign/models/list.rb +54 -0
  180. data/lib/docusign_esign/models/list_custom_field.rb +2 -0
  181. data/lib/docusign_esign/models/list_item.rb +4 -0
  182. data/lib/docusign_esign/models/locale_policy.rb +13 -0
  183. data/lib/docusign_esign/models/lock_information.rb +2 -0
  184. data/lib/docusign_esign/models/lock_request.rb +1 -0
  185. data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
  186. data/lib/docusign_esign/models/member_shared_items.rb +3 -0
  187. data/lib/docusign_esign/models/merge_field.rb +6 -0
  188. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
  189. data/lib/docusign_esign/models/money.rb +1 -0
  190. data/lib/docusign_esign/models/name_value.rb +2 -0
  191. data/lib/docusign_esign/models/new_account_definition.rb +20 -1
  192. data/lib/docusign_esign/models/new_account_summary.rb +1 -0
  193. data/lib/docusign_esign/models/new_user.rb +2 -0
  194. data/lib/docusign_esign/models/new_users_summary.rb +1 -0
  195. data/lib/docusign_esign/models/notarize.rb +38 -0
  196. data/lib/docusign_esign/models/notary.rb +1 -0
  197. data/lib/docusign_esign/models/notary_host.rb +20 -0
  198. data/lib/docusign_esign/models/notary_journal.rb +2 -0
  199. data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
  200. data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
  201. data/lib/docusign_esign/models/notary_recipient.rb +29 -0
  202. data/lib/docusign_esign/models/notary_result.rb +2 -0
  203. data/lib/docusign_esign/models/notary_seal.rb +39 -0
  204. data/lib/docusign_esign/models/note.rb +47 -0
  205. data/lib/docusign_esign/models/notification.rb +2 -0
  206. data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
  207. data/lib/docusign_esign/models/notification_defaults.rb +2 -0
  208. data/lib/docusign_esign/models/number.rb +61 -0
  209. data/lib/docusign_esign/models/page.rb +1 -0
  210. data/lib/docusign_esign/models/payment_details.rb +5 -0
  211. data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
  212. data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
  213. data/lib/docusign_esign/models/payment_line_item.rb +1 -0
  214. data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
  215. data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
  216. data/lib/docusign_esign/models/permission_profile.rb +2 -0
  217. data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
  218. data/lib/docusign_esign/models/phone_number.rb +52 -0
  219. data/lib/docusign_esign/models/poly_line_overlay.rb +40 -0
  220. data/lib/docusign_esign/models/power_form.rb +2 -0
  221. data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
  222. data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
  223. data/lib/docusign_esign/models/power_forms_response.rb +1 -0
  224. data/lib/docusign_esign/models/prefill_tabs.rb +1 -0
  225. data/lib/docusign_esign/models/property_metadata.rb +1 -0
  226. data/lib/docusign_esign/models/radio.rb +28 -0
  227. data/lib/docusign_esign/models/radio_group.rb +17 -0
  228. data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
  229. data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
  230. data/lib/docusign_esign/models/recipient_group.rb +1 -0
  231. data/lib/docusign_esign/models/recipient_identity_phone_number.rb +3 -0
  232. data/lib/docusign_esign/models/recipient_identity_verification.rb +2 -0
  233. data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
  234. data/lib/docusign_esign/models/recipient_option.rb +1 -0
  235. data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
  236. data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
  237. data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
  238. data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
  239. data/lib/docusign_esign/models/recipient_routing.rb +2 -0
  240. data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
  241. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
  242. data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
  243. data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +30 -30
  244. data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
  245. data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
  246. data/lib/docusign_esign/models/recipients.rb +1 -0
  247. data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
  248. data/lib/docusign_esign/models/return_url_request.rb +1 -0
  249. data/lib/docusign_esign/models/scheduled_sending.rb +3 -3
  250. data/lib/docusign_esign/models/seal_sign.rb +17 -0
  251. data/lib/docusign_esign/models/seat_discount.rb +1 -0
  252. data/lib/docusign_esign/models/sender_company.rb +45 -0
  253. data/lib/docusign_esign/models/sender_email_notifications.rb +1 -0
  254. data/lib/docusign_esign/models/sender_name.rb +45 -0
  255. data/lib/docusign_esign/models/settings_metadata.rb +1 -0
  256. data/lib/docusign_esign/models/shared_item.rb +3 -0
  257. data/lib/docusign_esign/models/sign_here.rb +42 -0
  258. data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
  259. data/lib/docusign_esign/models/signature_type.rb +1 -0
  260. data/lib/docusign_esign/models/signer.rb +30 -0
  261. data/lib/docusign_esign/models/signer_attachment.rb +40 -0
  262. data/lib/docusign_esign/models/signing_group.rb +2 -0
  263. data/lib/docusign_esign/models/signing_group_user.rb +1 -0
  264. data/lib/docusign_esign/models/smart_section.rb +41 -0
  265. data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
  266. data/lib/docusign_esign/models/social_account_information.rb +1 -0
  267. data/lib/docusign_esign/models/ssn.rb +59 -0
  268. data/lib/docusign_esign/models/stamp.rb +2 -0
  269. data/lib/docusign_esign/models/supported_languages.rb +1 -0
  270. data/lib/docusign_esign/models/tab_account_settings.rb +22 -0
  271. data/lib/docusign_esign/models/tab_group.rb +41 -0
  272. data/lib/docusign_esign/models/tab_metadata.rb +14 -1
  273. data/lib/docusign_esign/models/tabs.rb +2 -0
  274. data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
  275. data/lib/docusign_esign/models/template_notification_request.rb +2 -0
  276. data/lib/docusign_esign/models/template_recipients.rb +1 -0
  277. data/lib/docusign_esign/models/template_role.rb +4 -0
  278. data/lib/docusign_esign/models/template_shared_item.rb +3 -0
  279. data/lib/docusign_esign/models/template_summary.rb +3 -0
  280. data/lib/docusign_esign/models/template_tabs.rb +1 -0
  281. data/lib/docusign_esign/models/template_update_summary.rb +4 -0
  282. data/lib/docusign_esign/models/text.rb +61 -0
  283. data/lib/docusign_esign/models/text_custom_field.rb +2 -0
  284. data/lib/docusign_esign/models/title.rb +52 -0
  285. data/lib/docusign_esign/models/user_account_management_granular_information.rb +12 -0
  286. data/lib/docusign_esign/models/user_info.rb +1 -0
  287. data/lib/docusign_esign/models/user_information.rb +6 -0
  288. data/lib/docusign_esign/models/user_information_list.rb +1 -0
  289. data/lib/docusign_esign/models/user_password_information.rb +1 -0
  290. data/lib/docusign_esign/models/user_password_rules.rb +2 -0
  291. data/lib/docusign_esign/models/user_profile.rb +3 -0
  292. data/lib/docusign_esign/models/user_settings_information.rb +61 -0
  293. data/lib/docusign_esign/models/user_shared_item.rb +3 -0
  294. data/lib/docusign_esign/models/user_signature.rb +2 -0
  295. data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
  296. data/lib/docusign_esign/models/view.rb +46 -0
  297. data/lib/docusign_esign/models/witness.rb +30 -0
  298. data/lib/docusign_esign/models/workflow.rb +2 -0
  299. data/lib/docusign_esign/models/workflow_step.rb +3 -0
  300. data/lib/docusign_esign/models/workspace.rb +4 -0
  301. data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
  302. data/lib/docusign_esign/models/workspace_item.rb +5 -0
  303. data/lib/docusign_esign/models/workspace_settings.rb +1 -0
  304. data/lib/docusign_esign/models/workspace_user.rb +1 -0
  305. data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
  306. data/lib/docusign_esign/models/zip.rb +60 -0
  307. data/lib/docusign_esign/version.rb +1 -1
  308. data/lib/docusign_esign.rb +3 -0
  309. metadata +9 -6
@@ -233,6 +233,9 @@ module DocuSign_eSign
233
233
  #
234
234
  attr_accessor :documents_by_userid
235
235
 
236
+ #
237
+ attr_accessor :include_docgen_formfields
238
+
236
239
  #
237
240
  attr_accessor :include_document_size
238
241
 
@@ -604,7 +607,7 @@ module DocuSign_eSign
604
607
  end
605
608
 
606
609
  # Initiate a new ChunkedUpload.
607
- #
610
+ # This method initiates a new chunked upload with the first part of the content.
608
611
  # @param account_id The external account number (int) or account ID Guid.
609
612
  # @param chunked_upload_request (optional parameter)
610
613
  # @return [ChunkedUploadResponse]
@@ -614,7 +617,7 @@ module DocuSign_eSign
614
617
  end
615
618
 
616
619
  # Initiate a new ChunkedUpload.
617
- #
620
+ # This method initiates a new chunked upload with the first part of the content.
618
621
  # @param account_id The external account number (int) or account ID Guid.
619
622
  # @param chunked_upload_request (optional parameter)
620
623
  # @return [Array<(ChunkedUploadResponse, Fixnum, Hash)>] ChunkedUploadResponse data, response status code and response headers
@@ -875,7 +878,7 @@ module DocuSign_eSign
875
878
  end
876
879
 
877
880
  # Get Responsive HTML Preview for a document in an envelope.
878
- #
881
+ # Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/) HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
879
882
  # @param account_id The external account number (int) or account ID Guid.
880
883
  # @param document_id The ID of the document being accessed.
881
884
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -887,7 +890,7 @@ module DocuSign_eSign
887
890
  end
888
891
 
889
892
  # Get Responsive HTML Preview for a document in an envelope.
890
- #
893
+ # Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/) HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
891
894
  # @param account_id The external account number (int) or account ID Guid.
892
895
  # @param document_id The ID of the document being accessed.
893
896
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -934,7 +937,7 @@ module DocuSign_eSign
934
937
  end
935
938
 
936
939
  # Adds the tabs to an envelope document
937
- #
940
+ # Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs), your request body might look like this: ``` { \"prefillTabs\": { \"textTabs\": [ { \"value\": \"a prefill text tab\", \"pageNumber\": \"1\", \"documentId\": \"1\", \"xPosition\": 316, \"yPosition\": 97 } ] } } ```
938
941
  # @param account_id The external account number (int) or account ID Guid.
939
942
  # @param document_id The ID of the document being accessed.
940
943
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -946,7 +949,7 @@ module DocuSign_eSign
946
949
  end
947
950
 
948
951
  # Adds the tabs to an envelope document
949
- #
952
+ # Adds tabs to the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs), your request body might look like this: &#x60;&#x60;&#x60; { \&quot;prefillTabs\&quot;: { \&quot;textTabs\&quot;: [ { \&quot;value\&quot;: \&quot;a prefill text tab\&quot;, \&quot;pageNumber\&quot;: \&quot;1\&quot;, \&quot;documentId\&quot;: \&quot;1\&quot;, \&quot;xPosition\&quot;: 316, \&quot;yPosition\&quot;: 97 } ] } } &#x60;&#x60;&#x60;
950
953
  # @param account_id The external account number (int) or account ID Guid.
951
954
  # @param document_id The ID of the document being accessed.
952
955
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -1216,7 +1219,7 @@ module DocuSign_eSign
1216
1219
  end
1217
1220
 
1218
1221
  # Provides a URL to start a recipient view of the Envelope UI
1219
- #
1222
+ # This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see [Preview and Send](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
1220
1223
  # @param account_id The external account number (int) or account ID Guid.
1221
1224
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1222
1225
  # @param recipient_preview_request (optional parameter)
@@ -1227,7 +1230,7 @@ module DocuSign_eSign
1227
1230
  end
1228
1231
 
1229
1232
  # Provides a URL to start a recipient view of the Envelope UI
1230
- #
1233
+ # This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients&#39; experience. For more information, see [Preview and Send](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
1231
1234
  # @param account_id The external account number (int) or account ID Guid.
1232
1235
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1233
1236
  # @param recipient_preview_request (optional parameter)
@@ -1271,7 +1274,7 @@ module DocuSign_eSign
1271
1274
  end
1272
1275
 
1273
1276
  # Provides a URL to start a shared recipient view of the Envelope UI
1274
- #
1277
+ # Returns a URL that enables you to embed the DocuSign UI recipient view of a [shared envelope](https://support.docusign.com/en/guides/ndse-admin-guide-share-envelopes) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/) - [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/) - [How to embed the DocuSign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)
1275
1278
  # @param account_id The external account number (int) or account ID Guid.
1276
1279
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1277
1280
  # @param recipient_view_request (optional parameter)
@@ -1282,7 +1285,7 @@ module DocuSign_eSign
1282
1285
  end
1283
1286
 
1284
1287
  # Provides a URL to start a shared recipient view of the Envelope UI
1285
- #
1288
+ # Returns a URL that enables you to embed the DocuSign UI recipient view of a [shared envelope](https://support.docusign.com/en/guides/ndse-admin-guide-share-envelopes) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an &#x60;&lt;iframe&gt;&#x60; for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/) - [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/) - [How to embed the DocuSign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)
1286
1289
  # @param account_id The external account number (int) or account ID Guid.
1287
1290
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1288
1291
  # @param recipient_view_request (optional parameter)
@@ -1326,7 +1329,7 @@ module DocuSign_eSign
1326
1329
  end
1327
1330
 
1328
1331
  # Add envelope transfer rules to an account.
1329
- #
1332
+ # This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` **Note:** Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
1330
1333
  # @param account_id The external account number (int) or account ID Guid.
1331
1334
  # @param envelope_transfer_rule_request (optional parameter)
1332
1335
  # @return [EnvelopeTransferRuleInformation]
@@ -1336,7 +1339,7 @@ module DocuSign_eSign
1336
1339
  end
1337
1340
 
1338
1341
  # Add envelope transfer rules to an account.
1339
- #
1342
+ # This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - &#x60;eventType&#x60; - &#x60;fromGroups&#x60; - &#x60;toUser&#x60; - &#x60;toFolder&#x60; - &#x60;carbonCopyOriginalOwner&#x60; - &#x60;enabled&#x60; **Note:** Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
1340
1343
  # @param account_id The external account number (int) or account ID Guid.
1341
1344
  # @param envelope_transfer_rule_request (optional parameter)
1342
1345
  # @return [Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>] EnvelopeTransferRuleInformation data, response status code and response headers
@@ -1376,6 +1379,61 @@ module DocuSign_eSign
1376
1379
  return data, status_code, headers
1377
1380
  end
1378
1381
 
1382
+ # Creates and adds a new workflow step definition for an envelope's workflow
1383
+ #
1384
+ # @param account_id The external account number (int) or account ID Guid.
1385
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1386
+ # @param workflow_step (optional parameter)
1387
+ # @return [WorkflowStep]
1388
+ def create_envelope_workflow_step_definition(account_id, envelope_id, workflow_step)
1389
+ data, _status_code, _headers = create_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step)
1390
+ return data
1391
+ end
1392
+
1393
+ # Creates and adds a new workflow step definition for an envelope&#39;s workflow
1394
+ #
1395
+ # @param account_id The external account number (int) or account ID Guid.
1396
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1397
+ # @param workflow_step (optional parameter)
1398
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
1399
+ def create_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step)
1400
+ if @api_client.config.debugging
1401
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_workflow_step_definition ..."
1402
+ end
1403
+ # verify the required parameter 'account_id' is set
1404
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_workflow_step_definition" if account_id.nil?
1405
+ # verify the required parameter 'envelope_id' is set
1406
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_envelope_workflow_step_definition" if envelope_id.nil?
1407
+ # resource path
1408
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1409
+
1410
+ # query parameters
1411
+ query_params = {}
1412
+
1413
+ # header parameters
1414
+ header_params = {}
1415
+ # HTTP header 'Accept' (if needed)
1416
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1417
+
1418
+ # form parameters
1419
+ form_params = {}
1420
+
1421
+ # http body (model)
1422
+ post_body = @api_client.object_to_http_body(workflow_step)
1423
+ auth_names = []
1424
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1425
+ :header_params => header_params,
1426
+ :query_params => query_params,
1427
+ :form_params => form_params,
1428
+ :body => post_body,
1429
+ :auth_names => auth_names,
1430
+ :return_type => 'WorkflowStep')
1431
+ if @api_client.config.debugging
1432
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1433
+ end
1434
+ return data, status_code, headers
1435
+ end
1436
+
1379
1437
  # Submits a batch of historical envelopes for republish to an adhoc config.
1380
1438
  #
1381
1439
  # @param account_id The external account number (int) or account ID Guid.
@@ -1541,7 +1599,7 @@ module DocuSign_eSign
1541
1599
  end
1542
1600
 
1543
1601
  # Provides a link to access the Identity manual review related to a recipient.
1544
- #
1602
+ # This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.
1545
1603
  # @param account_id The external account number (int) or account ID Guid.
1546
1604
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1547
1605
  # @param recipient_id The ID of the recipient being accessed.
@@ -1552,7 +1610,7 @@ module DocuSign_eSign
1552
1610
  end
1553
1611
 
1554
1612
  # Provides a link to access the Identity manual review related to a recipient.
1555
- #
1613
+ # This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.
1556
1614
  # @param account_id The external account number (int) or account ID Guid.
1557
1615
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1558
1616
  # @param recipient_id The ID of the recipient being accessed.
@@ -1655,7 +1713,7 @@ module DocuSign_eSign
1655
1713
  end
1656
1714
 
1657
1715
  # Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
1658
- #
1716
+ # Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).
1659
1717
  # @param account_id The external account number (int) or account ID Guid.
1660
1718
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1661
1719
  # @param recipient_id The ID of the recipient being accessed.
@@ -1667,7 +1725,7 @@ module DocuSign_eSign
1667
1725
  end
1668
1726
 
1669
1727
  # Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
1670
- #
1728
+ # Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).
1671
1729
  # @param account_id The external account number (int) or account ID Guid.
1672
1730
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1673
1731
  # @param recipient_id The ID of the recipient being accessed.
@@ -1771,7 +1829,7 @@ module DocuSign_eSign
1771
1829
  end
1772
1830
 
1773
1831
  # Get Responsive HTML Preview for all documents in an envelope.
1774
- #
1832
+ # Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
1775
1833
  # @param account_id The external account number (int) or account ID Guid.
1776
1834
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1777
1835
  # @param document_html_definition (optional parameter)
@@ -1782,7 +1840,7 @@ module DocuSign_eSign
1782
1840
  end
1783
1841
 
1784
1842
  # Get Responsive HTML Preview for all documents in an envelope.
1785
- #
1843
+ # Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
1786
1844
  # @param account_id The external account number (int) or account ID Guid.
1787
1845
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1788
1846
  # @param document_html_definition (optional parameter)
@@ -1939,9 +1997,64 @@ module DocuSign_eSign
1939
1997
  return data, status_code, headers
1940
1998
  end
1941
1999
 
1942
- # Delete one or more attachments from a DRAFT envelope.
2000
+ # Creates and adds a new workflow step definition for a template's workflow
2001
+ #
2002
+ # @param account_id The external account number (int) or account ID Guid.
2003
+ # @param template_id The ID of the template being accessed.
2004
+ # @param workflow_step (optional parameter)
2005
+ # @return [WorkflowStep]
2006
+ def create_template_workflow_step_definition(account_id, template_id, workflow_step)
2007
+ data, _status_code, _headers = create_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step)
2008
+ return data
2009
+ end
2010
+
2011
+ # Creates and adds a new workflow step definition for a template&#39;s workflow
1943
2012
  #
1944
2013
  # @param account_id The external account number (int) or account ID Guid.
2014
+ # @param template_id The ID of the template being accessed.
2015
+ # @param workflow_step (optional parameter)
2016
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
2017
+ def create_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step)
2018
+ if @api_client.config.debugging
2019
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_template_workflow_step_definition ..."
2020
+ end
2021
+ # verify the required parameter 'account_id' is set
2022
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_template_workflow_step_definition" if account_id.nil?
2023
+ # verify the required parameter 'template_id' is set
2024
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.create_template_workflow_step_definition" if template_id.nil?
2025
+ # resource path
2026
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
2027
+
2028
+ # query parameters
2029
+ query_params = {}
2030
+
2031
+ # header parameters
2032
+ header_params = {}
2033
+ # HTTP header 'Accept' (if needed)
2034
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2035
+
2036
+ # form parameters
2037
+ form_params = {}
2038
+
2039
+ # http body (model)
2040
+ post_body = @api_client.object_to_http_body(workflow_step)
2041
+ auth_names = []
2042
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2043
+ :header_params => header_params,
2044
+ :query_params => query_params,
2045
+ :form_params => form_params,
2046
+ :body => post_body,
2047
+ :auth_names => auth_names,
2048
+ :return_type => 'WorkflowStep')
2049
+ if @api_client.config.debugging
2050
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2051
+ end
2052
+ return data, status_code, headers
2053
+ end
2054
+
2055
+ # Delete one or more attachments from a DRAFT envelope.
2056
+ # Deletes one or more attachments from a draft envelope.
2057
+ # @param account_id The external account number (int) or account ID Guid.
1945
2058
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1946
2059
  # @param envelope_attachments_request (optional parameter)
1947
2060
  # @return [EnvelopeAttachmentsResult]
@@ -1951,7 +2064,7 @@ module DocuSign_eSign
1951
2064
  end
1952
2065
 
1953
2066
  # Delete one or more attachments from a DRAFT envelope.
1954
- #
2067
+ # Deletes one or more attachments from a draft envelope.
1955
2068
  # @param account_id The external account number (int) or account ID Guid.
1956
2069
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1957
2070
  # @param envelope_attachments_request (optional parameter)
@@ -1995,7 +2108,7 @@ module DocuSign_eSign
1995
2108
  end
1996
2109
 
1997
2110
  # Delete an existing ChunkedUpload.
1998
- #
2111
+ # Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. **Note:** If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.
1999
2112
  # @param account_id The external account number (int) or account ID Guid.
2000
2113
  # @param chunked_upload_id
2001
2114
  # @return [ChunkedUploadResponse]
@@ -2005,7 +2118,7 @@ module DocuSign_eSign
2005
2118
  end
2006
2119
 
2007
2120
  # Delete an existing ChunkedUpload.
2008
- #
2121
+ # Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. **Note:** If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.
2009
2122
  # @param account_id The external account number (int) or account ID Guid.
2010
2123
  # @param chunked_upload_id
2011
2124
  # @return [Array<(ChunkedUploadResponse, Fixnum, Hash)>] ChunkedUploadResponse data, response status code and response headers
@@ -2222,7 +2335,7 @@ module DocuSign_eSign
2222
2335
  end
2223
2336
 
2224
2337
  # Deletes tabs from an envelope document
2225
- #
2338
+ # Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.
2226
2339
  # @param account_id The external account number (int) or account ID Guid.
2227
2340
  # @param document_id The ID of the document being accessed.
2228
2341
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2234,7 +2347,7 @@ module DocuSign_eSign
2234
2347
  end
2235
2348
 
2236
2349
  # Deletes tabs from an envelope document
2237
- #
2350
+ # Deletes tabs from the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.
2238
2351
  # @param account_id The external account number (int) or account ID Guid.
2239
2352
  # @param document_id The ID of the document being accessed.
2240
2353
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2389,7 +2502,7 @@ module DocuSign_eSign
2389
2502
  end
2390
2503
 
2391
2504
  # Revokes the correction view URL to the Envelope UI
2392
- #
2505
+ # Revokes the correction view URL to the Envelope UI.
2393
2506
  # @param account_id The external account number (int) or account ID Guid.
2394
2507
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2395
2508
  # @param correct_view_request (optional parameter)
@@ -2400,7 +2513,7 @@ module DocuSign_eSign
2400
2513
  end
2401
2514
 
2402
2515
  # Revokes the correction view URL to the Envelope UI
2403
- #
2516
+ # Revokes the correction view URL to the Envelope UI.
2404
2517
  # @param account_id The external account number (int) or account ID Guid.
2405
2518
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2406
2519
  # @param correct_view_request (optional parameter)
@@ -2442,9 +2555,117 @@ module DocuSign_eSign
2442
2555
  return data, status_code, headers
2443
2556
  end
2444
2557
 
2445
- # Delete envelope transfer rules for an account.
2558
+ # Deletes the delayed routing rules for the specified envelope workflow step.
2559
+ #
2560
+ # @param account_id The external account number (int) or account ID Guid.
2561
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2562
+ # @param workflow_step_id
2563
+ # @return [nil]
2564
+ def delete_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id)
2565
+ delete_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id)
2566
+ return nil
2567
+ end
2568
+
2569
+ # Deletes the delayed routing rules for the specified envelope workflow step.
2570
+ #
2571
+ # @param account_id The external account number (int) or account ID Guid.
2572
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2573
+ # @param workflow_step_id
2574
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2575
+ def delete_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id)
2576
+ if @api_client.config.debugging
2577
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_delayed_routing_definition ..."
2578
+ end
2579
+ # verify the required parameter 'account_id' is set
2580
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_delayed_routing_definition" if account_id.nil?
2581
+ # verify the required parameter 'envelope_id' is set
2582
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_delayed_routing_definition" if envelope_id.nil?
2583
+ # verify the required parameter 'workflow_step_id' is set
2584
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_envelope_delayed_routing_definition" if workflow_step_id.nil?
2585
+ # resource path
2586
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
2587
+
2588
+ # query parameters
2589
+ query_params = {}
2590
+
2591
+ # header parameters
2592
+ header_params = {}
2593
+ # HTTP header 'Accept' (if needed)
2594
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2595
+
2596
+ # form parameters
2597
+ form_params = {}
2598
+
2599
+ # http body (model)
2600
+ post_body = nil
2601
+ auth_names = []
2602
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2603
+ :header_params => header_params,
2604
+ :query_params => query_params,
2605
+ :form_params => form_params,
2606
+ :body => post_body,
2607
+ :auth_names => auth_names)
2608
+ if @api_client.config.debugging
2609
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2610
+ end
2611
+ return data, status_code, headers
2612
+ end
2613
+
2614
+ # Deletes the scheduled sending rules for the envelope's workflow.
2615
+ #
2616
+ # @param account_id The external account number (int) or account ID Guid.
2617
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2618
+ # @return [nil]
2619
+ def delete_envelope_scheduled_sending_definition(account_id, envelope_id)
2620
+ delete_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id)
2621
+ return nil
2622
+ end
2623
+
2624
+ # Deletes the scheduled sending rules for the envelope&#39;s workflow.
2446
2625
  #
2447
2626
  # @param account_id The external account number (int) or account ID Guid.
2627
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2628
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2629
+ def delete_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id)
2630
+ if @api_client.config.debugging
2631
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_scheduled_sending_definition ..."
2632
+ end
2633
+ # verify the required parameter 'account_id' is set
2634
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_scheduled_sending_definition" if account_id.nil?
2635
+ # verify the required parameter 'envelope_id' is set
2636
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_scheduled_sending_definition" if envelope_id.nil?
2637
+ # resource path
2638
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2639
+
2640
+ # query parameters
2641
+ query_params = {}
2642
+
2643
+ # header parameters
2644
+ header_params = {}
2645
+ # HTTP header 'Accept' (if needed)
2646
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2647
+
2648
+ # form parameters
2649
+ form_params = {}
2650
+
2651
+ # http body (model)
2652
+ post_body = nil
2653
+ auth_names = []
2654
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2655
+ :header_params => header_params,
2656
+ :query_params => query_params,
2657
+ :form_params => form_params,
2658
+ :body => post_body,
2659
+ :auth_names => auth_names)
2660
+ if @api_client.config.debugging
2661
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2662
+ end
2663
+ return data, status_code, headers
2664
+ end
2665
+
2666
+ # Delete envelope transfer rules for an account.
2667
+ # This method deletes an envelope transfer rule. **Note:** Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
2668
+ # @param account_id The external account number (int) or account ID Guid.
2448
2669
  # @param envelope_transfer_rule_id
2449
2670
  # @return [nil]
2450
2671
  def delete_envelope_transfer_rules(account_id, envelope_transfer_rule_id)
@@ -2453,7 +2674,7 @@ module DocuSign_eSign
2453
2674
  end
2454
2675
 
2455
2676
  # Delete envelope transfer rules for an account.
2456
- #
2677
+ # This method deletes an envelope transfer rule. **Note:** Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
2457
2678
  # @param account_id The external account number (int) or account ID Guid.
2458
2679
  # @param envelope_transfer_rule_id
2459
2680
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -2495,7 +2716,7 @@ module DocuSign_eSign
2495
2716
  end
2496
2717
 
2497
2718
  # Delete the workflow definition for an envelope.
2498
- #
2719
+ # Deletes the specified envelope's workflow definition if it has one.
2499
2720
  # @param account_id The external account number (int) or account ID Guid.
2500
2721
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2501
2722
  # @return [nil]
@@ -2505,7 +2726,7 @@ module DocuSign_eSign
2505
2726
  end
2506
2727
 
2507
2728
  # Delete the workflow definition for an envelope.
2508
- #
2729
+ # Deletes the specified envelope&#39;s workflow definition if it has one.
2509
2730
  # @param account_id The external account number (int) or account ID Guid.
2510
2731
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2511
2732
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -2546,6 +2767,62 @@ module DocuSign_eSign
2546
2767
  return data, status_code, headers
2547
2768
  end
2548
2769
 
2770
+ # Deletes the envelope workflow step definition for an envelope's workflow by step id.
2771
+ #
2772
+ # @param account_id The external account number (int) or account ID Guid.
2773
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2774
+ # @param workflow_step_id
2775
+ # @return [nil]
2776
+ def delete_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id)
2777
+ delete_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id)
2778
+ return nil
2779
+ end
2780
+
2781
+ # Deletes the envelope workflow step definition for an envelope&#39;s workflow by step id.
2782
+ #
2783
+ # @param account_id The external account number (int) or account ID Guid.
2784
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2785
+ # @param workflow_step_id
2786
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2787
+ def delete_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id)
2788
+ if @api_client.config.debugging
2789
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_workflow_step_definition ..."
2790
+ end
2791
+ # verify the required parameter 'account_id' is set
2792
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_workflow_step_definition" if account_id.nil?
2793
+ # verify the required parameter 'envelope_id' is set
2794
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_workflow_step_definition" if envelope_id.nil?
2795
+ # verify the required parameter 'workflow_step_id' is set
2796
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_envelope_workflow_step_definition" if workflow_step_id.nil?
2797
+ # resource path
2798
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
2799
+
2800
+ # query parameters
2801
+ query_params = {}
2802
+
2803
+ # header parameters
2804
+ header_params = {}
2805
+ # HTTP header 'Accept' (if needed)
2806
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2807
+
2808
+ # form parameters
2809
+ form_params = {}
2810
+
2811
+ # http body (model)
2812
+ post_body = nil
2813
+ auth_names = []
2814
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2815
+ :header_params => header_params,
2816
+ :query_params => query_params,
2817
+ :form_params => form_params,
2818
+ :body => post_body,
2819
+ :auth_names => auth_names)
2820
+ if @api_client.config.debugging
2821
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2822
+ end
2823
+ return data, status_code, headers
2824
+ end
2825
+
2549
2826
  # Deletes an envelope lock.
2550
2827
  # Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
2551
2828
  # @param account_id The external account number (int) or account ID Guid.
@@ -2770,31 +3047,35 @@ module DocuSign_eSign
2770
3047
  return data, status_code, headers
2771
3048
  end
2772
3049
 
2773
- # Delete the workflow definition for a template.
3050
+ # Deletes the delayed routing rules for the specified template workflow step.
2774
3051
  #
2775
3052
  # @param account_id The external account number (int) or account ID Guid.
2776
3053
  # @param template_id The ID of the template being accessed.
3054
+ # @param workflow_step_id
2777
3055
  # @return [nil]
2778
- def delete_template_workflow_definition(account_id, template_id)
2779
- delete_template_workflow_definition_with_http_info(account_id, template_id)
3056
+ def delete_template_delayed_routing_definition(account_id, template_id, workflow_step_id)
3057
+ delete_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id)
2780
3058
  return nil
2781
3059
  end
2782
3060
 
2783
- # Delete the workflow definition for a template.
3061
+ # Deletes the delayed routing rules for the specified template workflow step.
2784
3062
  #
2785
3063
  # @param account_id The external account number (int) or account ID Guid.
2786
3064
  # @param template_id The ID of the template being accessed.
3065
+ # @param workflow_step_id
2787
3066
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2788
- def delete_template_workflow_definition_with_http_info(account_id, template_id)
3067
+ def delete_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id)
2789
3068
  if @api_client.config.debugging
2790
- @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_workflow_definition ..."
3069
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_delayed_routing_definition ..."
2791
3070
  end
2792
3071
  # verify the required parameter 'account_id' is set
2793
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_workflow_definition" if account_id.nil?
3072
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_delayed_routing_definition" if account_id.nil?
2794
3073
  # verify the required parameter 'template_id' is set
2795
- fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_workflow_definition" if template_id.nil?
3074
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_delayed_routing_definition" if template_id.nil?
3075
+ # verify the required parameter 'workflow_step_id' is set
3076
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_template_delayed_routing_definition" if workflow_step_id.nil?
2796
3077
  # resource path
2797
- local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
3078
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
2798
3079
 
2799
3080
  # query parameters
2800
3081
  query_params = {}
@@ -2817,25 +3098,185 @@ module DocuSign_eSign
2817
3098
  :body => post_body,
2818
3099
  :auth_names => auth_names)
2819
3100
  if @api_client.config.debugging
2820
- @api_client.config.logger.debug "API called: EnvelopesApi#delete_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3101
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_template_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2821
3102
  end
2822
3103
  return data, status_code, headers
2823
3104
  end
2824
3105
 
2825
- # Deletes a template from a document in an existing envelope.
2826
- # Deletes the specified template from a document in an existing envelope.
3106
+ # Deletes the scheduled sending rules for the template's workflow.
3107
+ #
2827
3108
  # @param account_id The external account number (int) or account ID Guid.
2828
- # @param document_id The ID of the document being accessed.
2829
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
2830
3109
  # @param template_id The ID of the template being accessed.
2831
3110
  # @return [nil]
2832
- def delete_templates_from_document(account_id, document_id, envelope_id, template_id)
2833
- delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id)
3111
+ def delete_template_scheduled_sending_definition(account_id, template_id)
3112
+ delete_template_scheduled_sending_definition_with_http_info(account_id, template_id)
2834
3113
  return nil
2835
3114
  end
2836
3115
 
2837
- # Deletes a template from a document in an existing envelope.
2838
- # Deletes the specified template from a document in an existing envelope.
3116
+ # Deletes the scheduled sending rules for the template&#39;s workflow.
3117
+ #
3118
+ # @param account_id The external account number (int) or account ID Guid.
3119
+ # @param template_id The ID of the template being accessed.
3120
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3121
+ def delete_template_scheduled_sending_definition_with_http_info(account_id, template_id)
3122
+ if @api_client.config.debugging
3123
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_scheduled_sending_definition ..."
3124
+ end
3125
+ # verify the required parameter 'account_id' is set
3126
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_scheduled_sending_definition" if account_id.nil?
3127
+ # verify the required parameter 'template_id' is set
3128
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_scheduled_sending_definition" if template_id.nil?
3129
+ # resource path
3130
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
3131
+
3132
+ # query parameters
3133
+ query_params = {}
3134
+
3135
+ # header parameters
3136
+ header_params = {}
3137
+ # HTTP header 'Accept' (if needed)
3138
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3139
+
3140
+ # form parameters
3141
+ form_params = {}
3142
+
3143
+ # http body (model)
3144
+ post_body = nil
3145
+ auth_names = []
3146
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3147
+ :header_params => header_params,
3148
+ :query_params => query_params,
3149
+ :form_params => form_params,
3150
+ :body => post_body,
3151
+ :auth_names => auth_names)
3152
+ if @api_client.config.debugging
3153
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_template_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3154
+ end
3155
+ return data, status_code, headers
3156
+ end
3157
+
3158
+ # Delete the workflow definition for a template.
3159
+ # Deletes the specified template's workflow definition if it has one.
3160
+ # @param account_id The external account number (int) or account ID Guid.
3161
+ # @param template_id The ID of the template being accessed.
3162
+ # @return [nil]
3163
+ def delete_template_workflow_definition(account_id, template_id)
3164
+ delete_template_workflow_definition_with_http_info(account_id, template_id)
3165
+ return nil
3166
+ end
3167
+
3168
+ # Delete the workflow definition for a template.
3169
+ # Deletes the specified template&#39;s workflow definition if it has one.
3170
+ # @param account_id The external account number (int) or account ID Guid.
3171
+ # @param template_id The ID of the template being accessed.
3172
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3173
+ def delete_template_workflow_definition_with_http_info(account_id, template_id)
3174
+ if @api_client.config.debugging
3175
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_workflow_definition ..."
3176
+ end
3177
+ # verify the required parameter 'account_id' is set
3178
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_workflow_definition" if account_id.nil?
3179
+ # verify the required parameter 'template_id' is set
3180
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_workflow_definition" if template_id.nil?
3181
+ # resource path
3182
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
3183
+
3184
+ # query parameters
3185
+ query_params = {}
3186
+
3187
+ # header parameters
3188
+ header_params = {}
3189
+ # HTTP header 'Accept' (if needed)
3190
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3191
+
3192
+ # form parameters
3193
+ form_params = {}
3194
+
3195
+ # http body (model)
3196
+ post_body = nil
3197
+ auth_names = []
3198
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3199
+ :header_params => header_params,
3200
+ :query_params => query_params,
3201
+ :form_params => form_params,
3202
+ :body => post_body,
3203
+ :auth_names => auth_names)
3204
+ if @api_client.config.debugging
3205
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3206
+ end
3207
+ return data, status_code, headers
3208
+ end
3209
+
3210
+ # Deletes the workflow step definition for an template's workflow by step id.
3211
+ #
3212
+ # @param account_id The external account number (int) or account ID Guid.
3213
+ # @param template_id The ID of the template being accessed.
3214
+ # @param workflow_step_id
3215
+ # @return [nil]
3216
+ def delete_template_workflow_step_definition(account_id, template_id, workflow_step_id)
3217
+ delete_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id)
3218
+ return nil
3219
+ end
3220
+
3221
+ # Deletes the workflow step definition for an template&#39;s workflow by step id.
3222
+ #
3223
+ # @param account_id The external account number (int) or account ID Guid.
3224
+ # @param template_id The ID of the template being accessed.
3225
+ # @param workflow_step_id
3226
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3227
+ def delete_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id)
3228
+ if @api_client.config.debugging
3229
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_workflow_step_definition ..."
3230
+ end
3231
+ # verify the required parameter 'account_id' is set
3232
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_workflow_step_definition" if account_id.nil?
3233
+ # verify the required parameter 'template_id' is set
3234
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_workflow_step_definition" if template_id.nil?
3235
+ # verify the required parameter 'workflow_step_id' is set
3236
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_template_workflow_step_definition" if workflow_step_id.nil?
3237
+ # resource path
3238
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
3239
+
3240
+ # query parameters
3241
+ query_params = {}
3242
+
3243
+ # header parameters
3244
+ header_params = {}
3245
+ # HTTP header 'Accept' (if needed)
3246
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3247
+
3248
+ # form parameters
3249
+ form_params = {}
3250
+
3251
+ # http body (model)
3252
+ post_body = nil
3253
+ auth_names = []
3254
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3255
+ :header_params => header_params,
3256
+ :query_params => query_params,
3257
+ :form_params => form_params,
3258
+ :body => post_body,
3259
+ :auth_names => auth_names)
3260
+ if @api_client.config.debugging
3261
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3262
+ end
3263
+ return data, status_code, headers
3264
+ end
3265
+
3266
+ # Deletes a template from a document in an existing envelope.
3267
+ # Deletes the specified template from a document in an existing envelope.
3268
+ # @param account_id The external account number (int) or account ID Guid.
3269
+ # @param document_id The ID of the document being accessed.
3270
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3271
+ # @param template_id The ID of the template being accessed.
3272
+ # @return [nil]
3273
+ def delete_templates_from_document(account_id, document_id, envelope_id, template_id)
3274
+ delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id)
3275
+ return nil
3276
+ end
3277
+
3278
+ # Deletes a template from a document in an existing envelope.
3279
+ # Deletes the specified template from a document in an existing envelope.
2839
3280
  # @param account_id The external account number (int) or account ID Guid.
2840
3281
  # @param document_id The ID of the document being accessed.
2841
3282
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2883,7 +3324,7 @@ module DocuSign_eSign
2883
3324
  end
2884
3325
 
2885
3326
  # Retrieves an attachment from the envelope.
2886
- #
3327
+ # Retrieves an attachment from an envelope.
2887
3328
  # @param account_id The external account number (int) or account ID Guid.
2888
3329
  # @param attachment_id
2889
3330
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2894,7 +3335,7 @@ module DocuSign_eSign
2894
3335
  end
2895
3336
 
2896
3337
  # Retrieves an attachment from the envelope.
2897
- #
3338
+ # Retrieves an attachment from an envelope.
2898
3339
  # @param account_id The external account number (int) or account ID Guid.
2899
3340
  # @param attachment_id
2900
3341
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2939,7 +3380,7 @@ module DocuSign_eSign
2939
3380
  end
2940
3381
 
2941
3382
  # Returns a list of attachments associated with the specified envelope
2942
- #
3383
+ # Returns a list of attachments associated with a specified envelope
2943
3384
  # @param account_id The external account number (int) or account ID Guid.
2944
3385
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2945
3386
  # @return [EnvelopeAttachmentsResult]
@@ -2949,7 +3390,7 @@ module DocuSign_eSign
2949
3390
  end
2950
3391
 
2951
3392
  # Returns a list of attachments associated with the specified envelope
2952
- #
3393
+ # Returns a list of attachments associated with a specified envelope
2953
3394
  # @param account_id The external account number (int) or account ID Guid.
2954
3395
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2955
3396
  # @return [Array<(EnvelopeAttachmentsResult, Fixnum, Hash)>] EnvelopeAttachmentsResult data, response status code and response headers
@@ -2992,7 +3433,7 @@ module DocuSign_eSign
2992
3433
  end
2993
3434
 
2994
3435
  # Retrieves the current metadata of a ChunkedUpload.
2995
- #
3436
+ # Returns the details (but not the content) about a chunked upload. **Note:** You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
2996
3437
  # @param account_id The external account number (int) or account ID Guid.
2997
3438
  # @param chunked_upload_id
2998
3439
  # @param DocuSign_eSign::GetChunkedUploadOptions Options for modifying the behavior of the function.
@@ -3003,7 +3444,7 @@ module DocuSign_eSign
3003
3444
  end
3004
3445
 
3005
3446
  # Retrieves the current metadata of a ChunkedUpload.
3006
- #
3447
+ # Returns the details (but not the content) about a chunked upload. **Note:** You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
3007
3448
  # @param account_id The external account number (int) or account ID Guid.
3008
3449
  # @param chunked_upload_id
3009
3450
  # @param DocuSign_eSign::GetChunkedUploadOptions Options for modifying the behavior of the function.
@@ -3048,7 +3489,7 @@ module DocuSign_eSign
3048
3489
  end
3049
3490
 
3050
3491
  # Gets comment transcript for envelope and user
3051
- #
3492
+ # Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. **Note:** Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**).
3052
3493
  # @param account_id The external account number (int) or account ID Guid.
3053
3494
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3054
3495
  # @param DocuSign_eSign::GetCommentsTranscriptOptions Options for modifying the behavior of the function.
@@ -3059,7 +3500,7 @@ module DocuSign_eSign
3059
3500
  end
3060
3501
 
3061
3502
  # Gets comment transcript for envelope and user
3062
- #
3503
+ # Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. **Note:** Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the &#x60;accountSettingsInformation&#x60; object, set the &#x60;enableSigningExtensionComments&#x60; property to **true**).
3063
3504
  # @param account_id The external account number (int) or account ID Guid.
3064
3505
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3065
3506
  # @param DocuSign_eSign::GetCommentsTranscriptOptions Options for modifying the behavior of the function.
@@ -3107,7 +3548,7 @@ module DocuSign_eSign
3107
3548
  # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
3108
3549
  # @param account_id The external account number (int) or account ID Guid.
3109
3550
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3110
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3551
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3111
3552
  # @param recipient_id The ID of the recipient being accessed.
3112
3553
  # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
3113
3554
  # @return [ConsumerDisclosure]
@@ -3120,7 +3561,7 @@ module DocuSign_eSign
3120
3561
  # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
3121
3562
  # @param account_id The external account number (int) or account ID Guid.
3122
3563
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3123
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3564
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3124
3565
  # @param recipient_id The ID of the recipient being accessed.
3125
3566
  # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
3126
3567
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
@@ -3363,7 +3804,7 @@ module DocuSign_eSign
3363
3804
  end
3364
3805
 
3365
3806
  # Returns tabs on the document.
3366
- #
3807
+ # Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.
3367
3808
  # @param account_id The external account number (int) or account ID Guid.
3368
3809
  # @param document_id The ID of the document being accessed.
3369
3810
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3375,7 +3816,7 @@ module DocuSign_eSign
3375
3816
  end
3376
3817
 
3377
3818
  # Returns tabs on the document.
3378
- #
3819
+ # Returns the tabs on the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.
3379
3820
  # @param account_id The external account number (int) or account ID Guid.
3380
3821
  # @param document_id The ID of the document being accessed.
3381
3822
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3533,6 +3974,63 @@ module DocuSign_eSign
3533
3974
  return data, status_code, headers
3534
3975
  end
3535
3976
 
3977
+ # Returns the delayed routing rules for an envelope's workflow step definition.
3978
+ #
3979
+ # @param account_id The external account number (int) or account ID Guid.
3980
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3981
+ # @param workflow_step_id
3982
+ # @return [DelayedRouting]
3983
+ def get_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id)
3984
+ data, _status_code, _headers = get_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id)
3985
+ return data
3986
+ end
3987
+
3988
+ # Returns the delayed routing rules for an envelope&#39;s workflow step definition.
3989
+ #
3990
+ # @param account_id The external account number (int) or account ID Guid.
3991
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3992
+ # @param workflow_step_id
3993
+ # @return [Array<(DelayedRouting, Fixnum, Hash)>] DelayedRouting data, response status code and response headers
3994
+ def get_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id)
3995
+ if @api_client.config.debugging
3996
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_delayed_routing_definition ..."
3997
+ end
3998
+ # verify the required parameter 'account_id' is set
3999
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_delayed_routing_definition" if account_id.nil?
4000
+ # verify the required parameter 'envelope_id' is set
4001
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_delayed_routing_definition" if envelope_id.nil?
4002
+ # verify the required parameter 'workflow_step_id' is set
4003
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_envelope_delayed_routing_definition" if workflow_step_id.nil?
4004
+ # resource path
4005
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
4006
+
4007
+ # query parameters
4008
+ query_params = {}
4009
+
4010
+ # header parameters
4011
+ header_params = {}
4012
+ # HTTP header 'Accept' (if needed)
4013
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4014
+
4015
+ # form parameters
4016
+ form_params = {}
4017
+
4018
+ # http body (model)
4019
+ post_body = nil
4020
+ auth_names = []
4021
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4022
+ :header_params => header_params,
4023
+ :query_params => query_params,
4024
+ :form_params => form_params,
4025
+ :body => post_body,
4026
+ :auth_names => auth_names,
4027
+ :return_type => 'DelayedRouting')
4028
+ if @api_client.config.debugging
4029
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4030
+ end
4031
+ return data, status_code, headers
4032
+ end
4033
+
3536
4034
  # Get the Original HTML Definition used to generate the Responsive HTML for a given document.
3537
4035
  #
3538
4036
  # @param account_id The external account number (int) or account ID Guid.
@@ -3643,9 +4141,62 @@ module DocuSign_eSign
3643
4141
  return data, status_code, headers
3644
4142
  end
3645
4143
 
3646
- # Returns a list of envelope transfer rules in the specified account.
4144
+ # Returns the scheduled sending rules for an envelope's workflow definition.
3647
4145
  #
3648
4146
  # @param account_id The external account number (int) or account ID Guid.
4147
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4148
+ # @return [ScheduledSending]
4149
+ def get_envelope_scheduled_sending_definition(account_id, envelope_id)
4150
+ data, _status_code, _headers = get_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id)
4151
+ return data
4152
+ end
4153
+
4154
+ # Returns the scheduled sending rules for an envelope&#39;s workflow definition.
4155
+ #
4156
+ # @param account_id The external account number (int) or account ID Guid.
4157
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4158
+ # @return [Array<(ScheduledSending, Fixnum, Hash)>] ScheduledSending data, response status code and response headers
4159
+ def get_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id)
4160
+ if @api_client.config.debugging
4161
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_scheduled_sending_definition ..."
4162
+ end
4163
+ # verify the required parameter 'account_id' is set
4164
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_scheduled_sending_definition" if account_id.nil?
4165
+ # verify the required parameter 'envelope_id' is set
4166
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_scheduled_sending_definition" if envelope_id.nil?
4167
+ # resource path
4168
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4169
+
4170
+ # query parameters
4171
+ query_params = {}
4172
+
4173
+ # header parameters
4174
+ header_params = {}
4175
+ # HTTP header 'Accept' (if needed)
4176
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4177
+
4178
+ # form parameters
4179
+ form_params = {}
4180
+
4181
+ # http body (model)
4182
+ post_body = nil
4183
+ auth_names = []
4184
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4185
+ :header_params => header_params,
4186
+ :query_params => query_params,
4187
+ :form_params => form_params,
4188
+ :body => post_body,
4189
+ :auth_names => auth_names,
4190
+ :return_type => 'ScheduledSending')
4191
+ if @api_client.config.debugging
4192
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4193
+ end
4194
+ return data, status_code, headers
4195
+ end
4196
+
4197
+ # Returns a list of envelope transfer rules in the specified account.
4198
+ # This method retrieves a list of envelope transfer rules associated with an account. **Note:** Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
4199
+ # @param account_id The external account number (int) or account ID Guid.
3649
4200
  # @param DocuSign_eSign::GetEnvelopeTransferRulesOptions Options for modifying the behavior of the function.
3650
4201
  # @return [EnvelopeTransferRuleInformation]
3651
4202
  def get_envelope_transfer_rules(account_id, options = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default)
@@ -3654,7 +4205,7 @@ module DocuSign_eSign
3654
4205
  end
3655
4206
 
3656
4207
  # Returns a list of envelope transfer rules in the specified account.
3657
- #
4208
+ # This method retrieves a list of envelope transfer rules associated with an account. **Note:** Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
3658
4209
  # @param account_id The external account number (int) or account ID Guid.
3659
4210
  # @param DocuSign_eSign::GetEnvelopeTransferRulesOptions Options for modifying the behavior of the function.
3660
4211
  # @return [Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>] EnvelopeTransferRuleInformation data, response status code and response headers
@@ -3697,7 +4248,7 @@ module DocuSign_eSign
3697
4248
  end
3698
4249
 
3699
4250
  # Returns the workflow definition for an envelope.
3700
- #
4251
+ # Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one.
3701
4252
  # @param account_id The external account number (int) or account ID Guid.
3702
4253
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3703
4254
  # @return [Workflow]
@@ -3707,7 +4258,7 @@ module DocuSign_eSign
3707
4258
  end
3708
4259
 
3709
4260
  # Returns the workflow definition for an envelope.
3710
- #
4261
+ # Returns an envelope&#39;s workflow definition if the envelope specified by &#x60;envelopeId&#x60; has one.
3711
4262
  # @param account_id The external account number (int) or account ID Guid.
3712
4263
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3713
4264
  # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
@@ -3749,10 +4300,67 @@ module DocuSign_eSign
3749
4300
  return data, status_code, headers
3750
4301
  end
3751
4302
 
3752
- # Returns envelope form data for an existing envelope.
4303
+ # Returns the workflow step definition for an envelope by step id.
3753
4304
  #
3754
4305
  # @param account_id The external account number (int) or account ID Guid.
3755
4306
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4307
+ # @param workflow_step_id
4308
+ # @return [WorkflowStep]
4309
+ def get_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id)
4310
+ data, _status_code, _headers = get_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id)
4311
+ return data
4312
+ end
4313
+
4314
+ # Returns the workflow step definition for an envelope by step id.
4315
+ #
4316
+ # @param account_id The external account number (int) or account ID Guid.
4317
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4318
+ # @param workflow_step_id
4319
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
4320
+ def get_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id)
4321
+ if @api_client.config.debugging
4322
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_workflow_step_definition ..."
4323
+ end
4324
+ # verify the required parameter 'account_id' is set
4325
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_workflow_step_definition" if account_id.nil?
4326
+ # verify the required parameter 'envelope_id' is set
4327
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_workflow_step_definition" if envelope_id.nil?
4328
+ # verify the required parameter 'workflow_step_id' is set
4329
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_envelope_workflow_step_definition" if workflow_step_id.nil?
4330
+ # resource path
4331
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
4332
+
4333
+ # query parameters
4334
+ query_params = {}
4335
+
4336
+ # header parameters
4337
+ header_params = {}
4338
+ # HTTP header 'Accept' (if needed)
4339
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4340
+
4341
+ # form parameters
4342
+ form_params = {}
4343
+
4344
+ # http body (model)
4345
+ post_body = nil
4346
+ auth_names = []
4347
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4348
+ :header_params => header_params,
4349
+ :query_params => query_params,
4350
+ :form_params => form_params,
4351
+ :body => post_body,
4352
+ :auth_names => auth_names,
4353
+ :return_type => 'WorkflowStep')
4354
+ if @api_client.config.debugging
4355
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4356
+ end
4357
+ return data, status_code, headers
4358
+ end
4359
+
4360
+ # Returns envelope form data for an existing envelope.
4361
+ # This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. **Note:** To use this feature, the Sending Setting \"Allow sender to download form data\" must be enabled for the account. ### Related topics - [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)
4362
+ # @param account_id The external account number (int) or account ID Guid.
4363
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3756
4364
  # @return [EnvelopeFormData]
3757
4365
  def get_form_data(account_id, envelope_id)
3758
4366
  data, _status_code, _headers = get_form_data_with_http_info(account_id, envelope_id)
@@ -3760,7 +4368,7 @@ module DocuSign_eSign
3760
4368
  end
3761
4369
 
3762
4370
  # Returns envelope form data for an existing envelope.
3763
- #
4371
+ # This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. **Note:** To use this feature, the Sending Setting \&quot;Allow sender to download form data\&quot; must be enabled for the account. ### Related topics - [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)
3764
4372
  # @param account_id The external account number (int) or account ID Guid.
3765
4373
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3766
4374
  # @return [Array<(EnvelopeFormData, Fixnum, Hash)>] EnvelopeFormData data, response status code and response headers
@@ -3909,7 +4517,7 @@ module DocuSign_eSign
3909
4517
  end
3910
4518
 
3911
4519
  # Returns tabs on the specified page.
3912
- #
4520
+ # Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.
3913
4521
  # @param account_id The external account number (int) or account ID Guid.
3914
4522
  # @param document_id The ID of the document being accessed.
3915
4523
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3921,7 +4529,7 @@ module DocuSign_eSign
3921
4529
  end
3922
4530
 
3923
4531
  # Returns tabs on the specified page.
3924
- #
4532
+ # Returns the tabs from the page specified by &#x60;pageNumber&#x60; of the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.
3925
4533
  # @param account_id The external account number (int) or account ID Guid.
3926
4534
  # @param document_id The ID of the document being accessed.
3927
4535
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3970,7 +4578,7 @@ module DocuSign_eSign
3970
4578
  end
3971
4579
 
3972
4580
  # Returns document page image(s) based on input.
3973
- #
4581
+ # Returns images of the pages in a document for display based on the parameters that you specify.
3974
4582
  # @param account_id The external account number (int) or account ID Guid.
3975
4583
  # @param document_id The ID of the document being accessed.
3976
4584
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3982,7 +4590,7 @@ module DocuSign_eSign
3982
4590
  end
3983
4591
 
3984
4592
  # Returns document page image(s) based on input.
3985
- #
4593
+ # Returns images of the pages in a document for display based on the parameters that you specify.
3986
4594
  # @param account_id The external account number (int) or account ID Guid.
3987
4595
  # @param document_id The ID of the document being accessed.
3988
4596
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -4036,7 +4644,7 @@ module DocuSign_eSign
4036
4644
  end
4037
4645
 
4038
4646
  # Returns document visibility for the recipients
4039
- #
4647
+ # This method returns information about document visibility for a recipient.
4040
4648
  # @param account_id The external account number (int) or account ID Guid.
4041
4649
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4042
4650
  # @param recipient_id The ID of the recipient being accessed.
@@ -4047,7 +4655,7 @@ module DocuSign_eSign
4047
4655
  end
4048
4656
 
4049
4657
  # Returns document visibility for the recipients
4050
- #
4658
+ # This method returns information about document visibility for a recipient.
4051
4659
  # @param account_id The external account number (int) or account ID Guid.
4052
4660
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4053
4661
  # @param recipient_id The ID of the recipient being accessed.
@@ -4321,9 +4929,66 @@ module DocuSign_eSign
4321
4929
  return data, status_code, headers
4322
4930
  end
4323
4931
 
4324
- # Returns document visibility for the recipients
4932
+ # Returns the delayed routing rules for a template's workflow step definition.
4325
4933
  #
4326
4934
  # @param account_id The external account number (int) or account ID Guid.
4935
+ # @param template_id The ID of the template being accessed.
4936
+ # @param workflow_step_id
4937
+ # @return [DelayedRouting]
4938
+ def get_template_delayed_routing_definition(account_id, template_id, workflow_step_id)
4939
+ data, _status_code, _headers = get_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id)
4940
+ return data
4941
+ end
4942
+
4943
+ # Returns the delayed routing rules for a template&#39;s workflow step definition.
4944
+ #
4945
+ # @param account_id The external account number (int) or account ID Guid.
4946
+ # @param template_id The ID of the template being accessed.
4947
+ # @param workflow_step_id
4948
+ # @return [Array<(DelayedRouting, Fixnum, Hash)>] DelayedRouting data, response status code and response headers
4949
+ def get_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id)
4950
+ if @api_client.config.debugging
4951
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_delayed_routing_definition ..."
4952
+ end
4953
+ # verify the required parameter 'account_id' is set
4954
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_delayed_routing_definition" if account_id.nil?
4955
+ # verify the required parameter 'template_id' is set
4956
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_delayed_routing_definition" if template_id.nil?
4957
+ # verify the required parameter 'workflow_step_id' is set
4958
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_template_delayed_routing_definition" if workflow_step_id.nil?
4959
+ # resource path
4960
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
4961
+
4962
+ # query parameters
4963
+ query_params = {}
4964
+
4965
+ # header parameters
4966
+ header_params = {}
4967
+ # HTTP header 'Accept' (if needed)
4968
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4969
+
4970
+ # form parameters
4971
+ form_params = {}
4972
+
4973
+ # http body (model)
4974
+ post_body = nil
4975
+ auth_names = []
4976
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4977
+ :header_params => header_params,
4978
+ :query_params => query_params,
4979
+ :form_params => form_params,
4980
+ :body => post_body,
4981
+ :auth_names => auth_names,
4982
+ :return_type => 'DelayedRouting')
4983
+ if @api_client.config.debugging
4984
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_template_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4985
+ end
4986
+ return data, status_code, headers
4987
+ end
4988
+
4989
+ # Returns document visibility for the recipients
4990
+ # This method returns information about document visibility for a template recipient.
4991
+ # @param account_id The external account number (int) or account ID Guid.
4327
4992
  # @param recipient_id The ID of the recipient being accessed.
4328
4993
  # @param template_id The ID of the template being accessed.
4329
4994
  # @return [DocumentVisibilityList]
@@ -4333,7 +4998,7 @@ module DocuSign_eSign
4333
4998
  end
4334
4999
 
4335
5000
  # Returns document visibility for the recipients
4336
- #
5001
+ # This method returns information about document visibility for a template recipient.
4337
5002
  # @param account_id The external account number (int) or account ID Guid.
4338
5003
  # @param recipient_id The ID of the recipient being accessed.
4339
5004
  # @param template_id The ID of the template being accessed.
@@ -4378,10 +5043,63 @@ module DocuSign_eSign
4378
5043
  return data, status_code, headers
4379
5044
  end
4380
5045
 
4381
- # Returns the workflow definition for a template.
5046
+ # Returns the scheduled sending rules for a template's workflow definition.
4382
5047
  #
4383
5048
  # @param account_id The external account number (int) or account ID Guid.
4384
5049
  # @param template_id The ID of the template being accessed.
5050
+ # @return [ScheduledSending]
5051
+ def get_template_scheduled_sending_definition(account_id, template_id)
5052
+ data, _status_code, _headers = get_template_scheduled_sending_definition_with_http_info(account_id, template_id)
5053
+ return data
5054
+ end
5055
+
5056
+ # Returns the scheduled sending rules for a template&#39;s workflow definition.
5057
+ #
5058
+ # @param account_id The external account number (int) or account ID Guid.
5059
+ # @param template_id The ID of the template being accessed.
5060
+ # @return [Array<(ScheduledSending, Fixnum, Hash)>] ScheduledSending data, response status code and response headers
5061
+ def get_template_scheduled_sending_definition_with_http_info(account_id, template_id)
5062
+ if @api_client.config.debugging
5063
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_scheduled_sending_definition ..."
5064
+ end
5065
+ # verify the required parameter 'account_id' is set
5066
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_scheduled_sending_definition" if account_id.nil?
5067
+ # verify the required parameter 'template_id' is set
5068
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_scheduled_sending_definition" if template_id.nil?
5069
+ # resource path
5070
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
5071
+
5072
+ # query parameters
5073
+ query_params = {}
5074
+
5075
+ # header parameters
5076
+ header_params = {}
5077
+ # HTTP header 'Accept' (if needed)
5078
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5079
+
5080
+ # form parameters
5081
+ form_params = {}
5082
+
5083
+ # http body (model)
5084
+ post_body = nil
5085
+ auth_names = []
5086
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
5087
+ :header_params => header_params,
5088
+ :query_params => query_params,
5089
+ :form_params => form_params,
5090
+ :body => post_body,
5091
+ :auth_names => auth_names,
5092
+ :return_type => 'ScheduledSending')
5093
+ if @api_client.config.debugging
5094
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_template_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5095
+ end
5096
+ return data, status_code, headers
5097
+ end
5098
+
5099
+ # Returns the workflow definition for a template.
5100
+ # Returns template's workflow definition if the template specified by `templateId` has one.
5101
+ # @param account_id The external account number (int) or account ID Guid.
5102
+ # @param template_id The ID of the template being accessed.
4385
5103
  # @return [Workflow]
4386
5104
  def get_template_workflow_definition(account_id, template_id)
4387
5105
  data, _status_code, _headers = get_template_workflow_definition_with_http_info(account_id, template_id)
@@ -4389,7 +5107,7 @@ module DocuSign_eSign
4389
5107
  end
4390
5108
 
4391
5109
  # Returns the workflow definition for a template.
4392
- #
5110
+ # Returns template&#39;s workflow definition if the template specified by &#x60;templateId&#x60; has one.
4393
5111
  # @param account_id The external account number (int) or account ID Guid.
4394
5112
  # @param template_id The ID of the template being accessed.
4395
5113
  # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
@@ -4431,6 +5149,63 @@ module DocuSign_eSign
4431
5149
  return data, status_code, headers
4432
5150
  end
4433
5151
 
5152
+ # Returns the workflow step definition for a template by step id.
5153
+ #
5154
+ # @param account_id The external account number (int) or account ID Guid.
5155
+ # @param template_id The ID of the template being accessed.
5156
+ # @param workflow_step_id
5157
+ # @return [WorkflowStep]
5158
+ def get_template_workflow_step_definition(account_id, template_id, workflow_step_id)
5159
+ data, _status_code, _headers = get_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id)
5160
+ return data
5161
+ end
5162
+
5163
+ # Returns the workflow step definition for a template by step id.
5164
+ #
5165
+ # @param account_id The external account number (int) or account ID Guid.
5166
+ # @param template_id The ID of the template being accessed.
5167
+ # @param workflow_step_id
5168
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
5169
+ def get_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id)
5170
+ if @api_client.config.debugging
5171
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_workflow_step_definition ..."
5172
+ end
5173
+ # verify the required parameter 'account_id' is set
5174
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_workflow_step_definition" if account_id.nil?
5175
+ # verify the required parameter 'template_id' is set
5176
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_workflow_step_definition" if template_id.nil?
5177
+ # verify the required parameter 'workflow_step_id' is set
5178
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_template_workflow_step_definition" if workflow_step_id.nil?
5179
+ # resource path
5180
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
5181
+
5182
+ # query parameters
5183
+ query_params = {}
5184
+
5185
+ # header parameters
5186
+ header_params = {}
5187
+ # HTTP header 'Accept' (if needed)
5188
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5189
+
5190
+ # form parameters
5191
+ form_params = {}
5192
+
5193
+ # http body (model)
5194
+ post_body = nil
5195
+ auth_names = []
5196
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
5197
+ :header_params => header_params,
5198
+ :query_params => query_params,
5199
+ :form_params => form_params,
5200
+ :body => post_body,
5201
+ :auth_names => auth_names,
5202
+ :return_type => 'WorkflowStep')
5203
+ if @api_client.config.debugging
5204
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5205
+ end
5206
+ return data, status_code, headers
5207
+ end
5208
+
4434
5209
  # Gets the envelope audit events for an envelope.
4435
5210
  # Gets the envelope audit events for the specified envelope.
4436
5211
  # @param account_id The external account number (int) or account ID Guid.
@@ -4625,6 +5400,7 @@ module DocuSign_eSign
4625
5400
  # query parameters
4626
5401
  query_params = {}
4627
5402
  query_params[:'documents_by_userid'] = options.documents_by_userid if !options.documents_by_userid.nil?
5403
+ query_params[:'include_docgen_formfields'] = options.include_docgen_formfields if !options.include_docgen_formfields.nil?
4628
5404
  query_params[:'include_document_size'] = options.include_document_size if !options.include_document_size.nil?
4629
5405
  query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
4630
5406
  query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
@@ -5038,7 +5814,7 @@ module DocuSign_eSign
5038
5814
  end
5039
5815
 
5040
5816
  # Add an attachment to a DRAFT or IN-PROCESS envelope.
5041
- #
5817
+ # Adds an attachment to a draft or in-process envelope.
5042
5818
  # @param account_id The external account number (int) or account ID Guid.
5043
5819
  # @param attachment_id
5044
5820
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -5050,7 +5826,7 @@ module DocuSign_eSign
5050
5826
  end
5051
5827
 
5052
5828
  # Add an attachment to a DRAFT or IN-PROCESS envelope.
5053
- #
5829
+ # Adds an attachment to a draft or in-process envelope.
5054
5830
  # @param account_id The external account number (int) or account ID Guid.
5055
5831
  # @param attachment_id
5056
5832
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -5097,7 +5873,7 @@ module DocuSign_eSign
5097
5873
  end
5098
5874
 
5099
5875
  # Add one or more attachments to a DRAFT or IN-PROCESS envelope.
5100
- #
5876
+ # Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see [Supported File Formats](https://support.docusign.com/guides/ndse-user-guide-supported-file-formats).
5101
5877
  # @param account_id The external account number (int) or account ID Guid.
5102
5878
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5103
5879
  # @param envelope_attachments_request (optional parameter)
@@ -5108,7 +5884,7 @@ module DocuSign_eSign
5108
5884
  end
5109
5885
 
5110
5886
  # Add one or more attachments to a DRAFT or IN-PROCESS envelope.
5111
- #
5887
+ # Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see [Supported File Formats](https://support.docusign.com/guides/ndse-user-guide-supported-file-formats).
5112
5888
  # @param account_id The external account number (int) or account ID Guid.
5113
5889
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5114
5890
  # @param envelope_attachments_request (optional parameter)
@@ -5273,7 +6049,7 @@ module DocuSign_eSign
5273
6049
  end
5274
6050
 
5275
6051
  # Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
5276
- #
6052
+ # This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. **Note:** After you commit a chunked upload, it no longer accepts additional parts.
5277
6053
  # @param account_id The external account number (int) or account ID Guid.
5278
6054
  # @param chunked_upload_id
5279
6055
  # @param DocuSign_eSign::UpdateChunkedUploadOptions Options for modifying the behavior of the function.
@@ -5284,7 +6060,7 @@ module DocuSign_eSign
5284
6060
  end
5285
6061
 
5286
6062
  # Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
5287
- #
6063
+ # This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. **Note:** After you commit a chunked upload, it no longer accepts additional parts.
5288
6064
  # @param account_id The external account number (int) or account ID Guid.
5289
6065
  # @param chunked_upload_id
5290
6066
  # @param DocuSign_eSign::UpdateChunkedUploadOptions Options for modifying the behavior of the function.
@@ -5329,7 +6105,7 @@ module DocuSign_eSign
5329
6105
  end
5330
6106
 
5331
6107
  # Add a chunk, a chunk 'part', to an existing ChunkedUpload.
5332
- #
6108
+ # Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` **Note:** You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.
5333
6109
  # @param account_id The external account number (int) or account ID Guid.
5334
6110
  # @param chunked_upload_id
5335
6111
  # @param chunked_upload_part_seq
@@ -5341,7 +6117,7 @@ module DocuSign_eSign
5341
6117
  end
5342
6118
 
5343
6119
  # Add a chunk, a chunk &#39;part&#39;, to an existing ChunkedUpload.
5344
- #
6120
+ # Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the &#x60;sequence&#x60; value &#x60;0&#x60;. As a result, DocuSign recommends that you start with a &#x60;sequence&#x60; value of &#x60;1&#x60; when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: &#x60;&#x60;&#x60; PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 &#x60;&#x60;&#x60; **Note:** You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.
5345
6121
  # @param account_id The external account number (int) or account ID Guid.
5346
6122
  # @param chunked_upload_id
5347
6123
  # @param chunked_upload_part_seq
@@ -5559,7 +6335,7 @@ module DocuSign_eSign
5559
6335
  end
5560
6336
 
5561
6337
  # Updates the tabs for an envelope document
5562
- #
6338
+ # Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`.
5563
6339
  # @param account_id The external account number (int) or account ID Guid.
5564
6340
  # @param document_id The ID of the document being accessed.
5565
6341
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -5571,7 +6347,7 @@ module DocuSign_eSign
5571
6347
  end
5572
6348
 
5573
6349
  # Updates the tabs for an envelope document
5574
- #
6350
+ # Updates tabs in the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.
5575
6351
  # @param account_id The external account number (int) or account ID Guid.
5576
6352
  # @param document_id The ID of the document being accessed.
5577
6353
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -5727,9 +6503,123 @@ module DocuSign_eSign
5727
6503
  return data, status_code, headers
5728
6504
  end
5729
6505
 
5730
- # Update an envelope transfer rule for an account.
6506
+ # Updates the delayed routing rules for an envelope's workflow step definition.
6507
+ #
6508
+ # @param account_id The external account number (int) or account ID Guid.
6509
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6510
+ # @param workflow_step_id
6511
+ # @param delayed_routing (optional parameter)
6512
+ # @return [DelayedRouting]
6513
+ def update_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id, delayed_routing)
6514
+ data, _status_code, _headers = update_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id, delayed_routing)
6515
+ return data
6516
+ end
6517
+
6518
+ # Updates the delayed routing rules for an envelope&#39;s workflow step definition.
6519
+ #
6520
+ # @param account_id The external account number (int) or account ID Guid.
6521
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6522
+ # @param workflow_step_id
6523
+ # @param delayed_routing (optional parameter)
6524
+ # @return [Array<(DelayedRouting, Fixnum, Hash)>] DelayedRouting data, response status code and response headers
6525
+ def update_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id, delayed_routing)
6526
+ if @api_client.config.debugging
6527
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_delayed_routing_definition ..."
6528
+ end
6529
+ # verify the required parameter 'account_id' is set
6530
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_delayed_routing_definition" if account_id.nil?
6531
+ # verify the required parameter 'envelope_id' is set
6532
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_delayed_routing_definition" if envelope_id.nil?
6533
+ # verify the required parameter 'workflow_step_id' is set
6534
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_envelope_delayed_routing_definition" if workflow_step_id.nil?
6535
+ # resource path
6536
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
6537
+
6538
+ # query parameters
6539
+ query_params = {}
6540
+
6541
+ # header parameters
6542
+ header_params = {}
6543
+ # HTTP header 'Accept' (if needed)
6544
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6545
+
6546
+ # form parameters
6547
+ form_params = {}
6548
+
6549
+ # http body (model)
6550
+ post_body = @api_client.object_to_http_body(delayed_routing)
6551
+ auth_names = []
6552
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6553
+ :header_params => header_params,
6554
+ :query_params => query_params,
6555
+ :form_params => form_params,
6556
+ :body => post_body,
6557
+ :auth_names => auth_names,
6558
+ :return_type => 'DelayedRouting')
6559
+ if @api_client.config.debugging
6560
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6561
+ end
6562
+ return data, status_code, headers
6563
+ end
6564
+
6565
+ # Updates the scheduled sending rules for an envelope's workflow definition.
6566
+ #
6567
+ # @param account_id The external account number (int) or account ID Guid.
6568
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6569
+ # @param scheduled_sending (optional parameter)
6570
+ # @return [ScheduledSending]
6571
+ def update_envelope_scheduled_sending_definition(account_id, envelope_id, scheduled_sending)
6572
+ data, _status_code, _headers = update_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id, scheduled_sending)
6573
+ return data
6574
+ end
6575
+
6576
+ # Updates the scheduled sending rules for an envelope&#39;s workflow definition.
5731
6577
  #
5732
6578
  # @param account_id The external account number (int) or account ID Guid.
6579
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6580
+ # @param scheduled_sending (optional parameter)
6581
+ # @return [Array<(ScheduledSending, Fixnum, Hash)>] ScheduledSending data, response status code and response headers
6582
+ def update_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id, scheduled_sending)
6583
+ if @api_client.config.debugging
6584
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_scheduled_sending_definition ..."
6585
+ end
6586
+ # verify the required parameter 'account_id' is set
6587
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_scheduled_sending_definition" if account_id.nil?
6588
+ # verify the required parameter 'envelope_id' is set
6589
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_scheduled_sending_definition" if envelope_id.nil?
6590
+ # resource path
6591
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
6592
+
6593
+ # query parameters
6594
+ query_params = {}
6595
+
6596
+ # header parameters
6597
+ header_params = {}
6598
+ # HTTP header 'Accept' (if needed)
6599
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6600
+
6601
+ # form parameters
6602
+ form_params = {}
6603
+
6604
+ # http body (model)
6605
+ post_body = @api_client.object_to_http_body(scheduled_sending)
6606
+ auth_names = []
6607
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6608
+ :header_params => header_params,
6609
+ :query_params => query_params,
6610
+ :form_params => form_params,
6611
+ :body => post_body,
6612
+ :auth_names => auth_names,
6613
+ :return_type => 'ScheduledSending')
6614
+ if @api_client.config.debugging
6615
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6616
+ end
6617
+ return data, status_code, headers
6618
+ end
6619
+
6620
+ # Update an envelope transfer rule for an account.
6621
+ # This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. **Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
6622
+ # @param account_id The external account number (int) or account ID Guid.
5733
6623
  # @param envelope_transfer_rule_id
5734
6624
  # @param envelope_transfer_rule (optional parameter)
5735
6625
  # @return [EnvelopeTransferRule]
@@ -5739,7 +6629,7 @@ module DocuSign_eSign
5739
6629
  end
5740
6630
 
5741
6631
  # Update an envelope transfer rule for an account.
5742
- #
6632
+ # This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the &#x60;envelopeTransferRuleId&#x60; both as a query parameter, and in the request body. **Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
5743
6633
  # @param account_id The external account number (int) or account ID Guid.
5744
6634
  # @param envelope_transfer_rule_id
5745
6635
  # @param envelope_transfer_rule (optional parameter)
@@ -5783,7 +6673,7 @@ module DocuSign_eSign
5783
6673
  end
5784
6674
 
5785
6675
  # Update envelope transfer rules for an account.
5786
- #
6676
+ # This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. **Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
5787
6677
  # @param account_id The external account number (int) or account ID Guid.
5788
6678
  # @param envelope_transfer_rule_information (optional parameter)
5789
6679
  # @return [EnvelopeTransferRuleInformation]
@@ -5793,7 +6683,7 @@ module DocuSign_eSign
5793
6683
  end
5794
6684
 
5795
6685
  # Update envelope transfer rules for an account.
5796
- #
6686
+ # This method changes the status for one or more envelope transfer rules based on the &#x60;envelopeTransferRuleId&#x60;s in the request body. You use this method to change whether or not the rules are enabled. **Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
5797
6687
  # @param account_id The external account number (int) or account ID Guid.
5798
6688
  # @param envelope_transfer_rule_information (optional parameter)
5799
6689
  # @return [Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>] EnvelopeTransferRuleInformation data, response status code and response headers
@@ -5834,7 +6724,7 @@ module DocuSign_eSign
5834
6724
  end
5835
6725
 
5836
6726
  # Updates the envelope workflow definition for an envelope.
5837
- #
6727
+ # Updates the specified envelope's workflow definition if it has one.
5838
6728
  # @param account_id The external account number (int) or account ID Guid.
5839
6729
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5840
6730
  # @param workflow (optional parameter)
@@ -5845,7 +6735,7 @@ module DocuSign_eSign
5845
6735
  end
5846
6736
 
5847
6737
  # Updates the envelope workflow definition for an envelope.
5848
- #
6738
+ # Updates the specified envelope&#39;s workflow definition if it has one.
5849
6739
  # @param account_id The external account number (int) or account ID Guid.
5850
6740
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5851
6741
  # @param workflow (optional parameter)
@@ -5888,6 +6778,65 @@ module DocuSign_eSign
5888
6778
  return data, status_code, headers
5889
6779
  end
5890
6780
 
6781
+ # Updates the envelope workflow step definition for an envelope.
6782
+ #
6783
+ # @param account_id The external account number (int) or account ID Guid.
6784
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6785
+ # @param workflow_step_id
6786
+ # @param workflow_step (optional parameter)
6787
+ # @return [WorkflowStep]
6788
+ def update_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id, workflow_step)
6789
+ data, _status_code, _headers = update_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id, workflow_step)
6790
+ return data
6791
+ end
6792
+
6793
+ # Updates the envelope workflow step definition for an envelope.
6794
+ #
6795
+ # @param account_id The external account number (int) or account ID Guid.
6796
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6797
+ # @param workflow_step_id
6798
+ # @param workflow_step (optional parameter)
6799
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
6800
+ def update_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id, workflow_step)
6801
+ if @api_client.config.debugging
6802
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_workflow_step_definition ..."
6803
+ end
6804
+ # verify the required parameter 'account_id' is set
6805
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_workflow_step_definition" if account_id.nil?
6806
+ # verify the required parameter 'envelope_id' is set
6807
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_workflow_step_definition" if envelope_id.nil?
6808
+ # verify the required parameter 'workflow_step_id' is set
6809
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_envelope_workflow_step_definition" if workflow_step_id.nil?
6810
+ # resource path
6811
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
6812
+
6813
+ # query parameters
6814
+ query_params = {}
6815
+
6816
+ # header parameters
6817
+ header_params = {}
6818
+ # HTTP header 'Accept' (if needed)
6819
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6820
+
6821
+ # form parameters
6822
+ form_params = {}
6823
+
6824
+ # http body (model)
6825
+ post_body = @api_client.object_to_http_body(workflow_step)
6826
+ auth_names = []
6827
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6828
+ :header_params => header_params,
6829
+ :query_params => query_params,
6830
+ :form_params => form_params,
6831
+ :body => post_body,
6832
+ :auth_names => auth_names,
6833
+ :return_type => 'WorkflowStep')
6834
+ if @api_client.config.debugging
6835
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6836
+ end
6837
+ return data, status_code, headers
6838
+ end
6839
+
5891
6840
  # Updates an envelope lock.
5892
6841
  # Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
5893
6842
  # @param account_id The external account number (int) or account ID Guid.
@@ -5944,7 +6893,7 @@ module DocuSign_eSign
5944
6893
  end
5945
6894
 
5946
6895
  # Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
5947
- #
6896
+ # This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.
5948
6897
  # @param account_id The external account number (int) or account ID Guid.
5949
6898
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5950
6899
  # @param envelope_notification_request (optional parameter)
@@ -5955,7 +6904,7 @@ module DocuSign_eSign
5955
6904
  end
5956
6905
 
5957
6906
  # Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
5958
- #
6907
+ # This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.
5959
6908
  # @param account_id The external account number (int) or account ID Guid.
5960
6909
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5961
6910
  # @param envelope_notification_request (optional parameter)
@@ -5999,7 +6948,7 @@ module DocuSign_eSign
5999
6948
  end
6000
6949
 
6001
6950
  # Updates document visibility for the recipients
6002
- #
6951
+ # This method updates document visibility for a recipient. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
6003
6952
  # @param account_id The external account number (int) or account ID Guid.
6004
6953
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6005
6954
  # @param recipient_id The ID of the recipient being accessed.
@@ -6011,7 +6960,7 @@ module DocuSign_eSign
6011
6960
  end
6012
6961
 
6013
6962
  # Updates document visibility for the recipients
6014
- #
6963
+ # This method updates document visibility for a recipient. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
6015
6964
  # @param account_id The external account number (int) or account ID Guid.
6016
6965
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6017
6966
  # @param recipient_id The ID of the recipient being accessed.
@@ -6234,7 +7183,7 @@ module DocuSign_eSign
6234
7183
  end
6235
7184
 
6236
7185
  # Updates document visibility for the recipients
6237
- #
7186
+ # This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
6238
7187
  # @param account_id The external account number (int) or account ID Guid.
6239
7188
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6240
7189
  # @param document_visibility_list (optional parameter)
@@ -6245,7 +7194,7 @@ module DocuSign_eSign
6245
7194
  end
6246
7195
 
6247
7196
  # Updates document visibility for the recipients
6248
- #
7197
+ # This method updates document visibility for one or more recipients based on the &#x60;recipientId&#x60; and &#x60;visible&#x60; values that you include in the request body. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
6249
7198
  # @param account_id The external account number (int) or account ID Guid.
6250
7199
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6251
7200
  # @param document_visibility_list (optional parameter)
@@ -6458,9 +7407,68 @@ module DocuSign_eSign
6458
7407
  return data, status_code, headers
6459
7408
  end
6460
7409
 
6461
- # Updates document visibility for the recipients
7410
+ # Updates the delayed routing rules for a template's workflow step definition.
7411
+ #
7412
+ # @param account_id The external account number (int) or account ID Guid.
7413
+ # @param template_id The ID of the template being accessed.
7414
+ # @param workflow_step_id
7415
+ # @param delayed_routing (optional parameter)
7416
+ # @return [DelayedRouting]
7417
+ def update_template_delayed_routing_definition(account_id, template_id, workflow_step_id, delayed_routing)
7418
+ data, _status_code, _headers = update_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id, delayed_routing)
7419
+ return data
7420
+ end
7421
+
7422
+ # Updates the delayed routing rules for a template&#39;s workflow step definition.
6462
7423
  #
6463
7424
  # @param account_id The external account number (int) or account ID Guid.
7425
+ # @param template_id The ID of the template being accessed.
7426
+ # @param workflow_step_id
7427
+ # @param delayed_routing (optional parameter)
7428
+ # @return [Array<(DelayedRouting, Fixnum, Hash)>] DelayedRouting data, response status code and response headers
7429
+ def update_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id, delayed_routing)
7430
+ if @api_client.config.debugging
7431
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_delayed_routing_definition ..."
7432
+ end
7433
+ # verify the required parameter 'account_id' is set
7434
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_delayed_routing_definition" if account_id.nil?
7435
+ # verify the required parameter 'template_id' is set
7436
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_delayed_routing_definition" if template_id.nil?
7437
+ # verify the required parameter 'workflow_step_id' is set
7438
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_template_delayed_routing_definition" if workflow_step_id.nil?
7439
+ # resource path
7440
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
7441
+
7442
+ # query parameters
7443
+ query_params = {}
7444
+
7445
+ # header parameters
7446
+ header_params = {}
7447
+ # HTTP header 'Accept' (if needed)
7448
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7449
+
7450
+ # form parameters
7451
+ form_params = {}
7452
+
7453
+ # http body (model)
7454
+ post_body = @api_client.object_to_http_body(delayed_routing)
7455
+ auth_names = []
7456
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7457
+ :header_params => header_params,
7458
+ :query_params => query_params,
7459
+ :form_params => form_params,
7460
+ :body => post_body,
7461
+ :auth_names => auth_names,
7462
+ :return_type => 'DelayedRouting')
7463
+ if @api_client.config.debugging
7464
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_template_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7465
+ end
7466
+ return data, status_code, headers
7467
+ end
7468
+
7469
+ # Updates document visibility for the recipients
7470
+ # This method updates the document visibility for a template recipient. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
7471
+ # @param account_id The external account number (int) or account ID Guid.
6464
7472
  # @param recipient_id The ID of the recipient being accessed.
6465
7473
  # @param template_id The ID of the template being accessed.
6466
7474
  # @param template_document_visibility_list (optional parameter)
@@ -6471,7 +7479,7 @@ module DocuSign_eSign
6471
7479
  end
6472
7480
 
6473
7481
  # Updates document visibility for the recipients
6474
- #
7482
+ # This method updates the document visibility for a template recipient. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
6475
7483
  # @param account_id The external account number (int) or account ID Guid.
6476
7484
  # @param recipient_id The ID of the recipient being accessed.
6477
7485
  # @param template_id The ID of the template being accessed.
@@ -6518,7 +7526,7 @@ module DocuSign_eSign
6518
7526
  end
6519
7527
 
6520
7528
  # Updates document visibility for the recipients
6521
- #
7529
+ # This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
6522
7530
  # @param account_id The external account number (int) or account ID Guid.
6523
7531
  # @param template_id The ID of the template being accessed.
6524
7532
  # @param template_document_visibility_list (optional parameter)
@@ -6529,7 +7537,7 @@ module DocuSign_eSign
6529
7537
  end
6530
7538
 
6531
7539
  # Updates document visibility for the recipients
6532
- #
7540
+ # This method updates document visibility for one or more template recipients based on the &#x60;recipientId&#x60; and &#x60;visible&#x60; values that you include in the request body. **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
6533
7541
  # @param account_id The external account number (int) or account ID Guid.
6534
7542
  # @param template_id The ID of the template being accessed.
6535
7543
  # @param template_document_visibility_list (optional parameter)
@@ -6572,10 +7580,65 @@ module DocuSign_eSign
6572
7580
  return data, status_code, headers
6573
7581
  end
6574
7582
 
6575
- # Updates the workflow definition for a template.
7583
+ # Updates the scheduled sending rules for a template's workflow definition.
7584
+ #
7585
+ # @param account_id The external account number (int) or account ID Guid.
7586
+ # @param template_id The ID of the template being accessed.
7587
+ # @param scheduled_sending (optional parameter)
7588
+ # @return [ScheduledSending]
7589
+ def update_template_scheduled_sending_definition(account_id, template_id, scheduled_sending)
7590
+ data, _status_code, _headers = update_template_scheduled_sending_definition_with_http_info(account_id, template_id, scheduled_sending)
7591
+ return data
7592
+ end
7593
+
7594
+ # Updates the scheduled sending rules for a template&#39;s workflow definition.
6576
7595
  #
6577
7596
  # @param account_id The external account number (int) or account ID Guid.
6578
7597
  # @param template_id The ID of the template being accessed.
7598
+ # @param scheduled_sending (optional parameter)
7599
+ # @return [Array<(ScheduledSending, Fixnum, Hash)>] ScheduledSending data, response status code and response headers
7600
+ def update_template_scheduled_sending_definition_with_http_info(account_id, template_id, scheduled_sending)
7601
+ if @api_client.config.debugging
7602
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_scheduled_sending_definition ..."
7603
+ end
7604
+ # verify the required parameter 'account_id' is set
7605
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_scheduled_sending_definition" if account_id.nil?
7606
+ # verify the required parameter 'template_id' is set
7607
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_scheduled_sending_definition" if template_id.nil?
7608
+ # resource path
7609
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
7610
+
7611
+ # query parameters
7612
+ query_params = {}
7613
+
7614
+ # header parameters
7615
+ header_params = {}
7616
+ # HTTP header 'Accept' (if needed)
7617
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7618
+
7619
+ # form parameters
7620
+ form_params = {}
7621
+
7622
+ # http body (model)
7623
+ post_body = @api_client.object_to_http_body(scheduled_sending)
7624
+ auth_names = []
7625
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7626
+ :header_params => header_params,
7627
+ :query_params => query_params,
7628
+ :form_params => form_params,
7629
+ :body => post_body,
7630
+ :auth_names => auth_names,
7631
+ :return_type => 'ScheduledSending')
7632
+ if @api_client.config.debugging
7633
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_template_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7634
+ end
7635
+ return data, status_code, headers
7636
+ end
7637
+
7638
+ # Updates the workflow definition for a template.
7639
+ # Updates the specified template's workflow definition if it has one.
7640
+ # @param account_id The external account number (int) or account ID Guid.
7641
+ # @param template_id The ID of the template being accessed.
6579
7642
  # @param workflow (optional parameter)
6580
7643
  # @return [Workflow]
6581
7644
  def update_template_workflow_definition(account_id, template_id, workflow)
@@ -6584,7 +7647,7 @@ module DocuSign_eSign
6584
7647
  end
6585
7648
 
6586
7649
  # Updates the workflow definition for a template.
6587
- #
7650
+ # Updates the specified template&#39;s workflow definition if it has one.
6588
7651
  # @param account_id The external account number (int) or account ID Guid.
6589
7652
  # @param template_id The ID of the template being accessed.
6590
7653
  # @param workflow (optional parameter)
@@ -6626,5 +7689,64 @@ module DocuSign_eSign
6626
7689
  end
6627
7690
  return data, status_code, headers
6628
7691
  end
7692
+
7693
+ # Updates the template workflow step definition for an envelope.
7694
+ #
7695
+ # @param account_id The external account number (int) or account ID Guid.
7696
+ # @param template_id The ID of the template being accessed.
7697
+ # @param workflow_step_id
7698
+ # @param workflow_step (optional parameter)
7699
+ # @return [WorkflowStep]
7700
+ def update_template_workflow_step_definition(account_id, template_id, workflow_step_id, workflow_step)
7701
+ data, _status_code, _headers = update_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id, workflow_step)
7702
+ return data
7703
+ end
7704
+
7705
+ # Updates the template workflow step definition for an envelope.
7706
+ #
7707
+ # @param account_id The external account number (int) or account ID Guid.
7708
+ # @param template_id The ID of the template being accessed.
7709
+ # @param workflow_step_id
7710
+ # @param workflow_step (optional parameter)
7711
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
7712
+ def update_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id, workflow_step)
7713
+ if @api_client.config.debugging
7714
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_workflow_step_definition ..."
7715
+ end
7716
+ # verify the required parameter 'account_id' is set
7717
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_workflow_step_definition" if account_id.nil?
7718
+ # verify the required parameter 'template_id' is set
7719
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_workflow_step_definition" if template_id.nil?
7720
+ # verify the required parameter 'workflow_step_id' is set
7721
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_template_workflow_step_definition" if workflow_step_id.nil?
7722
+ # resource path
7723
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)
7724
+
7725
+ # query parameters
7726
+ query_params = {}
7727
+
7728
+ # header parameters
7729
+ header_params = {}
7730
+ # HTTP header 'Accept' (if needed)
7731
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7732
+
7733
+ # form parameters
7734
+ form_params = {}
7735
+
7736
+ # http body (model)
7737
+ post_body = @api_client.object_to_http_body(workflow_step)
7738
+ auth_names = []
7739
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7740
+ :header_params => header_params,
7741
+ :query_params => query_params,
7742
+ :form_params => form_params,
7743
+ :body => post_body,
7744
+ :auth_names => auth_names,
7745
+ :return_type => 'WorkflowStep')
7746
+ if @api_client.config.debugging
7747
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7748
+ end
7749
+ return data, status_code, headers
7750
+ end
6629
7751
  end
6630
7752
  end