docusign_esign 3.12.0 → 3.19.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (355) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +54 -0
  3. data/docusign_esign.gemspec +5 -5
  4. data/lib/docusign_esign/api/accounts_api.rb +83 -433
  5. data/lib/docusign_esign/api/billing_api.rb +12 -4
  6. data/lib/docusign_esign/api/bulk_envelopes_api.rb +93 -26
  7. data/lib/docusign_esign/api/bulk_process_data_api.rb +412 -0
  8. data/lib/docusign_esign/api/bulk_process_data_send_api.rb +252 -0
  9. data/lib/docusign_esign/api/connect_api.rb +239 -5
  10. data/lib/docusign_esign/api/email_archive_api.rb +8 -8
  11. data/lib/docusign_esign/api/envelopes_api.rb +1435 -207
  12. data/lib/docusign_esign/api/notary_api.rb +16 -16
  13. data/lib/docusign_esign/api/organizations_api.rb +8 -60
  14. data/lib/docusign_esign/api/power_forms_api.rb +24 -16
  15. data/lib/docusign_esign/api/templates_api.rb +20 -79
  16. data/lib/docusign_esign/api/users_api.rb +22 -14
  17. data/lib/docusign_esign/api/workspaces_api.rb +4 -4
  18. data/lib/docusign_esign/client/api_client.rb +16 -10
  19. data/lib/docusign_esign/client/api_error.rb +1 -1
  20. data/lib/docusign_esign/client/auth/oauth.rb +1 -1
  21. data/lib/docusign_esign/models/access_code_format.rb +6 -0
  22. data/lib/docusign_esign/models/account_billing_plan.rb +25 -4
  23. data/lib/docusign_esign/models/account_billing_plan_response.rb +37 -10
  24. data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
  25. data/lib/docusign_esign/models/account_identity_verification_workflow.rb +2 -0
  26. data/lib/docusign_esign/models/account_information.rb +11 -1
  27. data/lib/docusign_esign/models/account_notification.rb +3 -0
  28. data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
  29. data/lib/docusign_esign/models/account_password_rules.rb +7 -0
  30. data/lib/docusign_esign/models/account_role_settings.rb +81 -4
  31. data/lib/docusign_esign/models/account_settings_information.rb +1075 -13
  32. data/lib/docusign_esign/models/account_shared_access.rb +1 -0
  33. data/lib/docusign_esign/models/account_signature.rb +2 -0
  34. data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
  35. data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
  36. data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
  37. data/lib/docusign_esign/models/account_ui_settings.rb +28 -13
  38. data/lib/docusign_esign/models/address_information_input.rb +1 -0
  39. data/lib/docusign_esign/models/agent.rb +45 -1
  40. data/lib/docusign_esign/models/app_store_receipt.rb +21 -1
  41. data/lib/docusign_esign/models/approve.rb +65 -1
  42. data/lib/docusign_esign/models/authentication_status.rb +19 -0
  43. data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
  44. data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
  45. data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
  46. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  47. data/lib/docusign_esign/models/billing_entity_information_response.rb +214 -0
  48. data/lib/docusign_esign/models/billing_invoice_item.rb +21 -1
  49. data/lib/docusign_esign/models/billing_invoices_summary.rb +21 -1
  50. data/lib/docusign_esign/models/billing_plan_information.rb +52 -4
  51. data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
  52. data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
  53. data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
  54. data/lib/docusign_esign/models/brand.rb +4 -0
  55. data/lib/docusign_esign/models/brand_email_content.rb +1 -0
  56. data/lib/docusign_esign/models/brand_link.rb +1 -0
  57. data/lib/docusign_esign/models/brand_logos.rb +1 -0
  58. data/lib/docusign_esign/models/brand_request.rb +1 -0
  59. data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
  60. data/lib/docusign_esign/models/brand_resources.rb +3 -0
  61. data/lib/docusign_esign/models/brands_request.rb +1 -0
  62. data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
  63. data/lib/docusign_esign/models/bulk_process_request.rb +194 -0
  64. data/lib/docusign_esign/models/bulk_process_response.rb +248 -0
  65. data/lib/docusign_esign/models/bulk_process_result.rb +206 -0
  66. data/lib/docusign_esign/models/bulk_processing_list_summaries.rb +186 -0
  67. data/lib/docusign_esign/models/bulk_processing_list_summary.rb +214 -0
  68. data/lib/docusign_esign/models/bulk_processing_lists.rb +186 -0
  69. data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
  70. data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +204 -0
  71. data/lib/docusign_esign/models/bulk_send_batch_error.rb +194 -0
  72. data/lib/docusign_esign/models/bulk_send_batch_status.rb +42 -1
  73. data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +22 -1
  74. data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
  75. data/lib/docusign_esign/models/bulk_send_envelopes_info.rb +304 -0
  76. data/lib/docusign_esign/models/bulk_send_error_status.rb +12 -1
  77. data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
  78. data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
  79. data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
  80. data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
  81. data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
  82. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
  83. data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
  84. data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
  85. data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
  86. data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
  87. data/lib/docusign_esign/models/captive_recipient.rb +2 -0
  88. data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
  89. data/lib/docusign_esign/models/carbon_copy.rb +48 -1
  90. data/lib/docusign_esign/models/certified_delivery.rb +47 -1
  91. data/lib/docusign_esign/models/checkbox.rb +109 -1
  92. data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
  93. data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
  94. data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
  95. data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
  96. data/lib/docusign_esign/models/comment_thread.rb +63 -1
  97. data/lib/docusign_esign/models/commission_county.rb +72 -1
  98. data/lib/docusign_esign/models/commission_expiration.rb +72 -1
  99. data/lib/docusign_esign/models/commission_number.rb +72 -1
  100. data/lib/docusign_esign/models/commission_state.rb +72 -1
  101. data/lib/docusign_esign/models/company.rb +72 -1
  102. data/lib/docusign_esign/models/composite_template.rb +2 -0
  103. data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
  104. data/lib/docusign_esign/models/connect_config_results.rb +1 -0
  105. data/lib/docusign_esign/models/connect_custom_configuration.rb +60 -4
  106. data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
  107. data/lib/docusign_esign/models/connect_delete_failure_result.rb +174 -0
  108. data/lib/docusign_esign/models/connect_event_data.rb +1 -0
  109. data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
  110. data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
  111. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +195 -0
  112. data/lib/docusign_esign/models/connect_log.rb +1 -0
  113. data/lib/docusign_esign/models/connect_o_auth_config.rb +214 -0
  114. data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
  115. data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
  116. data/lib/docusign_esign/models/connect_user_info.rb +214 -0
  117. data/lib/docusign_esign/models/consent_details.rb +204 -0
  118. data/lib/docusign_esign/models/console_view_request.rb +1 -0
  119. data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
  120. data/lib/docusign_esign/models/contact.rb +12 -1
  121. data/lib/docusign_esign/models/contact_get_response.rb +1 -0
  122. data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
  123. data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
  124. data/lib/docusign_esign/models/contact_update_response.rb +1 -0
  125. data/lib/docusign_esign/models/correct_view_request.rb +12 -1
  126. data/lib/docusign_esign/models/credit_card_information.rb +2 -0
  127. data/lib/docusign_esign/models/currency.rb +95 -1
  128. data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
  129. data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
  130. data/lib/docusign_esign/models/custom_field.rb +2 -0
  131. data/lib/docusign_esign/models/date.rb +98 -1
  132. data/lib/docusign_esign/models/date_signed.rb +66 -1
  133. data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
  134. data/lib/docusign_esign/models/decline.rb +66 -1
  135. data/lib/docusign_esign/models/delayed_routing.rb +206 -0
  136. data/lib/docusign_esign/models/delayed_routing_api_model.rb +206 -0
  137. data/lib/docusign_esign/models/delegation_info.rb +214 -0
  138. data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
  139. data/lib/docusign_esign/models/document.rb +3 -0
  140. data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
  141. data/lib/docusign_esign/models/document_html_definition.rb +1 -0
  142. data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
  143. data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
  144. data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
  145. data/lib/docusign_esign/models/document_template.rb +1 -0
  146. data/lib/docusign_esign/models/document_visibility.rb +2 -0
  147. data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
  148. data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
  149. data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
  150. data/lib/docusign_esign/models/downgrade_plan_update_response.rb +11 -1
  151. data/lib/docusign_esign/models/downgrade_request_information.rb +204 -0
  152. data/lib/docusign_esign/models/draw.rb +60 -1
  153. data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
  154. data/lib/docusign_esign/models/editor.rb +46 -1
  155. data/lib/docusign_esign/models/email.rb +98 -1
  156. data/lib/docusign_esign/models/email_address.rb +66 -1
  157. data/lib/docusign_esign/models/envelope.rb +20 -1
  158. data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
  159. data/lib/docusign_esign/models/envelope_custom_metadata.rb +186 -0
  160. data/lib/docusign_esign/models/envelope_definition.rb +23 -1
  161. data/lib/docusign_esign/models/envelope_delay_rule.rb +194 -0
  162. data/lib/docusign_esign/models/envelope_delay_rule_api_model.rb +195 -0
  163. data/lib/docusign_esign/models/envelope_document.rb +7 -0
  164. data/lib/docusign_esign/models/envelope_event.rb +1 -0
  165. data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
  166. data/lib/docusign_esign/models/envelope_id.rb +65 -1
  167. data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
  168. data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
  169. data/lib/docusign_esign/models/envelope_publish_transaction.rb +307 -0
  170. data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -0
  171. data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
  172. data/lib/docusign_esign/models/envelope_summary.rb +3 -0
  173. data/lib/docusign_esign/models/envelope_template.rb +22 -1
  174. data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
  175. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
  176. data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
  177. data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
  178. data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
  179. data/lib/docusign_esign/models/envelopes_information.rb +1 -0
  180. data/lib/docusign_esign/models/event_notification.rb +24 -1
  181. data/lib/docusign_esign/models/event_result.rb +1 -0
  182. data/lib/docusign_esign/models/external_document_sources.rb +6 -0
  183. data/lib/docusign_esign/models/external_file.rb +1 -0
  184. data/lib/docusign_esign/models/external_folder.rb +1 -0
  185. data/lib/docusign_esign/models/external_primary_account_recipient_auth_requirements.rb +214 -0
  186. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
  187. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
  188. data/lib/docusign_esign/models/feature_set.rb +1 -0
  189. data/lib/docusign_esign/models/filter.rb +1 -0
  190. data/lib/docusign_esign/models/first_name.rb +66 -1
  191. data/lib/docusign_esign/models/folder.rb +4 -0
  192. data/lib/docusign_esign/models/folder_item_response.rb +1 -0
  193. data/lib/docusign_esign/models/folder_item_v2.rb +13 -1
  194. data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
  195. data/lib/docusign_esign/models/folders_request.rb +1 -0
  196. data/lib/docusign_esign/models/form_data_item.rb +1 -0
  197. data/lib/docusign_esign/models/formula_tab.rb +103 -1
  198. data/lib/docusign_esign/models/full_name.rb +66 -1
  199. data/lib/docusign_esign/models/group.rb +13 -1
  200. data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
  201. data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
  202. data/lib/docusign_esign/models/id_evidence_resource_token.rb +194 -0
  203. data/lib/docusign_esign/models/id_evidence_view_link.rb +184 -0
  204. data/lib/docusign_esign/models/in_person_signer.rb +31 -0
  205. data/lib/docusign_esign/models/initial_here.rb +60 -1
  206. data/lib/docusign_esign/models/inline_template.rb +3 -0
  207. data/lib/docusign_esign/models/integrated_connect_user_info_list.rb +246 -0
  208. data/lib/docusign_esign/models/intermediary.rb +46 -1
  209. data/lib/docusign_esign/models/jurisdiction.rb +1 -0
  210. data/lib/docusign_esign/models/last_name.rb +66 -1
  211. data/lib/docusign_esign/models/linked_external_primary_account.rb +21 -1
  212. data/lib/docusign_esign/models/list.rb +112 -1
  213. data/lib/docusign_esign/models/list_custom_field.rb +2 -0
  214. data/lib/docusign_esign/models/list_item.rb +4 -0
  215. data/lib/docusign_esign/models/locale_policy.rb +13 -0
  216. data/lib/docusign_esign/models/lock_information.rb +2 -0
  217. data/lib/docusign_esign/models/lock_request.rb +1 -0
  218. data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
  219. data/lib/docusign_esign/models/member_shared_items.rb +3 -0
  220. data/lib/docusign_esign/models/merge_field.rb +6 -0
  221. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
  222. data/lib/docusign_esign/models/money.rb +1 -0
  223. data/lib/docusign_esign/models/name_value.rb +2 -0
  224. data/lib/docusign_esign/models/new_account_definition.rb +53 -4
  225. data/lib/docusign_esign/models/new_account_summary.rb +1 -0
  226. data/lib/docusign_esign/models/new_user.rb +2 -0
  227. data/lib/docusign_esign/models/new_users_summary.rb +1 -0
  228. data/lib/docusign_esign/models/notarize.rb +58 -1
  229. data/lib/docusign_esign/models/notary.rb +1 -0
  230. data/lib/docusign_esign/models/notary_host.rb +20 -0
  231. data/lib/docusign_esign/models/notary_journal.rb +2 -0
  232. data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
  233. data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
  234. data/lib/docusign_esign/models/notary_recipient.rb +93 -1
  235. data/lib/docusign_esign/models/notary_result.rb +2 -0
  236. data/lib/docusign_esign/models/notary_seal.rb +59 -1
  237. data/lib/docusign_esign/models/note.rb +67 -1
  238. data/lib/docusign_esign/models/notification.rb +2 -0
  239. data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
  240. data/lib/docusign_esign/models/notification_defaults.rb +2 -0
  241. data/lib/docusign_esign/models/number.rb +100 -1
  242. data/lib/docusign_esign/models/page.rb +1 -0
  243. data/lib/docusign_esign/models/participant.rb +908 -0
  244. data/lib/docusign_esign/models/payment_details.rb +16 -1
  245. data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
  246. data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
  247. data/lib/docusign_esign/models/payment_line_item.rb +1 -0
  248. data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
  249. data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
  250. data/lib/docusign_esign/models/permission_profile.rb +2 -0
  251. data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
  252. data/lib/docusign_esign/models/phone_number.rb +72 -1
  253. data/lib/docusign_esign/models/poly_line_overlay.rb +60 -1
  254. data/lib/docusign_esign/models/power_form.rb +2 -0
  255. data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
  256. data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
  257. data/lib/docusign_esign/models/power_forms_response.rb +1 -0
  258. data/lib/docusign_esign/models/prefill_tabs.rb +65 -4
  259. data/lib/docusign_esign/models/property_metadata.rb +1 -0
  260. data/lib/docusign_esign/models/radio.rb +48 -1
  261. data/lib/docusign_esign/models/radio_group.rb +78 -4
  262. data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
  263. data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
  264. data/lib/docusign_esign/models/recipient_group.rb +1 -0
  265. data/lib/docusign_esign/models/recipient_identity_phone_number.rb +44 -4
  266. data/lib/docusign_esign/models/recipient_identity_verification.rb +15 -4
  267. data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
  268. data/lib/docusign_esign/models/recipient_option.rb +1 -0
  269. data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
  270. data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
  271. data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
  272. data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
  273. data/lib/docusign_esign/models/recipient_routing.rb +2 -0
  274. data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
  275. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
  276. data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
  277. data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +102 -2
  278. data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
  279. data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
  280. data/lib/docusign_esign/models/recipients.rb +14 -1
  281. data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
  282. data/lib/docusign_esign/models/reserved_domain_existence.rb +194 -0
  283. data/lib/docusign_esign/models/return_url_request.rb +1 -0
  284. data/lib/docusign_esign/models/scheduled_sending.rb +216 -0
  285. data/lib/docusign_esign/models/scheduled_sending_api_model.rb +206 -0
  286. data/lib/docusign_esign/models/seal_sign.rb +17 -0
  287. data/lib/docusign_esign/models/seat_discount.rb +1 -0
  288. data/lib/docusign_esign/models/sender_company.rb +65 -1
  289. data/lib/docusign_esign/models/sender_email_notifications.rb +12 -1
  290. data/lib/docusign_esign/models/sender_name.rb +65 -1
  291. data/lib/docusign_esign/models/settings_metadata.rb +1 -0
  292. data/lib/docusign_esign/models/shared_item.rb +3 -0
  293. data/lib/docusign_esign/models/sign_here.rb +62 -1
  294. data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
  295. data/lib/docusign_esign/models/signature_type.rb +1 -0
  296. data/lib/docusign_esign/models/signer.rb +84 -1
  297. data/lib/docusign_esign/models/signer_attachment.rb +60 -1
  298. data/lib/docusign_esign/models/signing_group.rb +2 -0
  299. data/lib/docusign_esign/models/signing_group_user.rb +1 -0
  300. data/lib/docusign_esign/models/smart_section.rb +61 -1
  301. data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
  302. data/lib/docusign_esign/models/social_account_information.rb +1 -0
  303. data/lib/docusign_esign/models/ssn.rb +98 -1
  304. data/lib/docusign_esign/models/stamp.rb +2 -0
  305. data/lib/docusign_esign/models/supported_languages.rb +1 -0
  306. data/lib/docusign_esign/models/tab_account_settings.rb +42 -1
  307. data/lib/docusign_esign/models/tab_group.rb +61 -1
  308. data/lib/docusign_esign/models/tab_metadata.rb +34 -1
  309. data/lib/docusign_esign/models/tabs.rb +2 -0
  310. data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
  311. data/lib/docusign_esign/models/template_notification_request.rb +2 -0
  312. data/lib/docusign_esign/models/template_recipients.rb +14 -1
  313. data/lib/docusign_esign/models/template_role.rb +4 -0
  314. data/lib/docusign_esign/models/template_shared_item.rb +3 -0
  315. data/lib/docusign_esign/models/template_summary.rb +3 -0
  316. data/lib/docusign_esign/models/template_tabs.rb +1 -0
  317. data/lib/docusign_esign/models/template_update_summary.rb +4 -0
  318. data/lib/docusign_esign/models/text.rb +100 -1
  319. data/lib/docusign_esign/models/text_custom_field.rb +2 -0
  320. data/lib/docusign_esign/models/title.rb +72 -1
  321. data/lib/docusign_esign/models/user_account_management_granular_information.rb +70 -1
  322. data/lib/docusign_esign/models/user_info.rb +1 -0
  323. data/lib/docusign_esign/models/user_information.rb +17 -1
  324. data/lib/docusign_esign/models/user_information_list.rb +1 -0
  325. data/lib/docusign_esign/models/user_password_information.rb +1 -0
  326. data/lib/docusign_esign/models/user_password_rules.rb +2 -0
  327. data/lib/docusign_esign/models/user_profile.rb +3 -0
  328. data/lib/docusign_esign/models/user_settings_information.rb +103 -4
  329. data/lib/docusign_esign/models/user_shared_item.rb +3 -0
  330. data/lib/docusign_esign/models/user_signature.rb +2 -0
  331. data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
  332. data/lib/docusign_esign/models/view.rb +66 -1
  333. data/lib/docusign_esign/models/witness.rb +84 -1
  334. data/lib/docusign_esign/models/workflow.rb +32 -1
  335. data/lib/docusign_esign/models/workflow_step.rb +13 -1
  336. data/lib/docusign_esign/models/workspace.rb +4 -0
  337. data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
  338. data/lib/docusign_esign/models/workspace_item.rb +5 -0
  339. data/lib/docusign_esign/models/workspace_settings.rb +1 -0
  340. data/lib/docusign_esign/models/workspace_user.rb +1 -0
  341. data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
  342. data/lib/docusign_esign/models/zip.rb +99 -1
  343. data/lib/docusign_esign/version.rb +1 -1
  344. data/lib/docusign_esign.rb +30 -17
  345. data/tests/spec/unit_tests_using_jwt_spec.rb +605 -449
  346. metadata +70 -44
  347. data/Gemfile.lock +0 -73
  348. data/docusign_esign-2.12.0.rc1.gem +0 -0
  349. data/docusign_esign-3.12.0.rc1.gem +0 -0
  350. data/lib/docusign_esign/.DS_Store +0 -0
  351. data/lib/docusign_esign/api/.DS_Store +0 -0
  352. data/lib/docusign_esign/client/.DS_Store +0 -0
  353. data/tests/.DS_Store +0 -0
  354. data/tests/Gemfile.lock +0 -46
  355. data/tests/docs/private.pem +0 -27
