docusign_esign 3.18.0 → 3.19.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (304) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/lib/docusign_esign/api/accounts_api.rb +60 -60
  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 +1223 -105
  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 +2 -0
  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 +537 -3
  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 +15 -0
  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 +2 -0
  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 +214 -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/direct_debit_processor_information.rb +1 -0
  113. data/lib/docusign_esign/models/document.rb +3 -0
  114. data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
  115. data/lib/docusign_esign/models/document_html_definition.rb +1 -0
  116. data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
  117. data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
  118. data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
  119. data/lib/docusign_esign/models/document_template.rb +1 -0
  120. data/lib/docusign_esign/models/document_visibility.rb +2 -0
  121. data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
  122. data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
  123. data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
  124. data/lib/docusign_esign/models/draw.rb +40 -0
  125. data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
  126. data/lib/docusign_esign/models/editor.rb +23 -0
  127. data/lib/docusign_esign/models/email.rb +59 -0
  128. data/lib/docusign_esign/models/email_address.rb +46 -0
  129. data/lib/docusign_esign/models/envelope.rb +10 -0
  130. data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
  131. data/lib/docusign_esign/models/envelope_definition.rb +13 -0
  132. data/lib/docusign_esign/models/envelope_document.rb +7 -0
  133. data/lib/docusign_esign/models/envelope_event.rb +1 -0
  134. data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
  135. data/lib/docusign_esign/models/envelope_id.rb +45 -0
  136. data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
  137. data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
  138. data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
  139. data/lib/docusign_esign/models/envelope_summary.rb +3 -0
  140. data/lib/docusign_esign/models/envelope_template.rb +12 -0
  141. data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
  142. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
  143. data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
  144. data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
  145. data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
  146. data/lib/docusign_esign/models/envelopes_information.rb +1 -0
  147. data/lib/docusign_esign/models/event_notification.rb +1 -0
  148. data/lib/docusign_esign/models/event_result.rb +1 -0
  149. data/lib/docusign_esign/models/external_document_sources.rb +6 -0
  150. data/lib/docusign_esign/models/external_file.rb +1 -0
  151. data/lib/docusign_esign/models/external_folder.rb +1 -0
  152. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
  153. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
  154. data/lib/docusign_esign/models/feature_set.rb +1 -0
  155. data/lib/docusign_esign/models/filter.rb +1 -0
  156. data/lib/docusign_esign/models/first_name.rb +46 -0
  157. data/lib/docusign_esign/models/folder.rb +4 -0
  158. data/lib/docusign_esign/models/folder_item_response.rb +1 -0
  159. data/lib/docusign_esign/models/folder_item_v2.rb +2 -0
  160. data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
  161. data/lib/docusign_esign/models/folders_request.rb +1 -0
  162. data/lib/docusign_esign/models/form_data_item.rb +1 -0
  163. data/lib/docusign_esign/models/formula_tab.rb +64 -0
  164. data/lib/docusign_esign/models/full_name.rb +46 -0
  165. data/lib/docusign_esign/models/group.rb +2 -0
  166. data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
  167. data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
  168. data/lib/docusign_esign/models/in_person_signer.rb +31 -0
  169. data/lib/docusign_esign/models/initial_here.rb +40 -0
  170. data/lib/docusign_esign/models/inline_template.rb +3 -0
  171. data/lib/docusign_esign/models/intermediary.rb +23 -0
  172. data/lib/docusign_esign/models/jurisdiction.rb +1 -0
  173. data/lib/docusign_esign/models/last_name.rb +46 -0
  174. data/lib/docusign_esign/models/linked_external_primary_account.rb +1 -0
  175. data/lib/docusign_esign/models/list.rb +54 -0
  176. data/lib/docusign_esign/models/list_custom_field.rb +2 -0
  177. data/lib/docusign_esign/models/list_item.rb +4 -0
  178. data/lib/docusign_esign/models/locale_policy.rb +13 -0
  179. data/lib/docusign_esign/models/lock_information.rb +2 -0
  180. data/lib/docusign_esign/models/lock_request.rb +1 -0
  181. data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
  182. data/lib/docusign_esign/models/member_shared_items.rb +3 -0
  183. data/lib/docusign_esign/models/merge_field.rb +6 -0
  184. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
  185. data/lib/docusign_esign/models/money.rb +1 -0
  186. data/lib/docusign_esign/models/name_value.rb +2 -0
  187. data/lib/docusign_esign/models/new_account_definition.rb +20 -1
  188. data/lib/docusign_esign/models/new_account_summary.rb +1 -0
  189. data/lib/docusign_esign/models/new_user.rb +2 -0
  190. data/lib/docusign_esign/models/new_users_summary.rb +1 -0
  191. data/lib/docusign_esign/models/notarize.rb +38 -0
  192. data/lib/docusign_esign/models/notary.rb +1 -0
  193. data/lib/docusign_esign/models/notary_host.rb +20 -0
  194. data/lib/docusign_esign/models/notary_journal.rb +2 -0
  195. data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
  196. data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
  197. data/lib/docusign_esign/models/notary_recipient.rb +29 -0
  198. data/lib/docusign_esign/models/notary_result.rb +2 -0
  199. data/lib/docusign_esign/models/notary_seal.rb +39 -0
  200. data/lib/docusign_esign/models/note.rb +47 -0
  201. data/lib/docusign_esign/models/notification.rb +2 -0
  202. data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
  203. data/lib/docusign_esign/models/notification_defaults.rb +2 -0
  204. data/lib/docusign_esign/models/number.rb +61 -0
  205. data/lib/docusign_esign/models/page.rb +1 -0
  206. data/lib/docusign_esign/models/payment_details.rb +5 -0
  207. data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
  208. data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
  209. data/lib/docusign_esign/models/payment_line_item.rb +1 -0
  210. data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
  211. data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
  212. data/lib/docusign_esign/models/permission_profile.rb +2 -0
  213. data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
  214. data/lib/docusign_esign/models/phone_number.rb +52 -0
  215. data/lib/docusign_esign/models/poly_line_overlay.rb +40 -0
  216. data/lib/docusign_esign/models/power_form.rb +2 -0
  217. data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
  218. data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
  219. data/lib/docusign_esign/models/power_forms_response.rb +1 -0
  220. data/lib/docusign_esign/models/prefill_tabs.rb +1 -0
  221. data/lib/docusign_esign/models/property_metadata.rb +1 -0
  222. data/lib/docusign_esign/models/radio.rb +28 -0
  223. data/lib/docusign_esign/models/radio_group.rb +17 -0
  224. data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
  225. data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
  226. data/lib/docusign_esign/models/recipient_group.rb +1 -0
  227. data/lib/docusign_esign/models/recipient_identity_phone_number.rb +3 -0
  228. data/lib/docusign_esign/models/recipient_identity_verification.rb +2 -0
  229. data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
  230. data/lib/docusign_esign/models/recipient_option.rb +1 -0
  231. data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
  232. data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
  233. data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
  234. data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
  235. data/lib/docusign_esign/models/recipient_routing.rb +2 -0
  236. data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
  237. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
  238. data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
  239. data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +30 -30
  240. data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
  241. data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
  242. data/lib/docusign_esign/models/recipients.rb +1 -0
  243. data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
  244. data/lib/docusign_esign/models/return_url_request.rb +1 -0
  245. data/lib/docusign_esign/models/seal_sign.rb +17 -0
  246. data/lib/docusign_esign/models/seat_discount.rb +1 -0
  247. data/lib/docusign_esign/models/sender_company.rb +45 -0
  248. data/lib/docusign_esign/models/sender_email_notifications.rb +1 -0
  249. data/lib/docusign_esign/models/sender_name.rb +45 -0
  250. data/lib/docusign_esign/models/settings_metadata.rb +1 -0
  251. data/lib/docusign_esign/models/shared_item.rb +3 -0
  252. data/lib/docusign_esign/models/sign_here.rb +42 -0
  253. data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
  254. data/lib/docusign_esign/models/signature_type.rb +1 -0
  255. data/lib/docusign_esign/models/signer.rb +30 -0
  256. data/lib/docusign_esign/models/signer_attachment.rb +40 -0
  257. data/lib/docusign_esign/models/signing_group.rb +2 -0
  258. data/lib/docusign_esign/models/signing_group_user.rb +1 -0
  259. data/lib/docusign_esign/models/smart_section.rb +41 -0
  260. data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
  261. data/lib/docusign_esign/models/social_account_information.rb +1 -0
  262. data/lib/docusign_esign/models/ssn.rb +59 -0
  263. data/lib/docusign_esign/models/stamp.rb +2 -0
  264. data/lib/docusign_esign/models/supported_languages.rb +1 -0
  265. data/lib/docusign_esign/models/tab_account_settings.rb +22 -0
  266. data/lib/docusign_esign/models/tab_group.rb +41 -0
  267. data/lib/docusign_esign/models/tab_metadata.rb +14 -1
  268. data/lib/docusign_esign/models/tabs.rb +2 -0
  269. data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
  270. data/lib/docusign_esign/models/template_notification_request.rb +2 -0
  271. data/lib/docusign_esign/models/template_recipients.rb +1 -0
  272. data/lib/docusign_esign/models/template_role.rb +4 -0
  273. data/lib/docusign_esign/models/template_shared_item.rb +3 -0
  274. data/lib/docusign_esign/models/template_summary.rb +3 -0
  275. data/lib/docusign_esign/models/template_tabs.rb +1 -0
  276. data/lib/docusign_esign/models/template_update_summary.rb +4 -0
  277. data/lib/docusign_esign/models/text.rb +61 -0
  278. data/lib/docusign_esign/models/text_custom_field.rb +2 -0
  279. data/lib/docusign_esign/models/title.rb +52 -0
  280. data/lib/docusign_esign/models/user_account_management_granular_information.rb +12 -0
  281. data/lib/docusign_esign/models/user_info.rb +1 -0
  282. data/lib/docusign_esign/models/user_information.rb +6 -0
  283. data/lib/docusign_esign/models/user_information_list.rb +1 -0
  284. data/lib/docusign_esign/models/user_password_information.rb +1 -0
  285. data/lib/docusign_esign/models/user_password_rules.rb +2 -0
  286. data/lib/docusign_esign/models/user_profile.rb +3 -0
  287. data/lib/docusign_esign/models/user_settings_information.rb +61 -0
  288. data/lib/docusign_esign/models/user_shared_item.rb +3 -0
  289. data/lib/docusign_esign/models/user_signature.rb +2 -0
  290. data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
  291. data/lib/docusign_esign/models/view.rb +46 -0
  292. data/lib/docusign_esign/models/witness.rb +30 -0
  293. data/lib/docusign_esign/models/workflow.rb +2 -0
  294. data/lib/docusign_esign/models/workflow_step.rb +3 -0
  295. data/lib/docusign_esign/models/workspace.rb +4 -0
  296. data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
  297. data/lib/docusign_esign/models/workspace_item.rb +5 -0
  298. data/lib/docusign_esign/models/workspace_settings.rb +1 -0
  299. data/lib/docusign_esign/models/workspace_user.rb +1 -0
  300. data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
  301. data/lib/docusign_esign/models/zip.rb +60 -0
  302. data/lib/docusign_esign/version.rb +1 -1
  303. data/lib/docusign_esign.rb +1 -0
  304. metadata +7 -6
@@ -80,7 +80,7 @@ module DocuSign_eSign
80
80
  end
81
81
 
82
82
  class GetConsumerDisclosureOptions
83
- # The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
83
+ # The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
84
84
  attr_accessor :lang_code2
85
85
 
86
86
  def self.default
@@ -604,7 +604,7 @@ module DocuSign_eSign
604
604
  end
605
605
 
606
606
  # Initiate a new ChunkedUpload.
607
- #
607
+ # This method initiates a new chunked upload with the first part of the content.
608
608
  # @param account_id The external account number (int) or account ID Guid.
609
609
  # @param chunked_upload_request (optional parameter)
610
610
  # @return [ChunkedUploadResponse]
@@ -614,7 +614,7 @@ module DocuSign_eSign
614
614
  end
615
615
 
616
616
  # Initiate a new ChunkedUpload.
617
- #
617
+ # This method initiates a new chunked upload with the first part of the content.
618
618
  # @param account_id The external account number (int) or account ID Guid.
619
619
  # @param chunked_upload_request (optional parameter)
620
620
  # @return [Array<(ChunkedUploadResponse, Fixnum, Hash)>] ChunkedUploadResponse data, response status code and response headers
@@ -875,7 +875,7 @@ module DocuSign_eSign
875
875
  end
876
876
 
877
877
  # Get Responsive HTML Preview for a document in an envelope.
878
- #
878
+ # 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
879
  # @param account_id The external account number (int) or account ID Guid.
880
880
  # @param document_id The ID of the document being accessed.
881
881
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -887,7 +887,7 @@ module DocuSign_eSign
887
887
  end
888
888
 
889
889
  # Get Responsive HTML Preview for a document in an envelope.
890
- #
890
+ # 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
891
  # @param account_id The external account number (int) or account ID Guid.
892
892
  # @param document_id The ID of the document being accessed.
893
893
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -934,7 +934,7 @@ module DocuSign_eSign
934
934
  end
935
935
 
936
936
  # Adds the tabs to an envelope document
937
- #
937
+ # 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
938
  # @param account_id The external account number (int) or account ID Guid.
939
939
  # @param document_id The ID of the document being accessed.
940
940
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -946,7 +946,7 @@ module DocuSign_eSign
946
946
  end
947
947
 
948
948
  # Adds the tabs to an envelope document
949
- #
949
+ # 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
950
  # @param account_id The external account number (int) or account ID Guid.
951
951
  # @param document_id The ID of the document being accessed.
952
952
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -1216,7 +1216,7 @@ module DocuSign_eSign
1216
1216
  end
1217
1217
 
1218
1218
  # Provides a URL to start a recipient view of the Envelope UI
1219
- #
1219
+ # 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
1220
  # @param account_id The external account number (int) or account ID Guid.
1221
1221
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1222
1222
  # @param recipient_preview_request (optional parameter)
@@ -1227,7 +1227,7 @@ module DocuSign_eSign
1227
1227
  end
1228
1228
 
1229
1229
  # Provides a URL to start a recipient view of the Envelope UI
1230
- #
1230
+ # 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
1231
  # @param account_id The external account number (int) or account ID Guid.
1232
1232
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1233
1233
  # @param recipient_preview_request (optional parameter)
@@ -1271,7 +1271,7 @@ module DocuSign_eSign
1271
1271
  end
1272
1272
 
1273
1273
  # Provides a URL to start a shared recipient view of the Envelope UI
1274
- #
1274
+ # 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
1275
  # @param account_id The external account number (int) or account ID Guid.
1276
1276
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1277
1277
  # @param recipient_view_request (optional parameter)
@@ -1282,7 +1282,7 @@ module DocuSign_eSign
1282
1282
  end
1283
1283
 
1284
1284
  # Provides a URL to start a shared recipient view of the Envelope UI
1285
- #
1285
+ # 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
1286
  # @param account_id The external account number (int) or account ID Guid.
1287
1287
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1288
1288
  # @param recipient_view_request (optional parameter)
@@ -1326,7 +1326,7 @@ module DocuSign_eSign
1326
1326
  end
1327
1327
 
1328
1328
  # Add envelope transfer rules to an account.
1329
- #
1329
+ # 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
1330
  # @param account_id The external account number (int) or account ID Guid.
1331
1331
  # @param envelope_transfer_rule_request (optional parameter)
1332
1332
  # @return [EnvelopeTransferRuleInformation]
@@ -1336,7 +1336,7 @@ module DocuSign_eSign
1336
1336
  end
1337
1337
 
1338
1338
  # Add envelope transfer rules to an account.
1339
- #
1339
+ # 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
1340
  # @param account_id The external account number (int) or account ID Guid.
1341
1341
  # @param envelope_transfer_rule_request (optional parameter)
1342
1342
  # @return [Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>] EnvelopeTransferRuleInformation data, response status code and response headers
@@ -1376,6 +1376,61 @@ module DocuSign_eSign
1376
1376
  return data, status_code, headers
1377
1377
  end
1378
1378
 
1379
+ # Creates and adds a new workflow step definition for an envelope's workflow
1380
+ #
1381
+ # @param account_id The external account number (int) or account ID Guid.
1382
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1383
+ # @param workflow_step (optional parameter)
1384
+ # @return [WorkflowStep]
1385
+ def create_envelope_workflow_step_definition(account_id, envelope_id, workflow_step)
1386
+ data, _status_code, _headers = create_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step)
1387
+ return data
1388
+ end
1389
+
1390
+ # Creates and adds a new workflow step definition for an envelope&#39;s workflow
1391
+ #
1392
+ # @param account_id The external account number (int) or account ID Guid.
1393
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1394
+ # @param workflow_step (optional parameter)
1395
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
1396
+ def create_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step)
1397
+ if @api_client.config.debugging
1398
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_workflow_step_definition ..."
1399
+ end
1400
+ # verify the required parameter 'account_id' is set
1401
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_workflow_step_definition" if account_id.nil?
1402
+ # verify the required parameter 'envelope_id' is set
1403
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_envelope_workflow_step_definition" if envelope_id.nil?
1404
+ # resource path
1405
+ 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)
1406
+
1407
+ # query parameters
1408
+ query_params = {}
1409
+
1410
+ # header parameters
1411
+ header_params = {}
1412
+ # HTTP header 'Accept' (if needed)
1413
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1414
+
1415
+ # form parameters
1416
+ form_params = {}
1417
+
1418
+ # http body (model)
1419
+ post_body = @api_client.object_to_http_body(workflow_step)
1420
+ auth_names = []
1421
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1422
+ :header_params => header_params,
1423
+ :query_params => query_params,
1424
+ :form_params => form_params,
1425
+ :body => post_body,
1426
+ :auth_names => auth_names,
1427
+ :return_type => 'WorkflowStep')
1428
+ if @api_client.config.debugging
1429
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1430
+ end
1431
+ return data, status_code, headers
1432
+ end
1433
+
1379
1434
  # Submits a batch of historical envelopes for republish to an adhoc config.
1380
1435
  #
1381
1436
  # @param account_id The external account number (int) or account ID Guid.
@@ -1541,7 +1596,7 @@ module DocuSign_eSign
1541
1596
  end
1542
1597
 
1543
1598
  # Provides a link to access the Identity manual review related to a recipient.
1544
- #
1599
+ # 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
1600
  # @param account_id The external account number (int) or account ID Guid.
1546
1601
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1547
1602
  # @param recipient_id The ID of the recipient being accessed.
@@ -1552,7 +1607,7 @@ module DocuSign_eSign
1552
1607
  end
1553
1608
 
1554
1609
  # Provides a link to access the Identity manual review related to a recipient.
1555
- #
1610
+ # 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
1611
  # @param account_id The external account number (int) or account ID Guid.
1557
1612
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1558
1613
  # @param recipient_id The ID of the recipient being accessed.
@@ -1655,7 +1710,7 @@ module DocuSign_eSign
1655
1710
  end
1656
1711
 
1657
1712
  # Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
1658
- #
1713
+ # 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
1714
  # @param account_id The external account number (int) or account ID Guid.
1660
1715
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1661
1716
  # @param recipient_id The ID of the recipient being accessed.
@@ -1667,7 +1722,7 @@ module DocuSign_eSign
1667
1722
  end
1668
1723
 
1669
1724
  # Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
1670
- #
1725
+ # 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
1726
  # @param account_id The external account number (int) or account ID Guid.
1672
1727
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1673
1728
  # @param recipient_id The ID of the recipient being accessed.
@@ -1771,7 +1826,7 @@ module DocuSign_eSign
1771
1826
  end
1772
1827
 
1773
1828
  # Get Responsive HTML Preview for all documents in an envelope.
1774
- #
1829
+ # 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
1830
  # @param account_id The external account number (int) or account ID Guid.
1776
1831
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1777
1832
  # @param document_html_definition (optional parameter)
@@ -1782,7 +1837,7 @@ module DocuSign_eSign
1782
1837
  end
1783
1838
 
1784
1839
  # Get Responsive HTML Preview for all documents in an envelope.
1785
- #
1840
+ # 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
1841
  # @param account_id The external account number (int) or account ID Guid.
1787
1842
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1788
1843
  # @param document_html_definition (optional parameter)
@@ -1939,9 +1994,64 @@ module DocuSign_eSign
1939
1994
  return data, status_code, headers
1940
1995
  end
1941
1996
 
1942
- # Delete one or more attachments from a DRAFT envelope.
1997
+ # Creates and adds a new workflow step definition for a template's workflow
1998
+ #
1999
+ # @param account_id The external account number (int) or account ID Guid.
2000
+ # @param template_id The ID of the template being accessed.
2001
+ # @param workflow_step (optional parameter)
2002
+ # @return [WorkflowStep]
2003
+ def create_template_workflow_step_definition(account_id, template_id, workflow_step)
2004
+ data, _status_code, _headers = create_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step)
2005
+ return data
2006
+ end
2007
+
2008
+ # Creates and adds a new workflow step definition for a template&#39;s workflow
1943
2009
  #
1944
2010
  # @param account_id The external account number (int) or account ID Guid.
2011
+ # @param template_id The ID of the template being accessed.
2012
+ # @param workflow_step (optional parameter)
2013
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
2014
+ def create_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step)
2015
+ if @api_client.config.debugging
2016
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_template_workflow_step_definition ..."
2017
+ end
2018
+ # verify the required parameter 'account_id' is set
2019
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_template_workflow_step_definition" if account_id.nil?
2020
+ # verify the required parameter 'template_id' is set
2021
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.create_template_workflow_step_definition" if template_id.nil?
2022
+ # resource path
2023
+ 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)
2024
+
2025
+ # query parameters
2026
+ query_params = {}
2027
+
2028
+ # header parameters
2029
+ header_params = {}
2030
+ # HTTP header 'Accept' (if needed)
2031
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2032
+
2033
+ # form parameters
2034
+ form_params = {}
2035
+
2036
+ # http body (model)
2037
+ post_body = @api_client.object_to_http_body(workflow_step)
2038
+ auth_names = []
2039
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2040
+ :header_params => header_params,
2041
+ :query_params => query_params,
2042
+ :form_params => form_params,
2043
+ :body => post_body,
2044
+ :auth_names => auth_names,
2045
+ :return_type => 'WorkflowStep')
2046
+ if @api_client.config.debugging
2047
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2048
+ end
2049
+ return data, status_code, headers
2050
+ end
2051
+
2052
+ # Delete one or more attachments from a DRAFT envelope.
2053
+ # Deletes one or more attachments from a draft envelope.
2054
+ # @param account_id The external account number (int) or account ID Guid.
1945
2055
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1946
2056
  # @param envelope_attachments_request (optional parameter)