@@ -80,7 +80,7 @@ module DocuSign_eSign
80
80
  end
81
81
 
82
82
  class GetConsumerDisclosureOptions
83
- #
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,112 @@ 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
+
1434
+ # Submits a batch of historical envelopes for republish to an adhoc config.
1435
+ #
1436
+ # @param account_id The external account number (int) or account ID Guid.
1437
+ # @param connect_historical_envelope_republish (optional parameter)
1438
+ # @return [EnvelopePublishTransaction]
1439
+ def create_historical_envelope_publish_transaction(account_id, connect_historical_envelope_republish)
1440
+ data, _status_code, _headers = create_historical_envelope_publish_transaction_with_http_info(account_id, connect_historical_envelope_republish)
1441
+ return data
1442
+ end
1443
+
1444
+ # Submits a batch of historical envelopes for republish to an adhoc config.
1445
+ #
1446
+ # @param account_id The external account number (int) or account ID Guid.
1447
+ # @param connect_historical_envelope_republish (optional parameter)
1448
+ # @return [Array<(EnvelopePublishTransaction, Fixnum, Hash)>] EnvelopePublishTransaction data, response status code and response headers
1449
+ def create_historical_envelope_publish_transaction_with_http_info(account_id, connect_historical_envelope_republish)
1450
+ if @api_client.config.debugging
1451
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_historical_envelope_publish_transaction ..."
1452
+ end
1453
+ # verify the required parameter 'account_id' is set
1454
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_historical_envelope_publish_transaction" if account_id.nil?
1455
+ # resource path
1456
+ local_var_path = "/v2.1/accounts/{accountId}/connect/envelopes/publish/historical".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1457
+
1458
+ # query parameters
1459
+ query_params = {}
1460
+
1461
+ # header parameters
1462
+ header_params = {}
1463
+ # HTTP header 'Accept' (if needed)
1464
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1465
+
1466
+ # form parameters
1467
+ form_params = {}
1468
+
1469
+ # http body (model)
1470
+ post_body = @api_client.object_to_http_body(connect_historical_envelope_republish)
1471
+ auth_names = []
1472
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1473
+ :header_params => header_params,
1474
+ :query_params => query_params,
1475
+ :form_params => form_params,
1476
+ :body => post_body,
1477
+ :auth_names => auth_names,
1478
+ :return_type => 'EnvelopePublishTransaction')
1479
+ if @api_client.config.debugging
1480
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_historical_envelope_publish_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1481
+ end
1482
+ return data, status_code, headers
1483
+ end
1484
+
1379
1485
  # Lock an envelope.
1380
1486
  # Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
1381
1487
  # @param account_id The external account number (int) or account ID Guid.
@@ -1490,7 +1596,7 @@ module DocuSign_eSign
1490
1596
  end
1491
1597
 
1492
1598
  # Provides a link to access the Identity manual review related to a recipient.
1493
- #
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.
1494
1600
  # @param account_id The external account number (int) or account ID Guid.
1495
1601
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1496
1602
  # @param recipient_id The ID of the recipient being accessed.
@@ -1501,7 +1607,7 @@ module DocuSign_eSign
1501
1607
  end
1502
1608
 
1503
1609
  # Provides a link to access the Identity manual review related to a recipient.
1504
- #
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.
1505
1611
  # @param account_id The external account number (int) or account ID Guid.
1506
1612
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1507
1613
  # @param recipient_id The ID of the recipient being accessed.
@@ -1551,7 +1657,7 @@ module DocuSign_eSign
1551
1657
  # @param account_id The external account number (int) or account ID Guid.
1552
1658
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1553
1659
  # @param recipient_id The ID of the recipient being accessed.
1554
- # @return [ProofServiceViewLink]
1660
+ # @return [IdEvidenceViewLink]
1555
1661
  def create_recipient_proof_file_link(account_id, envelope_id, recipient_id)
1556
1662
  data, _status_code, _headers = create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id)
1557
1663
  return data
@@ -1562,7 +1668,7 @@ module DocuSign_eSign
1562
1668
  # @param account_id The external account number (int) or account ID Guid.
1563
1669
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1564
1670
  # @param recipient_id The ID of the recipient being accessed.
1565
- # @return [Array<(ProofServiceViewLink, Fixnum, Hash)>] ProofServiceViewLink data, response status code and response headers
1671
+ # @return [Array<(IdEvidenceViewLink, Fixnum, Hash)>] IdEvidenceViewLink data, response status code and response headers
1566
1672
  def create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id)
1567
1673
  if @api_client.config.debugging
1568
1674
  @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_proof_file_link ..."
@@ -1596,7 +1702,7 @@ module DocuSign_eSign
1596
1702
  :form_params => form_params,
1597
1703
  :body => post_body,
1598
1704
  :auth_names => auth_names,
1599
- :return_type => 'ProofServiceViewLink')
1705
+ :return_type => 'IdEvidenceViewLink')
1600
1706
  if @api_client.config.debugging
1601
1707
  @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient_proof_file_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1602
1708
  end
@@ -1604,24 +1710,24 @@ module DocuSign_eSign
1604
1710
  end
1605
1711
 
1606
1712
  # Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
1607
- #
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/).
1608
1714
  # @param account_id The external account number (int) or account ID Guid.
1609
1715
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1610
1716
  # @param recipient_id The ID of the recipient being accessed.
1611
1717
  # @param token_scopes
1612
- # @return [ProofServiceResourceToken]
1718
+ # @return [IdEvidenceResourceToken]
1613
1719
  def create_recipient_proof_file_resource_token(account_id, envelope_id, recipient_id, token_scopes)
1614
1720
  data, _status_code, _headers = create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes)
1615
1721
  return data
1616
1722
  end
1617
1723
 
1618
1724
  # Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
1619
- #
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/).
1620
1726
  # @param account_id The external account number (int) or account ID Guid.
1621
1727
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1622
1728
  # @param recipient_id The ID of the recipient being accessed.
1623
1729
  # @param token_scopes
1624
- # @return [Array<(ProofServiceResourceToken, Fixnum, Hash)>] ProofServiceResourceToken data, response status code and response headers
1730
+ # @return [Array<(IdEvidenceResourceToken, Fixnum, Hash)>] IdEvidenceResourceToken data, response status code and response headers
1625
1731
  def create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes)
1626
1732
  if @api_client.config.debugging
1627
1733
  @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_proof_file_resource_token ..."
@@ -1657,7 +1763,7 @@ module DocuSign_eSign
1657
1763
  :form_params => form_params,
1658
1764
  :body => post_body,
1659
1765
  :auth_names => auth_names,
1660
- :return_type => 'ProofServiceResourceToken')
1766
+ :return_type => 'IdEvidenceResourceToken')
1661
1767
  if @api_client.config.debugging
1662
1768
  @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient_proof_file_resource_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1663
1769
  end
@@ -1720,7 +1826,7 @@ module DocuSign_eSign
1720
1826
  end
1721
1827
 
1722
1828
  # Get Responsive HTML Preview for all documents in an envelope.
1723
- #
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.
1724
1830
  # @param account_id The external account number (int) or account ID Guid.
1725
1831
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1726
1832
  # @param document_html_definition (optional parameter)
@@ -1731,7 +1837,7 @@ module DocuSign_eSign
1731
1837
  end
1732
1838
 
1733
1839
  # Get Responsive HTML Preview for all documents in an envelope.
1734
- #
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.
1735
1841
  # @param account_id The external account number (int) or account ID Guid.
1736
1842
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1737
1843
  # @param document_html_definition (optional parameter)
@@ -1888,9 +1994,64 @@ module DocuSign_eSign
1888
1994
  return data, status_code, headers
1889
1995
  end
1890
1996
 
1891
- # 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
1892
2009
  #
1893
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.
1894
2055
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1895
2056
  # @param envelope_attachments_request (optional parameter)
1896
2057
  # @return [EnvelopeAttachmentsResult]
@@ -1900,7 +2061,7 @@ module DocuSign_eSign
1900
2061
  end
1901
2062
 
1902
2063
  # Delete one or more attachments from a DRAFT envelope.
1903
- #
2064
+ # Deletes one or more attachments from a draft envelope.
1904
2065
  # @param account_id The external account number (int) or account ID Guid.
1905
2066
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1906
2067
  # @param envelope_attachments_request (optional parameter)
@@ -1944,7 +2105,7 @@ module DocuSign_eSign
1944
2105
  end
1945
2106
 
1946
2107
  # Delete an existing ChunkedUpload.
1947
- #
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.
1948
2109
  # @param account_id The external account number (int) or account ID Guid.
1949
2110
  # @param chunked_upload_id
1950
2111
  # @return [ChunkedUploadResponse]
@@ -1954,7 +2115,7 @@ module DocuSign_eSign
1954
2115
  end
1955
2116
 
1956
2117
  # Delete an existing ChunkedUpload.
1957
- #
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.
1958
2119
  # @param account_id The external account number (int) or account ID Guid.
1959
2120
  # @param chunked_upload_id
1960
2121
  # @return [Array<(ChunkedUploadResponse, Fixnum, Hash)>] ChunkedUploadResponse data, response status code and response headers
@@ -2171,7 +2332,7 @@ module DocuSign_eSign
2171
2332
  end
2172
2333
 
2173
2334
  # Deletes tabs from an envelope document
2174
- #
2335
+ # Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.
2175
2336
  # @param account_id The external account number (int) or account ID Guid.
2176
2337
  # @param document_id The ID of the document being accessed.
2177
2338
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2183,7 +2344,7 @@ module DocuSign_eSign
2183
2344
  end
2184
2345
 
2185
2346
  # Deletes tabs from an envelope document
2186
- #
2347
+ # Deletes tabs from the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.
2187
2348
  # @param account_id The external account number (int) or account ID Guid.
2188
2349
  # @param document_id The ID of the document being accessed.
2189
2350
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2338,7 +2499,7 @@ module DocuSign_eSign
2338
2499
  end
2339
2500
 
2340
2501
  # Revokes the correction view URL to the Envelope UI
2341
- #
2502
+ # Revokes the correction view URL to the Envelope UI.
2342
2503
  # @param account_id The external account number (int) or account ID Guid.
2343
2504
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2344
2505
  # @param correct_view_request (optional parameter)
@@ -2349,7 +2510,7 @@ module DocuSign_eSign
2349
2510
  end
2350
2511
 
2351
2512
  # Revokes the correction view URL to the Envelope UI
2352
- #
2513
+ # Revokes the correction view URL to the Envelope UI.
2353
2514
  # @param account_id The external account number (int) or account ID Guid.
2354
2515
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2355
2516
  # @param correct_view_request (optional parameter)
@@ -2391,31 +2552,35 @@ module DocuSign_eSign
2391
2552
  return data, status_code, headers
2392
2553
  end
2393
2554
 
2394
- # Delete envelope transfer rules for an account.
2555
+ # Deletes the delayed routing rules for the specified envelope workflow step.
2395
2556
  #
2396
2557
  # @param account_id The external account number (int) or account ID Guid.
2397
- # @param envelope_transfer_rule_id
2558
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2559
+ # @param workflow_step_id
2398
2560
  # @return [nil]
2399
- def delete_envelope_transfer_rules(account_id, envelope_transfer_rule_id)
2400
- delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id)
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)
2401
2563
  return nil
2402
2564
  end
2403
2565
 
2404
- # Delete envelope transfer rules for an account.
2566
+ # Deletes the delayed routing rules for the specified envelope workflow step.
2405
2567
  #
2406
2568
  # @param account_id The external account number (int) or account ID Guid.
2407
- # @param envelope_transfer_rule_id
2569
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2570
+ # @param workflow_step_id
2408
2571
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2409
- def delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id)
2572
+ def delete_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id)
2410
2573
  if @api_client.config.debugging
2411
- @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_transfer_rules ..."
2574
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_delayed_routing_definition ..."
2412
2575
  end
2413
2576
  # verify the required parameter 'account_id' is set
2414
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_transfer_rules" if account_id.nil?
2415
- # verify the required parameter 'envelope_transfer_rule_id' is set
2416
- fail ArgumentError, "Missing the required parameter 'envelope_transfer_rule_id' when calling EnvelopesApi.delete_envelope_transfer_rules" if envelope_transfer_rule_id.nil?
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?
2417
2582
  # resource path
2418
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeTransferRuleId' + '}', envelope_transfer_rule_id.to_s)
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)
2419
2584
 
2420
2585
  # query parameters
2421
2586
  query_params = {}