1947
2057
  # @return [EnvelopeAttachmentsResult]
@@ -1951,7 +2061,7 @@ module DocuSign_eSign
1951
2061
  end
1952
2062
 
1953
2063
  # Delete one or more attachments from a DRAFT envelope.
1954
- #
2064
+ # Deletes one or more attachments from a draft envelope.
1955
2065
  # @param account_id The external account number (int) or account ID Guid.
1956
2066
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1957
2067
  # @param envelope_attachments_request (optional parameter)
@@ -1995,7 +2105,7 @@ module DocuSign_eSign
1995
2105
  end
1996
2106
 
1997
2107
  # Delete an existing ChunkedUpload.
1998
- #
2108
+ # 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
2109
  # @param account_id The external account number (int) or account ID Guid.
2000
2110
  # @param chunked_upload_id
2001
2111
  # @return [ChunkedUploadResponse]
@@ -2005,7 +2115,7 @@ module DocuSign_eSign
2005
2115
  end
2006
2116
 
2007
2117
  # Delete an existing ChunkedUpload.
2008
- #
2118
+ # 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
2119
  # @param account_id The external account number (int) or account ID Guid.
2010
2120
  # @param chunked_upload_id
2011
2121
  # @return [Array<(ChunkedUploadResponse, Fixnum, Hash)>] ChunkedUploadResponse data, response status code and response headers
@@ -2222,7 +2332,7 @@ module DocuSign_eSign
2222
2332
  end
2223
2333
 
2224
2334
  # Deletes tabs from an envelope document
2225
- #
2335
+ # Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.
2226
2336
  # @param account_id The external account number (int) or account ID Guid.
2227
2337
  # @param document_id The ID of the document being accessed.
2228
2338
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2234,7 +2344,7 @@ module DocuSign_eSign
2234
2344
  end
2235
2345
 
2236
2346
  # Deletes tabs from an envelope document
2237
- #
2347
+ # Deletes tabs from the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.
2238
2348
  # @param account_id The external account number (int) or account ID Guid.
2239
2349
  # @param document_id The ID of the document being accessed.
2240
2350
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2389,7 +2499,7 @@ module DocuSign_eSign
2389
2499
  end
2390
2500
 
2391
2501
  # Revokes the correction view URL to the Envelope UI
2392
- #
2502
+ # Revokes the correction view URL to the Envelope UI.
2393
2503
  # @param account_id The external account number (int) or account ID Guid.
2394
2504
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2395
2505
  # @param correct_view_request (optional parameter)
@@ -2400,7 +2510,7 @@ module DocuSign_eSign
2400
2510
  end
2401
2511
 
2402
2512
  # Revokes the correction view URL to the Envelope UI
2403
- #
2513
+ # Revokes the correction view URL to the Envelope UI.
2404
2514
  # @param account_id The external account number (int) or account ID Guid.
2405
2515
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2406
2516
  # @param correct_view_request (optional parameter)
@@ -2442,9 +2552,117 @@ module DocuSign_eSign
2442
2552
  return data, status_code, headers
2443
2553
  end
2444
2554
 
2445
- # Delete envelope transfer rules for an account.
2555
+ # Deletes the delayed routing rules for the specified envelope workflow step.
2556
+ #
2557
+ # @param account_id The external account number (int) or account ID Guid.
2558
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2559
+ # @param workflow_step_id
2560
+ # @return [nil]
2561
+ def delete_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id)
2562
+ delete_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id)
2563
+ return nil
2564
+ end
2565
+
2566
+ # Deletes the delayed routing rules for the specified envelope workflow step.
2567
+ #
2568
+ # @param account_id The external account number (int) or account ID Guid.
2569
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2570
+ # @param workflow_step_id
2571
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2572
+ def delete_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id)
2573
+ if @api_client.config.debugging
2574
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_delayed_routing_definition ..."
2575
+ end
2576
+ # verify the required parameter 'account_id' is set
2577
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_delayed_routing_definition" if account_id.nil?
2578
+ # verify the required parameter 'envelope_id' is set
2579
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_delayed_routing_definition" if envelope_id.nil?
2580
+ # verify the required parameter 'workflow_step_id' is set
2581
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_envelope_delayed_routing_definition" if workflow_step_id.nil?
2582
+ # resource path
2583
+ 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)
2584
+
2585
+ # query parameters
2586
+ query_params = {}
2587
+
2588
+ # header parameters
2589
+ header_params = {}
2590
+ # HTTP header 'Accept' (if needed)
2591
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2592
+
2593
+ # form parameters
2594
+ form_params = {}
2595
+
2596
+ # http body (model)
2597
+ post_body = nil
2598
+ auth_names = []
2599
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2600
+ :header_params => header_params,
2601
+ :query_params => query_params,
2602
+ :form_params => form_params,
2603
+ :body => post_body,
2604
+ :auth_names => auth_names)
2605
+ if @api_client.config.debugging
2606
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2607
+ end
2608
+ return data, status_code, headers
2609
+ end
2610
+
2611
+ # Deletes the scheduled sending rules for the envelope's workflow.
2612
+ #
2613
+ # @param account_id The external account number (int) or account ID Guid.
2614
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2615
+ # @return [nil]
2616
+ def delete_envelope_scheduled_sending_definition(account_id, envelope_id)
2617
+ delete_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id)
2618
+ return nil
2619
+ end
2620
+
2621
+ # Deletes the scheduled sending rules for the envelope&#39;s workflow.
2446
2622
  #
2447
2623
  # @param account_id The external account number (int) or account ID Guid.
2624
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2625
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2626
+ def delete_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id)
2627
+ if @api_client.config.debugging
2628
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_scheduled_sending_definition ..."
2629
+ end
2630
+ # verify the required parameter 'account_id' is set
2631
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_scheduled_sending_definition" if account_id.nil?
2632
+ # verify the required parameter 'envelope_id' is set
2633
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_scheduled_sending_definition" if envelope_id.nil?
2634
+ # resource path
2635
+ 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)
2636
+
2637
+ # query parameters
2638
+ query_params = {}
2639
+
2640
+ # header parameters
2641
+ header_params = {}
2642
+ # HTTP header 'Accept' (if needed)
2643
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2644
+
2645
+ # form parameters
2646
+ form_params = {}
2647
+
2648
+ # http body (model)
2649
+ post_body = nil
2650
+ auth_names = []
2651
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2652
+ :header_params => header_params,
2653
+ :query_params => query_params,
2654
+ :form_params => form_params,
2655
+ :body => post_body,
2656
+ :auth_names => auth_names)
2657
+ if @api_client.config.debugging
2658
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2659
+ end
2660
+ return data, status_code, headers
2661
+ end
2662
+
2663
+ # Delete envelope transfer rules for an account.
2664
+ # 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.
2665
+ # @param account_id The external account number (int) or account ID Guid.
2448
2666
  # @param envelope_transfer_rule_id
2449
2667
  # @return [nil]
2450
2668
  def delete_envelope_transfer_rules(account_id, envelope_transfer_rule_id)
@@ -2453,7 +2671,7 @@ module DocuSign_eSign
2453
2671
  end
2454
2672
 
2455
2673
  # Delete envelope transfer rules for an account.
2456
- #
2674
+ # 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
2675
  # @param account_id The external account number (int) or account ID Guid.
2458
2676
  # @param envelope_transfer_rule_id
2459
2677
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -2495,7 +2713,7 @@ module DocuSign_eSign
2495
2713
  end
2496
2714
 
2497
2715
  # Delete the workflow definition for an envelope.
2498
- #
2716
+ # Deletes the specified envelope's workflow definition if it has one.
2499
2717
  # @param account_id The external account number (int) or account ID Guid.
2500
2718
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2501
2719
  # @return [nil]
@@ -2505,7 +2723,7 @@ module DocuSign_eSign
2505
2723
  end
2506
2724
 
2507
2725
  # Delete the workflow definition for an envelope.
2508
- #
2726
+ # Deletes the specified envelope&#39;s workflow definition if it has one.
2509
2727
  # @param account_id The external account number (int) or account ID Guid.
2510
2728
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2511
2729
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -2546,6 +2764,62 @@ module DocuSign_eSign
2546
2764
  return data, status_code, headers
2547
2765
  end
2548
2766
 
2767
+ # Deletes the envelope workflow step definition for an envelope's workflow by step id.
2768
+ #
2769
+ # @param account_id The external account number (int) or account ID Guid.
2770
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2771
+ # @param workflow_step_id
2772
+ # @return [nil]
2773
+ def delete_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id)
2774
+ delete_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id)
2775
+ return nil
2776
+ end
2777
+
2778
+ # Deletes the envelope workflow step definition for an envelope&#39;s workflow by step id.
2779
+ #
2780
+ # @param account_id The external account number (int) or account ID Guid.
2781
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2782
+ # @param workflow_step_id
2783
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2784
+ def delete_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id)
2785
+ if @api_client.config.debugging
2786
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_workflow_step_definition ..."
2787
+ end
2788
+ # verify the required parameter 'account_id' is set
2789
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_workflow_step_definition" if account_id.nil?
2790
+ # verify the required parameter 'envelope_id' is set
2791
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_workflow_step_definition" if envelope_id.nil?
2792
+ # verify the required parameter 'workflow_step_id' is set
2793
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_envelope_workflow_step_definition" if workflow_step_id.nil?
2794
+ # resource path
2795
+ 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)
2796
+
2797
+ # query parameters
2798
+ query_params = {}
2799
+
2800
+ # header parameters
2801
+ header_params = {}
2802
+ # HTTP header 'Accept' (if needed)
2803
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2804
+
2805
+ # form parameters
2806
+ form_params = {}
2807
+
2808
+ # http body (model)
2809
+ post_body = nil
2810
+ auth_names = []
2811
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2812
+ :header_params => header_params,
2813
+ :query_params => query_params,
2814
+ :form_params => form_params,
2815
+ :body => post_body,
2816
+ :auth_names => auth_names)
2817
+ if @api_client.config.debugging
2818
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2819
+ end
2820
+ return data, status_code, headers
2821
+ end
2822
+
2549
2823
  # Deletes an envelope lock.
2550
2824
  # Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
2551
2825
  # @param account_id The external account number (int) or account ID Guid.
@@ -2770,31 +3044,35 @@ module DocuSign_eSign
2770
3044
  return data, status_code, headers
2771
3045
  end
2772
3046
 
2773
- # Delete the workflow definition for a template.
3047
+ # Deletes the delayed routing rules for the specified template workflow step.
2774
3048
  #
2775
3049
  # @param account_id The external account number (int) or account ID Guid.
2776
3050
  # @param template_id The ID of the template being accessed.
3051
+ # @param workflow_step_id
2777
3052
  # @return [nil]
2778
- def delete_template_workflow_definition(account_id, template_id)
2779
- delete_template_workflow_definition_with_http_info(account_id, template_id)
3053
+ def delete_template_delayed_routing_definition(account_id, template_id, workflow_step_id)
3054
+ delete_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id)
2780
3055
  return nil
2781
3056
  end
2782
3057
 
2783
- # Delete the workflow definition for a template.
3058
+ # Deletes the delayed routing rules for the specified template workflow step.
2784
3059
  #
2785
3060
  # @param account_id The external account number (int) or account ID Guid.
2786
3061
  # @param template_id The ID of the template being accessed.
3062
+ # @param workflow_step_id
2787
3063
  # @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)
3064
+ def delete_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id)
2789
3065
  if @api_client.config.debugging