@@ -2438,36 +2603,36 @@ module DocuSign_eSign
2438
2603
  :body => post_body,
2439
2604
  :auth_names => auth_names)
2440
2605
  if @api_client.config.debugging
2441
- @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_transfer_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2606
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2442
2607
  end
2443
2608
  return data, status_code, headers
2444
2609
  end
2445
2610
 
2446
- # Delete the workflow definition for an envelope.
2611
+ # Deletes the scheduled sending rules for the envelope's workflow.
2447
2612
  #
2448
2613
  # @param account_id The external account number (int) or account ID Guid.
2449
2614
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2450
2615
  # @return [nil]
2451
- def delete_envelope_workflow_definition(account_id, envelope_id)
2452
- delete_envelope_workflow_definition_with_http_info(account_id, envelope_id)
2616
+ def delete_envelope_scheduled_sending_definition(account_id, envelope_id)
2617
+ delete_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id)
2453
2618
  return nil
2454
2619
  end
2455
2620
 
2456
- # Delete the workflow definition for an envelope.
2621
+ # Deletes the scheduled sending rules for the envelope&#39;s workflow.
2457
2622
  #
2458
2623
  # @param account_id The external account number (int) or account ID Guid.
2459
2624
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2460
2625
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2461
- def delete_envelope_workflow_definition_with_http_info(account_id, envelope_id)
2626
+ def delete_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id)
2462
2627
  if @api_client.config.debugging
2463
- @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_workflow_definition ..."
2628
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_scheduled_sending_definition ..."
2464
2629
  end
2465
2630
  # verify the required parameter 'account_id' is set
2466
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if account_id.nil?
2631
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_scheduled_sending_definition" if account_id.nil?
2467
2632
  # verify the required parameter 'envelope_id' is set
2468
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if envelope_id.nil?
2633
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_scheduled_sending_definition" if envelope_id.nil?
2469
2634
  # resource path
2470
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
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)
2471
2636
 
2472
2637
  # query parameters
2473
2638
  query_params = {}
@@ -2490,36 +2655,36 @@ module DocuSign_eSign
2490
2655
  :body => post_body,
2491
2656
  :auth_names => auth_names)
2492
2657
  if @api_client.config.debugging
2493
- @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2658
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2494
2659
  end
2495
2660
  return data, status_code, headers
2496
2661
  end
2497
2662
 
2498
- # Deletes an envelope lock.
2499
- # Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
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.
2500
2665
  # @param account_id The external account number (int) or account ID Guid.
2501
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
2502
- # @return [LockInformation]
2503
- def delete_lock(account_id, envelope_id)
2504
- data, _status_code, _headers = delete_lock_with_http_info(account_id, envelope_id)
2505
- return data
2666
+ # @param envelope_transfer_rule_id
2667
+ # @return [nil]
2668
+ def delete_envelope_transfer_rules(account_id, envelope_transfer_rule_id)
2669
+ delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id)
2670
+ return nil
2506
2671
  end
2507
2672
 
2508
- # Deletes an envelope lock.
2509
- # Deletes the lock from the specified envelope. The &#x60;X-DocuSign-Edit&#x60; header must be included in the request.
2673
+ # Delete envelope transfer rules for an account.
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.
2510
2675
  # @param account_id The external account number (int) or account ID Guid.
2511
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
2512
- # @return [Array<(LockInformation, Fixnum, Hash)>] LockInformation data, response status code and response headers
2513
- def delete_lock_with_http_info(account_id, envelope_id)
2676
+ # @param envelope_transfer_rule_id
2677
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2678
+ def delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id)
2514
2679
  if @api_client.config.debugging
2515
- @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_lock ..."
2680
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_transfer_rules ..."
2516
2681
  end
2517
2682
  # verify the required parameter 'account_id' is set
2518
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_lock" if account_id.nil?
2519
- # verify the required parameter 'envelope_id' is set
2520
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_lock" if envelope_id.nil?
2683
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_transfer_rules" if account_id.nil?
2684
+ # verify the required parameter 'envelope_transfer_rule_id' is set
2685
+ fail ArgumentError, "Missing the required parameter 'envelope_transfer_rule_id' when calling EnvelopesApi.delete_envelope_transfer_rules" if envelope_transfer_rule_id.nil?
2521
2686
  # resource path
2522
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2687
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeTransferRuleId' + '}', envelope_transfer_rule_id.to_s)
2523
2688
 
2524
2689
  # query parameters
2525
2690
  query_params = {}
@@ -2540,43 +2705,38 @@ module DocuSign_eSign
2540
2705
  :query_params => query_params,
2541
2706
  :form_params => form_params,
2542
2707
  :body => post_body,
2543
- :auth_names => auth_names,
2544
- :return_type => 'LockInformation')
2708
+ :auth_names => auth_names)
2545
2709
  if @api_client.config.debugging
2546
- @api_client.config.logger.debug "API called: EnvelopesApi#delete_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2710
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_transfer_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2547
2711
  end
2548
2712
  return data, status_code, headers
2549
2713
  end
2550
2714
 
2551
- # Deletes a recipient from an envelope.
2552
- # Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
2715
+ # Delete the workflow definition for an envelope.
2716
+ # Deletes the specified envelope's workflow definition if it has one.
2553
2717
  # @param account_id The external account number (int) or account ID Guid.
2554
2718
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2555
- # @param recipient_id The ID of the recipient being accessed.
2556
- # @return [Recipients]
2557
- def delete_recipient(account_id, envelope_id, recipient_id)
2558
- data, _status_code, _headers = delete_recipient_with_http_info(account_id, envelope_id, recipient_id)
2559
- return data
2719
+ # @return [nil]
2720
+ def delete_envelope_workflow_definition(account_id, envelope_id)
2721
+ delete_envelope_workflow_definition_with_http_info(account_id, envelope_id)
2722
+ return nil
2560
2723
  end
2561
2724
 
2562
- # Deletes a recipient from an envelope.
2563
- # Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
2725
+ # Delete the workflow definition for an envelope.
2726
+ # Deletes the specified envelope&#39;s workflow definition if it has one.
2564
2727
  # @param account_id The external account number (int) or account ID Guid.
2565
2728
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2566
- # @param recipient_id The ID of the recipient being accessed.
2567
- # @return [Array<(Recipients, Fixnum, Hash)>] Recipients data, response status code and response headers
2568
- def delete_recipient_with_http_info(account_id, envelope_id, recipient_id)
2729
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2730
+ def delete_envelope_workflow_definition_with_http_info(account_id, envelope_id)
2569
2731
  if @api_client.config.debugging
2570
- @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_recipient ..."
2732
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_workflow_definition ..."
2571
2733
  end
2572
2734
  # verify the required parameter 'account_id' is set
2573
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_recipient" if account_id.nil?
2735
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if account_id.nil?
2574
2736
  # verify the required parameter 'envelope_id' is set
2575
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_recipient" if envelope_id.nil?
2576
- # verify the required parameter 'recipient_id' is set
2577
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.delete_recipient" if recipient_id.nil?
2737
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if envelope_id.nil?
2578
2738
  # resource path
2579
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
2739
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2580
2740
 
2581
2741
  # query parameters
2582
2742
  query_params = {}
@@ -2597,32 +2757,197 @@ module DocuSign_eSign
2597
2757
  :query_params => query_params,
2598
2758
  :form_params => form_params,
2599
2759
  :body => post_body,
2600
- :auth_names => auth_names,
2601
- :return_type => 'Recipients')
2760
+ :auth_names => auth_names)
2602
2761
  if @api_client.config.debugging
2603
- @api_client.config.logger.debug "API called: EnvelopesApi#delete_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2762
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2604
2763
  end
2605
2764
  return data, status_code, headers
2606
2765
  end
2607
2766
 
2608
- # Deletes recipients from an envelope.
2609
- # Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
2767
+ # Deletes the envelope workflow step definition for an envelope's workflow by step id.
2768
+ #
2610
2769
  # @param account_id The external account number (int) or account ID Guid.
2611
2770
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2612
- # @param recipients (optional parameter)
2613
- # @return [Recipients]
2614
- def delete_recipients(account_id, envelope_id, recipients)
2615
- data, _status_code, _headers = delete_recipients_with_http_info(account_id, envelope_id, recipients)
2616
- return data
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
2617
2776
  end
2618
2777
 
2619
- # Deletes recipients from an envelope.
2620
- # Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the &#x60;recipientId&#x60; being used as the key for deleting recipients. If the envelope is &#x60;In Process&#x60;, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
2778
+ # Deletes the envelope workflow step definition for an envelope&#39;s workflow by step id.
2779
+ #
2621
2780
  # @param account_id The external account number (int) or account ID Guid.