2790
- @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_workflow_definition ..."
3066
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_delayed_routing_definition ..."
2791
3067
  end
2792
3068
  # 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?
3069
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_delayed_routing_definition" if account_id.nil?
2794
3070
  # 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?
3071
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_delayed_routing_definition" if template_id.nil?
3072
+ # verify the required parameter 'workflow_step_id' is set
3073
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_template_delayed_routing_definition" if workflow_step_id.nil?
2796
3074
  # 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)
3075
+ 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
3076
 
2799
3077
  # query parameters
2800
3078
  query_params = {}
@@ -2817,28 +3095,188 @@ module DocuSign_eSign
2817
3095
  :body => post_body,
2818
3096
  :auth_names => auth_names)
2819
3097
  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}"
3098
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_template_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2821
3099
  end
2822
3100
  return data, status_code, headers
2823
3101
  end
2824
3102
 
2825
- # Deletes a template from a document in an existing envelope.
2826
- # Deletes the specified template from a document in an existing envelope.
3103
+ # Deletes the scheduled sending rules for the template's workflow.
3104
+ #
2827
3105
  # @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
3106
  # @param template_id The ID of the template being accessed.
2831
3107
  # @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)
3108
+ def delete_template_scheduled_sending_definition(account_id, template_id)
3109
+ delete_template_scheduled_sending_definition_with_http_info(account_id, template_id)
2834
3110
  return nil
2835
3111
  end
2836
3112
 
2837
- # Deletes a template from a document in an existing envelope.
2838
- # Deletes the specified template from a document in an existing envelope.
3113
+ # Deletes the scheduled sending rules for the template&#39;s workflow.
3114
+ #
2839
3115
  # @param account_id The external account number (int) or account ID Guid.
2840
- # @param document_id The ID of the document being accessed.
2841
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
3116
+ # @param template_id The ID of the template being accessed.
3117
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3118
+ def delete_template_scheduled_sending_definition_with_http_info(account_id, template_id)
3119
+ if @api_client.config.debugging
3120
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_scheduled_sending_definition ..."
3121
+ end
3122
+ # verify the required parameter 'account_id' is set
3123
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_scheduled_sending_definition" if account_id.nil?
3124
+ # verify the required parameter 'template_id' is set
3125
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_scheduled_sending_definition" if template_id.nil?
3126
+ # resource path
3127
+ 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)
3128
+
3129
+ # query parameters
3130
+ query_params = {}
3131
+
3132
+ # header parameters
3133
+ header_params = {}
3134
+ # HTTP header 'Accept' (if needed)
3135
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3136
+
3137
+ # form parameters
3138
+ form_params = {}
3139
+
3140
+ # http body (model)
3141
+ post_body = nil
3142
+ auth_names = []
3143
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3144
+ :header_params => header_params,
3145
+ :query_params => query_params,
3146
+ :form_params => form_params,
3147
+ :body => post_body,
3148
+ :auth_names => auth_names)
3149
+ if @api_client.config.debugging
3150
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_template_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3151
+ end
3152
+ return data, status_code, headers
3153
+ end
3154
+
3155
+ # Delete the workflow definition for a template.
3156
+ # Deletes the specified template's workflow definition if it has one.
3157
+ # @param account_id The external account number (int) or account ID Guid.
3158
+ # @param template_id The ID of the template being accessed.
3159
+ # @return [nil]
3160
+ def delete_template_workflow_definition(account_id, template_id)
3161
+ delete_template_workflow_definition_with_http_info(account_id, template_id)
3162
+ return nil
3163
+ end
3164
+
3165
+ # Delete the workflow definition for a template.
3166
+ # Deletes the specified template&#39;s workflow definition if it has one.
3167
+ # @param account_id The external account number (int) or account ID Guid.
3168
+ # @param template_id The ID of the template being accessed.
3169
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3170
+ def delete_template_workflow_definition_with_http_info(account_id, template_id)
3171
+ if @api_client.config.debugging
3172
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_workflow_definition ..."
3173
+ end
3174
+ # verify the required parameter 'account_id' is set
3175
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_workflow_definition" if account_id.nil?
3176
+ # verify the required parameter 'template_id' is set
3177
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_workflow_definition" if template_id.nil?
3178
+ # resource path
3179
+ 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)
3180
+
3181
+ # query parameters
3182
+ query_params = {}
3183
+
3184
+ # header parameters
3185
+ header_params = {}
3186
+ # HTTP header 'Accept' (if needed)
3187
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3188
+
3189
+ # form parameters
3190
+ form_params = {}
3191
+
3192
+ # http body (model)
3193
+ post_body = nil
3194
+ auth_names = []
3195
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3196
+ :header_params => header_params,
3197
+ :query_params => query_params,
3198
+ :form_params => form_params,
3199
+ :body => post_body,
3200
+ :auth_names => auth_names)
3201
+ if @api_client.config.debugging
3202
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3203
+ end
3204
+ return data, status_code, headers
3205
+ end
3206
+
3207
+ # Deletes the workflow step definition for an template's workflow by step id.
3208
+ #
3209
+ # @param account_id The external account number (int) or account ID Guid.
3210
+ # @param template_id The ID of the template being accessed.
3211
+ # @param workflow_step_id
3212
+ # @return [nil]
3213
+ def delete_template_workflow_step_definition(account_id, template_id, workflow_step_id)
3214
+ delete_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id)
3215
+ return nil
3216
+ end
3217
+
3218
+ # Deletes the workflow step definition for an template&#39;s workflow by step id.
3219
+ #
3220
+ # @param account_id The external account number (int) or account ID Guid.
3221
+ # @param template_id The ID of the template being accessed.
3222
+ # @param workflow_step_id
3223
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3224
+ def delete_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id)
3225
+ if @api_client.config.debugging
3226
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_workflow_step_definition ..."
3227
+ end
3228
+ # verify the required parameter 'account_id' is set
3229
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_workflow_step_definition" if account_id.nil?
3230
+ # verify the required parameter 'template_id' is set
3231
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_workflow_step_definition" if template_id.nil?
3232
+ # verify the required parameter 'workflow_step_id' is set
3233
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_template_workflow_step_definition" if workflow_step_id.nil?
3234
+ # resource path
3235
+ 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)
3236
+
3237
+ # query parameters
3238
+ query_params = {}
3239
+
3240
+ # header parameters
3241
+ header_params = {}
3242
+ # HTTP header 'Accept' (if needed)
3243
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3244
+
3245
+ # form parameters
3246
+ form_params = {}
3247
+
3248
+ # http body (model)
3249
+ post_body = nil
3250
+ auth_names = []
3251
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3252
+ :header_params => header_params,
3253
+ :query_params => query_params,
3254
+ :form_params => form_params,
3255
+ :body => post_body,
3256
+ :auth_names => auth_names)
3257
+ if @api_client.config.debugging
3258
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3259
+ end
3260
+ return data, status_code, headers
3261
+ end
3262
+
3263
+ # Deletes a template from a document in an existing envelope.
3264
+ # Deletes the specified template from a document in an existing envelope.
3265
+ # @param account_id The external account number (int) or account ID Guid.
3266
+ # @param document_id The ID of the document being accessed.
3267
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3268
+ # @param template_id The ID of the template being accessed.
3269
+ # @return [nil]
3270
+ def delete_templates_from_document(account_id, document_id, envelope_id, template_id)
3271
+ delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id)
3272
+ return nil
3273
+ end
3274
+
3275
+ # Deletes a template from a document in an existing envelope.
3276
+ # Deletes the specified template from a document in an existing envelope.
3277
+ # @param account_id The external account number (int) or account ID Guid.
3278
+ # @param document_id The ID of the document being accessed.
3279
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2842
3280
  # @param template_id The ID of the template being accessed.
2843
3281
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2844
3282
  def delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id)
@@ -2883,7 +3321,7 @@ module DocuSign_eSign
2883
3321
  end
2884
3322
 
2885
3323
  # Retrieves an attachment from the envelope.
2886
- #
3324
+ # Retrieves an attachment from an envelope.
2887
3325
  # @param account_id The external account number (int) or account ID Guid.
2888
3326
  # @param attachment_id
2889
3327
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2894,7 +3332,7 @@ module DocuSign_eSign
2894
3332
  end
2895
3333
 
2896
3334
  # Retrieves an attachment from the envelope.
2897
- #
3335
+ # Retrieves an attachment from an envelope.
2898
3336
  # @param account_id The external account number (int) or account ID Guid.
2899
3337
  # @param attachment_id
2900
3338
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2939,7 +3377,7 @@ module DocuSign_eSign
2939
3377
  end
2940
3378
 
2941
3379
  # Returns a list of attachments associated with the specified envelope
2942
- #
3380
+ # Returns a list of attachments associated with a specified envelope
2943
3381
  # @param account_id The external account number (int) or account ID Guid.
2944
3382
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2945
3383
  # @return [EnvelopeAttachmentsResult]
@@ -2949,7 +3387,7 @@ module DocuSign_eSign
2949
3387
  end
2950
3388
 
2951
3389
  # Returns a list of attachments associated with the specified envelope
2952
- #
3390
+ # Returns a list of attachments associated with a specified envelope
2953
3391
  # @param account_id The external account number (int) or account ID Guid.
2954
3392
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2955
3393
  # @return [Array<(EnvelopeAttachmentsResult, Fixnum, Hash)>] EnvelopeAttachmentsResult data, response status code and response headers
@@ -2992,7 +3430,7 @@ module DocuSign_eSign
2992
3430
  end
2993
3431
 
2994
3432
  # Retrieves the current metadata of a ChunkedUpload.
2995
- #
3433
+ # 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
3434
  # @param account_id The external account number (int) or account ID Guid.
2997
3435
  # @param chunked_upload_id
2998
3436
  # @param DocuSign_eSign::GetChunkedUploadOptions Options for modifying the behavior of the function.
@@ -3003,7 +3441,7 @@ module DocuSign_eSign
3003
3441
  end
3004
3442
 
3005
3443
  # Retrieves the current metadata of a ChunkedUpload.
3006
- #
3444
+ # 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
3445
  # @param account_id The external account number (int) or account ID Guid.
3008
3446
  # @param chunked_upload_id
3009
3447
  # @param DocuSign_eSign::GetChunkedUploadOptions Options for modifying the behavior of the function.
@@ -3048,7 +3486,7 @@ module DocuSign_eSign
3048
3486
  end
3049
3487
 
3050
3488
  # Gets comment transcript for envelope and user
3051
- #
3489
+ # 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
3490
  # @param account_id The external account number (int) or account ID Guid.
3053
3491
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3054
3492
  # @param DocuSign_eSign::GetCommentsTranscriptOptions Options for modifying the behavior of the function.
@@ -3059,7 +3497,7 @@ module DocuSign_eSign
3059
3497
  end
3060
3498
 
3061
3499
  # Gets comment transcript for envelope and user
3062
- #
3500
+ # 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
3501
  # @param account_id The external account number (int) or account ID Guid.
3064
3502
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3065
3503
  # @param DocuSign_eSign::GetCommentsTranscriptOptions Options for modifying the behavior of the function.
@@ -3363,7 +3801,7 @@ module DocuSign_eSign
3363
3801
  end
3364
3802
 
3365
3803
  # Returns tabs on the document.
3366
- #
3804
+ # Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.
3367
3805
  # @param account_id The external account number (int) or account ID Guid.
3368
3806
  # @param document_id The ID of the document being accessed.
3369
3807
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3375,7 +3813,7 @@ module DocuSign_eSign
3375
3813
  end
3376
3814
 
3377
3815
  # Returns tabs on the document.
3378
- #
3816
+ # Returns the tabs on the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.
3379
3817
  # @param account_id The external account number (int) or account ID Guid.
3380
3818
  # @param document_id The ID of the document being accessed.
3381
3819
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3533,6 +3971,63 @@ module DocuSign_eSign
3533
3971
  return data, status_code, headers
3534
3972
  end
3535
3973
 
3974
+ # Returns the delayed routing rules for an envelope's workflow step definition.
3975
+ #
3976
+ # @param account_id The external account number (int) or account ID Guid.
3977
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3978
+ # @param workflow_step_id
3979
+ # @return [DelayedRouting]
3980
+ def get_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id)
3981
+ data, _status_code, _headers = get_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id)
3982
+ return data
3983
+ end
3984
+
3985
+ # Returns the delayed routing rules for an envelope&#39;s workflow step definition.
3986
+ #
3987
+ # @param account_id The external account number (int) or account ID Guid.
3988
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3989
+ # @param workflow_step_id
3990
+ # @return [Array<(DelayedRouting, Fixnum, Hash)>] DelayedRouting data, response status code and response headers
3991
+ def get_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id)
3992
+ if @api_client.config.debugging
3993
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_delayed_routing_definition ..."
3994
+ end
3995
+ # verify the required parameter 'account_id' is set
3996
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_delayed_routing_definition" if account_id.nil?
3997
+ # verify the required parameter 'envelope_id' is set
3998
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_delayed_routing_definition" if envelope_id.nil?
3999
+ # verify the required parameter 'workflow_step_id' is set
4000
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_envelope_delayed_routing_definition" if workflow_step_id.nil?
4001
+ # resource path
4002
+ 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)
4003
+
4004
+ # query parameters
4005
+ query_params = {}
4006
+
4007
+ # header parameters
4008
+ header_params = {}
4009
+ # HTTP header 'Accept' (if needed)
4010
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4011
+
4012
+ # form parameters
4013
+ form_params = {}
4014
+
4015
+ # http body (model)
4016
+ post_body = nil
4017
+ auth_names = []
4018
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4019
+ :header_params => header_params,
4020
+ :query_params => query_params,
4021
+ :form_params => form_params,
4022
+ :body => post_body,
4023
+ :auth_names => auth_names,
4024
+ :return_type => 'DelayedRouting')
4025
+ if @api_client.config.debugging
4026
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4027
+ end
4028
+ return data, status_code, headers
4029
+ end
4030
+
3536
4031
  # Get the Original HTML Definition used to generate the Responsive HTML for a given document.
3537
4032
  #
3538
4033
  # @param account_id The external account number (int) or account ID Guid.
@@ -3643,9 +4138,62 @@ module DocuSign_eSign
3643
4138
  return data, status_code, headers
3644
4139
  end
3645
4140
 
3646
- # Returns a list of envelope transfer rules in the specified account.
4141
+ # Returns the scheduled sending rules for an envelope's workflow definition.
3647
4142
  #
3648
4143
  # @param account_id The external account number (int) or account ID Guid.
4144
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4145
+ # @return [ScheduledSending]
4146
+ def get_envelope_scheduled_sending_definition(account_id, envelope_id)
4147
+ data, _status_code, _headers = get_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id)
4148
+ return data
4149
+ end
4150
+
4151
+ # Returns the scheduled sending rules for an envelope&#39;s workflow definition.
4152
+ #
4153
+ # @param account_id The external account number (int) or account ID Guid.
4154
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4155
+ # @return [Array<(ScheduledSending, Fixnum, Hash)>] ScheduledSending data, response status code and response headers
4156
+ def get_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id)
4157
+ if @api_client.config.debugging
4158
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_scheduled_sending_definition ..."
4159
+ end
4160
+ # verify the required parameter 'account_id' is set
4161
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_scheduled_sending_definition" if account_id.nil?
4162
+ # verify the required parameter 'envelope_id' is set
4163
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_scheduled_sending_definition" if envelope_id.nil?
4164
+ # resource path
4165
+ 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)
4166
+
4167
+ # query parameters
4168
+ query_params = {}
4169
+
4170
+ # header parameters
4171
+ header_params = {}
4172
+ # HTTP header 'Accept' (if needed)
4173
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4174
+
4175
+ # form parameters
4176
+ form_params = {}
4177
+
4178
+ # http body (model)
4179
+ post_body = nil
4180
+ auth_names = []
4181
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4182
+ :header_params => header_params,
4183
+ :query_params => query_params,
4184
+ :form_params => form_params,
4185
+ :body => post_body,
4186
+ :auth_names => auth_names,
4187
+ :return_type => 'ScheduledSending')
4188
+ if @api_client.config.debugging
4189
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4190
+ end
4191
+ return data, status_code, headers
4192
+ end
4193
+
4194
+ # Returns a list of envelope transfer rules in the specified account.
4195
+ # 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.
4196
+ # @param account_id The external account number (int) or account ID Guid.
3649
4197
  # @param DocuSign_eSign::GetEnvelopeTransferRulesOptions Options for modifying the behavior of the function.
3650
4198
  # @return [EnvelopeTransferRuleInformation]
3651
4199
  def get_envelope_transfer_rules(account_id, options = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default)
@@ -3654,7 +4202,7 @@ module DocuSign_eSign
3654
4202
  end
3655
4203
 
3656
4204
  # Returns a list of envelope transfer rules in the specified account.
3657
- #
4205
+ # 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
4206
  # @param account_id The external account number (int) or account ID Guid.
3659
4207
  # @param DocuSign_eSign::GetEnvelopeTransferRulesOptions Options for modifying the behavior of the function.
3660
4208
  # @return [Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>] EnvelopeTransferRuleInformation data, response status code and response headers
@@ -3697,7 +4245,7 @@ module DocuSign_eSign
3697
4245
  end
3698
4246
 
3699
4247
  # Returns the workflow definition for an envelope.
3700
- #
4248
+ # Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one.
3701
4249
  # @param account_id The external account number (int) or account ID Guid.
3702
4250
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3703
4251
  # @return [Workflow]
@@ -3707,7 +4255,7 @@ module DocuSign_eSign
3707
4255
  end
3708
4256
 
3709
4257
  # Returns the workflow definition for an envelope.
3710
- #
4258
+ # Returns an envelope&#39;s workflow definition if the envelope specified by &#x60;envelopeId&#x60; has one.
3711
4259
  # @param account_id The external account number (int) or account ID Guid.
3712
4260
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3713
4261
  # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
@@ -3749,10 +4297,67 @@ module DocuSign_eSign
3749
4297
  return data, status_code, headers
3750
4298
  end
3751
4299
 
3752
- # Returns envelope form data for an existing envelope.
4300
+ # Returns the workflow step definition for an envelope by step id.
3753
4301
  #
3754
4302
  # @param account_id The external account number (int) or account ID Guid.
3755
4303
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4304
+ # @param workflow_step_id
4305
+ # @return [WorkflowStep]
4306
+ def get_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id)
4307
+ data, _status_code, _headers = get_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id)
4308
+ return data
4309
+ end
4310
+
4311
+ # Returns the workflow step definition for an envelope by step id.
4312
+ #
4313
+ # @param account_id The external account number (int) or account ID Guid.
4314
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4315
+ # @param workflow_step_id
4316
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
4317
+ def get_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id)
4318
+ if @api_client.config.debugging
4319
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_workflow_step_definition ..."
4320
+ end
4321
+ # verify the required parameter 'account_id' is set
4322
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_workflow_step_definition" if account_id.nil?
4323
+ # verify the required parameter 'envelope_id' is set
4324
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_workflow_step_definition" if envelope_id.nil?
4325
+ # verify the required parameter 'workflow_step_id' is set
4326
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_envelope_workflow_step_definition" if workflow_step_id.nil?
4327
+ # resource path
4328
+ 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)
4329
+
4330
+ # query parameters
4331
+ query_params = {}
4332
+
4333
+ # header parameters
4334
+ header_params = {}
4335
+ # HTTP header 'Accept' (if needed)
4336
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4337
+
4338
+ # form parameters
4339
+ form_params = {}
4340
+
4341
+ # http body (model)
4342
+ post_body = nil
4343
+ auth_names = []
4344
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4345
+ :header_params => header_params,
4346
+ :query_params => query_params,
4347
+ :form_params => form_params,
4348
+ :body => post_body,
4349
+ :auth_names => auth_names,
4350
+ :return_type => 'WorkflowStep')
4351
+ if @api_client.config.debugging
4352
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4353
+ end
4354
+ return data, status_code, headers
4355
+ end
4356
+
4357
+ # Returns envelope form data for an existing envelope.
4358
+ # 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/)
4359
+ # @param account_id The external account number (int) or account ID Guid.
4360
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3756
4361
  # @return [EnvelopeFormData]
3757
4362
  def get_form_data(account_id, envelope_id)
3758
4363
  data, _status_code, _headers = get_form_data_with_http_info(account_id, envelope_id)
@@ -3760,7 +4365,7 @@ module DocuSign_eSign
3760
4365
  end
3761
4366
 
3762
4367
  # Returns envelope form data for an existing envelope.
3763
- #
4368
+ # 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
4369
  # @param account_id The external account number (int) or account ID Guid.
3765
4370
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3766
4371
  # @return [Array<(EnvelopeFormData, Fixnum, Hash)>] EnvelopeFormData data, response status code and response headers
@@ -3909,7 +4514,7 @@ module DocuSign_eSign
3909
4514
  end
3910
4515
 
3911
4516
  # Returns tabs on the specified page.
3912
- #
4517
+ # Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.
3913
4518
  # @param account_id The external account number (int) or account ID Guid.
3914
4519
  # @param document_id The ID of the document being accessed.
3915
4520
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3921,7 +4526,7 @@ module DocuSign_eSign
3921
4526
  end
3922
4527
 
3923
4528
  # Returns tabs on the specified page.
3924
- #
4529
+ # 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
4530
  # @param account_id The external account number (int) or account ID Guid.
3926
4531
  # @param document_id The ID of the document being accessed.
3927
4532
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3970,7 +4575,7 @@ module DocuSign_eSign
3970
4575
  end
3971
4576
 
3972
4577
  # Returns document page image(s) based on input.
3973
- #
4578
+ # Returns images of the pages in a document for display based on the parameters that you specify.
3974
4579
  # @param account_id The external account number (int) or account ID Guid.
3975
4580
  # @param document_id The ID of the document being accessed.
3976
4581
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3982,7 +4587,7 @@ module DocuSign_eSign
3982
4587
  end
3983
4588
 
3984
4589
  # Returns document page image(s) based on input.
3985
- #
4590
+ # Returns images of the pages in a document for display based on the parameters that you specify.
3986
4591
  # @param account_id The external account number (int) or account ID Guid.
3987
4592
  # @param document_id The ID of the document being accessed.
3988
4593
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -4036,7 +4641,7 @@ module DocuSign_eSign
4036
4641
  end
4037
4642
 
4038
4643
  # Returns document visibility for the recipients
4039
- #
4644
+ # This method returns information about document visibility for a recipient.
4040
4645
  # @param account_id The external account number (int) or account ID Guid.
4041
4646
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4042
4647
  # @param recipient_id The ID of the recipient being accessed.
@@ -4047,7 +4652,7 @@ module DocuSign_eSign
4047
4652
  end
4048
4653
 