2622
2781
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2623
- # @param recipients (optional parameter)
2624
- # @return [Array<(Recipients, Fixnum, Hash)>] Recipients data, response status code and response headers
2625
- def delete_recipients_with_http_info(account_id, envelope_id, recipients)
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
+
2823
+ # Deletes an envelope lock.
2824
+ # Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
2825
+ # @param account_id The external account number (int) or account ID Guid.
2826
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2827
+ # @return [LockInformation]
2828
+ def delete_lock(account_id, envelope_id)
2829
+ data, _status_code, _headers = delete_lock_with_http_info(account_id, envelope_id)
2830
+ return data
2831
+ end
2832
+
2833
+ # Deletes an envelope lock.
2834
+ # Deletes the lock from the specified envelope. The &#x60;X-DocuSign-Edit&#x60; header must be included in the request.
2835
+ # @param account_id The external account number (int) or account ID Guid.
2836
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2837
+ # @return [Array<(LockInformation, Fixnum, Hash)>] LockInformation data, response status code and response headers
2838
+ def delete_lock_with_http_info(account_id, envelope_id)
2839
+ if @api_client.config.debugging
2840
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_lock ..."
2841
+ end
2842
+ # verify the required parameter 'account_id' is set
2843
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_lock" if account_id.nil?
2844
+ # verify the required parameter 'envelope_id' is set
2845
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_lock" if envelope_id.nil?
2846
+ # resource path
2847
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2848
+
2849
+ # query parameters
2850
+ query_params = {}
2851
+
2852
+ # header parameters
2853
+ header_params = {}
2854
+ # HTTP header 'Accept' (if needed)
2855
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2856
+
2857
+ # form parameters
2858
+ form_params = {}
2859
+
2860
+ # http body (model)
2861
+ post_body = nil
2862
+ auth_names = []
2863
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2864
+ :header_params => header_params,
2865
+ :query_params => query_params,
2866
+ :form_params => form_params,
2867
+ :body => post_body,
2868
+ :auth_names => auth_names,
2869
+ :return_type => 'LockInformation')
2870
+ if @api_client.config.debugging
2871
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2872
+ end
2873
+ return data, status_code, headers
2874
+ end
2875
+
2876
+ # Deletes a recipient from an envelope.
2877
+ # Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
2878
+ # @param account_id The external account number (int) or account ID Guid.
2879
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2880
+ # @param recipient_id The ID of the recipient being accessed.
2881
+ # @return [Recipients]
2882
+ def delete_recipient(account_id, envelope_id, recipient_id)
2883
+ data, _status_code, _headers = delete_recipient_with_http_info(account_id, envelope_id, recipient_id)
2884
+ return data
2885
+ end
2886
+
2887
+ # Deletes a recipient from an envelope.
2888
+ # Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
2889
+ # @param account_id The external account number (int) or account ID Guid.
2890
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2891
+ # @param recipient_id The ID of the recipient being accessed.
2892
+ # @return [Array<(Recipients, Fixnum, Hash)>] Recipients data, response status code and response headers
2893
+ def delete_recipient_with_http_info(account_id, envelope_id, recipient_id)
2894
+ if @api_client.config.debugging
2895
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_recipient ..."
2896
+ end
2897
+ # verify the required parameter 'account_id' is set
2898
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_recipient" if account_id.nil?
2899
+ # verify the required parameter 'envelope_id' is set
2900
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_recipient" if envelope_id.nil?
2901
+ # verify the required parameter 'recipient_id' is set
2902
+ fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.delete_recipient" if recipient_id.nil?
2903
+ # resource path
2904
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
2905
+
2906
+ # query parameters
2907
+ query_params = {}
2908
+
2909
+ # header parameters
2910
+ header_params = {}
2911
+ # HTTP header 'Accept' (if needed)
2912
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2913
+
2914
+ # form parameters
2915
+ form_params = {}
2916
+
2917
+ # http body (model)
2918
+ post_body = nil
2919
+ auth_names = []
2920
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2921
+ :header_params => header_params,
2922
+ :query_params => query_params,
2923
+ :form_params => form_params,
2924
+ :body => post_body,
2925
+ :auth_names => auth_names,
2926
+ :return_type => 'Recipients')
2927
+ if @api_client.config.debugging
2928
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2929
+ end
2930
+ return data, status_code, headers
2931
+ end
2932
+
2933
+ # Deletes recipients from an envelope.
2934
+ # Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
2935
+ # @param account_id The external account number (int) or account ID Guid.
2936
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2937
+ # @param recipients (optional parameter)
2938
+ # @return [Recipients]
2939
+ def delete_recipients(account_id, envelope_id, recipients)
2940
+ data, _status_code, _headers = delete_recipients_with_http_info(account_id, envelope_id, recipients)
2941
+ return data
2942
+ end
2943
+
2944
+ # Deletes recipients from an envelope.
2945
+ # Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the &#x60;recipientId&#x60; being used as the key for deleting recipients. If the envelope is &#x60;In Process&#x60;, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
2946
+ # @param account_id The external account number (int) or account ID Guid.
2947
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2948
+ # @param recipients (optional parameter)
2949
+ # @return [Array<(Recipients, Fixnum, Hash)>] Recipients data, response status code and response headers
2950
+ def delete_recipients_with_http_info(account_id, envelope_id, recipients)
2626
2951
  if @api_client.config.debugging
2627
2952
  @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_recipients ..."
2628
2953
  end
@@ -2719,10 +3044,118 @@ module DocuSign_eSign
2719
3044
  return data, status_code, headers
2720
3045
  end
2721
3046
 
2722
- # Delete the workflow definition for a template.
3047
+ # Deletes the delayed routing rules for the specified template workflow step.
2723
3048
  #
2724
3049
  # @param account_id The external account number (int) or account ID Guid.
2725
3050
  # @param template_id The ID of the template being accessed.
3051
+ # @param workflow_step_id
3052
+ # @return [nil]
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)
3055
+ return nil
3056
+ end
3057
+
3058
+ # Deletes the delayed routing rules for the specified template workflow step.
3059
+ #
3060
+ # @param account_id The external account number (int) or account ID Guid.
3061
+ # @param template_id The ID of the template being accessed.
3062
+ # @param workflow_step_id
3063
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3064
+ def delete_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id)
3065
+ if @api_client.config.debugging
3066
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_delayed_routing_definition ..."
3067
+ end
3068
+ # verify the required parameter 'account_id' is set
3069
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_delayed_routing_definition" if account_id.nil?
3070
+ # verify the required parameter 'template_id' is set
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?
3074
+ # resource path
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)
3076
+
3077
+ # query parameters
3078
+ query_params = {}
3079
+
3080
+ # header parameters
3081
+ header_params = {}
3082
+ # HTTP header 'Accept' (if needed)
3083
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3084
+
3085
+ # form parameters
3086
+ form_params = {}
3087
+
3088
+ # http body (model)
3089
+ post_body = nil
3090
+ auth_names = []
3091
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3092
+ :header_params => header_params,
3093
+ :query_params => query_params,
3094
+ :form_params => form_params,
3095
+ :body => post_body,
3096
+ :auth_names => auth_names)
3097
+ if @api_client.config.debugging
3098
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_template_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3099
+ end
3100
+ return data, status_code, headers
3101
+ end
3102
+
3103
+ # Deletes the scheduled sending rules for the template's workflow.
3104
+ #
3105
+ # @param account_id The external account number (int) or account ID Guid.
3106
+ # @param template_id The ID of the template being accessed.
3107
+ # @return [nil]
3108
+ def delete_template_scheduled_sending_definition(account_id, template_id)
3109
+ delete_template_scheduled_sending_definition_with_http_info(account_id, template_id)
3110
+ return nil
3111
+ end
3112
+
3113
+ # Deletes the scheduled sending rules for the template&#39;s workflow.
3114
+ #
3115
+ # @param account_id The external account number (int) or account ID Guid.
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.
2726
3159
  # @return [nil]
2727
3160
  def delete_template_workflow_definition(account_id, template_id)
2728
3161
  delete_template_workflow_definition_with_http_info(account_id, template_id)
@@ -2730,7 +3163,7 @@ module DocuSign_eSign
2730
3163
  end
2731
3164
 
2732
3165
  # Delete the workflow definition for a template.
2733
- #
3166
+ # Deletes the specified template&#39;s workflow definition if it has one.
2734
3167
  # @param account_id The external account number (int) or account ID Guid.
2735
3168
  # @param template_id The ID of the template being accessed.
2736
3169
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -2771,6 +3204,62 @@ module DocuSign_eSign
2771
3204
  return data, status_code, headers
2772
3205
  end
2773
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
+
2774
3263
  # Deletes a template from a document in an existing envelope.
2775
3264
  # Deletes the specified template from a document in an existing envelope.
2776
3265
  # @param account_id The external account number (int) or account ID Guid.
@@ -2832,7 +3321,7 @@ module DocuSign_eSign
2832
3321
  end
2833
3322
 
2834
3323
  # Retrieves an attachment from the envelope.
2835
- #
3324
+ # Retrieves an attachment from an envelope.
2836
3325
  # @param account_id The external account number (int) or account ID Guid.
2837
3326
  # @param attachment_id
2838
3327
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2843,7 +3332,7 @@ module DocuSign_eSign
2843
3332
  end
2844
3333
 
2845
3334
  # Retrieves an attachment from the envelope.
2846
- #
3335
+ # Retrieves an attachment from an envelope.
2847
3336
  # @param account_id The external account number (int) or account ID Guid.
2848
3337
  # @param attachment_id
2849
3338
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -2888,7 +3377,7 @@ module DocuSign_eSign
2888
3377
  end
2889
3378
 
2890
3379
  # Returns a list of attachments associated with the specified envelope
2891
- #
3380
+ # Returns a list of attachments associated with a specified envelope
2892
3381
  # @param account_id The external account number (int) or account ID Guid.
2893
3382
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2894
3383
  # @return [EnvelopeAttachmentsResult]
@@ -2898,7 +3387,7 @@ module DocuSign_eSign
2898
3387
  end
2899
3388
 
2900
3389
  # Returns a list of attachments associated with the specified envelope
2901
- #
3390
+ # Returns a list of attachments associated with a specified envelope
2902
3391
  # @param account_id The external account number (int) or account ID Guid.
2903
3392
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2904
3393
  # @return [Array<(EnvelopeAttachmentsResult, Fixnum, Hash)>] EnvelopeAttachmentsResult data, response status code and response headers
@@ -2941,7 +3430,7 @@ module DocuSign_eSign
2941
3430
  end
2942
3431
 
2943
3432
  # Retrieves the current metadata of a ChunkedUpload.
2944
- #
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.
2945
3434
  # @param account_id The external account number (int) or account ID Guid.
2946
3435
  # @param chunked_upload_id
2947
3436
  # @param DocuSign_eSign::GetChunkedUploadOptions Options for modifying the behavior of the function.
@@ -2952,7 +3441,7 @@ module DocuSign_eSign
2952
3441
  end
2953
3442
 
2954
3443
  # Retrieves the current metadata of a ChunkedUpload.
2955
- #
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.
2956
3445
  # @param account_id The external account number (int) or account ID Guid.
2957
3446
  # @param chunked_upload_id
2958
3447
  # @param DocuSign_eSign::GetChunkedUploadOptions Options for modifying the behavior of the function.
@@ -2997,7 +3486,7 @@ module DocuSign_eSign
2997
3486
  end
2998
3487
 
2999
3488
  # Gets comment transcript for envelope and user
3000
- #
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**).
3001
3490
  # @param account_id The external account number (int) or account ID Guid.
3002
3491
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3003
3492
  # @param DocuSign_eSign::GetCommentsTranscriptOptions Options for modifying the behavior of the function.
@@ -3008,7 +3497,7 @@ module DocuSign_eSign
3008
3497
  end
3009
3498
 
3010
3499
  # Gets comment transcript for envelope and user
3011
- #
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**).
3012
3501
  # @param account_id The external account number (int) or account ID Guid.
3013
3502
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3014
3503
  # @param DocuSign_eSign::GetCommentsTranscriptOptions Options for modifying the behavior of the function.
@@ -3056,7 +3545,7 @@ module DocuSign_eSign
3056
3545
  # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
3057
3546
  # @param account_id The external account number (int) or account ID Guid.
3058
3547
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3059
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3548
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3060
3549
  # @param recipient_id The ID of the recipient being accessed.
3061
3550
  # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
3062
3551
  # @return [ConsumerDisclosure]
@@ -3069,7 +3558,7 @@ module DocuSign_eSign
3069
3558
  # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
3070
3559
  # @param account_id The external account number (int) or account ID Guid.
3071
3560
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3072
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3561
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3073
3562
  # @param recipient_id The ID of the recipient being accessed.
3074
3563
  # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
3075
3564
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
@@ -3312,7 +3801,7 @@ module DocuSign_eSign
3312
3801
  end
3313
3802
 
3314
3803
  # Returns tabs on the document.
3315
- #
3804
+ # Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.
3316
3805
  # @param account_id The external account number (int) or account ID Guid.
3317
3806
  # @param document_id The ID of the document being accessed.
3318
3807
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3324,7 +3813,7 @@ module DocuSign_eSign
3324
3813
  end
3325
3814
 
3326
3815
  # Returns tabs on the document.
3327
- #
3816
+ # Returns the tabs on the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.
3328
3817
  # @param account_id The external account number (int) or account ID Guid.
3329
3818
  # @param document_id The ID of the document being accessed.
3330
3819
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3482,6 +3971,63 @@ module DocuSign_eSign
3482
3971
  return data, status_code, headers
3483
3972
  end
3484
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
+
3485
4031
  # Get the Original HTML Definition used to generate the Responsive HTML for a given document.
3486
4032
  #
3487
4033
  # @param account_id The external account number (int) or account ID Guid.
@@ -3592,9 +4138,62 @@ module DocuSign_eSign
3592
4138
  return data, status_code, headers
3593
4139
  end
3594
4140
 
3595
- # Returns a list of envelope transfer rules in the specified account.
4141
+ # Returns the scheduled sending rules for an envelope's workflow definition.
3596
4142
  #
3597
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.
3598
4197
  # @param DocuSign_eSign::GetEnvelopeTransferRulesOptions Options for modifying the behavior of the function.
3599
4198
  # @return [EnvelopeTransferRuleInformation]
3600
4199
  def get_envelope_transfer_rules(account_id, options = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default)
@@ -3603,7 +4202,7 @@ module DocuSign_eSign
3603
4202
  end
3604
4203
 
3605
4204
  # Returns a list of envelope transfer rules in the specified account.
3606
- #
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.
3607
4206
  # @param account_id The external account number (int) or account ID Guid.
3608
4207
  # @param DocuSign_eSign::GetEnvelopeTransferRulesOptions Options for modifying the behavior of the function.
3609
4208
  # @return [Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>] EnvelopeTransferRuleInformation data, response status code and response headers
@@ -3646,7 +4245,7 @@ module DocuSign_eSign
3646
4245
  end
3647
4246
 
3648
4247
  # Returns the workflow definition for an envelope.
3649
- #
4248
+ # Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one.
3650
4249
  # @param account_id The external account number (int) or account ID Guid.
3651
4250
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3652
4251
  # @return [Workflow]
@@ -3656,7 +4255,7 @@ module DocuSign_eSign
3656
4255
  end
3657
4256
 
3658
4257
  # Returns the workflow definition for an envelope.
3659
- #
4258
+ # Returns an envelope&#39;s workflow definition if the envelope specified by &#x60;envelopeId&#x60; has one.
3660
4259
  # @param account_id The external account number (int) or account ID Guid.
3661
4260
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3662
4261
  # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
@@ -3667,9 +4266,66 @@ module DocuSign_eSign
3667
4266
  # verify the required parameter 'account_id' is set
3668
4267
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_workflow_definition" if account_id.nil?
3669
4268
  # verify the required parameter 'envelope_id' is set
3670
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_workflow_definition" if envelope_id.nil?
4269
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_workflow_definition" if envelope_id.nil?
4270
+ # resource path
4271
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4272
+
4273
+ # query parameters
4274
+ query_params = {}
4275
+
4276
+ # header parameters
4277
+ header_params = {}
4278
+ # HTTP header 'Accept' (if needed)
4279
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4280
+
4281
+ # form parameters
4282
+ form_params = {}
4283
+
4284
+ # http body (model)
4285
+ post_body = nil
4286
+ auth_names = []
4287
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4288
+ :header_params => header_params,
4289
+ :query_params => query_params,
4290
+ :form_params => form_params,
4291
+ :body => post_body,
4292
+ :auth_names => auth_names,
4293
+ :return_type => 'Workflow')
4294
+ if @api_client.config.debugging
4295
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4296
+ end
4297
+ return data, status_code, headers
4298
+ end
4299
+
4300
+ # Returns the workflow step definition for an envelope by step id.
4301
+ #
4302
+ # @param account_id The external account number (int) or account ID Guid.
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?
3671
4327
  # resource path
3672
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
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)
3673
4329
 
3674
4330
  # query parameters
3675
4331
  query_params = {}
@@ -3691,15 +4347,15 @@ module DocuSign_eSign
3691
4347
  :form_params => form_params,
3692
4348
  :body => post_body,
3693
4349
  :auth_names => auth_names,
3694
- :return_type => 'Workflow')
4350
+ :return_type => 'WorkflowStep')
3695
4351
  if @api_client.config.debugging
3696
- @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4352
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3697
4353
  end
3698
4354
  return data, status_code, headers
3699
4355
  end
3700
4356
 
3701
4357
  # Returns envelope form data for an existing envelope.
3702
- #
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/)
3703
4359
  # @param account_id The external account number (int) or account ID Guid.
3704
4360
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3705
4361
  # @return [EnvelopeFormData]
@@ -3709,7 +4365,7 @@ module DocuSign_eSign
3709
4365
  end
3710
4366
 
3711
4367
  # Returns envelope form data for an existing envelope.
3712
- #
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/)
3713
4369
  # @param account_id The external account number (int) or account ID Guid.
3714
4370
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3715
4371
  # @return [Array<(EnvelopeFormData, Fixnum, Hash)>] EnvelopeFormData data, response status code and response headers
@@ -3858,7 +4514,7 @@ module DocuSign_eSign
3858
4514
  end
3859
4515
 
3860
4516
  # Returns tabs on the specified page.
3861
- #
4517
+ # Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.
3862
4518
  # @param account_id The external account number (int) or account ID Guid.
3863
4519
  # @param document_id The ID of the document being accessed.
3864
4520
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3870,7 +4526,7 @@ module DocuSign_eSign
3870
4526
  end
3871
4527
 
3872
4528
  # Returns tabs on the specified page.
3873
- #
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;.
3874
4530
  # @param account_id The external account number (int) or account ID Guid.
3875
4531
  # @param document_id The ID of the document being accessed.
3876
4532
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3919,7 +4575,7 @@ module DocuSign_eSign
3919
4575
  end
3920
4576
 
3921
4577
  # Returns document page image(s) based on input.
3922
- #
4578
+ # Returns images of the pages in a document for display based on the parameters that you specify.
3923
4579
  # @param account_id The external account number (int) or account ID Guid.
3924
4580
  # @param document_id The ID of the document being accessed.
3925
4581
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3931,7 +4587,7 @@ module DocuSign_eSign
3931
4587
  end
3932
4588
 
3933
4589
  # Returns document page image(s) based on input.
3934
- #
4590
+ # Returns images of the pages in a document for display based on the parameters that you specify.
3935
4591
  # @param account_id The external account number (int) or account ID Guid.
3936
4592
  # @param document_id The ID of the document being accessed.
3937
4593
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -3985,7 +4641,7 @@ module DocuSign_eSign
3985
4641
  end
3986
4642
 
3987
4643
  # Returns document visibility for the recipients
3988
- #
4644
+ # This method returns information about document visibility for a recipient.
3989
4645
  # @param account_id The external account number (int) or account ID Guid.
3990
4646
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3991
4647
  # @param recipient_id The ID of the recipient being accessed.
@@ -3996,7 +4652,7 @@ module DocuSign_eSign
3996
4652
  end
3997
4653
 
3998
4654
  # Returns document visibility for the recipients
3999
- #
4655
+ # This method returns information about document visibility for a recipient.
4000
4656
  # @param account_id The external account number (int) or account ID Guid.
4001
4657
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4002
4658
  # @param recipient_id The ID of the recipient being accessed.
@@ -4270,9 +4926,66 @@ module DocuSign_eSign
4270
4926
  return data, status_code, headers
4271
4927
  end
4272
4928
 
4273
- # Returns document visibility for the recipients
4929
+ # Returns the delayed routing rules for a template's workflow step definition.
4930
+ #
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.
4274
4941
  #
4275
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.
4276
4989
  # @param recipient_id The ID of the recipient being accessed.
4277
4990
  # @param template_id The ID of the template being accessed.
4278
4991
  # @return [DocumentVisibilityList]
@@ -4282,7 +4995,7 @@ module DocuSign_eSign
4282
4995
  end
4283
4996
 
4284
4997
  # Returns document visibility for the recipients
4285
- #
4998
+ # This method returns information about document visibility for a template recipient.
4286
4999
  # @param account_id The external account number (int) or account ID Guid.
4287
5000
  # @param recipient_id The ID of the recipient being accessed.
4288
5001
  # @param template_id The ID of the template being accessed.
@@ -4327,10 +5040,63 @@ module DocuSign_eSign
4327
5040
  return data, status_code, headers
4328
5041
  end
4329
5042
 
4330
- # Returns the workflow definition for a template.
5043
+ # Returns the scheduled sending rules for a template's workflow definition.
5044
+ #
5045
+ # @param account_id The external account number (int) or account ID Guid.
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.
4331
5054
  #
4332
5055
  # @param account_id The external account number (int) or account ID Guid.
4333
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.
4334
5100
  # @return [Workflow]
4335
5101
  def get_template_workflow_definition(account_id, template_id)
4336
5102
  data, _status_code, _headers = get_template_workflow_definition_with_http_info(account_id, template_id)
@@ -4338,7 +5104,7 @@ module DocuSign_eSign
4338
5104
  end
4339
5105
 
4340
5106
  # Returns the workflow definition for a template.
4341
- #
5107
+ # Returns template&#39;s workflow definition if the template specified by &#x60;templateId&#x60; has one.
4342
5108
  # @param account_id The external account number (int) or account ID Guid.
4343
5109
  # @param template_id The ID of the template being accessed.
4344
5110
  # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
@@ -4380,6 +5146,63 @@ module DocuSign_eSign
4380
5146
  return data, status_code, headers
4381
5147
  end
4382
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
+
4383
5206
  # Gets the envelope audit events for an envelope.
4384
5207
  # Gets the envelope audit events for the specified envelope.
4385
5208
  # @param account_id The external account number (int) or account ID Guid.
@@ -4987,7 +5810,7 @@ module DocuSign_eSign
4987
5810
  end
4988
5811
 
4989
5812
  # Add an attachment to a DRAFT or IN-PROCESS envelope.
4990
- #
5813
+ # Adds an attachment to a draft or in-process envelope.
4991
5814
  # @param account_id The external account number (int) or account ID Guid.
4992
5815
  # @param attachment_id
4993
5816
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -4999,7 +5822,7 @@ module DocuSign_eSign
4999
5822
  end
5000
5823
 
5001
5824
  # Add an attachment to a DRAFT or IN-PROCESS envelope.
5002
- #
5825
+ # Adds an attachment to a draft or in-process envelope.
5003
5826
  # @param account_id The external account number (int) or account ID Guid.
5004
5827
  # @param attachment_id
5005
5828
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -5046,7 +5869,7 @@ module DocuSign_eSign
5046
5869
  end
5047
5870
 
5048
5871
  # Add one or more attachments to a DRAFT or IN-PROCESS envelope.
5049
- #
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).
5050
5873
  # @param account_id The external account number (int) or account ID Guid.
5051
5874
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5052
5875
  # @param envelope_attachments_request (optional parameter)
@@ -5057,7 +5880,7 @@ module DocuSign_eSign
5057
5880
  end
5058
5881
 
5059
5882
  # Add one or more attachments to a DRAFT or IN-PROCESS envelope.
5060
- #
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).
5061
5884
  # @param account_id The external account number (int) or account ID Guid.
5062
5885
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5063
5886
  # @param envelope_attachments_request (optional parameter)