4049
4654
  # Returns document visibility for the recipients
4050
- #
4655
+ # This method returns information about document visibility for a recipient.
4051
4656
  # @param account_id The external account number (int) or account ID Guid.
4052
4657
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4053
4658
  # @param recipient_id The ID of the recipient being accessed.
@@ -4321,9 +4926,66 @@ module DocuSign_eSign
4321
4926
  return data, status_code, headers
4322
4927
  end
4323
4928
 
4324
- # Returns document visibility for the recipients
4929
+ # Returns the delayed routing rules for a template's workflow step definition.
4325
4930
  #
4326
4931
  # @param account_id The external account number (int) or account ID Guid.
4932
+ # @param template_id The ID of the template being accessed.
4933
+ # @param workflow_step_id
4934
+ # @return [DelayedRouting]
4935
+ def get_template_delayed_routing_definition(account_id, template_id, workflow_step_id)
4936
+ data, _status_code, _headers = get_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id)
4937
+ return data
4938
+ end
4939
+
4940
+ # Returns the delayed routing rules for a template&#39;s workflow step definition.
4941
+ #
4942
+ # @param account_id The external account number (int) or account ID Guid.
4943
+ # @param template_id The ID of the template being accessed.
4944
+ # @param workflow_step_id
4945
+ # @return [Array<(DelayedRouting, Fixnum, Hash)>] DelayedRouting data, response status code and response headers
4946
+ def get_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id)
4947
+ if @api_client.config.debugging
4948
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_delayed_routing_definition ..."
4949
+ end
4950
+ # verify the required parameter 'account_id' is set
4951
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_delayed_routing_definition" if account_id.nil?
4952
+ # verify the required parameter 'template_id' is set
4953
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_delayed_routing_definition" if template_id.nil?
4954
+ # verify the required parameter 'workflow_step_id' is set
4955
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_template_delayed_routing_definition" if workflow_step_id.nil?
4956
+ # resource path
4957
+ 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)
4958
+
4959
+ # query parameters
4960
+ query_params = {}
4961
+
4962
+ # header parameters
4963
+ header_params = {}
4964
+ # HTTP header 'Accept' (if needed)
4965
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4966
+
4967
+ # form parameters
4968
+ form_params = {}
4969
+
4970
+ # http body (model)
4971
+ post_body = nil
4972
+ auth_names = []
4973
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4974
+ :header_params => header_params,
4975
+ :query_params => query_params,
4976
+ :form_params => form_params,
4977
+ :body => post_body,
4978
+ :auth_names => auth_names,
4979
+ :return_type => 'DelayedRouting')
4980
+ if @api_client.config.debugging
4981
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_template_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4982
+ end
4983
+ return data, status_code, headers
4984
+ end
4985
+
4986
+ # Returns document visibility for the recipients
4987
+ # This method returns information about document visibility for a template recipient.
4988
+ # @param account_id The external account number (int) or account ID Guid.
4327
4989
  # @param recipient_id The ID of the recipient being accessed.
4328
4990
  # @param template_id The ID of the template being accessed.
4329
4991
  # @return [DocumentVisibilityList]
@@ -4333,7 +4995,7 @@ module DocuSign_eSign
4333
4995
  end
4334
4996
 
4335
4997
  # Returns document visibility for the recipients
4336
- #
4998
+ # This method returns information about document visibility for a template recipient.
4337
4999
  # @param account_id The external account number (int) or account ID Guid.
4338
5000
  # @param recipient_id The ID of the recipient being accessed.
4339
5001
  # @param template_id The ID of the template being accessed.
@@ -4378,10 +5040,63 @@ module DocuSign_eSign
4378
5040
  return data, status_code, headers
4379
5041
  end
4380
5042
 
4381
- # Returns the workflow definition for a template.
5043
+ # Returns the scheduled sending rules for a template's workflow definition.
4382
5044
  #
4383
5045
  # @param account_id The external account number (int) or account ID Guid.
4384
5046
  # @param template_id The ID of the template being accessed.
5047
+ # @return [ScheduledSending]
5048
+ def get_template_scheduled_sending_definition(account_id, template_id)
5049
+ data, _status_code, _headers = get_template_scheduled_sending_definition_with_http_info(account_id, template_id)
5050
+ return data
5051
+ end
5052
+
5053
+ # Returns the scheduled sending rules for a template&#39;s workflow definition.
5054
+ #
5055
+ # @param account_id The external account number (int) or account ID Guid.
5056
+ # @param template_id The ID of the template being accessed.
5057
+ # @return [Array<(ScheduledSending, Fixnum, Hash)>] ScheduledSending data, response status code and response headers
5058
+ def get_template_scheduled_sending_definition_with_http_info(account_id, template_id)
5059
+ if @api_client.config.debugging
5060
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_scheduled_sending_definition ..."
5061
+ end
5062
+ # verify the required parameter 'account_id' is set
5063
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_scheduled_sending_definition" if account_id.nil?
5064
+ # verify the required parameter 'template_id' is set
5065
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_scheduled_sending_definition" if template_id.nil?
5066
+ # resource path
5067
+ 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)
5068
+
5069
+ # query parameters
5070
+ query_params = {}
5071
+
5072
+ # header parameters
5073
+ header_params = {}
5074
+ # HTTP header 'Accept' (if needed)
5075
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5076
+
5077
+ # form parameters
5078
+ form_params = {}
5079
+
5080
+ # http body (model)
5081
+ post_body = nil
5082
+ auth_names = []
5083
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
5084
+ :header_params => header_params,
5085
+ :query_params => query_params,
5086
+ :form_params => form_params,
5087
+ :body => post_body,
5088
+ :auth_names => auth_names,
5089
+ :return_type => 'ScheduledSending')
5090
+ if @api_client.config.debugging
5091
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_template_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5092
+ end
5093
+ return data, status_code, headers
5094
+ end
5095
+
5096
+ # Returns the workflow definition for a template.
5097
+ # Returns template's workflow definition if the template specified by `templateId` has one.
5098
+ # @param account_id The external account number (int) or account ID Guid.
5099
+ # @param template_id The ID of the template being accessed.
4385
5100
  # @return [Workflow]
4386
5101
  def get_template_workflow_definition(account_id, template_id)
4387
5102
  data, _status_code, _headers = get_template_workflow_definition_with_http_info(account_id, template_id)
@@ -4389,7 +5104,7 @@ module DocuSign_eSign
4389
5104
  end
4390
5105
 
4391
5106
  # Returns the workflow definition for a template.
4392
- #
5107
+ # Returns template&#39;s workflow definition if the template specified by &#x60;templateId&#x60; has one.
4393
5108
  # @param account_id The external account number (int) or account ID Guid.
4394
5109
  # @param template_id The ID of the template being accessed.
4395
5110
  # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
@@ -4431,6 +5146,63 @@ module DocuSign_eSign
4431
5146
  return data, status_code, headers
4432
5147
  end
4433
5148
 
5149
+ # Returns the workflow step definition for a template by step id.
5150
+ #
5151
+ # @param account_id The external account number (int) or account ID Guid.
5152
+ # @param template_id The ID of the template being accessed.
5153
+ # @param workflow_step_id
5154
+ # @return [WorkflowStep]
5155
+ def get_template_workflow_step_definition(account_id, template_id, workflow_step_id)
5156
+ data, _status_code, _headers = get_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id)
5157
+ return data
5158
+ end
5159
+
5160
+ # Returns the workflow step definition for a template by step id.
5161
+ #
5162
+ # @param account_id The external account number (int) or account ID Guid.
5163
+ # @param template_id The ID of the template being accessed.
5164
+ # @param workflow_step_id
5165
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
5166
+ def get_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id)
5167
+ if @api_client.config.debugging
5168
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_workflow_step_definition ..."
5169
+ end
5170
+ # verify the required parameter 'account_id' is set
5171
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_workflow_step_definition" if account_id.nil?
5172
+ # verify the required parameter 'template_id' is set
5173
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_workflow_step_definition" if template_id.nil?
5174
+ # verify the required parameter 'workflow_step_id' is set
5175
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_template_workflow_step_definition" if workflow_step_id.nil?
5176
+ # resource path
5177
+ 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)
5178
+
5179
+ # query parameters
5180
+ query_params = {}
5181
+
5182
+ # header parameters
5183
+ header_params = {}
5184
+ # HTTP header 'Accept' (if needed)
5185
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5186
+
5187
+ # form parameters
5188
+ form_params = {}
5189
+
5190
+ # http body (model)
5191
+ post_body = nil
5192
+ auth_names = []
5193
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
5194
+ :header_params => header_params,
5195
+ :query_params => query_params,
5196
+ :form_params => form_params,
5197
+ :body => post_body,
5198
+ :auth_names => auth_names,
5199
+ :return_type => 'WorkflowStep')
5200
+ if @api_client.config.debugging
5201
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5202
+ end
5203
+ return data, status_code, headers
5204
+ end
5205
+
4434
5206
  # Gets the envelope audit events for an envelope.
4435
5207
  # Gets the envelope audit events for the specified envelope.
4436
5208
  # @param account_id The external account number (int) or account ID Guid.
@@ -5038,7 +5810,7 @@ module DocuSign_eSign
5038
5810
  end
5039
5811
 
5040
5812
  # Add an attachment to a DRAFT or IN-PROCESS envelope.
5041
- #
5813
+ # Adds an attachment to a draft or in-process envelope.
5042
5814
  # @param account_id The external account number (int) or account ID Guid.
5043
5815
  # @param attachment_id
5044
5816
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -5050,7 +5822,7 @@ module DocuSign_eSign
5050
5822
  end
5051
5823
 
5052
5824
  # Add an attachment to a DRAFT or IN-PROCESS envelope.
5053
- #
5825
+ # Adds an attachment to a draft or in-process envelope.
5054
5826
  # @param account_id The external account number (int) or account ID Guid.
5055
5827
  # @param attachment_id
5056
5828
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -5097,7 +5869,7 @@ module DocuSign_eSign
5097
5869
  end
5098
5870
 
5099
5871
  # Add one or more attachments to a DRAFT or IN-PROCESS envelope.
5100
- #
5872
+ # 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
5873
  # @param account_id The external account number (int) or account ID Guid.
5102
5874
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5103
5875
  # @param envelope_attachments_request (optional parameter)
@@ -5108,7 +5880,7 @@ module DocuSign_eSign
5108
5880
  end
5109
5881
 
5110
5882
  # Add one or more attachments to a DRAFT or IN-PROCESS envelope.
5111
- #
5883
+ # 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
5884
  # @param account_id The external account number (int) or account ID Guid.
5113
5885
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5114
5886
  # @param envelope_attachments_request (optional parameter)
@@ -5273,7 +6045,7 @@ module DocuSign_eSign
5273
6045
  end
5274
6046
 
5275
6047
  # Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
5276
- #
6048
+ # 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
6049
  # @param account_id The external account number (int) or account ID Guid.
5278
6050
  # @param chunked_upload_id
5279
6051
  # @param DocuSign_eSign::UpdateChunkedUploadOptions Options for modifying the behavior of the function.
@@ -5284,7 +6056,7 @@ module DocuSign_eSign
5284
6056
  end
5285
6057
 
5286
6058
  # Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
5287
- #
6059
+ # 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
6060
  # @param account_id The external account number (int) or account ID Guid.
5289
6061
  # @param chunked_upload_id
5290
6062
  # @param DocuSign_eSign::UpdateChunkedUploadOptions Options for modifying the behavior of the function.