@@ -5222,7 +6045,7 @@ module DocuSign_eSign
5222
6045
  end
5223
6046
 
5224
6047
  # Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
5225
- #
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.
5226
6049
  # @param account_id The external account number (int) or account ID Guid.
5227
6050
  # @param chunked_upload_id
5228
6051
  # @param DocuSign_eSign::UpdateChunkedUploadOptions Options for modifying the behavior of the function.
@@ -5233,7 +6056,7 @@ module DocuSign_eSign
5233
6056
  end
5234
6057
 
5235
6058
  # Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
5236
- #
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.
5237
6060
  # @param account_id The external account number (int) or account ID Guid.
5238
6061
  # @param chunked_upload_id
5239
6062
  # @param DocuSign_eSign::UpdateChunkedUploadOptions Options for modifying the behavior of the function.
@@ -5278,7 +6101,7 @@ module DocuSign_eSign
5278
6101
  end
5279
6102
 
5280
6103
  # Add a chunk, a chunk 'part', to an existing ChunkedUpload.
5281
- #
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.
5282
6105
  # @param account_id The external account number (int) or account ID Guid.
5283
6106
  # @param chunked_upload_id
5284
6107
  # @param chunked_upload_part_seq
@@ -5290,7 +6113,7 @@ module DocuSign_eSign
5290
6113
  end
5291
6114
 
5292
6115
  # Add a chunk, a chunk &#39;part&#39;, to an existing ChunkedUpload.
5293
- #
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.
5294
6117
  # @param account_id The external account number (int) or account ID Guid.
5295
6118
  # @param chunked_upload_id
5296
6119
  # @param chunked_upload_part_seq
@@ -5508,7 +6331,7 @@ module DocuSign_eSign
5508
6331
  end
5509
6332
 
5510
6333
  # Updates the tabs for an envelope document
5511
- #
6334
+ # Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`.
5512
6335
  # @param account_id The external account number (int) or account ID Guid.
5513
6336
  # @param document_id The ID of the document being accessed.
5514
6337
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -5520,7 +6343,7 @@ module DocuSign_eSign
5520
6343
  end
5521
6344
 
5522
6345
  # Updates the tabs for an envelope document
5523
- #
6346
+ # Updates tabs in the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.
5524
6347
  # @param account_id The external account number (int) or account ID Guid.
5525
6348
  # @param document_id The ID of the document being accessed.
5526
6349
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -5566,33 +6389,147 @@ module DocuSign_eSign
5566
6389
  return data, status_code, headers
5567
6390
  end
5568
6391
 
5569
- # Adds one or more documents to an existing envelope document.
5570
- # Adds one or more documents to an existing envelope document.
6392
+ # Adds one or more documents to an existing envelope document.
6393
+ # Adds one or more documents to an existing envelope document.
6394
+ # @param account_id The external account number (int) or account ID Guid.
6395
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6396
+ # @param envelope_definition (optional parameter)
6397
+ # @return [EnvelopeDocumentsResult]
6398
+ def update_documents(account_id, envelope_id, envelope_definition)
6399
+ data, _status_code, _headers = update_documents_with_http_info(account_id, envelope_id, envelope_definition)
6400
+ return data
6401
+ end
6402
+
6403
+ # Adds one or more documents to an existing envelope document.
6404
+ # Adds one or more documents to an existing envelope document.
6405
+ # @param account_id The external account number (int) or account ID Guid.
6406
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6407
+ # @param envelope_definition (optional parameter)
6408
+ # @return [Array<(EnvelopeDocumentsResult, Fixnum, Hash)>] EnvelopeDocumentsResult data, response status code and response headers
6409
+ def update_documents_with_http_info(account_id, envelope_id, envelope_definition)
6410
+ if @api_client.config.debugging
6411
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_documents ..."
6412
+ end
6413
+ # verify the required parameter 'account_id' is set
6414
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_documents" if account_id.nil?
6415
+ # verify the required parameter 'envelope_id' is set
6416
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_documents" if envelope_id.nil?
6417
+ # resource path
6418
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
6419
+
6420
+ # query parameters
6421
+ query_params = {}
6422
+
6423
+ # header parameters
6424
+ header_params = {}
6425
+ # HTTP header 'Accept' (if needed)
6426
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6427
+
6428
+ # form parameters
6429
+ form_params = {}
6430
+
6431
+ # http body (model)
6432
+ post_body = @api_client.object_to_http_body(envelope_definition)
6433
+ auth_names = []
6434
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6435
+ :header_params => header_params,
6436
+ :query_params => query_params,
6437
+ :form_params => form_params,
6438
+ :body => post_body,
6439
+ :auth_names => auth_names,
6440
+ :return_type => 'EnvelopeDocumentsResult')
6441
+ if @api_client.config.debugging
6442
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6443
+ end
6444
+ return data, status_code, headers
6445
+ end
6446
+
6447
+ # Updates the email setting overrides for an envelope.
6448
+ # Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
6449
+ # @param account_id The external account number (int) or account ID Guid.
6450
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6451
+ # @param email_settings (optional parameter)
6452
+ # @return [EmailSettings]
6453
+ def update_email_settings(account_id, envelope_id, email_settings)
6454
+ data, _status_code, _headers = update_email_settings_with_http_info(account_id, envelope_id, email_settings)
6455
+ return data
6456
+ end
6457
+
6458
+ # Updates the email setting overrides for an envelope.
6459
+ # Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
6460
+ # @param account_id The external account number (int) or account ID Guid.
6461
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6462
+ # @param email_settings (optional parameter)
6463
+ # @return [Array<(EmailSettings, Fixnum, Hash)>] EmailSettings data, response status code and response headers
6464
+ def update_email_settings_with_http_info(account_id, envelope_id, email_settings)
6465
+ if @api_client.config.debugging
6466
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_email_settings ..."
6467
+ end
6468
+ # verify the required parameter 'account_id' is set
6469
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_email_settings" if account_id.nil?
6470
+ # verify the required parameter 'envelope_id' is set
6471
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_email_settings" if envelope_id.nil?
6472
+ # resource path
6473
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
6474
+
6475
+ # query parameters
6476
+ query_params = {}
6477
+
6478
+ # header parameters
6479
+ header_params = {}
6480
+ # HTTP header 'Accept' (if needed)
6481
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6482
+
6483
+ # form parameters
6484
+ form_params = {}
6485
+
6486
+ # http body (model)
6487
+ post_body = @api_client.object_to_http_body(email_settings)
6488
+ auth_names = []
6489
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6490
+ :header_params => header_params,
6491
+ :query_params => query_params,
6492
+ :form_params => form_params,
6493
+ :body => post_body,
6494
+ :auth_names => auth_names,
6495
+ :return_type => 'EmailSettings')
6496
+ if @api_client.config.debugging
6497
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_email_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6498
+ end
6499
+ return data, status_code, headers
6500
+ end
6501
+
6502
+ # Updates the delayed routing rules for an envelope's workflow step definition.
6503
+ #
5571
6504
  # @param account_id The external account number (int) or account ID Guid.
5572
6505
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5573
- # @param envelope_definition (optional parameter)
5574
- # @return [EnvelopeDocumentsResult]
5575
- def update_documents(account_id, envelope_id, envelope_definition)
5576
- data, _status_code, _headers = update_documents_with_http_info(account_id, envelope_id, envelope_definition)
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)
5577
6511
  return data
5578
6512
  end
5579
6513
 
5580
- # Adds one or more documents to an existing envelope document.
5581
- # Adds one or more documents to an existing envelope document.
6514
+ # Updates the delayed routing rules for an envelope&#39;s workflow step definition.
6515
+ #
5582
6516
  # @param account_id The external account number (int) or account ID Guid.
5583
6517
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5584
- # @param envelope_definition (optional parameter)
5585
- # @return [Array<(EnvelopeDocumentsResult, Fixnum, Hash)>] EnvelopeDocumentsResult data, response status code and response headers
5586
- def update_documents_with_http_info(account_id, envelope_id, envelope_definition)
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)
5587
6522
  if @api_client.config.debugging
5588
- @api_client.config.logger.debug "Calling API: EnvelopesApi.update_documents ..."
6523
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_delayed_routing_definition ..."
5589
6524
  end
5590
6525
  # verify the required parameter 'account_id' is set
5591
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_documents" if account_id.nil?
6526
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_delayed_routing_definition" if account_id.nil?
5592
6527
  # verify the required parameter 'envelope_id' is set
5593
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_documents" if envelope_id.nil?
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?
5594
6531
  # resource path
5595
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
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)
5596
6533
 
5597
6534
  # query parameters
5598
6535
  query_params = {}
@@ -5606,7 +6543,7 @@ module DocuSign_eSign
5606
6543
  form_params = {}
5607
6544
 
5608
6545
  # http body (model)
5609
- post_body = @api_client.object_to_http_body(envelope_definition)
6546
+ post_body = @api_client.object_to_http_body(delayed_routing)
5610
6547
  auth_names = []
5611
6548
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
5612
6549
  :header_params => header_params,
@@ -5614,40 +6551,40 @@ module DocuSign_eSign
5614
6551
  :form_params => form_params,
5615
6552
  :body => post_body,
5616
6553
  :auth_names => auth_names,
5617
- :return_type => 'EnvelopeDocumentsResult')
6554
+ :return_type => 'DelayedRouting')
5618
6555
  if @api_client.config.debugging
5619
- @api_client.config.logger.debug "API called: EnvelopesApi#update_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6556
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5620
6557
  end
5621
6558
  return data, status_code, headers
5622
6559
  end
5623
6560
 
5624
- # Updates the email setting overrides for an envelope.
5625
- # Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
6561
+ # Updates the scheduled sending rules for an envelope's workflow definition.
6562
+ #
5626
6563
  # @param account_id The external account number (int) or account ID Guid.
5627
6564
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5628
- # @param email_settings (optional parameter)
5629
- # @return [EmailSettings]
5630
- def update_email_settings(account_id, envelope_id, email_settings)
5631
- data, _status_code, _headers = update_email_settings_with_http_info(account_id, envelope_id, email_settings)
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)
5632
6569
  return data
5633
6570
  end
5634
6571
 
5635
- # Updates the email setting overrides for an envelope.
5636
- # Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
6572
+ # Updates the scheduled sending rules for an envelope&#39;s workflow definition.
6573
+ #
5637
6574
  # @param account_id The external account number (int) or account ID Guid.
5638
6575
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5639
- # @param email_settings (optional parameter)
5640
- # @return [Array<(EmailSettings, Fixnum, Hash)>] EmailSettings data, response status code and response headers
5641
- def update_email_settings_with_http_info(account_id, envelope_id, email_settings)
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)
5642
6579
  if @api_client.config.debugging
5643
- @api_client.config.logger.debug "Calling API: EnvelopesApi.update_email_settings ..."
6580
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_scheduled_sending_definition ..."
5644
6581
  end
5645
6582
  # verify the required parameter 'account_id' is set
5646
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_email_settings" if account_id.nil?
6583
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_scheduled_sending_definition" if account_id.nil?
5647
6584
  # verify the required parameter 'envelope_id' is set