@@ -5329,7 +6101,7 @@ module DocuSign_eSign
5329
6101
  end
5330
6102
 
5331
6103
  # Add a chunk, a chunk 'part', to an existing ChunkedUpload.
5332
- #
6104
+ # 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
6105
  # @param account_id The external account number (int) or account ID Guid.
5334
6106
  # @param chunked_upload_id
5335
6107
  # @param chunked_upload_part_seq
@@ -5341,7 +6113,7 @@ module DocuSign_eSign
5341
6113
  end
5342
6114
 
5343
6115
  # Add a chunk, a chunk &#39;part&#39;, to an existing ChunkedUpload.
5344
- #
6116
+ # 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
6117
  # @param account_id The external account number (int) or account ID Guid.
5346
6118
  # @param chunked_upload_id
5347
6119
  # @param chunked_upload_part_seq
@@ -5559,7 +6331,7 @@ module DocuSign_eSign
5559
6331
  end
5560
6332
 
5561
6333
  # Updates the tabs for an envelope document
5562
- #
6334
+ # Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`.
5563
6335
  # @param account_id The external account number (int) or account ID Guid.
5564
6336
  # @param document_id The ID of the document being accessed.
5565
6337
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -5571,7 +6343,7 @@ module DocuSign_eSign
5571
6343
  end
5572
6344
 
5573
6345
  # Updates the tabs for an envelope document
5574
- #
6346
+ # Updates tabs in the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.
5575
6347
  # @param account_id The external account number (int) or account ID Guid.
5576
6348
  # @param document_id The ID of the document being accessed.
5577
6349
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -5727,9 +6499,123 @@ module DocuSign_eSign
5727
6499
  return data, status_code, headers
5728
6500
  end
5729
6501
 
5730
- # Update an envelope transfer rule for an account.
6502
+ # Updates the delayed routing rules for an envelope's workflow step definition.
6503
+ #
6504
+ # @param account_id The external account number (int) or account ID Guid.
6505
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6506
+ # @param workflow_step_id
6507
+ # @param delayed_routing (optional parameter)
6508
+ # @return [DelayedRouting]
6509
+ def update_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id, delayed_routing)
6510
+ data, _status_code, _headers = update_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id, delayed_routing)
6511
+ return data
6512
+ end
6513
+
6514
+ # Updates the delayed routing rules for an envelope&#39;s workflow step definition.
6515
+ #
6516
+ # @param account_id The external account number (int) or account ID Guid.
6517
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6518
+ # @param workflow_step_id
6519
+ # @param delayed_routing (optional parameter)
6520
+ # @return [Array<(DelayedRouting, Fixnum, Hash)>] DelayedRouting data, response status code and response headers
6521
+ def update_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id, delayed_routing)
6522
+ if @api_client.config.debugging
6523
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_delayed_routing_definition ..."
6524
+ end
6525
+ # verify the required parameter 'account_id' is set
6526
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_delayed_routing_definition" if account_id.nil?
6527
+ # verify the required parameter 'envelope_id' is set
6528
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_delayed_routing_definition" if envelope_id.nil?
6529
+ # verify the required parameter 'workflow_step_id' is set
6530
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_envelope_delayed_routing_definition" if workflow_step_id.nil?
6531
+ # resource path
6532
+ 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)
6533
+
6534
+ # query parameters
6535
+ query_params = {}
6536
+
6537
+ # header parameters
6538
+ header_params = {}
6539
+ # HTTP header 'Accept' (if needed)
6540
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6541
+
6542
+ # form parameters
6543
+ form_params = {}
6544
+
6545
+ # http body (model)
6546
+ post_body = @api_client.object_to_http_body(delayed_routing)
6547
+ auth_names = []
6548
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6549
+ :header_params => header_params,
6550
+ :query_params => query_params,
6551
+ :form_params => form_params,
6552
+ :body => post_body,
6553
+ :auth_names => auth_names,
6554
+ :return_type => 'DelayedRouting')
6555
+ if @api_client.config.debugging
6556
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6557
+ end
6558
+ return data, status_code, headers
6559
+ end
6560
+
6561
+ # Updates the scheduled sending rules for an envelope's workflow definition.
6562
+ #
6563
+ # @param account_id The external account number (int) or account ID Guid.
6564
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6565
+ # @param scheduled_sending (optional parameter)
6566
+ # @return [ScheduledSending]
6567
+ def update_envelope_scheduled_sending_definition(account_id, envelope_id, scheduled_sending)
6568
+ data, _status_code, _headers = update_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id, scheduled_sending)
6569
+ return data
6570
+ end
6571
+
6572
+ # Updates the scheduled sending rules for an envelope&#39;s workflow definition.
5731
6573
  #
5732
6574
  # @param account_id The external account number (int) or account ID Guid.
6575
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6576
+ # @param scheduled_sending (optional parameter)
6577
+ # @return [Array<(ScheduledSending, Fixnum, Hash)>] ScheduledSending data, response status code and response headers
6578
+ def update_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id, scheduled_sending)
6579
+ if @api_client.config.debugging
6580
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_scheduled_sending_definition ..."
6581
+ end
6582
+ # verify the required parameter 'account_id' is set
6583
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_scheduled_sending_definition" if account_id.nil?
6584
+ # verify the required parameter 'envelope_id' is set
6585
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_scheduled_sending_definition" if envelope_id.nil?
6586
+ # resource path
6587
+ 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)
6588
+
6589
+ # query parameters
6590
+ query_params = {}
6591
+
6592
+ # header parameters
6593
+ header_params = {}
6594
+ # HTTP header 'Accept' (if needed)
6595
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6596
+
6597
+ # form parameters
6598
+ form_params = {}
6599
+
6600
+ # http body (model)
6601
+ post_body = @api_client.object_to_http_body(scheduled_sending)
6602
+ auth_names = []
6603
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6604
+ :header_params => header_params,
6605
+ :query_params => query_params,
6606
+ :form_params => form_params,
6607
+ :body => post_body,
6608
+ :auth_names => auth_names,
6609
+ :return_type => 'ScheduledSending')
6610
+ if @api_client.config.debugging
6611
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6612
+ end
6613
+ return data, status_code, headers
6614
+ end
6615
+
6616
+ # Update an envelope transfer rule for an account.
6617
+ # 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.
6618
+ # @param account_id The external account number (int) or account ID Guid.
5733
6619
  # @param envelope_transfer_rule_id
5734
6620
  # @param envelope_transfer_rule (optional parameter)
5735
6621
  # @return [EnvelopeTransferRule]
@@ -5739,7 +6625,7 @@ module DocuSign_eSign
5739
6625
  end
5740
6626
 
5741
6627
  # Update an envelope transfer rule for an account.
5742
- #
6628
+ # 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
6629
  # @param account_id The external account number (int) or account ID Guid.
5744
6630
  # @param envelope_transfer_rule_id
5745
6631
  # @param envelope_transfer_rule (optional parameter)
@@ -5783,7 +6669,7 @@ module DocuSign_eSign
5783
6669
  end
5784
6670
 
5785
6671
  # Update envelope transfer rules for an account.
5786
- #
6672
+ # 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
6673
  # @param account_id The external account number (int) or account ID Guid.
5788
6674
  # @param envelope_transfer_rule_information (optional parameter)
5789
6675
  # @return [EnvelopeTransferRuleInformation]
@@ -5793,7 +6679,7 @@ module DocuSign_eSign
5793
6679
  end
5794
6680
 
5795
6681
  # Update envelope transfer rules for an account.
5796
- #
6682
+ # 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
6683
  # @param account_id The external account number (int) or account ID Guid.
5798
6684
  # @param envelope_transfer_rule_information (optional parameter)
5799
6685
  # @return [Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>] EnvelopeTransferRuleInformation data, response status code and response headers
@@ -5834,7 +6720,7 @@ module DocuSign_eSign
5834
6720
  end
5835
6721
 
5836
6722
  # Updates the envelope workflow definition for an envelope.
5837
- #
6723
+ # Updates the specified envelope's workflow definition if it has one.
5838
6724
  # @param account_id The external account number (int) or account ID Guid.
5839
6725
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5840
6726
  # @param workflow (optional parameter)
@@ -5845,7 +6731,7 @@ module DocuSign_eSign
5845
6731
  end
5846
6732
 
5847
6733
  # Updates the envelope workflow definition for an envelope.
5848
- #
6734
+ # Updates the specified envelope&#39;s workflow definition if it has one.
5849
6735
  # @param account_id The external account number (int) or account ID Guid.
5850
6736
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5851
6737
  # @param workflow (optional parameter)
@@ -5888,6 +6774,65 @@ module DocuSign_eSign
5888
6774
  return data, status_code, headers
5889
6775
  end
5890
6776
 
6777
+ # Updates the envelope workflow step definition for an envelope.
6778
+ #
6779
+ # @param account_id The external account number (int) or account ID Guid.
6780
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6781
+ # @param workflow_step_id
6782
+ # @param workflow_step (optional parameter)
6783
+ # @return [WorkflowStep]
6784
+ def update_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id, workflow_step)
6785
+ data, _status_code, _headers = update_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id, workflow_step)
6786
+ return data
6787
+ end
6788
+
6789
+ # Updates the envelope workflow step definition for an envelope.
6790
+ #
6791
+ # @param account_id The external account number (int) or account ID Guid.
6792
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6793
+ # @param workflow_step_id
6794
+ # @param workflow_step (optional parameter)
6795
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
6796
+ def update_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id, workflow_step)
6797
+ if @api_client.config.debugging
6798
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_workflow_step_definition ..."
6799
+ end
6800
+ # verify the required parameter 'account_id' is set
6801
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_workflow_step_definition" if account_id.nil?
6802
+ # verify the required parameter 'envelope_id' is set
6803
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_workflow_step_definition" if envelope_id.nil?
6804
+ # verify the required parameter 'workflow_step_id' is set
6805
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_envelope_workflow_step_definition" if workflow_step_id.nil?
6806
+ # resource path
6807
+ 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)
6808
+
6809
+ # query parameters
6810
+ query_params = {}
6811
+
6812
+ # header parameters
6813
+ header_params = {}
6814
+ # HTTP header 'Accept' (if needed)
6815
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6816
+
6817
+ # form parameters
6818
+ form_params = {}
6819
+
6820
+ # http body (model)
6821
+ post_body = @api_client.object_to_http_body(workflow_step)
6822
+ auth_names = []
6823
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6824
+ :header_params => header_params,
6825
+ :query_params => query_params,
6826
+ :form_params => form_params,
6827
+ :body => post_body,
6828
+ :auth_names => auth_names,
6829
+ :return_type => 'WorkflowStep')
6830
+ if @api_client.config.debugging
6831
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6832
+ end
6833
+ return data, status_code, headers
6834
+ end
6835
+
5891
6836
  # Updates an envelope lock.
5892
6837
  # 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
6838
  # @param account_id The external account number (int) or account ID Guid.
@@ -5944,7 +6889,7 @@ module DocuSign_eSign
5944
6889
  end
5945
6890
 
5946
6891
  # Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
5947
- #
6892
+ # 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
6893
  # @param account_id The external account number (int) or account ID Guid.
5949
6894
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5950
6895
  # @param envelope_notification_request (optional parameter)
@@ -5955,7 +6900,7 @@ module DocuSign_eSign
5955
6900
  end
5956
6901
 
5957
6902
  # Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
5958
- #
6903
+ # 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
6904
  # @param account_id The external account number (int) or account ID Guid.