5648
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_email_settings" if envelope_id.nil?
6585
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_scheduled_sending_definition" if envelope_id.nil?
5649
6586
  # resource path
5650
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
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)
5651
6588
 
5652
6589
  # query parameters
5653
6590
  query_params = {}
@@ -5661,7 +6598,7 @@ module DocuSign_eSign
5661
6598
  form_params = {}
5662
6599
 
5663
6600
  # http body (model)
5664
- post_body = @api_client.object_to_http_body(email_settings)
6601
+ post_body = @api_client.object_to_http_body(scheduled_sending)
5665
6602
  auth_names = []
5666
6603
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
5667
6604
  :header_params => header_params,
@@ -5669,15 +6606,15 @@ module DocuSign_eSign
5669
6606
  :form_params => form_params,
5670
6607
  :body => post_body,
5671
6608
  :auth_names => auth_names,
5672
- :return_type => 'EmailSettings')
6609
+ :return_type => 'ScheduledSending')
5673
6610
  if @api_client.config.debugging
5674
- @api_client.config.logger.debug "API called: EnvelopesApi#update_email_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6611
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5675
6612
  end
5676
6613
  return data, status_code, headers
5677
6614
  end
5678
6615
 
5679
6616
  # Update an envelope transfer rule for an account.
5680
- #
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.
5681
6618
  # @param account_id The external account number (int) or account ID Guid.
5682
6619
  # @param envelope_transfer_rule_id
5683
6620
  # @param envelope_transfer_rule (optional parameter)
@@ -5688,7 +6625,7 @@ module DocuSign_eSign
5688
6625
  end
5689
6626
 
5690
6627
  # Update an envelope transfer rule for an account.
5691
- #
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.
5692
6629
  # @param account_id The external account number (int) or account ID Guid.
5693
6630
  # @param envelope_transfer_rule_id
5694
6631
  # @param envelope_transfer_rule (optional parameter)
@@ -5732,7 +6669,7 @@ module DocuSign_eSign
5732
6669
  end
5733
6670
 
5734
6671
  # Update envelope transfer rules for an account.
5735
- #
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.
5736
6673
  # @param account_id The external account number (int) or account ID Guid.
5737
6674
  # @param envelope_transfer_rule_information (optional parameter)
5738
6675
  # @return [EnvelopeTransferRuleInformation]
@@ -5742,7 +6679,7 @@ module DocuSign_eSign
5742
6679
  end
5743
6680
 
5744
6681
  # Update envelope transfer rules for an account.
5745
- #
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.
5746
6683
  # @param account_id The external account number (int) or account ID Guid.
5747
6684
  # @param envelope_transfer_rule_information (optional parameter)
5748
6685
  # @return [Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>] EnvelopeTransferRuleInformation data, response status code and response headers
@@ -5783,7 +6720,7 @@ module DocuSign_eSign
5783
6720
  end
5784
6721
 
5785
6722
  # Updates the envelope workflow definition for an envelope.
5786
- #
6723
+ # Updates the specified envelope's workflow definition if it has one.
5787
6724
  # @param account_id The external account number (int) or account ID Guid.
5788
6725
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5789
6726
  # @param workflow (optional parameter)
@@ -5794,7 +6731,7 @@ module DocuSign_eSign
5794
6731
  end
5795
6732
 
5796
6733
  # Updates the envelope workflow definition for an envelope.
5797
- #
6734
+ # Updates the specified envelope&#39;s workflow definition if it has one.
5798
6735
  # @param account_id The external account number (int) or account ID Guid.
5799
6736
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5800
6737
  # @param workflow (optional parameter)
@@ -5837,6 +6774,65 @@ module DocuSign_eSign
5837
6774
  return data, status_code, headers
5838
6775
  end
5839
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
+
5840
6836
  # Updates an envelope lock.
5841
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.
5842
6838
  # @param account_id The external account number (int) or account ID Guid.
@@ -5893,7 +6889,7 @@ module DocuSign_eSign
5893
6889
  end
5894
6890
 
5895
6891
  # Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
5896
- #
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.
5897
6893
  # @param account_id The external account number (int) or account ID Guid.
5898
6894
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5899
6895
  # @param envelope_notification_request (optional parameter)
@@ -5904,7 +6900,7 @@ module DocuSign_eSign
5904
6900
  end
5905
6901
 
5906
6902
  # Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
5907
- #
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.
5908
6904
  # @param account_id The external account number (int) or account ID Guid.
5909
6905
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5910
6906
  # @param envelope_notification_request (optional parameter)
@@ -5948,7 +6944,7 @@ module DocuSign_eSign
5948
6944
  end
5949
6945
 
5950
6946
  # Updates document visibility for the recipients
5951
- #
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.
5952
6948
  # @param account_id The external account number (int) or account ID Guid.
5953
6949
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5954
6950
  # @param recipient_id The ID of the recipient being accessed.
@@ -5960,7 +6956,7 @@ module DocuSign_eSign
5960
6956
  end
5961
6957
 
5962
6958
  # Updates document visibility for the recipients
5963
- #
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.
5964
6960
  # @param account_id The external account number (int) or account ID Guid.
5965
6961
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
5966
6962
  # @param recipient_id The ID of the recipient being accessed.
@@ -6183,7 +7179,7 @@ module DocuSign_eSign
6183
7179
  end
6184
7180
 
6185
7181
  # Updates document visibility for the recipients
6186
- #
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.
6187
7183
  # @param account_id The external account number (int) or account ID Guid.
6188
7184
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6189
7185
  # @param document_visibility_list (optional parameter)
@@ -6194,7 +7190,7 @@ module DocuSign_eSign
6194
7190
  end
6195
7191
 
6196
7192
  # Updates document visibility for the recipients
6197
- #
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.
6198
7194
  # @param account_id The external account number (int) or account ID Guid.
6199
7195
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
6200
7196
  # @param document_visibility_list (optional parameter)
@@ -6237,6 +7233,65 @@ module DocuSign_eSign
6237
7233
  return data, status_code, headers
6238
7234
  end
6239
7235
 
7236
+ # Retrieves a PDF document from the envelope with no CoC.
7237
+ #
7238
+ # @param account_id The external account number (int) or account ID Guid.
7239
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
7240
+ # @param regen_document_id
7241
+ # @param document (optional parameter)
7242
+ # @return [File]
7243
+ def update_regen_document(account_id, envelope_id, regen_document_id, document)
7244
+ data, _status_code, _headers = update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document)
7245
+ return data
7246
+ end
7247
+
7248
+ # Retrieves a PDF document from the envelope with no CoC.
7249
+ #
7250
+ # @param account_id The external account number (int) or account ID Guid.
7251
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
7252
+ # @param regen_document_id
7253
+ # @param document (optional parameter)
7254
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
7255
+ def update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document)
7256
+ if @api_client.config.debugging
7257
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_regen_document ..."
7258
+ end
7259
+ # verify the required parameter 'account_id' is set
7260
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_regen_document" if account_id.nil?
7261
+ # verify the required parameter 'envelope_id' is set
7262
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_regen_document" if envelope_id.nil?
7263
+ # verify the required parameter 'regen_document_id' is set
7264
+ fail ArgumentError, "Missing the required parameter 'regen_document_id' when calling EnvelopesApi.update_regen_document" if regen_document_id.nil?
7265
+ # resource path
7266
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{regenDocumentId}/regen".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'regenDocumentId' + '}', regen_document_id.to_s)
7267
+
7268
+ # query parameters
7269
+ query_params = {}
7270
+
7271
+ # header parameters
7272
+ header_params = {}
7273
+ # HTTP header 'Accept' (if needed)
7274
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
7275
+
7276
+ # form parameters
7277
+ form_params = {}
7278
+
7279
+ # http body (model)
7280
+ post_body = @api_client.object_to_http_body(document)
7281
+ auth_names = []
7282
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
7283
+ :header_params => header_params,
7284
+ :query_params => query_params,
7285
+ :form_params => form_params,
7286
+ :body => post_body,
7287
+ :auth_names => auth_names,
7288
+ :return_type => 'File')
7289
+ if @api_client.config.debugging
7290
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_regen_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7291
+ end
7292
+ return data, status_code, headers
7293
+ end
7294
+
6240
7295
  # Updates the tabs for a recipient.
6241
7296
  # Updates one or more tabs for a recipient in a draft envelope.
6242
7297
  # @param account_id The external account number (int) or account ID Guid.
@@ -6348,9 +7403,68 @@ module DocuSign_eSign
6348
7403
  return data, status_code, headers
6349
7404
  end
6350
7405
 
6351
- # 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.
6352
7419
  #
6353
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.
6354
7468
  # @param recipient_id The ID of the recipient being accessed.
6355
7469
  # @param template_id The ID of the template being accessed.
6356
7470
  # @param template_document_visibility_list (optional parameter)
@@ -6361,7 +7475,7 @@ module DocuSign_eSign
6361
7475
  end
6362
7476
 
6363
7477
  # Updates document visibility for the recipients
6364
- #
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.
6365
7479
  # @param account_id The external account number (int) or account ID Guid.
6366
7480
  # @param recipient_id The ID of the recipient being accessed.
6367
7481
  # @param template_id The ID of the template being accessed.
@@ -6408,7 +7522,7 @@ module DocuSign_eSign
6408
7522
  end
6409
7523
 
6410
7524
  # Updates document visibility for the recipients
6411
- #
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.
6412
7526
  # @param account_id The external account number (int) or account ID Guid.
6413
7527
  # @param template_id The ID of the template being accessed.
6414
7528
  # @param template_document_visibility_list (optional parameter)
@@ -6419,7 +7533,7 @@ module DocuSign_eSign
6419
7533
  end
6420
7534
 
6421
7535
  # Updates document visibility for the recipients
6422
- #
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.
6423
7537
  # @param account_id The external account number (int) or account ID Guid.
6424
7538
  # @param template_id The ID of the template being accessed.
6425
7539
  # @param template_document_visibility_list (optional parameter)
@@ -6462,10 +7576,65 @@ module DocuSign_eSign
6462
7576
  return data, status_code, headers
6463
7577
  end
6464
7578
 
6465
- # 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.
6466
7591
  #
6467
7592
  # @param account_id The external account number (int) or account ID Guid.
6468
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.
6469
7638
  # @param workflow (optional parameter)
6470
7639
  # @return [Workflow]
6471
7640
  def update_template_workflow_definition(account_id, template_id, workflow)
@@ -6474,7 +7643,7 @@ module DocuSign_eSign
6474
7643
  end
6475
7644
 
6476
7645
  # Updates the workflow definition for a template.
6477
- #
7646
+ # Updates the specified template&#39;s workflow definition if it has one.
6478
7647
  # @param account_id The external account number (int) or account ID Guid.
6479
7648
  # @param template_id The ID of the template being accessed.
6480
7649
  # @param workflow (optional parameter)
@@ -6516,5 +7685,64 @@ module DocuSign_eSign
6516
7685
  end
6517
7686
  return data, status_code, headers
6518
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
6519
7747
  end
6520
7748
  end