5960
6905
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5961
6906
  # @param envelope_notification_request (optional parameter)
@@ -5999,7 +6944,7 @@ module DocuSign_eSign
5999
6944
  end
6000
6945
 
6001
6946
  # Updates document visibility for the recipients
6002
- #
6947
+ # 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
6948
  # @param account_id The external account number (int) or account ID Guid.
6004
6949
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6005
6950
  # @param recipient_id The ID of the recipient being accessed.
@@ -6011,7 +6956,7 @@ module DocuSign_eSign
6011
6956
  end
6012
6957
 
6013
6958
  # Updates document visibility for the recipients
6014
- #
6959
+ # 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
6960
  # @param account_id The external account number (int) or account ID Guid.
6016
6961
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6017
6962
  # @param recipient_id The ID of the recipient being accessed.
@@ -6234,7 +7179,7 @@ module DocuSign_eSign
6234
7179
  end
6235
7180
 
6236
7181
  # Updates document visibility for the recipients
6237
- #
7182
+ # 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
7183
  # @param account_id The external account number (int) or account ID Guid.
6239
7184
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6240
7185
  # @param document_visibility_list (optional parameter)
@@ -6245,7 +7190,7 @@ module DocuSign_eSign
6245
7190
  end
6246
7191
 
6247
7192
  # Updates document visibility for the recipients
6248
- #
7193
+ # 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
7194
  # @param account_id The external account number (int) or account ID Guid.
6250
7195
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6251
7196
  # @param document_visibility_list (optional parameter)
@@ -6458,9 +7403,68 @@ module DocuSign_eSign
6458
7403
  return data, status_code, headers
6459
7404
  end
6460
7405
 
6461
- # Updates document visibility for the recipients
7406
+ # Updates the delayed routing rules for a template's workflow step definition.
7407
+ #
7408
+ # @param account_id The external account number (int) or account ID Guid.
7409
+ # @param template_id The ID of the template being accessed.
7410
+ # @param workflow_step_id
7411
+ # @param delayed_routing (optional parameter)
7412
+ # @return [DelayedRouting]
7413
+ def update_template_delayed_routing_definition(account_id, template_id, workflow_step_id, delayed_routing)
7414
+ data, _status_code, _headers = update_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id, delayed_routing)
7415
+ return data
7416
+ end
7417
+
7418
+ # Updates the delayed routing rules for a template&#39;s workflow step definition.
6462
7419
  #
6463
7420
  # @param account_id The external account number (int) or account ID Guid.
7421
+ # @param template_id The ID of the template being accessed.
7422
+ # @param workflow_step_id
7423
+ # @param delayed_routing (optional parameter)
7424
+ # @return [Array<(DelayedRouting, Fixnum, Hash)>] DelayedRouting data, response status code and response headers
7425
+ def update_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id, delayed_routing)
7426
+ if @api_client.config.debugging
7427
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_delayed_routing_definition ..."
7428
+ end
7429
+ # verify the required parameter 'account_id' is set
7430
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_delayed_routing_definition" if account_id.nil?
7431
+ # verify the required parameter 'template_id' is set
7432
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_delayed_routing_definition" if template_id.nil?
7433
+ # verify the required parameter 'workflow_step_id' is set
7434
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_template_delayed_routing_definition" if workflow_step_id.nil?
7435
+ # resource path
7436
+ 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)
7437
+
7438
+ # query parameters
7439
+ query_params = {}
7440
+
7441
+ # header parameters
7442
+ header_params = {}
7443
+ # HTTP header 'Accept' (if needed)
7444
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7445
+
7446
+ # form parameters
7447
+ form_params = {}
7448
+
7449
+ # http body (model)
7450
+ post_body = @api_client.object_to_http_body(delayed_routing)
7451
+ auth_names = []
7452
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7453
+ :header_params => header_params,
7454
+ :query_params => query_params,
7455
+ :form_params => form_params,
7456
+ :body => post_body,
7457
+ :auth_names => auth_names,
7458
+ :return_type => 'DelayedRouting')
7459
+ if @api_client.config.debugging
7460
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_template_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7461
+ end
7462
+ return data, status_code, headers
7463
+ end
7464
+
7465
+ # Updates document visibility for the recipients
7466
+ # 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.
7467
+ # @param account_id The external account number (int) or account ID Guid.
6464
7468
  # @param recipient_id The ID of the recipient being accessed.
6465
7469
  # @param template_id The ID of the template being accessed.
6466
7470
  # @param template_document_visibility_list (optional parameter)
@@ -6471,7 +7475,7 @@ module DocuSign_eSign
6471
7475
  end
6472
7476
 
6473
7477
  # Updates document visibility for the recipients
6474
- #
7478
+ # 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
7479
  # @param account_id The external account number (int) or account ID Guid.
6476
7480
  # @param recipient_id The ID of the recipient being accessed.
6477
7481
  # @param template_id The ID of the template being accessed.
@@ -6518,7 +7522,7 @@ module DocuSign_eSign
6518
7522
  end
6519
7523
 
6520
7524
  # Updates document visibility for the recipients
6521
- #
7525
+ # 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
7526
  # @param account_id The external account number (int) or account ID Guid.
6523
7527
  # @param template_id The ID of the template being accessed.
6524
7528
  # @param template_document_visibility_list (optional parameter)
@@ -6529,7 +7533,7 @@ module DocuSign_eSign
6529
7533
  end
6530
7534
 
6531
7535
  # Updates document visibility for the recipients
6532
- #
7536
+ # 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
7537
  # @param account_id The external account number (int) or account ID Guid.
6534
7538
  # @param template_id The ID of the template being accessed.
6535
7539
  # @param template_document_visibility_list (optional parameter)
@@ -6572,10 +7576,65 @@ module DocuSign_eSign
6572
7576
  return data, status_code, headers
6573
7577
  end
6574
7578
 
6575
- # Updates the workflow definition for a template.
7579
+ # Updates the scheduled sending rules for a template's workflow definition.
7580
+ #
7581
+ # @param account_id The external account number (int) or account ID Guid.
7582
+ # @param template_id The ID of the template being accessed.
7583
+ # @param scheduled_sending (optional parameter)
7584
+ # @return [ScheduledSending]
7585
+ def update_template_scheduled_sending_definition(account_id, template_id, scheduled_sending)
7586
+ data, _status_code, _headers = update_template_scheduled_sending_definition_with_http_info(account_id, template_id, scheduled_sending)
7587
+ return data
7588
+ end
7589
+
7590
+ # Updates the scheduled sending rules for a template&#39;s workflow definition.
6576
7591
  #
6577
7592
  # @param account_id The external account number (int) or account ID Guid.
6578
7593
  # @param template_id The ID of the template being accessed.
7594
+ # @param scheduled_sending (optional parameter)
7595
+ # @return [Array<(ScheduledSending, Fixnum, Hash)>] ScheduledSending data, response status code and response headers
7596
+ def update_template_scheduled_sending_definition_with_http_info(account_id, template_id, scheduled_sending)
7597
+ if @api_client.config.debugging
7598
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_scheduled_sending_definition ..."
7599
+ end
7600
+ # verify the required parameter 'account_id' is set
7601
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_scheduled_sending_definition" if account_id.nil?
7602
+ # verify the required parameter 'template_id' is set
7603
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_scheduled_sending_definition" if template_id.nil?
7604
+ # resource path
7605
+ 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)
7606
+
7607
+ # query parameters
7608
+ query_params = {}
7609
+
7610
+ # header parameters
7611
+ header_params = {}
7612
+ # HTTP header 'Accept' (if needed)
7613
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7614
+
7615
+ # form parameters
7616
+ form_params = {}
7617
+
7618
+ # http body (model)
7619
+ post_body = @api_client.object_to_http_body(scheduled_sending)
7620
+ auth_names = []
7621
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7622
+ :header_params => header_params,
7623
+ :query_params => query_params,
7624
+ :form_params => form_params,
7625
+ :body => post_body,
7626
+ :auth_names => auth_names,
7627
+ :return_type => 'ScheduledSending')
7628
+ if @api_client.config.debugging
7629
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_template_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7630
+ end
7631
+ return data, status_code, headers
7632
+ end
7633
+
7634
+ # Updates the workflow definition for a template.
7635
+ # Updates the specified template's workflow definition if it has one.
7636
+ # @param account_id The external account number (int) or account ID Guid.
7637
+ # @param template_id The ID of the template being accessed.
6579
7638
  # @param workflow (optional parameter)
6580
7639
  # @return [Workflow]
6581
7640
  def update_template_workflow_definition(account_id, template_id, workflow)
@@ -6584,7 +7643,7 @@ module DocuSign_eSign
6584
7643
  end
6585
7644
 
6586
7645
  # Updates the workflow definition for a template.
6587
- #
7646
+ # Updates the specified template&#39;s workflow definition if it has one.
6588
7647
  # @param account_id The external account number (int) or account ID Guid.
6589
7648
  # @param template_id The ID of the template being accessed.
6590
7649
  # @param workflow (optional parameter)
@@ -6626,5 +7685,64 @@ module DocuSign_eSign
6626
7685
  end
6627
7686
  return data, status_code, headers
6628
7687
  end
7688
+
7689
+ # Updates the template workflow step definition for an envelope.
7690
+ #
7691
+ # @param account_id The external account number (int) or account ID Guid.
7692
+ # @param template_id The ID of the template being accessed.
7693
+ # @param workflow_step_id
7694
+ # @param workflow_step (optional parameter)
7695
+ # @return [WorkflowStep]
7696
+ def update_template_workflow_step_definition(account_id, template_id, workflow_step_id, workflow_step)
7697
+ data, _status_code, _headers = update_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id, workflow_step)
7698
+ return data
7699
+ end
7700
+
7701
+ # Updates the template workflow step definition for an envelope.
7702
+ #
7703
+ # @param account_id The external account number (int) or account ID Guid.
7704
+ # @param template_id The ID of the template being accessed.
7705
+ # @param workflow_step_id
7706
+ # @param workflow_step (optional parameter)
7707
+ # @return [Array<(WorkflowStep, Fixnum, Hash)>] WorkflowStep data, response status code and response headers
7708
+ def update_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id, workflow_step)
7709
+ if @api_client.config.debugging
7710
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_workflow_step_definition ..."
7711
+ end
7712
+ # verify the required parameter 'account_id' is set
7713
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_workflow_step_definition" if account_id.nil?
7714
+ # verify the required parameter 'template_id' is set
7715
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_workflow_step_definition" if template_id.nil?
7716
+ # verify the required parameter 'workflow_step_id' is set
7717
+ fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_template_workflow_step_definition" if workflow_step_id.nil?
7718
+ # resource path
7719
+ 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)
7720
+
7721
+ # query parameters
7722
+ query_params = {}
7723
+
7724
+ # header parameters
7725
+ header_params = {}
7726
+ # HTTP header 'Accept' (if needed)
7727
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7728
+
7729
+ # form parameters
7730
+ form_params = {}
7731
+
7732
+ # http body (model)
7733
+ post_body = @api_client.object_to_http_body(workflow_step)
7734
+ auth_names = []
7735
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7736
+ :header_params => header_params,
7737
+ :query_params => query_params,
7738
+ :form_params => form_params,
7739
+ :body => post_body,
7740
+ :auth_names => auth_names,
7741
+ :return_type => 'WorkflowStep')
7742
+ if @api_client.config.debugging
7743
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7744
+ end
7745
+ return data, status_code, headers
7746
+ end
6629
7747
  end
6630
7748
  end