docusign_esign 2.11.0 → 3.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (471) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +0 -55
  3. data/Gemfile +1 -1
  4. data/Gemfile.lock +31 -31
  5. data/README.md +40 -22
  6. data/docusign_esign-3.0.0.gem +0 -0
  7. data/docusign_esign.gemspec +1 -2
  8. data/lib/docusign_esign/api/accounts_api.rb +427 -89
  9. data/lib/docusign_esign/api/authentication_api.rb +1 -1
  10. data/lib/docusign_esign/api/billing_api.rb +14 -14
  11. data/lib/docusign_esign/api/bulk_envelopes_api.rb +195 -155
  12. data/lib/docusign_esign/api/cloud_storage_api.rb +13 -9
  13. data/lib/docusign_esign/api/connect_api.rb +16 -167
  14. data/lib/docusign_esign/api/custom_tabs_api.rb +7 -7
  15. data/lib/docusign_esign/api/data_feed_api.rb +76 -0
  16. data/lib/docusign_esign/api/diagnostics_api.rb +8 -8
  17. data/lib/docusign_esign/api/email_archive_api.rb +261 -0
  18. data/lib/docusign_esign/api/envelopes_api.rb +1692 -375
  19. data/lib/docusign_esign/api/folders_api.rb +20 -11
  20. data/lib/docusign_esign/api/groups_api.rb +25 -21
  21. data/lib/docusign_esign/api/notary_api.rb +3 -3
  22. data/lib/docusign_esign/api/power_forms_api.rb +10 -10
  23. data/lib/docusign_esign/api/signing_groups_api.rb +11 -11
  24. data/lib/docusign_esign/api/templates_api.rb +323 -79
  25. data/lib/docusign_esign/api/trust_service_providers_api.rb +3 -3
  26. data/lib/docusign_esign/api/users_api.rb +66 -38
  27. data/lib/docusign_esign/api/workspaces_api.rb +13 -13
  28. data/lib/docusign_esign/client/api_client.rb +2 -3
  29. data/lib/docusign_esign/configuration.rb +3 -4
  30. data/lib/docusign_esign/models/access_code_format.rb +273 -0
  31. data/lib/docusign_esign/models/account_address.rb +11 -8
  32. data/lib/docusign_esign/models/account_billing_plan.rb +12 -59
  33. data/lib/docusign_esign/models/account_billing_plan_response.rb +31 -9
  34. data/lib/docusign_esign/models/account_identity_verification_response.rb +12 -8
  35. data/lib/docusign_esign/models/account_identity_verification_step.rb +12 -8
  36. data/lib/docusign_esign/models/account_identity_verification_workflow.rb +45 -12
  37. data/lib/docusign_esign/models/account_information.rb +45 -19
  38. data/lib/docusign_esign/models/account_minimum_password_length.rb +12 -8
  39. data/lib/docusign_esign/models/account_notification.rb +206 -0
  40. data/lib/docusign_esign/models/account_password_expire_password_days.rb +12 -8
  41. data/lib/docusign_esign/models/account_password_lockout_duration_minutes.rb +12 -8
  42. data/lib/docusign_esign/models/account_password_lockout_duration_type.rb +12 -8
  43. data/lib/docusign_esign/models/account_password_minimum_password_age_days.rb +12 -8
  44. data/lib/docusign_esign/models/account_password_questions_required.rb +12 -8
  45. data/lib/docusign_esign/models/account_password_rules.rb +12 -8
  46. data/lib/docusign_esign/models/account_password_strength_type.rb +12 -8
  47. data/lib/docusign_esign/models/account_password_strength_type_option.rb +12 -8
  48. data/lib/docusign_esign/models/account_role_settings.rb +41 -9
  49. data/lib/docusign_esign/models/account_seals.rb +12 -8
  50. data/lib/docusign_esign/models/account_settings_information.rb +4700 -27
  51. data/lib/docusign_esign/models/account_shared_access.rb +11 -8
  52. data/lib/docusign_esign/models/account_signature_provider.rb +12 -8
  53. data/lib/docusign_esign/models/account_signature_provider_option.rb +12 -8
  54. data/lib/docusign_esign/models/account_signature_providers.rb +12 -8
  55. data/lib/docusign_esign/models/account_ui_settings.rb +330 -0
  56. data/lib/docusign_esign/models/add_on.rb +11 -8
  57. data/lib/docusign_esign/models/address_information.rb +44 -51
  58. data/lib/docusign_esign/models/address_information_input.rb +11 -8
  59. data/lib/docusign_esign/models/address_information_v2.rb +11 -7
  60. data/lib/docusign_esign/models/agent.rb +207 -34
  61. data/lib/docusign_esign/models/api_request_log.rb +11 -8
  62. data/lib/docusign_esign/models/api_request_logs_result.rb +11 -8
  63. data/lib/docusign_esign/models/app_store_product.rb +11 -8
  64. data/lib/docusign_esign/models/app_store_receipt.rb +11 -8
  65. data/lib/docusign_esign/models/approve.rb +448 -14
  66. data/lib/docusign_esign/models/attachment.rb +11 -8
  67. data/lib/docusign_esign/models/authentication_method.rb +12 -9
  68. data/lib/docusign_esign/models/authentication_status.rb +11 -8
  69. data/lib/docusign_esign/models/bcc_email_address.rb +11 -8
  70. data/lib/docusign_esign/models/bcc_email_archive.rb +276 -0
  71. data/lib/docusign_esign/models/bcc_email_archive_history.rb +237 -0
  72. data/lib/docusign_esign/models/bcc_email_archive_history_list.rb +250 -0
  73. data/lib/docusign_esign/models/bcc_email_archive_list.rb +250 -0
  74. data/lib/docusign_esign/models/billing_charge.rb +11 -8
  75. data/lib/docusign_esign/models/billing_charge_response.rb +11 -8
  76. data/lib/docusign_esign/models/billing_discount.rb +12 -8
  77. data/lib/docusign_esign/models/billing_invoice.rb +11 -8
  78. data/lib/docusign_esign/models/billing_invoice_item.rb +11 -8
  79. data/lib/docusign_esign/models/billing_invoices_response.rb +11 -8
  80. data/lib/docusign_esign/models/billing_invoices_summary.rb +12 -8
  81. data/lib/docusign_esign/models/billing_payment.rb +11 -8
  82. data/lib/docusign_esign/models/billing_payment_item.rb +11 -8
  83. data/lib/docusign_esign/models/billing_payment_request.rb +12 -8
  84. data/lib/docusign_esign/models/billing_payment_response.rb +11 -8
  85. data/lib/docusign_esign/models/billing_payments_response.rb +11 -8
  86. data/lib/docusign_esign/models/billing_plan.rb +11 -8
  87. data/lib/docusign_esign/models/billing_plan_information.rb +32 -9
  88. data/lib/docusign_esign/models/billing_plan_preview.rb +11 -8
  89. data/lib/docusign_esign/models/billing_plan_response.rb +11 -8
  90. data/lib/docusign_esign/models/billing_plan_update_response.rb +11 -8
  91. data/lib/docusign_esign/models/billing_plans_response.rb +11 -8
  92. data/lib/docusign_esign/models/billing_price.rb +12 -8
  93. data/lib/docusign_esign/models/brand.rb +38 -12
  94. data/lib/docusign_esign/models/brand_email_content.rb +12 -8
  95. data/lib/docusign_esign/models/brand_link.rb +12 -8
  96. data/lib/docusign_esign/models/brand_logos.rb +12 -8
  97. data/lib/docusign_esign/models/brand_request.rb +12 -8
  98. data/lib/docusign_esign/models/brand_resource_urls.rb +12 -8
  99. data/lib/docusign_esign/models/brand_resources.rb +25 -9
  100. data/lib/docusign_esign/models/brand_resources_list.rb +12 -8
  101. data/lib/docusign_esign/models/brands_request.rb +12 -8
  102. data/lib/docusign_esign/models/brands_response.rb +12 -8
  103. data/lib/docusign_esign/models/bulk_envelope.rb +12 -8
  104. data/lib/docusign_esign/models/bulk_envelope_status.rb +12 -8
  105. data/lib/docusign_esign/models/bulk_envelopes_response.rb +12 -8
  106. data/lib/docusign_esign/models/bulk_recipient.rb +12 -8
  107. data/lib/docusign_esign/models/bulk_recipient_signature_provider.rb +12 -8
  108. data/lib/docusign_esign/models/bulk_recipient_tab_label.rb +12 -8
  109. data/lib/docusign_esign/models/bulk_recipients_request.rb +12 -8
  110. data/lib/docusign_esign/models/bulk_recipients_response.rb +12 -8
  111. data/lib/docusign_esign/models/bulk_recipients_summary_response.rb +12 -8
  112. data/lib/docusign_esign/models/bulk_recipients_update_response.rb +12 -8
  113. data/lib/docusign_esign/models/{envelope_form_data_prefill_form_data.rb → bulk_send_request.rb} +20 -18
  114. data/lib/docusign_esign/models/{group_brands.rb → bulk_send_response.rb} +48 -33
  115. data/lib/docusign_esign/models/bulk_send_test_response.rb +212 -0
  116. data/lib/docusign_esign/models/bulk_sending_copy.rb +222 -0
  117. data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +198 -0
  118. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +382 -0
  119. data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +198 -0
  120. data/lib/docusign_esign/models/bulk_sending_list.rb +210 -0
  121. data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +190 -0
  122. data/lib/docusign_esign/models/bulk_sending_list_summary.rb +218 -0
  123. data/lib/docusign_esign/models/captive_recipient.rb +12 -8
  124. data/lib/docusign_esign/models/captive_recipient_information.rb +12 -8
  125. data/lib/docusign_esign/models/carbon_copy.rb +217 -43
  126. data/lib/docusign_esign/models/certified_delivery.rb +208 -43
  127. data/lib/docusign_esign/models/checkbox.rb +562 -12
  128. data/lib/docusign_esign/models/chunked_upload_part.rb +12 -8
  129. data/lib/docusign_esign/models/chunked_upload_request.rb +12 -8
  130. data/lib/docusign_esign/models/chunked_upload_response.rb +12 -8
  131. data/lib/docusign_esign/models/cloud_storage_provider.rb +12 -8
  132. data/lib/docusign_esign/models/cloud_storage_providers.rb +12 -8
  133. data/lib/docusign_esign/models/comment.rb +392 -0
  134. data/lib/docusign_esign/models/{prefill_form_data.rb → comment_history_result.rb} +39 -35
  135. data/lib/docusign_esign/models/comment_publish.rb +244 -0
  136. data/lib/docusign_esign/models/comment_thread.rb +961 -0
  137. data/lib/docusign_esign/models/comments_publish.rb +190 -0
  138. data/lib/docusign_esign/models/company.rb +521 -14
  139. data/lib/docusign_esign/models/complete_sign_hash_response.rb +12 -8
  140. data/lib/docusign_esign/models/complete_sign_request.rb +11 -7
  141. data/lib/docusign_esign/models/composite_template.rb +12 -8
  142. data/lib/docusign_esign/models/connect_config_results.rb +12 -8
  143. data/lib/docusign_esign/models/connect_custom_configuration.rb +159 -15
  144. data/lib/docusign_esign/models/connect_debug_log.rb +12 -8
  145. data/lib/docusign_esign/models/connect_failure_filter.rb +12 -8
  146. data/lib/docusign_esign/models/connect_failure_result.rb +12 -8
  147. data/lib/docusign_esign/models/connect_failure_results.rb +12 -8
  148. data/lib/docusign_esign/models/connect_log.rb +12 -8
  149. data/lib/docusign_esign/models/connect_logs.rb +12 -8
  150. data/lib/docusign_esign/models/connect_salesforce_field.rb +258 -0
  151. data/lib/docusign_esign/models/connect_salesforce_object.rb +272 -0
  152. data/lib/docusign_esign/models/connect_user_object.rb +230 -0
  153. data/lib/docusign_esign/models/console_view_request.rb +12 -8
  154. data/lib/docusign_esign/models/consumer_disclosure.rb +12 -8
  155. data/lib/docusign_esign/models/contact.rb +43 -9
  156. data/lib/docusign_esign/models/contact_get_response.rb +12 -8
  157. data/lib/docusign_esign/models/contact_mod_request.rb +20 -16
  158. data/lib/docusign_esign/models/contact_phone_number.rb +12 -8
  159. data/lib/docusign_esign/models/contact_update_response.rb +12 -8
  160. data/lib/docusign_esign/models/correct_view_request.rb +14 -20
  161. data/lib/docusign_esign/models/country.rb +12 -8
  162. data/lib/docusign_esign/models/credential.rb +11 -7
  163. data/lib/docusign_esign/models/credit_card_information.rb +23 -9
  164. data/lib/docusign_esign/models/credit_card_types.rb +12 -8
  165. data/lib/docusign_esign/models/currency_feature_set_price.rb +12 -8
  166. data/lib/docusign_esign/models/currency_plan_price.rb +12 -8
  167. data/lib/docusign_esign/models/custom_field.rb +12 -8
  168. data/lib/docusign_esign/models/custom_field_v2.rb +11 -7
  169. data/lib/docusign_esign/models/custom_fields.rb +11 -8
  170. data/lib/docusign_esign/models/custom_fields_envelope.rb +12 -8
  171. data/lib/docusign_esign/models/custom_settings_information.rb +12 -8
  172. data/lib/docusign_esign/models/date.rb +575 -14
  173. data/lib/docusign_esign/models/date_signed.rb +475 -12
  174. data/lib/docusign_esign/models/date_stamp_properties.rb +12 -8
  175. data/lib/docusign_esign/models/decline.rb +457 -14
  176. data/lib/docusign_esign/models/diagnostics_settings_information.rb +12 -8
  177. data/lib/docusign_esign/models/direct_debit_processor_information.rb +298 -0
  178. data/lib/docusign_esign/models/display_appliance_document.rb +258 -0
  179. data/lib/docusign_esign/models/display_appliance_document_page.rb +278 -0
  180. data/lib/docusign_esign/models/display_appliance_envelope.rb +328 -0
  181. data/lib/docusign_esign/models/display_appliance_info.rb +235 -0
  182. data/lib/docusign_esign/models/display_appliance_page.rb +278 -0
  183. data/lib/docusign_esign/models/display_appliance_pdf.rb +267 -0
  184. data/lib/docusign_esign/models/display_appliance_recipient.rb +388 -0
  185. data/lib/docusign_esign/models/{offline_attributes.rb → display_appliance_signer_attachment.rb} +65 -52
  186. data/lib/docusign_esign/models/dob_information_input.rb +11 -8
  187. data/lib/docusign_esign/models/document.rb +64 -19
  188. data/lib/docusign_esign/models/document_fields_information.rb +12 -8
  189. data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +12 -8
  190. data/lib/docusign_esign/models/document_html_definition.rb +12 -8
  191. data/lib/docusign_esign/models/document_html_definition_original.rb +12 -8
  192. data/lib/docusign_esign/models/document_html_definition_originals.rb +12 -8
  193. data/lib/docusign_esign/models/document_html_definitions.rb +12 -8
  194. data/lib/docusign_esign/models/document_html_display_anchor.rb +12 -8
  195. data/lib/docusign_esign/models/document_html_display_settings.rb +13 -19
  196. data/lib/docusign_esign/models/document_security_store.rb +11 -7
  197. data/lib/docusign_esign/models/document_template.rb +12 -8
  198. data/lib/docusign_esign/models/document_template_list.rb +12 -8
  199. data/lib/docusign_esign/models/document_update_info.rb +11 -7
  200. data/lib/docusign_esign/models/document_visibility.rb +12 -8
  201. data/lib/docusign_esign/models/document_visibility_list.rb +12 -8
  202. data/lib/docusign_esign/models/e_note_configuration.rb +12 -8
  203. data/lib/docusign_esign/models/editor.rb +208 -34
  204. data/lib/docusign_esign/models/email.rb +575 -14
  205. data/lib/docusign_esign/models/email_address.rb +475 -12
  206. data/lib/docusign_esign/models/email_settings.rb +11 -8
  207. data/lib/docusign_esign/models/envelope.rb +246 -19
  208. data/lib/docusign_esign/models/envelope_attachment.rb +12 -8
  209. data/lib/docusign_esign/models/envelope_attachments_request.rb +12 -8
  210. data/lib/docusign_esign/models/envelope_attachments_result.rb +12 -8
  211. data/lib/docusign_esign/models/envelope_audit_event.rb +12 -8
  212. data/lib/docusign_esign/models/envelope_audit_event_response.rb +12 -8
  213. data/lib/docusign_esign/models/envelope_definition.rb +258 -19
  214. data/lib/docusign_esign/models/envelope_document.rb +111 -18
  215. data/lib/docusign_esign/models/envelope_documents_result.rb +12 -8
  216. data/lib/docusign_esign/models/envelope_event.rb +12 -8
  217. data/lib/docusign_esign/models/envelope_form_data.rb +14 -19
  218. data/lib/docusign_esign/models/envelope_id.rb +466 -12
  219. data/lib/docusign_esign/models/envelope_ids_request.rb +12 -8
  220. data/lib/docusign_esign/models/envelope_metadata.rb +208 -0
  221. data/lib/docusign_esign/models/envelope_notification_request.rb +12 -8
  222. data/lib/docusign_esign/models/envelope_purge_configuration.rb +218 -0
  223. data/lib/docusign_esign/models/envelope_summary.rb +31 -9
  224. data/lib/docusign_esign/models/envelope_template.rb +461 -21
  225. data/lib/docusign_esign/models/envelope_template_definition.rb +10 -7
  226. data/lib/docusign_esign/models/envelope_template_result.rb +12 -28
  227. data/lib/docusign_esign/models/envelope_template_results.rb +13 -9
  228. data/lib/docusign_esign/models/envelope_transaction_status.rb +12 -8
  229. data/lib/docusign_esign/models/envelope_transfer_rule.rb +273 -0
  230. data/lib/docusign_esign/models/envelope_transfer_rule_information.rb +250 -0
  231. data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +279 -0
  232. data/lib/docusign_esign/models/envelope_update_summary.rb +23 -9
  233. data/lib/docusign_esign/models/envelopes_information.rb +25 -9
  234. data/lib/docusign_esign/models/error_details.rb +11 -8
  235. data/lib/docusign_esign/models/event_notification.rb +11 -8
  236. data/lib/docusign_esign/models/event_result.rb +12 -8
  237. data/lib/docusign_esign/models/expirations.rb +11 -8
  238. data/lib/docusign_esign/models/external_claim.rb +218 -0
  239. data/lib/docusign_esign/models/external_doc_service_error_details.rb +12 -8
  240. data/lib/docusign_esign/models/external_document_sources.rb +273 -0
  241. data/lib/docusign_esign/models/external_file.rb +12 -8
  242. data/lib/docusign_esign/models/external_folder.rb +12 -8
  243. data/lib/docusign_esign/models/favorite_templates_content_item.rb +207 -0
  244. data/lib/docusign_esign/models/favorite_templates_info.rb +209 -0
  245. data/lib/docusign_esign/models/feature_available_metadata.rb +198 -0
  246. data/lib/docusign_esign/models/feature_set.rb +12 -8
  247. data/lib/docusign_esign/models/file_type.rb +12 -8
  248. data/lib/docusign_esign/models/file_type_list.rb +12 -8
  249. data/lib/docusign_esign/models/filter.rb +12 -8
  250. data/lib/docusign_esign/models/first_name.rb +475 -12
  251. data/lib/docusign_esign/models/folder.rb +65 -30
  252. data/lib/docusign_esign/models/folder_item.rb +11 -7
  253. data/lib/docusign_esign/models/folder_item_response.rb +12 -8
  254. data/lib/docusign_esign/models/folder_item_v2.rb +36 -32
  255. data/lib/docusign_esign/models/folder_items_response.rb +33 -17
  256. data/lib/docusign_esign/models/folder_shared_item.rb +289 -0
  257. data/lib/docusign_esign/models/folders_request.rb +25 -9
  258. data/lib/docusign_esign/models/folders_response.rb +88 -12
  259. data/lib/docusign_esign/models/forgotten_password_information.rb +11 -8
  260. data/lib/docusign_esign/models/form_data_item.rb +227 -0
  261. data/lib/docusign_esign/models/formula_tab.rb +611 -14
  262. data/lib/docusign_esign/models/full_name.rb +475 -12
  263. data/lib/docusign_esign/models/graphics_context.rb +208 -0
  264. data/lib/docusign_esign/models/group.rb +26 -12
  265. data/lib/docusign_esign/models/group_information.rb +12 -8
  266. data/lib/docusign_esign/models/id_check_configuration.rb +210 -0
  267. data/lib/docusign_esign/models/id_check_information_input.rb +11 -8
  268. data/lib/docusign_esign/models/{payment_signer_values.rb → id_check_security_step.rb} +20 -16
  269. data/lib/docusign_esign/models/in_person_signer.rb +283 -24
  270. data/lib/docusign_esign/models/initial_here.rb +422 -13
  271. data/lib/docusign_esign/models/inline_template.rb +12 -8
  272. data/lib/docusign_esign/models/integrated_user_info_list.rb +12 -8
  273. data/lib/docusign_esign/models/intermediary.rb +208 -34
  274. data/lib/docusign_esign/models/jurisdiction.rb +12 -8
  275. data/lib/docusign_esign/models/last_name.rb +475 -12
  276. data/lib/docusign_esign/models/list.rb +530 -13
  277. data/lib/docusign_esign/models/list_custom_field.rb +12 -8
  278. data/lib/docusign_esign/models/list_item.rb +43 -12
  279. data/lib/docusign_esign/models/locale_policy.rb +595 -0
  280. data/lib/docusign_esign/models/locale_policy_tab.rb +298 -0
  281. data/lib/docusign_esign/models/lock_information.rb +12 -8
  282. data/lib/docusign_esign/models/lock_request.rb +12 -8
  283. data/lib/docusign_esign/models/login_account.rb +12 -8
  284. data/lib/docusign_esign/models/login_information.rb +12 -8
  285. data/lib/docusign_esign/models/match_box.rb +17 -13
  286. data/lib/docusign_esign/models/member_group_shared_item.rb +12 -8
  287. data/lib/docusign_esign/models/member_shared_items.rb +25 -9
  288. data/lib/docusign_esign/models/merge_field.rb +81 -12
  289. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +12 -8
  290. data/lib/docusign_esign/models/mobile_notifier_configuration_information.rb +12 -8
  291. data/lib/docusign_esign/models/money.rb +12 -8
  292. data/lib/docusign_esign/models/name_value.rb +12 -8
  293. data/lib/docusign_esign/models/new_account_definition.rb +37 -17
  294. data/lib/docusign_esign/models/new_account_summary.rb +12 -8
  295. data/lib/docusign_esign/models/new_user.rb +13 -19
  296. data/lib/docusign_esign/models/new_users_definition.rb +12 -8
  297. data/lib/docusign_esign/models/new_users_summary.rb +12 -8
  298. data/lib/docusign_esign/models/notarize.rb +403 -12
  299. data/lib/docusign_esign/models/notary_host.rb +213 -24
  300. data/lib/docusign_esign/models/notary_journal.rb +12 -8
  301. data/lib/docusign_esign/models/notary_journal_credible_witness.rb +12 -8
  302. data/lib/docusign_esign/models/notary_journal_list.rb +12 -8
  303. data/lib/docusign_esign/models/notary_journal_meta_data.rb +12 -8
  304. data/lib/docusign_esign/models/note.rb +466 -14
  305. data/lib/docusign_esign/models/notification.rb +11 -8
  306. data/lib/docusign_esign/models/notification_default_settings.rb +196 -0
  307. data/lib/docusign_esign/models/notification_defaults.rb +196 -0
  308. data/lib/docusign_esign/models/number.rb +593 -14
  309. data/lib/docusign_esign/models/oauth_access.rb +12 -8
  310. data/lib/docusign_esign/models/page.rb +11 -8
  311. data/lib/docusign_esign/models/page_images.rb +12 -8
  312. data/lib/docusign_esign/models/page_request.rb +12 -8
  313. data/lib/docusign_esign/models/page_size.rb +198 -0
  314. data/lib/docusign_esign/models/{recipient_identity_input_option.rb → path_extended_element.rb} +26 -24
  315. data/lib/docusign_esign/models/pay_pal_legacy_settings.rb +228 -0
  316. data/lib/docusign_esign/models/payment_details.rb +31 -18
  317. data/lib/docusign_esign/models/payment_gateway_account.rb +110 -12
  318. data/lib/docusign_esign/models/payment_gateway_account_setting.rb +218 -0
  319. data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +12 -8
  320. data/lib/docusign_esign/models/payment_line_item.rb +12 -8
  321. data/lib/docusign_esign/models/payment_method_with_options.rb +200 -0
  322. data/lib/docusign_esign/models/payment_processor_information.rb +12 -8
  323. data/lib/docusign_esign/models/permission_profile.rb +12 -8
  324. data/lib/docusign_esign/models/permission_profile_information.rb +12 -8
  325. data/lib/docusign_esign/models/plan_information.rb +11 -8
  326. data/lib/docusign_esign/models/{recipient_identity_phone_number.rb → poly_line.rb} +42 -28
  327. data/lib/docusign_esign/models/poly_line_overlay.rb +885 -0
  328. data/lib/docusign_esign/models/power_form.rb +12 -8
  329. data/lib/docusign_esign/models/power_form_form_data_envelope.rb +12 -8
  330. data/lib/docusign_esign/models/power_form_form_data_recipient.rb +12 -8
  331. data/lib/docusign_esign/models/power_form_recipient.rb +12 -8
  332. data/lib/docusign_esign/models/power_form_senders_response.rb +16 -12
  333. data/lib/docusign_esign/models/power_forms_form_data_response.rb +12 -8
  334. data/lib/docusign_esign/models/power_forms_request.rb +12 -8
  335. data/lib/docusign_esign/models/power_forms_response.rb +16 -12
  336. data/lib/docusign_esign/models/property_metadata.rb +12 -8
  337. data/lib/docusign_esign/models/province.rb +12 -8
  338. data/lib/docusign_esign/models/provisioning_information.rb +12 -8
  339. data/lib/docusign_esign/models/purchased_envelopes_information.rb +12 -8
  340. data/lib/docusign_esign/models/radio.rb +321 -12
  341. data/lib/docusign_esign/models/radio_group.rb +153 -12
  342. data/lib/docusign_esign/models/recipient_attachment.rb +12 -8
  343. data/lib/docusign_esign/models/recipient_domain.rb +12 -8
  344. data/lib/docusign_esign/models/recipient_email_notification.rb +44 -13
  345. data/lib/docusign_esign/models/recipient_event.rb +12 -8
  346. data/lib/docusign_esign/models/recipient_form_data.rb +25 -21
  347. data/lib/docusign_esign/models/recipient_identity_verification.rb +13 -21
  348. data/lib/docusign_esign/models/recipient_names_response.rb +12 -8
  349. data/lib/docusign_esign/models/recipient_phone_authentication.rb +51 -12
  350. data/lib/docusign_esign/models/recipient_preview_request.rb +278 -0
  351. data/lib/docusign_esign/models/recipient_saml_authentication.rb +10 -7
  352. data/lib/docusign_esign/models/recipient_signature_information.rb +11 -8
  353. data/lib/docusign_esign/models/recipient_signature_provider.rb +22 -9
  354. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +52 -12
  355. data/lib/docusign_esign/models/recipient_sms_authentication.rb +24 -12
  356. data/lib/docusign_esign/models/recipient_update_response.rb +33 -9
  357. data/lib/docusign_esign/models/recipient_view_request.rb +13 -33
  358. data/lib/docusign_esign/models/recipients.rb +11 -8
  359. data/lib/docusign_esign/models/recipients_update_summary.rb +12 -8
  360. data/lib/docusign_esign/models/referral_information.rb +11 -8
  361. data/lib/docusign_esign/models/reminders.rb +11 -8
  362. data/lib/docusign_esign/models/resource_information.rb +12 -8
  363. data/lib/docusign_esign/models/return_url_request.rb +12 -8
  364. data/lib/docusign_esign/models/revision.rb +11 -7
  365. data/lib/docusign_esign/models/saml_assertion_attribute.rb +11 -7
  366. data/lib/docusign_esign/models/seal.rb +13 -9
  367. data/lib/docusign_esign/models/seal_identifier.rb +12 -8
  368. data/lib/docusign_esign/models/seal_sign.rb +154 -24
  369. data/lib/docusign_esign/models/seat_discount.rb +12 -8
  370. data/lib/docusign_esign/models/sender.rb +11 -7
  371. data/lib/docusign_esign/models/sender_email_notifications.rb +19 -15
  372. data/lib/docusign_esign/models/server_template.rb +12 -8
  373. data/lib/docusign_esign/models/service_information.rb +12 -8
  374. data/lib/docusign_esign/models/service_version.rb +12 -8
  375. data/lib/docusign_esign/models/settings_metadata.rb +12 -8
  376. data/lib/docusign_esign/models/shared_item.rb +12 -8
  377. data/lib/docusign_esign/models/sign_hash_document.rb +11 -7
  378. data/lib/docusign_esign/models/sign_hash_session_info_response.rb +11 -7
  379. data/lib/docusign_esign/models/sign_here.rb +432 -13
  380. data/lib/docusign_esign/models/sign_session_info_request.rb +11 -7
  381. data/lib/docusign_esign/models/signature_data_info.rb +11 -7
  382. data/lib/docusign_esign/models/signature_properties.rb +198 -0
  383. data/lib/docusign_esign/models/signature_provider_required_option.rb +12 -8
  384. data/lib/docusign_esign/models/signature_type.rb +12 -8
  385. data/lib/docusign_esign/models/signer.rb +236 -34
  386. data/lib/docusign_esign/models/signer_attachment.rb +422 -13
  387. data/lib/docusign_esign/models/signer_email_notifications.rb +11 -8
  388. data/lib/docusign_esign/models/signing_group.rb +12 -8
  389. data/lib/docusign_esign/models/signing_group_information.rb +12 -8
  390. data/lib/docusign_esign/models/signing_group_user.rb +12 -8
  391. data/lib/docusign_esign/models/signing_group_users.rb +12 -8
  392. data/lib/docusign_esign/models/smart_section.rb +452 -12
  393. data/lib/docusign_esign/models/smart_section_anchor_position.rb +12 -8
  394. data/lib/docusign_esign/models/smart_section_collapsible_display_settings.rb +12 -8
  395. data/lib/docusign_esign/models/smart_section_display_settings.rb +13 -19
  396. data/lib/docusign_esign/models/social_account_information.rb +12 -8
  397. data/lib/docusign_esign/models/social_authentication.rb +12 -8
  398. data/lib/docusign_esign/models/ssn.rb +575 -14
  399. data/lib/docusign_esign/models/ssn4_information_input.rb +12 -8
  400. data/lib/docusign_esign/models/ssn9_information_input.rb +12 -8
  401. data/lib/docusign_esign/models/supported_languages.rb +12 -8
  402. data/lib/docusign_esign/models/tab_account_settings.rb +19 -15
  403. data/lib/docusign_esign/models/tab_group.rb +911 -0
  404. data/lib/docusign_esign/models/tab_metadata.rb +13 -39
  405. data/lib/docusign_esign/models/tab_metadata_list.rb +12 -8
  406. data/lib/docusign_esign/models/tabs.rb +50 -10
  407. data/lib/docusign_esign/models/template_custom_fields.rb +12 -8
  408. data/lib/docusign_esign/models/template_document_visibility_list.rb +12 -8
  409. data/lib/docusign_esign/models/template_documents_result.rb +12 -8
  410. data/lib/docusign_esign/models/template_information.rb +12 -8
  411. data/lib/docusign_esign/models/template_match.rb +12 -8
  412. data/lib/docusign_esign/models/template_notification_request.rb +12 -8
  413. data/lib/docusign_esign/models/template_recipients.rb +12 -8
  414. data/lib/docusign_esign/models/template_role.rb +12 -8
  415. data/lib/docusign_esign/models/template_shared_item.rb +23 -9
  416. data/lib/docusign_esign/models/template_summary.rb +22 -9
  417. data/lib/docusign_esign/models/template_tabs.rb +50 -10
  418. data/lib/docusign_esign/models/template_update_summary.rb +23 -9
  419. data/lib/docusign_esign/models/text.rb +584 -15
  420. data/lib/docusign_esign/models/text_custom_field.rb +12 -8
  421. data/lib/docusign_esign/models/time_stamp_field.rb +11 -7
  422. data/lib/docusign_esign/models/title.rb +521 -14
  423. data/lib/docusign_esign/models/tsp_health_check_request.rb +11 -7
  424. data/lib/docusign_esign/models/tsp_health_check_status_description.rb +11 -7
  425. data/lib/docusign_esign/models/update_transaction_request.rb +11 -7
  426. data/lib/docusign_esign/models/update_transaction_response.rb +11 -7
  427. data/lib/docusign_esign/models/usage_history.rb +13 -10
  428. data/lib/docusign_esign/models/user.rb +11 -7
  429. data/lib/docusign_esign/models/user_account_management_granular_information.rb +14 -67
  430. data/lib/docusign_esign/models/user_info.rb +43 -9
  431. data/lib/docusign_esign/models/user_info_list.rb +12 -8
  432. data/lib/docusign_esign/models/user_info_response.rb +11 -7
  433. data/lib/docusign_esign/models/user_information.rb +69 -25
  434. data/lib/docusign_esign/models/user_information_list.rb +12 -8
  435. data/lib/docusign_esign/models/user_password_information.rb +12 -8
  436. data/lib/docusign_esign/models/user_password_rules.rb +12 -8
  437. data/lib/docusign_esign/models/user_profile.rb +13 -9
  438. data/lib/docusign_esign/models/user_settings_information.rb +1115 -17
  439. data/lib/docusign_esign/models/user_shared_item.rb +12 -8
  440. data/lib/docusign_esign/models/user_signature.rb +93 -9
  441. data/lib/docusign_esign/models/user_signature_definition.rb +115 -12
  442. data/lib/docusign_esign/models/user_signatures_information.rb +12 -8
  443. data/lib/docusign_esign/models/user_social_id_result.rb +12 -8
  444. data/lib/docusign_esign/models/users_response.rb +12 -8
  445. data/lib/docusign_esign/models/view.rb +457 -14
  446. data/lib/docusign_esign/models/view_url.rb +12 -8
  447. data/lib/docusign_esign/models/watermark.rb +12 -8
  448. data/lib/docusign_esign/models/witness.rb +236 -34
  449. data/lib/docusign_esign/models/workspace.rb +30 -9
  450. data/lib/docusign_esign/models/workspace_folder_contents.rb +11 -8
  451. data/lib/docusign_esign/models/workspace_item.rb +63 -12
  452. data/lib/docusign_esign/models/workspace_item_list.rb +11 -8
  453. data/lib/docusign_esign/models/workspace_list.rb +11 -8
  454. data/lib/docusign_esign/models/{recipient_proof_file.rb → workspace_settings.rb} +20 -16
  455. data/lib/docusign_esign/models/workspace_user.rb +45 -12
  456. data/lib/docusign_esign/models/workspace_user_authorization.rb +11 -8
  457. data/lib/docusign_esign/models/zip.rb +584 -14
  458. data/lib/docusign_esign/version.rb +1 -1
  459. data/lib/docusign_esign.rb +138 -60
  460. data/tests/.DS_Store +0 -0
  461. data/tests/Gemfile.lock +21 -21
  462. data/{lib/docusign_esign/api → tests/spec}/.DS_Store +0 -0
  463. data/tests/spec/unit_tests_using_jwt_spec.rb +2 -61
  464. metadata +102 -69
  465. data/docusign_esign-3.11.0.gem +0 -0
  466. data/lib/docusign_esign/.DS_Store +0 -0
  467. data/lib/docusign_esign/api/organizations_api.rb +0 -128
  468. data/lib/docusign_esign/api/signature_api.rb +0 -256
  469. data/lib/docusign_esign/api/tsps_api.rb +0 -256
  470. data/lib/docusign_esign/client/.DS_Store +0 -0
  471. data/tests/docs/private.pem +0 -27
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
5
 
6
- OpenAPI spec version: v2
6
+ OpenAPI spec version: v2.1
7
7
  Contact: devcenter@docusign.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
@@ -46,7 +46,7 @@ module DocuSign_eSign
46
46
  @api_client.config.logger.debug "Calling API: DiagnosticsApi.delete_request_logs ..."
47
47
  end
48
48
  # resource path
49
- local_var_path = "/v2/diagnostics/request_logs".sub('{format}','json')
49
+ local_var_path = "/v2.1/diagnostics/request_logs".sub('{format}','json')
50
50
 
51
51
  # query parameters
52
52
  query_params = {}
@@ -94,7 +94,7 @@ module DocuSign_eSign
94
94
  # verify the required parameter 'request_log_id' is set
95
95
  fail ArgumentError, "Missing the required parameter 'request_log_id' when calling DiagnosticsApi.get_request_log" if request_log_id.nil?
96
96
  # resource path
97
- local_var_path = "/v2/diagnostics/request_logs/{requestLogId}".sub('{format}','json').sub('{' + 'requestLogId' + '}', request_log_id.to_s)
97
+ local_var_path = "/v2.1/diagnostics/request_logs/{requestLogId}".sub('{format}','json').sub('{' + 'requestLogId' + '}', request_log_id.to_s)
98
98
 
99
99
  # query parameters
100
100
  query_params = {}
@@ -139,7 +139,7 @@ module DocuSign_eSign
139
139
  @api_client.config.logger.debug "Calling API: DiagnosticsApi.get_request_log_settings ..."
140
140
  end
141
141
  # resource path
142
- local_var_path = "/v2/diagnostics/settings".sub('{format}','json')
142
+ local_var_path = "/v2.1/diagnostics/settings".sub('{format}','json')
143
143
 
144
144
  # query parameters
145
145
  query_params = {}
@@ -184,7 +184,7 @@ module DocuSign_eSign
184
184
  @api_client.config.logger.debug "Calling API: DiagnosticsApi.get_resources ..."
185
185
  end
186
186
  # resource path
187
- local_var_path = "/v2".sub('{format}','json')
187
+ local_var_path = "/v2.1".sub('{format}','json')
188
188
 
189
189
  # query parameters
190
190
  query_params = {}
@@ -276,7 +276,7 @@ module DocuSign_eSign
276
276
  @api_client.config.logger.debug "Calling API: DiagnosticsApi.list_request_logs ..."
277
277
  end
278
278
  # resource path
279
- local_var_path = "/v2/diagnostics/request_logs".sub('{format}','json')
279
+ local_var_path = "/v2.1/diagnostics/request_logs".sub('{format}','json')
280
280
 
281
281
  # query parameters
282
282
  query_params = {}
@@ -324,7 +324,7 @@ module DocuSign_eSign
324
324
  @api_client.config.logger.debug "Calling API: DiagnosticsApi.update_request_log_settings ..."
325
325
  end
326
326
  # resource path
327
- local_var_path = "/v2/diagnostics/settings".sub('{format}','json')
327
+ local_var_path = "/v2.1/diagnostics/settings".sub('{format}','json')
328
328
 
329
329
  # query parameters
330
330
  query_params = {}
@@ -353,4 +353,4 @@ module DocuSign_eSign
353
353
  return data, status_code, headers
354
354
  end
355
355
  end
356
- end
356
+ end
@@ -0,0 +1,261 @@
1
+ =begin
2
+ #DocuSign REST API
3
+
4
+ #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
+
6
+ OpenAPI spec version: v2.1
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require "uri"
13
+
14
+ module DocuSign_eSign
15
+
16
+ class GetBccEmailArchiveHistoryListOptions
17
+ #
18
+ attr_accessor :count
19
+
20
+ #
21
+ attr_accessor :start_position
22
+
23
+ def self.default
24
+ @@default ||= GetBccEmailArchiveHistoryListOptions.new
25
+ end
26
+ end
27
+
28
+ class GetBccEmailArchiveListOptions
29
+ #
30
+ attr_accessor :count
31
+
32
+ #
33
+ attr_accessor :start_position
34
+
35
+ def self.default
36
+ @@default ||= GetBccEmailArchiveListOptions.new
37
+ end
38
+ end
39
+
40
+
41
+ class EmailArchiveApi
42
+ attr_accessor :api_client
43
+
44
+ def initialize(api_client = EmailArchiveApi.default)
45
+ @api_client = api_client
46
+ end
47
+
48
+ # Creates a blind carbon copy email archive entry
49
+ #
50
+ # @param account_id The external account number (int) or account ID Guid.
51
+ # @param bcc_email_archive (optional parameter)
52
+ # @return [BccEmailArchive]
53
+ def create_bcc_email_archive(account_id, bcc_email_archive)
54
+ data, _status_code, _headers = create_bcc_email_archive_with_http_info(account_id, bcc_email_archive)
55
+ return data
56
+ end
57
+
58
+ # Creates a blind carbon copy email archive entry
59
+ #
60
+ # @param account_id The external account number (int) or account ID Guid.
61
+ # @param bcc_email_archive (optional parameter)
62
+ # @return [Array<(BccEmailArchive, Fixnum, Hash)>] BccEmailArchive data, response status code and response headers
63
+ def create_bcc_email_archive_with_http_info(account_id, bcc_email_archive)
64
+ if @api_client.config.debugging
65
+ @api_client.config.logger.debug "Calling API: EmailArchiveApi.create_bcc_email_archive ..."
66
+ end
67
+ # verify the required parameter 'account_id' is set
68
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EmailArchiveApi.create_bcc_email_archive" if account_id.nil?
69
+ # resource path
70
+ local_var_path = "/v2.1/accounts/{accountId}/settings/bcc_email_archives".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
71
+
72
+ # query parameters
73
+ query_params = {}
74
+
75
+ # header parameters
76
+ header_params = {}
77
+ # HTTP header 'Accept' (if needed)
78
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
79
+
80
+ # form parameters
81
+ form_params = {}
82
+
83
+ # http body (model)
84
+ post_body = @api_client.object_to_http_body(bcc_email_archive)
85
+ auth_names = []
86
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
87
+ :header_params => header_params,
88
+ :query_params => query_params,
89
+ :form_params => form_params,
90
+ :body => post_body,
91
+ :auth_names => auth_names,
92
+ :return_type => 'BccEmailArchive')
93
+ if @api_client.config.debugging
94
+ @api_client.config.logger.debug "API called: EmailArchiveApi#create_bcc_email_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
95
+ end
96
+ return data, status_code, headers
97
+ end
98
+
99
+ # Delete a blind carbon copy email archive for an account.
100
+ #
101
+ # @param account_id The external account number (int) or account ID Guid.
102
+ # @param bcc_email_archive_id
103
+ # @return [nil]
104
+ def delete_bcc_email_archive(account_id, bcc_email_archive_id)
105
+ delete_bcc_email_archive_with_http_info(account_id, bcc_email_archive_id)
106
+ return nil
107
+ end
108
+
109
+ # Delete a blind carbon copy email archive for an account.
110
+ #
111
+ # @param account_id The external account number (int) or account ID Guid.
112
+ # @param bcc_email_archive_id
113
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
114
+ def delete_bcc_email_archive_with_http_info(account_id, bcc_email_archive_id)
115
+ if @api_client.config.debugging
116
+ @api_client.config.logger.debug "Calling API: EmailArchiveApi.delete_bcc_email_archive ..."
117
+ end
118
+ # verify the required parameter 'account_id' is set
119
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EmailArchiveApi.delete_bcc_email_archive" if account_id.nil?
120
+ # verify the required parameter 'bcc_email_archive_id' is set
121
+ fail ArgumentError, "Missing the required parameter 'bcc_email_archive_id' when calling EmailArchiveApi.delete_bcc_email_archive" if bcc_email_archive_id.nil?
122
+ # resource path
123
+ local_var_path = "/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bccEmailArchiveId' + '}', bcc_email_archive_id.to_s)
124
+
125
+ # query parameters
126
+ query_params = {}
127
+
128
+ # header parameters
129
+ header_params = {}
130
+ # HTTP header 'Accept' (if needed)
131
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
132
+
133
+ # form parameters
134
+ form_params = {}
135
+
136
+ # http body (model)
137
+ post_body = nil
138
+ auth_names = []
139
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
140
+ :header_params => header_params,
141
+ :query_params => query_params,
142
+ :form_params => form_params,
143
+ :body => post_body,
144
+ :auth_names => auth_names)
145
+ if @api_client.config.debugging
146
+ @api_client.config.logger.debug "API called: EmailArchiveApi#delete_bcc_email_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
147
+ end
148
+ return data, status_code, headers
149
+ end
150
+
151
+ # Get the blind carbon copy email archive history entries for the specified archive
152
+ #
153
+ # @param account_id The external account number (int) or account ID Guid.
154
+ # @param bcc_email_archive_id
155
+ # @param DocuSign_eSign::GetBccEmailArchiveHistoryListOptions Options for modifying the behavior of the function.
156
+ # @return [BccEmailArchiveHistoryList]
157
+ def get_bcc_email_archive_history_list(account_id, bcc_email_archive_id, options = DocuSign_eSign::GetBccEmailArchiveHistoryListOptions.default)
158
+ data, _status_code, _headers = get_bcc_email_archive_history_list_with_http_info(account_id, bcc_email_archive_id, options)
159
+ return data
160
+ end
161
+
162
+ # Get the blind carbon copy email archive history entries for the specified archive
163
+ #
164
+ # @param account_id The external account number (int) or account ID Guid.
165
+ # @param bcc_email_archive_id
166
+ # @param DocuSign_eSign::GetBccEmailArchiveHistoryListOptions Options for modifying the behavior of the function.
167
+ # @return [Array<(BccEmailArchiveHistoryList, Fixnum, Hash)>] BccEmailArchiveHistoryList data, response status code and response headers
168
+ def get_bcc_email_archive_history_list_with_http_info(account_id, bcc_email_archive_id, options = DocuSign_eSign::GetBccEmailArchiveHistoryListOptions.default)
169
+ if @api_client.config.debugging
170
+ @api_client.config.logger.debug "Calling API: EmailArchiveApi.get_bcc_email_archive_history_list ..."
171
+ end
172
+ # verify the required parameter 'account_id' is set
173
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EmailArchiveApi.get_bcc_email_archive_history_list" if account_id.nil?
174
+ # verify the required parameter 'bcc_email_archive_id' is set
175
+ fail ArgumentError, "Missing the required parameter 'bcc_email_archive_id' when calling EmailArchiveApi.get_bcc_email_archive_history_list" if bcc_email_archive_id.nil?
176
+ # resource path
177
+ local_var_path = "/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bccEmailArchiveId' + '}', bcc_email_archive_id.to_s)
178
+
179
+ # query parameters
180
+ query_params = {}
181
+ query_params[:'count'] = options.count if !options.count.nil?
182
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
183
+
184
+ # header parameters
185
+ header_params = {}
186
+ # HTTP header 'Accept' (if needed)
187
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
188
+
189
+ # form parameters
190
+ form_params = {}
191
+
192
+ # http body (model)
193
+ post_body = nil
194
+ auth_names = []
195
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
196
+ :header_params => header_params,
197
+ :query_params => query_params,
198
+ :form_params => form_params,
199
+ :body => post_body,
200
+ :auth_names => auth_names,
201
+ :return_type => 'BccEmailArchiveHistoryList')
202
+ if @api_client.config.debugging
203
+ @api_client.config.logger.debug "API called: EmailArchiveApi#get_bcc_email_archive_history_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
204
+ end
205
+ return data, status_code, headers
206
+ end
207
+
208
+ # Get the blind carbon copy email archive entries owned by the specified account
209
+ #
210
+ # @param account_id The external account number (int) or account ID Guid.
211
+ # @param DocuSign_eSign::GetBccEmailArchiveListOptions Options for modifying the behavior of the function.
212
+ # @return [BccEmailArchiveList]
213
+ def get_bcc_email_archive_list(account_id, options = DocuSign_eSign::GetBccEmailArchiveListOptions.default)
214
+ data, _status_code, _headers = get_bcc_email_archive_list_with_http_info(account_id, options)
215
+ return data
216
+ end
217
+
218
+ # Get the blind carbon copy email archive entries owned by the specified account
219
+ #
220
+ # @param account_id The external account number (int) or account ID Guid.
221
+ # @param DocuSign_eSign::GetBccEmailArchiveListOptions Options for modifying the behavior of the function.
222
+ # @return [Array<(BccEmailArchiveList, Fixnum, Hash)>] BccEmailArchiveList data, response status code and response headers
223
+ def get_bcc_email_archive_list_with_http_info(account_id, options = DocuSign_eSign::GetBccEmailArchiveListOptions.default)
224
+ if @api_client.config.debugging
225
+ @api_client.config.logger.debug "Calling API: EmailArchiveApi.get_bcc_email_archive_list ..."
226
+ end
227
+ # verify the required parameter 'account_id' is set
228
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EmailArchiveApi.get_bcc_email_archive_list" if account_id.nil?
229
+ # resource path
230
+ local_var_path = "/v2.1/accounts/{accountId}/settings/bcc_email_archives".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
231
+
232
+ # query parameters
233
+ query_params = {}
234
+ query_params[:'count'] = options.count if !options.count.nil?
235
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
236
+
237
+ # header parameters
238
+ header_params = {}
239
+ # HTTP header 'Accept' (if needed)
240
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
241
+
242
+ # form parameters
243
+ form_params = {}
244
+
245
+ # http body (model)
246
+ post_body = nil
247
+ auth_names = []
248
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
249
+ :header_params => header_params,
250
+ :query_params => query_params,
251
+ :form_params => form_params,
252
+ :body => post_body,
253
+ :auth_names => auth_names,
254
+ :return_type => 'BccEmailArchiveList')
255
+ if @api_client.config.debugging
256
+ @api_client.config.logger.debug "API called: EmailArchiveApi#get_bcc_email_archive_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
257
+ end
258
+ return data, status_code, headers
259
+ end
260
+ end
261
+ end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
5
 
6
- OpenAPI spec version: v2
6
+ OpenAPI spec version: v2.1
7
7
  Contact: devcenter@docusign.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
@@ -83,6 +83,9 @@ module DocuSign_eSign
83
83
  # When set to **false**, the envelope signing certificate is removed from the download.
84
84
  attr_accessor :certificate
85
85
 
86
+ #
87
+ attr_accessor :documents_by_userid
88
+
86
89
  #
87
90
  attr_accessor :encoding
88
91
 
@@ -95,6 +98,9 @@ module DocuSign_eSign
95
98
  #
96
99
  attr_accessor :recipient_id
97
100
 
101
+ #
102
+ attr_accessor :shared_user_id
103
+
98
104
  # When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.
99
105
  attr_accessor :show_changes
100
106
 
@@ -145,6 +151,18 @@ module DocuSign_eSign
145
151
  end
146
152
  end
147
153
 
154
+ class GetEnvelopeTransferRulesOptions
155
+ #
156
+ attr_accessor :count
157
+
158
+ #
159
+ attr_accessor :start_position
160
+
161
+ def self.default
162
+ @@default ||= GetEnvelopeTransferRulesOptions.new
163
+ end
164
+ end
165
+
148
166
  class GetPagesOptions
149
167
  #
150
168
  attr_accessor :count
@@ -192,7 +210,19 @@ module DocuSign_eSign
192
210
 
193
211
  class ListDocumentsOptions
194
212
  #
195
- attr_accessor :include_document_size
213
+ attr_accessor :documents_by_userid
214
+
215
+ #
216
+ attr_accessor :include_metadata
217
+
218
+ #
219
+ attr_accessor :include_tabs
220
+
221
+ #
222
+ attr_accessor :recipient_id
223
+
224
+ #
225
+ attr_accessor :shared_user_id
196
226
 
197
227
  def self.default
198
228
  @@default ||= ListDocumentsOptions.new
@@ -206,6 +236,9 @@ module DocuSign_eSign
206
236
  # When set to **true**, the extended properties are included in the response.
207
237
  attr_accessor :include_extended
208
238
 
239
+ #
240
+ attr_accessor :include_metadata
241
+
209
242
  # When set to **true**, the tab information associated with the recipient is included in the response.
210
243
  attr_accessor :include_tabs
211
244
 
@@ -263,6 +296,12 @@ module DocuSign_eSign
263
296
  #
264
297
  attr_accessor :block
265
298
 
299
+ #
300
+ attr_accessor :cdse_mode
301
+
302
+ #
303
+ attr_accessor :continuation_token
304
+
266
305
  #
267
306
  attr_accessor :count
268
307
 
@@ -275,12 +314,51 @@ module DocuSign_eSign
275
314
  #
276
315
  attr_accessor :envelope_ids
277
316
 
317
+ #
318
+ attr_accessor :exclude
319
+
320
+ #
321
+ attr_accessor :folder_ids
322
+
323
+ #
324
+ attr_accessor :folder_types
325
+
278
326
  # The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used.
279
327
  attr_accessor :from_date
280
328
 
281
329
  # This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.
282
330
  attr_accessor :from_to_status
283
331
 
332
+ #
333
+ attr_accessor :include
334
+
335
+ #
336
+ attr_accessor :include_purge_information
337
+
338
+ #
339
+ attr_accessor :intersecting_folder_ids
340
+
341
+ #
342
+ attr_accessor :last_queried_date
343
+
344
+ #
345
+ attr_accessor :order
346
+
347
+ #
348
+ attr_accessor :order_by
349
+
350
+ #
351
+ attr_accessor :powerformids
352
+
353
+ #
354
+ attr_accessor :query_budget
355
+
356
+ #
357
+ attr_accessor :requester_date_format
358
+
359
+ #
360
+ attr_accessor :search_text
361
+
284
362
  #
285
363
  attr_accessor :start_position
286
364
 
@@ -293,6 +371,12 @@ module DocuSign_eSign
293
371
  # If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days.
294
372
  attr_accessor :transaction_ids
295
373
 
374
+ #
375
+ attr_accessor :user_filter
376
+
377
+ #
378
+ attr_accessor :user_id
379
+
296
380
  #
297
381
  attr_accessor :user_name
298
382
 
@@ -352,28 +436,10 @@ module DocuSign_eSign
352
436
  end
353
437
  end
354
438
 
355
- class UpdateDocumentOptions
356
- #
357
- attr_accessor :apply_document_fields
358
-
359
- def self.default
360
- @@default ||= UpdateDocumentOptions.new
361
- end
362
- end
363
-
364
- class UpdateDocumentsOptions
365
- # When true, Document fields can be added or modified while adding or modifying envelope documents.
366
- attr_accessor :apply_document_fields
367
-
439
+ class UpdateRecipientsOptions
368
440
  #
369
- attr_accessor :persist_tabs
441
+ attr_accessor :combine_same_order_recipients
370
442
 
371
- def self.default
372
- @@default ||= UpdateDocumentsOptions.new
373
- end
374
- end
375
-
376
- class UpdateRecipientsOptions
377
443
  #
378
444
  attr_accessor :offline_signing
379
445
 
@@ -419,7 +485,7 @@ module DocuSign_eSign
419
485
  # verify the required parameter 'envelope_id' is set
420
486
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.apply_template" if envelope_id.nil?
421
487
  # resource path
422
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
488
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
423
489
 
424
490
  # query parameters
425
491
  query_params = {}
@@ -478,7 +544,7 @@ module DocuSign_eSign
478
544
  # verify the required parameter 'envelope_id' is set
479
545
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.apply_template_to_document" if envelope_id.nil?
480
546
  # resource path
481
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
547
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
482
548
 
483
549
  # query parameters
484
550
  query_params = {}
@@ -529,7 +595,7 @@ module DocuSign_eSign
529
595
  # verify the required parameter 'account_id' is set
530
596
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_chunked_upload" if account_id.nil?
531
597
  # resource path
532
- local_var_path = "/v2/accounts/{accountId}/chunked_uploads".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
598
+ local_var_path = "/v2.1/accounts/{accountId}/chunked_uploads".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
533
599
 
534
600
  # query parameters
535
601
  query_params = {}
@@ -580,7 +646,7 @@ module DocuSign_eSign
580
646
  # verify the required parameter 'account_id' is set
581
647
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_console_view" if account_id.nil?
582
648
  # resource path
583
- local_var_path = "/v2/accounts/{accountId}/views/console".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
649
+ local_var_path = "/v2.1/accounts/{accountId}/views/console".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
584
650
 
585
651
  # query parameters
586
652
  query_params = {}
@@ -635,7 +701,7 @@ module DocuSign_eSign
635
701
  # verify the required parameter 'envelope_id' is set
636
702
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_correct_view" if envelope_id.nil?
637
703
  # resource path
638
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/views/correct".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
704
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
639
705
 
640
706
  # query parameters
641
707
  query_params = {}
@@ -690,7 +756,7 @@ module DocuSign_eSign
690
756
  # verify the required parameter 'envelope_id' is set
691
757
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_custom_fields" if envelope_id.nil?
692
758
  # resource path
693
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
759
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
694
760
 
695
761
  # query parameters
696
762
  query_params = {}
@@ -749,7 +815,7 @@ module DocuSign_eSign
749
815
  # verify the required parameter 'envelope_id' is set
750
816
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_document_fields" if envelope_id.nil?
751
817
  # resource path
752
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
818
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
753
819
 
754
820
  # query parameters
755
821
  query_params = {}
@@ -808,7 +874,7 @@ module DocuSign_eSign
808
874
  # verify the required parameter 'envelope_id' is set
809
875
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_document_responsive_html_preview" if envelope_id.nil?
810
876
  # resource path
811
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
877
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
812
878
 
813
879
  # query parameters
814
880
  query_params = {}
@@ -837,6 +903,65 @@ module DocuSign_eSign
837
903
  return data, status_code, headers
838
904
  end
839
905
 
906
+ # Adds the tabs to an envelope document
907
+ #
908
+ # @param account_id The external account number (int) or account ID Guid.
909
+ # @param document_id The ID of the document being accessed.
910
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
911
+ # @param tabs (optional parameter)
912
+ # @return [Tabs]
913
+ def create_document_tabs(account_id, document_id, envelope_id, tabs)
914
+ data, _status_code, _headers = create_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs)
915
+ return data
916
+ end
917
+
918
+ # Adds the tabs to an envelope document
919
+ #
920
+ # @param account_id The external account number (int) or account ID Guid.
921
+ # @param document_id The ID of the document being accessed.
922
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
923
+ # @param tabs (optional parameter)
924
+ # @return [Array<(Tabs, Fixnum, Hash)>] Tabs data, response status code and response headers
925
+ def create_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs)
926
+ if @api_client.config.debugging
927
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_document_tabs ..."
928
+ end
929
+ # verify the required parameter 'account_id' is set
930
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_document_tabs" if account_id.nil?
931
+ # verify the required parameter 'document_id' is set
932
+ fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.create_document_tabs" if document_id.nil?
933
+ # verify the required parameter 'envelope_id' is set
934
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_document_tabs" if envelope_id.nil?
935
+ # resource path
936
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
937
+
938
+ # query parameters
939
+ query_params = {}
940
+
941
+ # header parameters
942
+ header_params = {}
943
+ # HTTP header 'Accept' (if needed)
944
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
945
+
946
+ # form parameters
947
+ form_params = {}
948
+
949
+ # http body (model)
950
+ post_body = @api_client.object_to_http_body(tabs)
951
+ auth_names = []
952
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
953
+ :header_params => header_params,
954
+ :query_params => query_params,
955
+ :form_params => form_params,
956
+ :body => post_body,
957
+ :auth_names => auth_names,
958
+ :return_type => 'Tabs')
959
+ if @api_client.config.debugging
960
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
961
+ end
962
+ return data, status_code, headers
963
+ end
964
+
840
965
  # Returns a URL to the edit view UI.
841
966
  # Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
842
967
  # @param account_id The external account number (int) or account ID Guid.
@@ -863,7 +988,7 @@ module DocuSign_eSign
863
988
  # verify the required parameter 'envelope_id' is set
864
989
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_edit_view" if envelope_id.nil?
865
990
  # resource path
866
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/views/edit".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
991
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
867
992
 
868
993
  # query parameters
869
994
  query_params = {}
@@ -918,7 +1043,7 @@ module DocuSign_eSign
918
1043
  # verify the required parameter 'envelope_id' is set
919
1044
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_email_settings" if envelope_id.nil?
920
1045
  # resource path
921
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1046
+ 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)
922
1047
 
923
1048
  # query parameters
924
1049
  query_params = {}
@@ -971,7 +1096,7 @@ module DocuSign_eSign
971
1096
  # verify the required parameter 'account_id' is set
972
1097
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope" if account_id.nil?
973
1098
  # resource path
974
- local_var_path = "/v2/accounts/{accountId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1099
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
975
1100
 
976
1101
  # query parameters
977
1102
  query_params = {}
@@ -1005,33 +1130,33 @@ module DocuSign_eSign
1005
1130
  return data, status_code, headers
1006
1131
  end
1007
1132
 
1008
- # Provides a URL to start a shared recipient view of the Envelope UI
1133
+ # Posts a list of comments for authorized user
1009
1134
  #
1010
1135
  # @param account_id The external account number (int) or account ID Guid.
1011
1136
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1012
- # @param recipient_view_request (optional parameter)
1013
- # @return [ViewUrl]
1014
- def create_envelope_recipient_shared_view(account_id, envelope_id, recipient_view_request)
1015
- data, _status_code, _headers = create_envelope_recipient_shared_view_with_http_info(account_id, envelope_id, recipient_view_request)
1137
+ # @param comments_publish (optional parameter)
1138
+ # @return [CommentHistoryResult]
1139
+ def create_envelope_comments(account_id, envelope_id, comments_publish)
1140
+ data, _status_code, _headers = create_envelope_comments_with_http_info(account_id, envelope_id, comments_publish)
1016
1141
  return data
1017
1142
  end
1018
1143
 
1019
- # Provides a URL to start a shared recipient view of the Envelope UI
1144
+ # Posts a list of comments for authorized user
1020
1145
  #
1021
1146
  # @param account_id The external account number (int) or account ID Guid.
1022
1147
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1023
- # @param recipient_view_request (optional parameter)
1024
- # @return [Array<(ViewUrl, Fixnum, Hash)>] ViewUrl data, response status code and response headers
1025
- def create_envelope_recipient_shared_view_with_http_info(account_id, envelope_id, recipient_view_request)
1148
+ # @param comments_publish (optional parameter)
1149
+ # @return [Array<(CommentHistoryResult, Fixnum, Hash)>] CommentHistoryResult data, response status code and response headers
1150
+ def create_envelope_comments_with_http_info(account_id, envelope_id, comments_publish)
1026
1151
  if @api_client.config.debugging
1027
- @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_recipient_shared_view ..."
1152
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_comments ..."
1028
1153
  end
1029
1154
  # verify the required parameter 'account_id' is set
1030
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_recipient_shared_view" if account_id.nil?
1155
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_comments" if account_id.nil?
1031
1156
  # verify the required parameter 'envelope_id' is set
1032
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_envelope_recipient_shared_view" if envelope_id.nil?
1157
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_envelope_comments" if envelope_id.nil?
1033
1158
  # resource path
1034
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/views/shared".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1159
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1035
1160
 
1036
1161
  # query parameters
1037
1162
  query_params = {}
@@ -1045,7 +1170,7 @@ module DocuSign_eSign
1045
1170
  form_params = {}
1046
1171
 
1047
1172
  # http body (model)
1048
- post_body = @api_client.object_to_http_body(recipient_view_request)
1173
+ post_body = @api_client.object_to_http_body(comments_publish)
1049
1174
  auth_names = []
1050
1175
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1051
1176
  :header_params => header_params,
@@ -1053,40 +1178,40 @@ module DocuSign_eSign
1053
1178
  :form_params => form_params,
1054
1179
  :body => post_body,
1055
1180
  :auth_names => auth_names,
1056
- :return_type => 'ViewUrl')
1181
+ :return_type => 'CommentHistoryResult')
1057
1182
  if @api_client.config.debugging
1058
- @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_recipient_shared_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1183
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1059
1184
  end
1060
1185
  return data, status_code, headers
1061
1186
  end
1062
1187
 
1063
- # Lock an envelope.
1064
- # 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).
1188
+ # Provides a URL to start a recipient view of the Envelope UI
1189
+ #
1065
1190
  # @param account_id The external account number (int) or account ID Guid.
1066
1191
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1067
- # @param lock_request (optional parameter)
1068
- # @return [LockInformation]
1069
- def create_lock(account_id, envelope_id, lock_request)
1070
- data, _status_code, _headers = create_lock_with_http_info(account_id, envelope_id, lock_request)
1192
+ # @param recipient_preview_request (optional parameter)
1193
+ # @return [ViewUrl]
1194
+ def create_envelope_recipient_preview(account_id, envelope_id, recipient_preview_request)
1195
+ data, _status_code, _headers = create_envelope_recipient_preview_with_http_info(account_id, envelope_id, recipient_preview_request)
1071
1196
  return data
1072
1197
  end
1073
1198
 
1074
- # Lock an envelope.
1075
- # 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 &#x60;canLockEnvelopes&#x60; must be set to true for the user).
1199
+ # Provides a URL to start a recipient view of the Envelope UI
1200
+ #
1076
1201
  # @param account_id The external account number (int) or account ID Guid.
1077
1202
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1078
- # @param lock_request (optional parameter)
1079
- # @return [Array<(LockInformation, Fixnum, Hash)>] LockInformation data, response status code and response headers
1080
- def create_lock_with_http_info(account_id, envelope_id, lock_request)
1203
+ # @param recipient_preview_request (optional parameter)
1204
+ # @return [Array<(ViewUrl, Fixnum, Hash)>] ViewUrl data, response status code and response headers
1205
+ def create_envelope_recipient_preview_with_http_info(account_id, envelope_id, recipient_preview_request)
1081
1206
  if @api_client.config.debugging
1082
- @api_client.config.logger.debug "Calling API: EnvelopesApi.create_lock ..."
1207
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_recipient_preview ..."
1083
1208
  end
1084
1209
  # verify the required parameter 'account_id' is set
1085
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_lock" if account_id.nil?
1210
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_recipient_preview" if account_id.nil?
1086
1211
  # verify the required parameter 'envelope_id' is set
1087
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_lock" if envelope_id.nil?
1212
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_envelope_recipient_preview" if envelope_id.nil?
1088
1213
  # resource path
1089
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1214
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1090
1215
 
1091
1216
  # query parameters
1092
1217
  query_params = {}
@@ -1100,7 +1225,7 @@ module DocuSign_eSign
1100
1225
  form_params = {}
1101
1226
 
1102
1227
  # http body (model)
1103
- post_body = @api_client.object_to_http_body(lock_request)
1228
+ post_body = @api_client.object_to_http_body(recipient_preview_request)
1104
1229
  auth_names = []
1105
1230
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1106
1231
  :header_params => header_params,
@@ -1108,46 +1233,43 @@ module DocuSign_eSign
1108
1233
  :form_params => form_params,
1109
1234
  :body => post_body,
1110
1235
  :auth_names => auth_names,
1111
- :return_type => 'LockInformation')
1236
+ :return_type => 'ViewUrl')
1112
1237
  if @api_client.config.debugging
1113
- @api_client.config.logger.debug "API called: EnvelopesApi#create_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1238
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_recipient_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1114
1239
  end
1115
1240
  return data, status_code, headers
1116
1241
  end
1117
1242
 
1118
- # Adds one or more recipients to an envelope.
1119
- # Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
1243
+ # Provides a URL to start a shared recipient view of the Envelope UI
1244
+ #
1120
1245
  # @param account_id The external account number (int) or account ID Guid.
1121
1246
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1122
- # @param recipients (optional parameter)
1123
- # @param DocuSign_eSign::CreateRecipientOptions Options for modifying the behavior of the function.
1124
- # @return [Recipients]
1125
- def create_recipient(account_id, envelope_id, recipients, options = DocuSign_eSign::CreateRecipientOptions.default)
1126
- data, _status_code, _headers = create_recipient_with_http_info(account_id, envelope_id, recipients, options)
1247
+ # @param recipient_view_request (optional parameter)
1248
+ # @return [ViewUrl]
1249
+ def create_envelope_recipient_shared_view(account_id, envelope_id, recipient_view_request)
1250
+ data, _status_code, _headers = create_envelope_recipient_shared_view_with_http_info(account_id, envelope_id, recipient_view_request)
1127
1251
  return data
1128
1252
  end
1129
1253
 
1130
- # Adds one or more recipients to an envelope.
1131
- # Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient&#39;s routing order is before or the same as the envelope&#39;s next recipient, an email is only sent if the optional &#x60;resend_envelope&#x60; query string is set to **true**.
1254
+ # Provides a URL to start a shared recipient view of the Envelope UI
1255
+ #
1132
1256
  # @param account_id The external account number (int) or account ID Guid.
1133
1257
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1134
- # @param recipients (optional parameter)
1135
- # @param DocuSign_eSign::CreateRecipientOptions Options for modifying the behavior of the function.
1136
- # @return [Array<(Recipients, Fixnum, Hash)>] Recipients data, response status code and response headers
1137
- def create_recipient_with_http_info(account_id, envelope_id, recipients, options = DocuSign_eSign::CreateRecipientOptions.default)
1258
+ # @param recipient_view_request (optional parameter)
1259
+ # @return [Array<(ViewUrl, Fixnum, Hash)>] ViewUrl data, response status code and response headers
1260
+ def create_envelope_recipient_shared_view_with_http_info(account_id, envelope_id, recipient_view_request)
1138
1261
  if @api_client.config.debugging
1139
- @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient ..."
1262
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_recipient_shared_view ..."
1140
1263
  end
1141
1264
  # verify the required parameter 'account_id' is set
1142
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_recipient" if account_id.nil?
1265
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_recipient_shared_view" if account_id.nil?
1143
1266
  # verify the required parameter 'envelope_id' is set
1144
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_recipient" if envelope_id.nil?
1267
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_envelope_recipient_shared_view" if envelope_id.nil?
1145
1268
  # resource path
1146
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1269
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1147
1270
 
1148
1271
  # query parameters
1149
1272
  query_params = {}
1150
- query_params[:'resend_envelope'] = options.resend_envelope if !options.resend_envelope.nil?
1151
1273
 
1152
1274
  # header parameters
1153
1275
  header_params = {}
@@ -1158,7 +1280,7 @@ module DocuSign_eSign
1158
1280
  form_params = {}
1159
1281
 
1160
1282
  # http body (model)
1161
- post_body = @api_client.object_to_http_body(recipients)
1283
+ post_body = @api_client.object_to_http_body(recipient_view_request)
1162
1284
  auth_names = []
1163
1285
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1164
1286
  :header_params => header_params,
@@ -1166,40 +1288,36 @@ module DocuSign_eSign
1166
1288
  :form_params => form_params,
1167
1289
  :body => post_body,
1168
1290
  :auth_names => auth_names,
1169
- :return_type => 'Recipients')
1291
+ :return_type => 'ViewUrl')
1170
1292
  if @api_client.config.debugging
1171
- @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1293
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_recipient_shared_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1172
1294
  end
1173
1295
  return data, status_code, headers
1174
1296
  end
1175
1297
 
1176
- # Returns a URL to the recipient view UI.
1177
- # Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
1298
+ # Add envelope transfer rules to an account.
1299
+ #
1178
1300
  # @param account_id The external account number (int) or account ID Guid.
1179
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
1180
- # @param recipient_view_request (optional parameter)
1181
- # @return [ViewUrl]
1182
- def create_recipient_view(account_id, envelope_id, recipient_view_request)
1183
- data, _status_code, _headers = create_recipient_view_with_http_info(account_id, envelope_id, recipient_view_request)
1301
+ # @param envelope_transfer_rule_request (optional parameter)
1302
+ # @return [EnvelopeTransferRuleInformation]
1303
+ def create_envelope_transfer_rules(account_id, envelope_transfer_rule_request)
1304
+ data, _status_code, _headers = create_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_request)
1184
1305
  return data
1185
1306
  end
1186
1307
 
1187
- # Returns a URL to the recipient view UI.
1188
- # Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the &#x60;securityDomain&#x60; and &#x60;authenticationMethod&#x60; properties used to verify the user identity.
1308
+ # Add envelope transfer rules to an account.
1309
+ #
1189
1310
  # @param account_id The external account number (int) or account ID Guid.
1190
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
1191
- # @param recipient_view_request (optional parameter)
1192
- # @return [Array<(ViewUrl, Fixnum, Hash)>] ViewUrl data, response status code and response headers
1193
- def create_recipient_view_with_http_info(account_id, envelope_id, recipient_view_request)
1311
+ # @param envelope_transfer_rule_request (optional parameter)
1312
+ # @return [Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>] EnvelopeTransferRuleInformation data, response status code and response headers
1313
+ def create_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_request)
1194
1314
  if @api_client.config.debugging
1195
- @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_view ..."
1315
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_transfer_rules ..."
1196
1316
  end
1197
1317
  # verify the required parameter 'account_id' is set
1198
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_recipient_view" if account_id.nil?
1199
- # verify the required parameter 'envelope_id' is set
1200
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_recipient_view" if envelope_id.nil?
1318
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_transfer_rules" if account_id.nil?
1201
1319
  # resource path
1202
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/views/recipient".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1320
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1203
1321
 
1204
1322
  # query parameters
1205
1323
  query_params = {}
@@ -1213,7 +1331,7 @@ module DocuSign_eSign
1213
1331
  form_params = {}
1214
1332
 
1215
1333
  # http body (model)
1216
- post_body = @api_client.object_to_http_body(recipient_view_request)
1334
+ post_body = @api_client.object_to_http_body(envelope_transfer_rule_request)
1217
1335
  auth_names = []
1218
1336
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1219
1337
  :header_params => header_params,
@@ -1221,40 +1339,40 @@ module DocuSign_eSign
1221
1339
  :form_params => form_params,
1222
1340
  :body => post_body,
1223
1341
  :auth_names => auth_names,
1224
- :return_type => 'ViewUrl')
1342
+ :return_type => 'EnvelopeTransferRuleInformation')
1225
1343
  if @api_client.config.debugging
1226
- @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1344
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_transfer_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1227
1345
  end
1228
1346
  return data, status_code, headers
1229
1347
  end
1230
1348
 
1231
- # Get Responsive HTML Preview for all documents in an envelope.
1232
- #
1349
+ # Lock an envelope.
1350
+ # 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).
1233
1351
  # @param account_id The external account number (int) or account ID Guid.
1234
1352
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1235
- # @param document_html_definition (optional parameter)
1236
- # @return [DocumentHtmlDefinitions]
1237
- def create_responsive_html_preview(account_id, envelope_id, document_html_definition)
1238
- data, _status_code, _headers = create_responsive_html_preview_with_http_info(account_id, envelope_id, document_html_definition)
1353
+ # @param lock_request (optional parameter)
1354
+ # @return [LockInformation]
1355
+ def create_lock(account_id, envelope_id, lock_request)
1356
+ data, _status_code, _headers = create_lock_with_http_info(account_id, envelope_id, lock_request)
1239
1357
  return data
1240
1358
  end
1241
1359
 
1242
- # Get Responsive HTML Preview for all documents in an envelope.
1243
- #
1360
+ # Lock an envelope.
1361
+ # 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 &#x60;canLockEnvelopes&#x60; must be set to true for the user).
1244
1362
  # @param account_id The external account number (int) or account ID Guid.
1245
1363
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1246
- # @param document_html_definition (optional parameter)
1247
- # @return [Array<(DocumentHtmlDefinitions, Fixnum, Hash)>] DocumentHtmlDefinitions data, response status code and response headers
1248
- def create_responsive_html_preview_with_http_info(account_id, envelope_id, document_html_definition)
1364
+ # @param lock_request (optional parameter)
1365
+ # @return [Array<(LockInformation, Fixnum, Hash)>] LockInformation data, response status code and response headers
1366
+ def create_lock_with_http_info(account_id, envelope_id, lock_request)
1249
1367
  if @api_client.config.debugging
1250
- @api_client.config.logger.debug "Calling API: EnvelopesApi.create_responsive_html_preview ..."
1368
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_lock ..."
1251
1369
  end
1252
1370
  # verify the required parameter 'account_id' is set
1253
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_responsive_html_preview" if account_id.nil?
1371
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_lock" if account_id.nil?
1254
1372
  # verify the required parameter 'envelope_id' is set
1255
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_responsive_html_preview" if envelope_id.nil?
1373
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_lock" if envelope_id.nil?
1256
1374
  # resource path
1257
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1375
+ 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)
1258
1376
 
1259
1377
  # query parameters
1260
1378
  query_params = {}
@@ -1268,7 +1386,7 @@ module DocuSign_eSign
1268
1386
  form_params = {}
1269
1387
 
1270
1388
  # http body (model)
1271
- post_body = @api_client.object_to_http_body(document_html_definition)
1389
+ post_body = @api_client.object_to_http_body(lock_request)
1272
1390
  auth_names = []
1273
1391
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1274
1392
  :header_params => header_params,
@@ -1276,14 +1394,287 @@ module DocuSign_eSign
1276
1394
  :form_params => form_params,
1277
1395
  :body => post_body,
1278
1396
  :auth_names => auth_names,
1279
- :return_type => 'DocumentHtmlDefinitions')
1397
+ :return_type => 'LockInformation')
1280
1398
  if @api_client.config.debugging
1281
- @api_client.config.logger.debug "API called: EnvelopesApi#create_responsive_html_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1399
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1282
1400
  end
1283
1401
  return data, status_code, headers
1284
1402
  end
1285
1403
 
1286
- # Returns a URL to the sender view UI.
1404
+ # Create page information for Display Appliance
1405
+ #
1406
+ # @param account_id The external account number (int) or account ID Guid.
1407
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1408
+ # @return [nil]
1409
+ def create_page_info(account_id, envelope_id)
1410
+ create_page_info_with_http_info(account_id, envelope_id)
1411
+ return nil
1412
+ end
1413
+
1414
+ # Create page information for Display Appliance
1415
+ #
1416
+ # @param account_id The external account number (int) or account ID Guid.
1417
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1418
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1419
+ def create_page_info_with_http_info(account_id, envelope_id)
1420
+ if @api_client.config.debugging
1421
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_page_info ..."
1422
+ end
1423
+ # verify the required parameter 'account_id' is set
1424
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_page_info" if account_id.nil?
1425
+ # verify the required parameter 'envelope_id' is set
1426
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_page_info" if envelope_id.nil?
1427
+ # resource path
1428
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1429
+
1430
+ # query parameters
1431
+ query_params = {}
1432
+
1433
+ # header parameters
1434
+ header_params = {}
1435
+ # HTTP header 'Accept' (if needed)
1436
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1437
+
1438
+ # form parameters
1439
+ form_params = {}
1440
+
1441
+ # http body (model)
1442
+ post_body = nil
1443
+ auth_names = []
1444
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1445
+ :header_params => header_params,
1446
+ :query_params => query_params,
1447
+ :form_params => form_params,
1448
+ :body => post_body,
1449
+ :auth_names => auth_names)
1450
+ if @api_client.config.debugging
1451
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_page_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1452
+ end
1453
+ return data, status_code, headers
1454
+ end
1455
+
1456
+ # Add pdf blobs for Display Appliance
1457
+ #
1458
+ # @param account_id The external account number (int) or account ID Guid.
1459
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1460
+ # @return [DisplayAppliancePdf]
1461
+ def create_pdf_blob(account_id, envelope_id)
1462
+ data, _status_code, _headers = create_pdf_blob_with_http_info(account_id, envelope_id)
1463
+ return data
1464
+ end
1465
+
1466
+ # Add pdf blobs for Display Appliance
1467
+ #
1468
+ # @param account_id The external account number (int) or account ID Guid.
1469
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1470
+ # @return [Array<(DisplayAppliancePdf, Fixnum, Hash)>] DisplayAppliancePdf data, response status code and response headers
1471
+ def create_pdf_blob_with_http_info(account_id, envelope_id)
1472
+ if @api_client.config.debugging
1473
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_pdf_blob ..."
1474
+ end
1475
+ # verify the required parameter 'account_id' is set
1476
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_pdf_blob" if account_id.nil?
1477
+ # verify the required parameter 'envelope_id' is set
1478
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_pdf_blob" if envelope_id.nil?
1479
+ # resource path
1480
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1481
+
1482
+ # query parameters
1483
+ query_params = {}
1484
+
1485
+ # header parameters
1486
+ header_params = {}
1487
+ # HTTP header 'Accept' (if needed)
1488
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1489
+
1490
+ # form parameters
1491
+ form_params = {}
1492
+
1493
+ # http body (model)
1494
+ post_body = nil
1495
+ auth_names = []
1496
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1497
+ :header_params => header_params,
1498
+ :query_params => query_params,
1499
+ :form_params => form_params,
1500
+ :body => post_body,
1501
+ :auth_names => auth_names,
1502
+ :return_type => 'DisplayAppliancePdf')
1503
+ if @api_client.config.debugging
1504
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_pdf_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1505
+ end
1506
+ return data, status_code, headers
1507
+ end
1508
+
1509
+ # Adds one or more recipients to an envelope.
1510
+ # Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
1511
+ # @param account_id The external account number (int) or account ID Guid.
1512
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1513
+ # @param recipients (optional parameter)
1514
+ # @param DocuSign_eSign::CreateRecipientOptions Options for modifying the behavior of the function.
1515
+ # @return [Recipients]
1516
+ def create_recipient(account_id, envelope_id, recipients, options = DocuSign_eSign::CreateRecipientOptions.default)
1517
+ data, _status_code, _headers = create_recipient_with_http_info(account_id, envelope_id, recipients, options)
1518
+ return data
1519
+ end
1520
+
1521
+ # Adds one or more recipients to an envelope.
1522
+ # Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient&#39;s routing order is before or the same as the envelope&#39;s next recipient, an email is only sent if the optional &#x60;resend_envelope&#x60; query string is set to **true**.
1523
+ # @param account_id The external account number (int) or account ID Guid.
1524
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1525
+ # @param recipients (optional parameter)
1526
+ # @param DocuSign_eSign::CreateRecipientOptions Options for modifying the behavior of the function.
1527
+ # @return [Array<(Recipients, Fixnum, Hash)>] Recipients data, response status code and response headers
1528
+ def create_recipient_with_http_info(account_id, envelope_id, recipients, options = DocuSign_eSign::CreateRecipientOptions.default)
1529
+ if @api_client.config.debugging
1530
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient ..."
1531
+ end
1532
+ # verify the required parameter 'account_id' is set
1533
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_recipient" if account_id.nil?
1534
+ # verify the required parameter 'envelope_id' is set
1535
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_recipient" if envelope_id.nil?
1536
+ # resource path
1537
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1538
+
1539
+ # query parameters
1540
+ query_params = {}
1541
+ query_params[:'resend_envelope'] = options.resend_envelope if !options.resend_envelope.nil?
1542
+
1543
+ # header parameters
1544
+ header_params = {}
1545
+ # HTTP header 'Accept' (if needed)
1546
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1547
+
1548
+ # form parameters
1549
+ form_params = {}
1550
+
1551
+ # http body (model)
1552
+ post_body = @api_client.object_to_http_body(recipients)
1553
+ auth_names = []
1554
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1555
+ :header_params => header_params,
1556
+ :query_params => query_params,
1557
+ :form_params => form_params,
1558
+ :body => post_body,
1559
+ :auth_names => auth_names,
1560
+ :return_type => 'Recipients')
1561
+ if @api_client.config.debugging
1562
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1563
+ end
1564
+ return data, status_code, headers
1565
+ end
1566
+
1567
+ # Returns a URL to the recipient view UI.
1568
+ # Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
1569
+ # @param account_id The external account number (int) or account ID Guid.
1570
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1571
+ # @param recipient_view_request (optional parameter)
1572
+ # @return [ViewUrl]
1573
+ def create_recipient_view(account_id, envelope_id, recipient_view_request)
1574
+ data, _status_code, _headers = create_recipient_view_with_http_info(account_id, envelope_id, recipient_view_request)
1575
+ return data
1576
+ end
1577
+
1578
+ # Returns a URL to the recipient view UI.
1579
+ # Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the &#x60;securityDomain&#x60; and &#x60;authenticationMethod&#x60; properties used to verify the user identity.
1580
+ # @param account_id The external account number (int) or account ID Guid.
1581
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1582
+ # @param recipient_view_request (optional parameter)
1583
+ # @return [Array<(ViewUrl, Fixnum, Hash)>] ViewUrl data, response status code and response headers
1584
+ def create_recipient_view_with_http_info(account_id, envelope_id, recipient_view_request)
1585
+ if @api_client.config.debugging
1586
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_view ..."
1587
+ end
1588
+ # verify the required parameter 'account_id' is set
1589
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_recipient_view" if account_id.nil?
1590
+ # verify the required parameter 'envelope_id' is set
1591
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_recipient_view" if envelope_id.nil?
1592
+ # resource path
1593
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1594
+
1595
+ # query parameters
1596
+ query_params = {}
1597
+
1598
+ # header parameters
1599
+ header_params = {}
1600
+ # HTTP header 'Accept' (if needed)
1601
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1602
+
1603
+ # form parameters
1604
+ form_params = {}
1605
+
1606
+ # http body (model)
1607
+ post_body = @api_client.object_to_http_body(recipient_view_request)
1608
+ auth_names = []
1609
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1610
+ :header_params => header_params,
1611
+ :query_params => query_params,
1612
+ :form_params => form_params,
1613
+ :body => post_body,
1614
+ :auth_names => auth_names,
1615
+ :return_type => 'ViewUrl')
1616
+ if @api_client.config.debugging
1617
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1618
+ end
1619
+ return data, status_code, headers
1620
+ end
1621
+
1622
+ # Get Responsive HTML Preview for all documents in an envelope.
1623
+ #
1624
+ # @param account_id The external account number (int) or account ID Guid.
1625
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1626
+ # @param document_html_definition (optional parameter)
1627
+ # @return [DocumentHtmlDefinitions]
1628
+ def create_responsive_html_preview(account_id, envelope_id, document_html_definition)
1629
+ data, _status_code, _headers = create_responsive_html_preview_with_http_info(account_id, envelope_id, document_html_definition)
1630
+ return data
1631
+ end
1632
+
1633
+ # Get Responsive HTML Preview for all documents in an envelope.
1634
+ #
1635
+ # @param account_id The external account number (int) or account ID Guid.
1636
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
1637
+ # @param document_html_definition (optional parameter)
1638
+ # @return [Array<(DocumentHtmlDefinitions, Fixnum, Hash)>] DocumentHtmlDefinitions data, response status code and response headers
1639
+ def create_responsive_html_preview_with_http_info(account_id, envelope_id, document_html_definition)
1640
+ if @api_client.config.debugging
1641
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.create_responsive_html_preview ..."
1642
+ end
1643
+ # verify the required parameter 'account_id' is set
1644
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_responsive_html_preview" if account_id.nil?
1645
+ # verify the required parameter 'envelope_id' is set
1646
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_responsive_html_preview" if envelope_id.nil?
1647
+ # resource path
1648
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1649
+
1650
+ # query parameters
1651
+ query_params = {}
1652
+
1653
+ # header parameters
1654
+ header_params = {}
1655
+ # HTTP header 'Accept' (if needed)
1656
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1657
+
1658
+ # form parameters
1659
+ form_params = {}
1660
+
1661
+ # http body (model)
1662
+ post_body = @api_client.object_to_http_body(document_html_definition)
1663
+ auth_names = []
1664
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1665
+ :header_params => header_params,
1666
+ :query_params => query_params,
1667
+ :form_params => form_params,
1668
+ :body => post_body,
1669
+ :auth_names => auth_names,
1670
+ :return_type => 'DocumentHtmlDefinitions')
1671
+ if @api_client.config.debugging
1672
+ @api_client.config.logger.debug "API called: EnvelopesApi#create_responsive_html_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1673
+ end
1674
+ return data, status_code, headers
1675
+ end
1676
+
1677
+ # Returns a URL to the sender view UI.
1287
1678
  # Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
1288
1679
  # @param account_id The external account number (int) or account ID Guid.
1289
1680
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
@@ -1309,7 +1700,7 @@ module DocuSign_eSign
1309
1700
  # verify the required parameter 'envelope_id' is set
1310
1701
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_sender_view" if envelope_id.nil?
1311
1702
  # resource path
1312
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/views/sender".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1703
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1313
1704
 
1314
1705
  # query parameters
1315
1706
  query_params = {}
@@ -1368,7 +1759,7 @@ module DocuSign_eSign
1368
1759
  # verify the required parameter 'recipient_id' is set
1369
1760
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.create_tabs" if recipient_id.nil?
1370
1761
  # resource path
1371
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
1762
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
1372
1763
 
1373
1764
  # query parameters
1374
1765
  query_params = {}
@@ -1423,7 +1814,7 @@ module DocuSign_eSign
1423
1814
  # verify the required parameter 'envelope_id' is set
1424
1815
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_attachments" if envelope_id.nil?
1425
1816
  # resource path
1426
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1817
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1427
1818
 
1428
1819
  # query parameters
1429
1820
  query_params = {}
@@ -1476,7 +1867,7 @@ module DocuSign_eSign
1476
1867
  # verify the required parameter 'chunked_upload_id' is set
1477
1868
  fail ArgumentError, "Missing the required parameter 'chunked_upload_id' when calling EnvelopesApi.delete_chunked_upload" if chunked_upload_id.nil?
1478
1869
  # resource path
1479
- local_var_path = "/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s)
1870
+ local_var_path = "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s)
1480
1871
 
1481
1872
  # query parameters
1482
1873
  query_params = {}
@@ -1531,7 +1922,7 @@ module DocuSign_eSign
1531
1922
  # verify the required parameter 'envelope_id' is set
1532
1923
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_custom_fields" if envelope_id.nil?
1533
1924
  # resource path
1534
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1925
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1535
1926
 
1536
1927
  # query parameters
1537
1928
  query_params = {}
@@ -1590,7 +1981,7 @@ module DocuSign_eSign
1590
1981
  # verify the required parameter 'envelope_id' is set
1591
1982
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_document_fields" if envelope_id.nil?
1592
1983
  # resource path
1593
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1984
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1594
1985
 
1595
1986
  # query parameters
1596
1987
  query_params = {}
@@ -1651,7 +2042,7 @@ module DocuSign_eSign
1651
2042
  # verify the required parameter 'page_number' is set
1652
2043
  fail ArgumentError, "Missing the required parameter 'page_number' when calling EnvelopesApi.delete_document_page" if page_number.nil?
1653
2044
  # resource path
1654
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
2045
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
1655
2046
 
1656
2047
  # query parameters
1657
2048
  query_params = {}
@@ -1679,14 +2070,73 @@ module DocuSign_eSign
1679
2070
  return data, status_code, headers
1680
2071
  end
1681
2072
 
1682
- # Deletes documents from a draft envelope.
1683
- # Deletes one or more documents from an existing draft envelope.
2073
+ # Deletes tabs from an envelope document
2074
+ #
1684
2075
  # @param account_id The external account number (int) or account ID Guid.
2076
+ # @param document_id The ID of the document being accessed.
1685
2077
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
1686
- # @param envelope_definition (optional parameter)
1687
- # @return [EnvelopeDocumentsResult]
1688
- def delete_documents(account_id, envelope_id, envelope_definition)
1689
- data, _status_code, _headers = delete_documents_with_http_info(account_id, envelope_id, envelope_definition)
2078
+ # @param tabs (optional parameter)
2079
+ # @return [Tabs]
2080
+ def delete_document_tabs(account_id, document_id, envelope_id, tabs)
2081
+ data, _status_code, _headers = delete_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs)
2082
+ return data
2083
+ end
2084
+
2085
+ # Deletes tabs from an envelope document
2086
+ #
2087
+ # @param account_id The external account number (int) or account ID Guid.
2088
+ # @param document_id The ID of the document being accessed.
2089
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2090
+ # @param tabs (optional parameter)
2091
+ # @return [Array<(Tabs, Fixnum, Hash)>] Tabs data, response status code and response headers
2092
+ def delete_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs)
2093
+ if @api_client.config.debugging
2094
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_document_tabs ..."
2095
+ end
2096
+ # verify the required parameter 'account_id' is set
2097
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_document_tabs" if account_id.nil?
2098
+ # verify the required parameter 'document_id' is set
2099
+ fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.delete_document_tabs" if document_id.nil?
2100
+ # verify the required parameter 'envelope_id' is set
2101
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_document_tabs" if envelope_id.nil?
2102
+ # resource path
2103
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2104
+
2105
+ # query parameters
2106
+ query_params = {}
2107
+
2108
+ # header parameters
2109
+ header_params = {}
2110
+ # HTTP header 'Accept' (if needed)
2111
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2112
+
2113
+ # form parameters
2114
+ form_params = {}
2115
+
2116
+ # http body (model)
2117
+ post_body = @api_client.object_to_http_body(tabs)
2118
+ auth_names = []
2119
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2120
+ :header_params => header_params,
2121
+ :query_params => query_params,
2122
+ :form_params => form_params,
2123
+ :body => post_body,
2124
+ :auth_names => auth_names,
2125
+ :return_type => 'Tabs')
2126
+ if @api_client.config.debugging
2127
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2128
+ end
2129
+ return data, status_code, headers
2130
+ end
2131
+
2132
+ # Deletes documents from a draft envelope.
2133
+ # Deletes one or more documents from an existing draft envelope.
2134
+ # @param account_id The external account number (int) or account ID Guid.
2135
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2136
+ # @param envelope_definition (optional parameter)
2137
+ # @return [EnvelopeDocumentsResult]
2138
+ def delete_documents(account_id, envelope_id, envelope_definition)
2139
+ data, _status_code, _headers = delete_documents_with_http_info(account_id, envelope_id, envelope_definition)
1690
2140
  return data
1691
2141
  end
1692
2142
 
@@ -1705,7 +2155,7 @@ module DocuSign_eSign
1705
2155
  # verify the required parameter 'envelope_id' is set
1706
2156
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_documents" if envelope_id.nil?
1707
2157
  # resource path
1708
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2158
+ 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)
1709
2159
 
1710
2160
  # query parameters
1711
2161
  query_params = {}
@@ -1758,7 +2208,7 @@ module DocuSign_eSign
1758
2208
  # verify the required parameter 'envelope_id' is set
1759
2209
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_email_settings" if envelope_id.nil?
1760
2210
  # resource path
1761
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2211
+ 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)
1762
2212
 
1763
2213
  # query parameters
1764
2214
  query_params = {}
@@ -1787,33 +2237,31 @@ module DocuSign_eSign
1787
2237
  return data, status_code, headers
1788
2238
  end
1789
2239
 
1790
- # Revokes the correction view URL to the Envelope UI
2240
+ # Delete envelope transfer rules for an account.
1791
2241
  #
1792
2242
  # @param account_id The external account number (int) or account ID Guid.
1793
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
1794
- # @param correct_view_request (optional parameter)
2243
+ # @param envelope_transfer_rule_id
1795
2244
  # @return [nil]
1796
- def delete_envelope_correct_view(account_id, envelope_id, correct_view_request)
1797
- delete_envelope_correct_view_with_http_info(account_id, envelope_id, correct_view_request)
2245
+ def delete_envelope_transfer_rules(account_id, envelope_transfer_rule_id)
2246
+ delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id)
1798
2247
  return nil
1799
2248
  end
1800
2249
 
1801
- # Revokes the correction view URL to the Envelope UI
2250
+ # Delete envelope transfer rules for an account.
1802
2251
  #
1803
2252
  # @param account_id The external account number (int) or account ID Guid.
1804
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
1805
- # @param correct_view_request (optional parameter)
2253
+ # @param envelope_transfer_rule_id
1806
2254
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1807
- def delete_envelope_correct_view_with_http_info(account_id, envelope_id, correct_view_request)
2255
+ def delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id)
1808
2256
  if @api_client.config.debugging
1809
- @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_correct_view ..."
2257
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_transfer_rules ..."
1810
2258
  end
1811
2259
  # verify the required parameter 'account_id' is set
1812
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_correct_view" if account_id.nil?
1813
- # verify the required parameter 'envelope_id' is set
1814
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_correct_view" if envelope_id.nil?
2260
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_transfer_rules" if account_id.nil?
2261
+ # verify the required parameter 'envelope_transfer_rule_id' is set
2262
+ fail ArgumentError, "Missing the required parameter 'envelope_transfer_rule_id' when calling EnvelopesApi.delete_envelope_transfer_rules" if envelope_transfer_rule_id.nil?
1815
2263
  # resource path
1816
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/views/correct".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2264
+ 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)
1817
2265
 
1818
2266
  # query parameters
1819
2267
  query_params = {}
@@ -1827,7 +2275,7 @@ module DocuSign_eSign
1827
2275
  form_params = {}
1828
2276
 
1829
2277
  # http body (model)
1830
- post_body = @api_client.object_to_http_body(correct_view_request)
2278
+ post_body = nil
1831
2279
  auth_names = []
1832
2280
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
1833
2281
  :header_params => header_params,
@@ -1836,7 +2284,7 @@ module DocuSign_eSign
1836
2284
  :body => post_body,
1837
2285
  :auth_names => auth_names)
1838
2286
  if @api_client.config.debugging
1839
- @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_correct_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2287
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_transfer_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1840
2288
  end
1841
2289
  return data, status_code, headers
1842
2290
  end
@@ -1865,7 +2313,7 @@ module DocuSign_eSign
1865
2313
  # verify the required parameter 'envelope_id' is set
1866
2314
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_lock" if envelope_id.nil?
1867
2315
  # resource path
1868
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2316
+ 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)
1869
2317
 
1870
2318
  # query parameters
1871
2319
  query_params = {}
@@ -1894,6 +2342,58 @@ module DocuSign_eSign
1894
2342
  return data, status_code, headers
1895
2343
  end
1896
2344
 
2345
+ # Delete page information for Display Appliance
2346
+ #
2347
+ # @param account_id The external account number (int) or account ID Guid.
2348
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2349
+ # @return [nil]
2350
+ def delete_page_info(account_id, envelope_id)
2351
+ delete_page_info_with_http_info(account_id, envelope_id)
2352
+ return nil
2353
+ end
2354
+
2355
+ # Delete page information for Display Appliance
2356
+ #
2357
+ # @param account_id The external account number (int) or account ID Guid.
2358
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2359
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2360
+ def delete_page_info_with_http_info(account_id, envelope_id)
2361
+ if @api_client.config.debugging
2362
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_page_info ..."
2363
+ end
2364
+ # verify the required parameter 'account_id' is set
2365
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_page_info" if account_id.nil?
2366
+ # verify the required parameter 'envelope_id' is set
2367
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_page_info" if envelope_id.nil?
2368
+ # resource path
2369
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2370
+
2371
+ # query parameters
2372
+ query_params = {}
2373
+
2374
+ # header parameters
2375
+ header_params = {}
2376
+ # HTTP header 'Accept' (if needed)
2377
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2378
+
2379
+ # form parameters
2380
+ form_params = {}
2381
+
2382
+ # http body (model)
2383
+ post_body = nil
2384
+ auth_names = []
2385
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2386
+ :header_params => header_params,
2387
+ :query_params => query_params,
2388
+ :form_params => form_params,
2389
+ :body => post_body,
2390
+ :auth_names => auth_names)
2391
+ if @api_client.config.debugging
2392
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_page_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2393
+ end
2394
+ return data, status_code, headers
2395
+ end
2396
+
1897
2397
  # Deletes a recipient from an envelope.
1898
2398
  # Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
1899
2399
  # @param account_id The external account number (int) or account ID Guid.
@@ -1922,7 +2422,7 @@ module DocuSign_eSign
1922
2422
  # verify the required parameter 'recipient_id' is set
1923
2423
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.delete_recipient" if recipient_id.nil?
1924
2424
  # resource path
1925
- local_var_path = "/v2/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)
2425
+ 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)
1926
2426
 
1927
2427
  # query parameters
1928
2428
  query_params = {}
@@ -1977,7 +2477,7 @@ module DocuSign_eSign
1977
2477
  # verify the required parameter 'envelope_id' is set
1978
2478
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_recipients" if envelope_id.nil?
1979
2479
  # resource path
1980
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2480
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
1981
2481
 
1982
2482
  # query parameters
1983
2483
  query_params = {}
@@ -2036,7 +2536,7 @@ module DocuSign_eSign
2036
2536
  # verify the required parameter 'recipient_id' is set
2037
2537
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.delete_tabs" if recipient_id.nil?
2038
2538
  # resource path
2039
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
2539
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
2040
2540
 
2041
2541
  # query parameters
2042
2542
  query_params = {}
@@ -2097,7 +2597,7 @@ module DocuSign_eSign
2097
2597
  # verify the required parameter 'template_id' is set
2098
2598
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_templates_from_document" if template_id.nil?
2099
2599
  # resource path
2100
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
2600
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
2101
2601
 
2102
2602
  # query parameters
2103
2603
  query_params = {}
@@ -2125,6 +2625,59 @@ module DocuSign_eSign
2125
2625
  return data, status_code, headers
2126
2626
  end
2127
2627
 
2628
+ # Returns envelope and recipient information for Display Appliance
2629
+ #
2630
+ # @param account_id The external account number (int) or account ID Guid.
2631
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2632
+ # @return [DisplayApplianceInfo]
2633
+ def get_appliance_info(account_id, envelope_id)
2634
+ data, _status_code, _headers = get_appliance_info_with_http_info(account_id, envelope_id)
2635
+ return data
2636
+ end
2637
+
2638
+ # Returns envelope and recipient information for Display Appliance
2639
+ #
2640
+ # @param account_id The external account number (int) or account ID Guid.
2641
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2642
+ # @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
2643
+ def get_appliance_info_with_http_info(account_id, envelope_id)
2644
+ if @api_client.config.debugging
2645
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_appliance_info ..."
2646
+ end
2647
+ # verify the required parameter 'account_id' is set
2648
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_appliance_info" if account_id.nil?
2649
+ # verify the required parameter 'envelope_id' is set
2650
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_appliance_info" if envelope_id.nil?
2651
+ # resource path
2652
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2653
+
2654
+ # query parameters
2655
+ query_params = {}
2656
+
2657
+ # header parameters
2658
+ header_params = {}
2659
+ # HTTP header 'Accept' (if needed)
2660
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2661
+
2662
+ # form parameters
2663
+ form_params = {}
2664
+
2665
+ # http body (model)
2666
+ post_body = nil
2667
+ auth_names = []
2668
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2669
+ :header_params => header_params,
2670
+ :query_params => query_params,
2671
+ :form_params => form_params,
2672
+ :body => post_body,
2673
+ :auth_names => auth_names,
2674
+ :return_type => 'DisplayApplianceInfo')
2675
+ if @api_client.config.debugging
2676
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_appliance_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2677
+ end
2678
+ return data, status_code, headers
2679
+ end
2680
+
2128
2681
  # Retrieves an attachment from the envelope.
2129
2682
  #
2130
2683
  # @param account_id The external account number (int) or account ID Guid.
@@ -2153,7 +2706,7 @@ module DocuSign_eSign
2153
2706
  # verify the required parameter 'envelope_id' is set
2154
2707
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_attachment" if envelope_id.nil?
2155
2708
  # resource path
2156
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2709
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2157
2710
 
2158
2711
  # query parameters
2159
2712
  query_params = {}
@@ -2205,7 +2758,7 @@ module DocuSign_eSign
2205
2758
  # verify the required parameter 'envelope_id' is set
2206
2759
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_attachments" if envelope_id.nil?
2207
2760
  # resource path
2208
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2761
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2209
2762
 
2210
2763
  # query parameters
2211
2764
  query_params = {}
@@ -2260,7 +2813,7 @@ module DocuSign_eSign
2260
2813
  # verify the required parameter 'chunked_upload_id' is set
2261
2814
  fail ArgumentError, "Missing the required parameter 'chunked_upload_id' when calling EnvelopesApi.get_chunked_upload" if chunked_upload_id.nil?
2262
2815
  # resource path
2263
- local_var_path = "/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s)
2816
+ local_var_path = "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s)
2264
2817
 
2265
2818
  # query parameters
2266
2819
  query_params = {}
@@ -2316,7 +2869,7 @@ module DocuSign_eSign
2316
2869
  # verify the required parameter 'envelope_id' is set
2317
2870
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_comments_transcript" if envelope_id.nil?
2318
2871
  # resource path
2319
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2872
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2320
2873
 
2321
2874
  # query parameters
2322
2875
  query_params = {}
@@ -2350,7 +2903,7 @@ module DocuSign_eSign
2350
2903
  # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
2351
2904
  # @param account_id The external account number (int) or account ID Guid.
2352
2905
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2353
- # @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.
2906
+ # @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), 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.
2354
2907
  # @param recipient_id The ID of the recipient being accessed.
2355
2908
  # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
2356
2909
  # @return [ConsumerDisclosure]
@@ -2363,7 +2916,7 @@ module DocuSign_eSign
2363
2916
  # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
2364
2917
  # @param account_id The external account number (int) or account ID Guid.
2365
2918
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
2366
- # @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.
2919
+ # @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), 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.
2367
2920
  # @param recipient_id The ID of the recipient being accessed.
2368
2921
  # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
2369
2922
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
@@ -2380,7 +2933,7 @@ module DocuSign_eSign
2380
2933
  # verify the required parameter 'recipient_id' is set
2381
2934
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_consumer_disclosure" if recipient_id.nil?
2382
2935
  # resource path
2383
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'langCode' + '}', lang_code.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
2936
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'langCode' + '}', lang_code.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
2384
2937
 
2385
2938
  # query parameters
2386
2939
  query_params = {}
@@ -2440,7 +2993,7 @@ module DocuSign_eSign
2440
2993
  # verify the required parameter 'recipient_id' is set
2441
2994
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_consumer_disclosure_default" if recipient_id.nil?
2442
2995
  # resource path
2443
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
2996
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
2444
2997
 
2445
2998
  # query parameters
2446
2999
  query_params = {}
@@ -2500,15 +3053,17 @@ module DocuSign_eSign
2500
3053
  # verify the required parameter 'envelope_id' is set
2501
3054
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_document" if envelope_id.nil?
2502
3055
  # resource path
2503
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3056
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2504
3057
 
2505
3058
  # query parameters
2506
3059
  query_params = {}
2507
3060
  query_params[:'certificate'] = options.certificate if !options.certificate.nil?
3061
+ query_params[:'documents_by_userid'] = options.documents_by_userid if !options.documents_by_userid.nil?
2508
3062
  query_params[:'encoding'] = options.encoding if !options.encoding.nil?
2509
3063
  query_params[:'encrypt'] = options.encrypt if !options.encrypt.nil?
2510
3064
  query_params[:'language'] = options.language if !options.language.nil?
2511
3065
  query_params[:'recipient_id'] = options.recipient_id if !options.recipient_id.nil?
3066
+ query_params[:'shared_user_id'] = options.shared_user_id if !options.shared_user_id.nil?
2512
3067
  query_params[:'show_changes'] = options.show_changes if !options.show_changes.nil?
2513
3068
  query_params[:'watermark'] = options.watermark if !options.watermark.nil?
2514
3069
 
@@ -2536,6 +3091,59 @@ module DocuSign_eSign
2536
3091
  return data, status_code, headers
2537
3092
  end
2538
3093
 
3094
+ # Return document pages for Display Appliance
3095
+ #
3096
+ # @param account_id The external account number (int) or account ID Guid.
3097
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3098
+ # @return [DisplayApplianceInfo]
3099
+ def get_document_page(account_id, envelope_id)
3100
+ data, _status_code, _headers = get_document_page_with_http_info(account_id, envelope_id)
3101
+ return data
3102
+ end
3103
+
3104
+ # Return document pages for Display Appliance
3105
+ #
3106
+ # @param account_id The external account number (int) or account ID Guid.
3107
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3108
+ # @return [Array<(DisplayApplianceInfo, Fixnum, Hash)>] DisplayApplianceInfo data, response status code and response headers
3109
+ def get_document_page_with_http_info(account_id, envelope_id)
3110
+ if @api_client.config.debugging
3111
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_document_page ..."
3112
+ end
3113
+ # verify the required parameter 'account_id' is set
3114
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_document_page" if account_id.nil?
3115
+ # verify the required parameter 'envelope_id' is set
3116
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_document_page" if envelope_id.nil?
3117
+ # resource path
3118
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document_page_list".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3119
+
3120
+ # query parameters
3121
+ query_params = {}
3122
+
3123
+ # header parameters
3124
+ header_params = {}
3125
+ # HTTP header 'Accept' (if needed)
3126
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3127
+
3128
+ # form parameters
3129
+ form_params = {}
3130
+
3131
+ # http body (model)
3132
+ post_body = nil
3133
+ auth_names = []
3134
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3135
+ :header_params => header_params,
3136
+ :query_params => query_params,
3137
+ :form_params => form_params,
3138
+ :body => post_body,
3139
+ :auth_names => auth_names,
3140
+ :return_type => 'DisplayApplianceInfo')
3141
+ if @api_client.config.debugging
3142
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_document_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3143
+ end
3144
+ return data, status_code, headers
3145
+ end
3146
+
2539
3147
  # Gets a page image from an envelope for display.
2540
3148
  # Retrieves a page image for display from the specified envelope.
2541
3149
  # @param account_id The external account number (int) or account ID Guid.
@@ -2570,7 +3178,7 @@ module DocuSign_eSign
2570
3178
  # verify the required parameter 'page_number' is set
2571
3179
  fail ArgumentError, "Missing the required parameter 'page_number' when calling EnvelopesApi.get_document_page_image" if page_number.nil?
2572
3180
  # resource path
2573
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
3181
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
2574
3182
 
2575
3183
  # query parameters
2576
3184
  query_params = {}
@@ -2633,7 +3241,7 @@ module DocuSign_eSign
2633
3241
  # verify the required parameter 'envelope_id' is set
2634
3242
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_document_tabs" if envelope_id.nil?
2635
3243
  # resource path
2636
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3244
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2637
3245
 
2638
3246
  # query parameters
2639
3247
  query_params = {}
@@ -2687,7 +3295,7 @@ module DocuSign_eSign
2687
3295
  # verify the required parameter 'envelope_id' is set
2688
3296
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_email_settings" if envelope_id.nil?
2689
3297
  # resource path
2690
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3298
+ 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)
2691
3299
 
2692
3300
  # query parameters
2693
3301
  query_params = {}
@@ -2742,7 +3350,7 @@ module DocuSign_eSign
2742
3350
  # verify the required parameter 'envelope_id' is set
2743
3351
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope" if envelope_id.nil?
2744
3352
  # resource path
2745
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3353
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2746
3354
 
2747
3355
  # query parameters
2748
3356
  query_params = {}
@@ -2801,7 +3409,7 @@ module DocuSign_eSign
2801
3409
  # verify the required parameter 'envelope_id' is set
2802
3410
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_document_html_definitions" if envelope_id.nil?
2803
3411
  # resource path
2804
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3412
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2805
3413
 
2806
3414
  # query parameters
2807
3415
  query_params = {}
@@ -2854,7 +3462,7 @@ module DocuSign_eSign
2854
3462
  # verify the required parameter 'envelope_id' is set
2855
3463
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_html_definitions" if envelope_id.nil?
2856
3464
  # resource path
2857
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/html_definitions".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3465
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2858
3466
 
2859
3467
  # query parameters
2860
3468
  query_params = {}
@@ -2883,6 +3491,59 @@ module DocuSign_eSign
2883
3491
  return data, status_code, headers
2884
3492
  end
2885
3493
 
3494
+ # Returns a list of envelope transfer rules in the specified account.
3495
+ #
3496
+ # @param account_id The external account number (int) or account ID Guid.
3497
+ # @param DocuSign_eSign::GetEnvelopeTransferRulesOptions Options for modifying the behavior of the function.
3498
+ # @return [EnvelopeTransferRuleInformation]
3499
+ def get_envelope_transfer_rules(account_id, options = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default)
3500
+ data, _status_code, _headers = get_envelope_transfer_rules_with_http_info(account_id, options)
3501
+ return data
3502
+ end
3503
+
3504
+ # Returns a list of envelope transfer rules in the specified account.
3505
+ #
3506
+ # @param account_id The external account number (int) or account ID Guid.
3507
+ # @param DocuSign_eSign::GetEnvelopeTransferRulesOptions Options for modifying the behavior of the function.
3508
+ # @return [Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>] EnvelopeTransferRuleInformation data, response status code and response headers
3509
+ def get_envelope_transfer_rules_with_http_info(account_id, options = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default)
3510
+ if @api_client.config.debugging
3511
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_transfer_rules ..."
3512
+ end
3513
+ # verify the required parameter 'account_id' is set
3514
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_transfer_rules" if account_id.nil?
3515
+ # resource path
3516
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
3517
+
3518
+ # query parameters
3519
+ query_params = {}
3520
+ query_params[:'count'] = options.count if !options.count.nil?
3521
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
3522
+
3523
+ # header parameters
3524
+ header_params = {}
3525
+ # HTTP header 'Accept' (if needed)
3526
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3527
+
3528
+ # form parameters
3529
+ form_params = {}
3530
+
3531
+ # http body (model)
3532
+ post_body = nil
3533
+ auth_names = []
3534
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3535
+ :header_params => header_params,
3536
+ :query_params => query_params,
3537
+ :form_params => form_params,
3538
+ :body => post_body,
3539
+ :auth_names => auth_names,
3540
+ :return_type => 'EnvelopeTransferRuleInformation')
3541
+ if @api_client.config.debugging
3542
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_transfer_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3543
+ end
3544
+ return data, status_code, headers
3545
+ end
3546
+
2886
3547
  # Returns envelope form data for an existing envelope.
2887
3548
  #
2888
3549
  # @param account_id The external account number (int) or account ID Guid.
@@ -2907,7 +3568,7 @@ module DocuSign_eSign
2907
3568
  # verify the required parameter 'envelope_id' is set
2908
3569
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_form_data" if envelope_id.nil?
2909
3570
  # resource path
2910
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/form_data".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3571
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
2911
3572
 
2912
3573
  # query parameters
2913
3574
  query_params = {}
@@ -2960,7 +3621,7 @@ module DocuSign_eSign
2960
3621
  # verify the required parameter 'envelope_id' is set
2961
3622
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_lock" if envelope_id.nil?
2962
3623
  # resource path
2963
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3624
+ 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)
2964
3625
 
2965
3626
  # query parameters
2966
3627
  query_params = {}
@@ -3013,7 +3674,7 @@ module DocuSign_eSign
3013
3674
  # verify the required parameter 'envelope_id' is set
3014
3675
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_notification_settings" if envelope_id.nil?
3015
3676
  # resource path
3016
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/notification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3677
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3017
3678
 
3018
3679
  # query parameters
3019
3680
  query_params = {}
@@ -3074,7 +3735,7 @@ module DocuSign_eSign
3074
3735
  # verify the required parameter 'page_number' is set
3075
3736
  fail ArgumentError, "Missing the required parameter 'page_number' when calling EnvelopesApi.get_page_tabs" if page_number.nil?
3076
3737
  # resource path
3077
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
3738
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
3078
3739
 
3079
3740
  # query parameters
3080
3741
  query_params = {}
@@ -3133,7 +3794,7 @@ module DocuSign_eSign
3133
3794
  # verify the required parameter 'envelope_id' is set
3134
3795
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_pages" if envelope_id.nil?
3135
3796
  # resource path
3136
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3797
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3137
3798
 
3138
3799
  # query parameters
3139
3800
  query_params = {}
@@ -3169,35 +3830,31 @@ module DocuSign_eSign
3169
3830
  return data, status_code, headers
3170
3831
  end
3171
3832
 
3172
- # Returns document visibility for the recipients
3833
+ # Return pdf blobs for Display Appliance
3173
3834
  #
3174
3835
  # @param account_id The external account number (int) or account ID Guid.
3175
3836
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3176
- # @param recipient_id The ID of the recipient being accessed.
3177
- # @return [DocumentVisibilityList]
3178
- def get_recipient_document_visibility(account_id, envelope_id, recipient_id)
3179
- data, _status_code, _headers = get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id)
3837
+ # @return [DisplayAppliancePdf]
3838
+ def get_pdf_blob(account_id, envelope_id)
3839
+ data, _status_code, _headers = get_pdf_blob_with_http_info(account_id, envelope_id)
3180
3840
  return data
3181
3841
  end
3182
3842
 
3183
- # Returns document visibility for the recipients
3843
+ # Return pdf blobs for Display Appliance
3184
3844
  #
3185
3845
  # @param account_id The external account number (int) or account ID Guid.
3186
3846
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3187
- # @param recipient_id The ID of the recipient being accessed.
3188
- # @return [Array<(DocumentVisibilityList, Fixnum, Hash)>] DocumentVisibilityList data, response status code and response headers
3189
- def get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id)
3847
+ # @return [Array<(DisplayAppliancePdf, Fixnum, Hash)>] DisplayAppliancePdf data, response status code and response headers
3848
+ def get_pdf_blob_with_http_info(account_id, envelope_id)
3190
3849
  if @api_client.config.debugging
3191
- @api_client.config.logger.debug "Calling API: EnvelopesApi.get_recipient_document_visibility ..."
3850
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_pdf_blob ..."
3192
3851
  end
3193
3852
  # verify the required parameter 'account_id' is set
3194
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_recipient_document_visibility" if account_id.nil?
3853
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_pdf_blob" if account_id.nil?
3195
3854
  # verify the required parameter 'envelope_id' is set
3196
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_recipient_document_visibility" if envelope_id.nil?
3197
- # verify the required parameter 'recipient_id' is set
3198
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_recipient_document_visibility" if recipient_id.nil?
3855
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_pdf_blob" if envelope_id.nil?
3199
3856
  # resource path
3200
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
3857
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3201
3858
 
3202
3859
  # query parameters
3203
3860
  query_params = {}
@@ -3219,33 +3876,90 @@ module DocuSign_eSign
3219
3876
  :form_params => form_params,
3220
3877
  :body => post_body,
3221
3878
  :auth_names => auth_names,
3222
- :return_type => 'DocumentVisibilityList')
3879
+ :return_type => 'DisplayAppliancePdf')
3223
3880
  if @api_client.config.debugging
3224
- @api_client.config.logger.debug "API called: EnvelopesApi#get_recipient_document_visibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3881
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_pdf_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3225
3882
  end
3226
3883
  return data, status_code, headers
3227
3884
  end
3228
3885
 
3229
- # Gets the initials image for a user.
3230
- # Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
3886
+ # Returns document visibility for the recipients
3887
+ #
3231
3888
  # @param account_id The external account number (int) or account ID Guid.
3232
3889
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3233
3890
  # @param recipient_id The ID of the recipient being accessed.
3234
- # @param DocuSign_eSign::GetRecipientInitialsImageOptions Options for modifying the behavior of the function.
3235
- # @return [File]
3236
- def get_recipient_initials_image(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientInitialsImageOptions.default)
3237
- data, _status_code, _headers = get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, options)
3891
+ # @return [DocumentVisibilityList]
3892
+ def get_recipient_document_visibility(account_id, envelope_id, recipient_id)
3893
+ data, _status_code, _headers = get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id)
3238
3894
  return data
3239
3895
  end
3240
3896
 
3241
- # Gets the initials image for a user.
3242
- # Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user&#39;s user id and the user must be a member of the account. The &#x60;signatureIdOrName&#x60; paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \&quot;Bob Smith\&quot; to \&quot;Bob%20Smith\&quot; Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
3897
+ # Returns document visibility for the recipients
3898
+ #
3243
3899
  # @param account_id The external account number (int) or account ID Guid.
3244
3900
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
3245
3901
  # @param recipient_id The ID of the recipient being accessed.
3246
- # @param DocuSign_eSign::GetRecipientInitialsImageOptions Options for modifying the behavior of the function.
3247
- # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
3248
- def get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientInitialsImageOptions.default)
3902
+ # @return [Array<(DocumentVisibilityList, Fixnum, Hash)>] DocumentVisibilityList data, response status code and response headers
3903
+ def get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id)
3904
+ if @api_client.config.debugging
3905
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_recipient_document_visibility ..."
3906
+ end
3907
+ # verify the required parameter 'account_id' is set
3908
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_recipient_document_visibility" if account_id.nil?
3909
+ # verify the required parameter 'envelope_id' is set
3910
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_recipient_document_visibility" if envelope_id.nil?
3911
+ # verify the required parameter 'recipient_id' is set
3912
+ fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_recipient_document_visibility" if recipient_id.nil?
3913
+ # resource path
3914
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
3915
+
3916
+ # query parameters
3917
+ query_params = {}
3918
+
3919
+ # header parameters
3920
+ header_params = {}
3921
+ # HTTP header 'Accept' (if needed)
3922
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3923
+
3924
+ # form parameters
3925
+ form_params = {}
3926
+
3927
+ # http body (model)
3928
+ post_body = nil
3929
+ auth_names = []
3930
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3931
+ :header_params => header_params,
3932
+ :query_params => query_params,
3933
+ :form_params => form_params,
3934
+ :body => post_body,
3935
+ :auth_names => auth_names,
3936
+ :return_type => 'DocumentVisibilityList')
3937
+ if @api_client.config.debugging
3938
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_recipient_document_visibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3939
+ end
3940
+ return data, status_code, headers
3941
+ end
3942
+
3943
+ # Gets the initials image for a user.
3944
+ # Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
3945
+ # @param account_id The external account number (int) or account ID Guid.
3946
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3947
+ # @param recipient_id The ID of the recipient being accessed.
3948
+ # @param DocuSign_eSign::GetRecipientInitialsImageOptions Options for modifying the behavior of the function.
3949
+ # @return [File]
3950
+ def get_recipient_initials_image(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientInitialsImageOptions.default)
3951
+ data, _status_code, _headers = get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, options)
3952
+ return data
3953
+ end
3954
+
3955
+ # Gets the initials image for a user.
3956
+ # Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user&#39;s user id and the user must be a member of the account. The &#x60;signatureIdOrName&#x60; paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \&quot;Bob Smith\&quot; to \&quot;Bob%20Smith\&quot; Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
3957
+ # @param account_id The external account number (int) or account ID Guid.
3958
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3959
+ # @param recipient_id The ID of the recipient being accessed.
3960
+ # @param DocuSign_eSign::GetRecipientInitialsImageOptions Options for modifying the behavior of the function.
3961
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
3962
+ def get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientInitialsImageOptions.default)
3249
3963
  if @api_client.config.debugging
3250
3964
  @api_client.config.logger.debug "Calling API: EnvelopesApi.get_recipient_initials_image ..."
3251
3965
  end
@@ -3256,7 +3970,7 @@ module DocuSign_eSign
3256
3970
  # verify the required parameter 'recipient_id' is set
3257
3971
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_recipient_initials_image" if recipient_id.nil?
3258
3972
  # resource path
3259
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
3973
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
3260
3974
 
3261
3975
  # query parameters
3262
3976
  query_params = {}
@@ -3314,7 +4028,7 @@ module DocuSign_eSign
3314
4028
  # verify the required parameter 'recipient_id' is set
3315
4029
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_recipient_signature" if recipient_id.nil?
3316
4030
  # resource path
3317
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
4031
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
3318
4032
 
3319
4033
  # query parameters
3320
4034
  query_params = {}
@@ -3373,7 +4087,7 @@ module DocuSign_eSign
3373
4087
  # verify the required parameter 'recipient_id' is set
3374
4088
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_recipient_signature_image" if recipient_id.nil?
3375
4089
  # resource path
3376
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
4090
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
3377
4091
 
3378
4092
  # query parameters
3379
4093
  query_params = {}
@@ -3403,6 +4117,111 @@ module DocuSign_eSign
3403
4117
  return data, status_code, headers
3404
4118
  end
3405
4119
 
4120
+ # Return signer attachment information for Display Appliance
4121
+ #
4122
+ # @param account_id The external account number (int) or account ID Guid.
4123
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4124
+ # @return [DisplayApplianceSignerAttachment]
4125
+ def get_signer_attachment(account_id, envelope_id)
4126
+ data, _status_code, _headers = get_signer_attachment_with_http_info(account_id, envelope_id)
4127
+ return data
4128
+ end
4129
+
4130
+ # Return signer attachment information for Display Appliance
4131
+ #
4132
+ # @param account_id The external account number (int) or account ID Guid.
4133
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4134
+ # @return [Array<(DisplayApplianceSignerAttachment, Fixnum, Hash)>] DisplayApplianceSignerAttachment data, response status code and response headers
4135
+ def get_signer_attachment_with_http_info(account_id, envelope_id)
4136
+ if @api_client.config.debugging
4137
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_signer_attachment ..."
4138
+ end
4139
+ # verify the required parameter 'account_id' is set
4140
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_signer_attachment" if account_id.nil?
4141
+ # verify the required parameter 'envelope_id' is set
4142
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_signer_attachment" if envelope_id.nil?
4143
+ # resource path
4144
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/signer_attachment_info".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4145
+
4146
+ # query parameters
4147
+ query_params = {}
4148
+
4149
+ # header parameters
4150
+ header_params = {}
4151
+ # HTTP header 'Accept' (if needed)
4152
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4153
+
4154
+ # form parameters
4155
+ form_params = {}
4156
+
4157
+ # http body (model)
4158
+ post_body = nil
4159
+ auth_names = []
4160
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4161
+ :header_params => header_params,
4162
+ :query_params => query_params,
4163
+ :form_params => form_params,
4164
+ :body => post_body,
4165
+ :auth_names => auth_names,
4166
+ :return_type => 'DisplayApplianceSignerAttachment')
4167
+ if @api_client.config.debugging
4168
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_signer_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4169
+ end
4170
+ return data, status_code, headers
4171
+ end
4172
+
4173
+ # Get encrypted tabs blob.
4174
+ #
4175
+ # @param account_id The external account number (int) or account ID Guid.
4176
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4177
+ # @return [nil]
4178
+ def get_tabs_blob(account_id, envelope_id)
4179
+ get_tabs_blob_with_http_info(account_id, envelope_id)
4180
+ return nil
4181
+ end
4182
+
4183
+ # Get encrypted tabs blob.
4184
+ #
4185
+ # @param account_id The external account number (int) or account ID Guid.
4186
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
4187
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
4188
+ def get_tabs_blob_with_http_info(account_id, envelope_id)
4189
+ if @api_client.config.debugging
4190
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_tabs_blob ..."
4191
+ end
4192
+ # verify the required parameter 'account_id' is set
4193
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_tabs_blob" if account_id.nil?
4194
+ # verify the required parameter 'envelope_id' is set
4195
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_tabs_blob" if envelope_id.nil?
4196
+ # resource path
4197
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4198
+
4199
+ # query parameters
4200
+ query_params = {}
4201
+
4202
+ # header parameters
4203
+ header_params = {}
4204
+ # HTTP header 'Accept' (if needed)
4205
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4206
+
4207
+ # form parameters
4208
+ form_params = {}
4209
+
4210
+ # http body (model)
4211
+ post_body = nil
4212
+ auth_names = []
4213
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4214
+ :header_params => header_params,
4215
+ :query_params => query_params,
4216
+ :form_params => form_params,
4217
+ :body => post_body,
4218
+ :auth_names => auth_names)
4219
+ if @api_client.config.debugging
4220
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_tabs_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4221
+ end
4222
+ return data, status_code, headers
4223
+ end
4224
+
3406
4225
  # Returns document visibility for the recipients
3407
4226
  #
3408
4227
  # @param account_id The external account number (int) or account ID Guid.
@@ -3431,7 +4250,7 @@ module DocuSign_eSign
3431
4250
  # verify the required parameter 'template_id' is set
3432
4251
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_recipient_document_visibility" if template_id.nil?
3433
4252
  # resource path
3434
- local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
4253
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
3435
4254
 
3436
4255
  # query parameters
3437
4256
  query_params = {}
@@ -3484,7 +4303,7 @@ module DocuSign_eSign
3484
4303
  # verify the required parameter 'envelope_id' is set
3485
4304
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_audit_events" if envelope_id.nil?
3486
4305
  # resource path
3487
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/audit_events".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4306
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3488
4307
 
3489
4308
  # query parameters
3490
4309
  query_params = {}
@@ -3537,7 +4356,7 @@ module DocuSign_eSign
3537
4356
  # verify the required parameter 'envelope_id' is set
3538
4357
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_custom_fields" if envelope_id.nil?
3539
4358
  # resource path
3540
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4359
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3541
4360
 
3542
4361
  # query parameters
3543
4362
  query_params = {}
@@ -3594,7 +4413,7 @@ module DocuSign_eSign
3594
4413
  # verify the required parameter 'envelope_id' is set
3595
4414
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_document_fields" if envelope_id.nil?
3596
4415
  # resource path
3597
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4416
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3598
4417
 
3599
4418
  # query parameters
3600
4419
  query_params = {}
@@ -3649,11 +4468,15 @@ module DocuSign_eSign
3649
4468
  # verify the required parameter 'envelope_id' is set
3650
4469
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_documents" if envelope_id.nil?
3651
4470
  # resource path
3652
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4471
+ 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)
3653
4472
 
3654
4473
  # query parameters
3655
4474
  query_params = {}
3656
- query_params[:'include_document_size'] = options.include_document_size if !options.include_document_size.nil?
4475
+ query_params[:'documents_by_userid'] = options.documents_by_userid if !options.documents_by_userid.nil?
4476
+ query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
4477
+ query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
4478
+ query_params[:'recipient_id'] = options.recipient_id if !options.recipient_id.nil?
4479
+ query_params[:'shared_user_id'] = options.shared_user_id if !options.shared_user_id.nil?
3657
4480
 
3658
4481
  # header parameters
3659
4482
  header_params = {}
@@ -3705,12 +4528,13 @@ module DocuSign_eSign
3705
4528
  # verify the required parameter 'envelope_id' is set
3706
4529
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_recipients" if envelope_id.nil?
3707
4530
  # resource path
3708
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4531
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3709
4532
 
3710
4533
  # query parameters
3711
4534
  query_params = {}
3712
4535
  query_params[:'include_anchor_tab_locations'] = options.include_anchor_tab_locations if !options.include_anchor_tab_locations.nil?
3713
4536
  query_params[:'include_extended'] = options.include_extended if !options.include_extended.nil?
4537
+ query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
3714
4538
  query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
3715
4539
 
3716
4540
  # header parameters
@@ -3761,7 +4585,7 @@ module DocuSign_eSign
3761
4585
  # verify the required parameter 'account_id' is set
3762
4586
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_status" if account_id.nil?
3763
4587
  # resource path
3764
- local_var_path = "/v2/accounts/{accountId}/envelopes/status".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
4588
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/status".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
3765
4589
 
3766
4590
  # query parameters
3767
4591
  query_params = {}
@@ -3824,22 +4648,39 @@ module DocuSign_eSign
3824
4648
  # verify the required parameter 'account_id' is set
3825
4649
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_status_changes" if account_id.nil?
3826
4650
  # resource path
3827
- local_var_path = "/v2/accounts/{accountId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
4651
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
3828
4652
 
3829
4653
  # query parameters
3830
4654
  query_params = {}
3831
4655
  query_params[:'ac_status'] = options.ac_status if !options.ac_status.nil?
3832
4656
  query_params[:'block'] = options.block if !options.block.nil?
4657
+ query_params[:'cdse_mode'] = options.cdse_mode if !options.cdse_mode.nil?
4658
+ query_params[:'continuation_token'] = options.continuation_token if !options.continuation_token.nil?
3833
4659
  query_params[:'count'] = options.count if !options.count.nil?
3834
4660
  query_params[:'custom_field'] = options.custom_field if !options.custom_field.nil?
3835
4661
  query_params[:'email'] = options.email if !options.email.nil?
3836
4662
  query_params[:'envelope_ids'] = options.envelope_ids if !options.envelope_ids.nil?
4663
+ query_params[:'exclude'] = options.exclude if !options.exclude.nil?
4664
+ query_params[:'folder_ids'] = options.folder_ids if !options.folder_ids.nil?
4665
+ query_params[:'folder_types'] = options.folder_types if !options.folder_types.nil?
3837
4666
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
3838
4667
  query_params[:'from_to_status'] = options.from_to_status if !options.from_to_status.nil?
4668
+ query_params[:'include'] = options.include if !options.include.nil?
4669
+ query_params[:'include_purge_information'] = options.include_purge_information if !options.include_purge_information.nil?
4670
+ query_params[:'intersecting_folder_ids'] = options.intersecting_folder_ids if !options.intersecting_folder_ids.nil?
4671
+ query_params[:'last_queried_date'] = options.last_queried_date if !options.last_queried_date.nil?
4672
+ query_params[:'order'] = options.order if !options.order.nil?
4673
+ query_params[:'order_by'] = options.order_by if !options.order_by.nil?
4674
+ query_params[:'powerformids'] = options.powerformids if !options.powerformids.nil?
4675
+ query_params[:'query_budget'] = options.query_budget if !options.query_budget.nil?
4676
+ query_params[:'requester_date_format'] = options.requester_date_format if !options.requester_date_format.nil?
4677
+ query_params[:'search_text'] = options.search_text if !options.search_text.nil?
3839
4678
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
3840
4679
  query_params[:'status'] = options.status if !options.status.nil?
3841
4680
  query_params[:'to_date'] = options.to_date if !options.to_date.nil?
3842
4681
  query_params[:'transaction_ids'] = options.transaction_ids if !options.transaction_ids.nil?
4682
+ query_params[:'user_filter'] = options.user_filter if !options.user_filter.nil?
4683
+ query_params[:'user_id'] = options.user_id if !options.user_id.nil?
3843
4684
  query_params[:'user_name'] = options.user_name if !options.user_name.nil?
3844
4685
 
3845
4686
  # header parameters
@@ -3896,7 +4737,7 @@ module DocuSign_eSign
3896
4737
  # verify the required parameter 'recipient_id' is set
3897
4738
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.list_tabs" if recipient_id.nil?
3898
4739
  # resource path
3899
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
4740
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
3900
4741
 
3901
4742
  # query parameters
3902
4743
  query_params = {}
@@ -3953,7 +4794,7 @@ module DocuSign_eSign
3953
4794
  # verify the required parameter 'envelope_id' is set
3954
4795
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_templates" if envelope_id.nil?
3955
4796
  # resource path
3956
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4797
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
3957
4798
 
3958
4799
  # query parameters
3959
4800
  query_params = {}
@@ -4013,7 +4854,7 @@ module DocuSign_eSign
4013
4854
  # verify the required parameter 'envelope_id' is set
4014
4855
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_templates_for_document" if envelope_id.nil?
4015
4856
  # resource path
4016
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4857
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4017
4858
 
4018
4859
  # query parameters
4019
4860
  query_params = {}
@@ -4073,7 +4914,7 @@ module DocuSign_eSign
4073
4914
  # verify the required parameter 'envelope_id' is set
4074
4915
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.put_attachment" if envelope_id.nil?
4075
4916
  # resource path
4076
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4917
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4077
4918
 
4078
4919
  # query parameters
4079
4920
  query_params = {}
@@ -4128,7 +4969,7 @@ module DocuSign_eSign
4128
4969
  # verify the required parameter 'envelope_id' is set
4129
4970
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.put_attachments" if envelope_id.nil?
4130
4971
  # resource path
4131
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4972
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4132
4973
 
4133
4974
  # query parameters
4134
4975
  query_params = {}
@@ -4191,7 +5032,7 @@ module DocuSign_eSign
4191
5032
  # verify the required parameter 'page_number' is set
4192
5033
  fail ArgumentError, "Missing the required parameter 'page_number' when calling EnvelopesApi.rotate_document_page" if page_number.nil?
4193
5034
  # resource path
4194
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
5035
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
4195
5036
 
4196
5037
  # query parameters
4197
5038
  query_params = {}
@@ -4247,7 +5088,7 @@ module DocuSign_eSign
4247
5088
  # verify the required parameter 'envelope_id' is set
4248
5089
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update" if envelope_id.nil?
4249
5090
  # resource path
4250
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5091
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4251
5092
 
4252
5093
  # query parameters
4253
5094
  query_params = {}
@@ -4278,6 +5119,62 @@ module DocuSign_eSign
4278
5119
  return data, status_code, headers
4279
5120
  end
4280
5121
 
5122
+ # Update document information for Display Appliance
5123
+ #
5124
+ # @param account_id The external account number (int) or account ID Guid.
5125
+ # @param document_id The ID of the document being accessed.
5126
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5127
+ # @return [nil]
5128
+ def update_appliance_document(account_id, document_id, envelope_id)
5129
+ update_appliance_document_with_http_info(account_id, document_id, envelope_id)
5130
+ return nil
5131
+ end
5132
+
5133
+ # Update document information for Display Appliance
5134
+ #
5135
+ # @param account_id The external account number (int) or account ID Guid.
5136
+ # @param document_id The ID of the document being accessed.
5137
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5138
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
5139
+ def update_appliance_document_with_http_info(account_id, document_id, envelope_id)
5140
+ if @api_client.config.debugging
5141
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_appliance_document ..."
5142
+ end
5143
+ # verify the required parameter 'account_id' is set
5144
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_appliance_document" if account_id.nil?
5145
+ # verify the required parameter 'document_id' is set
5146
+ fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_appliance_document" if document_id.nil?
5147
+ # verify the required parameter 'envelope_id' is set
5148
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_appliance_document" if envelope_id.nil?
5149
+ # resource path
5150
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5151
+
5152
+ # query parameters
5153
+ query_params = {}
5154
+
5155
+ # header parameters
5156
+ header_params = {}
5157
+ # HTTP header 'Accept' (if needed)
5158
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5159
+
5160
+ # form parameters
5161
+ form_params = {}
5162
+
5163
+ # http body (model)
5164
+ post_body = nil
5165
+ auth_names = []
5166
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
5167
+ :header_params => header_params,
5168
+ :query_params => query_params,
5169
+ :form_params => form_params,
5170
+ :body => post_body,
5171
+ :auth_names => auth_names)
5172
+ if @api_client.config.debugging
5173
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_appliance_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5174
+ end
5175
+ return data, status_code, headers
5176
+ end
5177
+
4281
5178
  # Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
4282
5179
  #
4283
5180
  # @param account_id The external account number (int) or account ID Guid.
@@ -4304,7 +5201,7 @@ module DocuSign_eSign
4304
5201
  # verify the required parameter 'chunked_upload_id' is set
4305
5202
  fail ArgumentError, "Missing the required parameter 'chunked_upload_id' when calling EnvelopesApi.update_chunked_upload" if chunked_upload_id.nil?
4306
5203
  # resource path
4307
- local_var_path = "/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s)
5204
+ local_var_path = "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s)
4308
5205
 
4309
5206
  # query parameters
4310
5207
  query_params = {}
@@ -4364,7 +5261,7 @@ module DocuSign_eSign
4364
5261
  # verify the required parameter 'chunked_upload_part_seq' is set
4365
5262
  fail ArgumentError, "Missing the required parameter 'chunked_upload_part_seq' when calling EnvelopesApi.update_chunked_upload_part" if chunked_upload_part_seq.nil?
4366
5263
  # resource path
4367
- local_var_path = "/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s).sub('{' + 'chunkedUploadPartSeq' + '}', chunked_upload_part_seq.to_s)
5264
+ local_var_path = "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s).sub('{' + 'chunkedUploadPartSeq' + '}', chunked_upload_part_seq.to_s)
4368
5265
 
4369
5266
  # query parameters
4370
5267
  query_params = {}
@@ -4419,7 +5316,347 @@ module DocuSign_eSign
4419
5316
  # verify the required parameter 'envelope_id' is set
4420
5317
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_custom_fields" if envelope_id.nil?
4421
5318
  # resource path
4422
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5319
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5320
+
5321
+ # query parameters
5322
+ query_params = {}
5323
+
5324
+ # header parameters
5325
+ header_params = {}
5326
+ # HTTP header 'Accept' (if needed)
5327
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5328
+
5329
+ # form parameters
5330
+ form_params = {}
5331
+
5332
+ # http body (model)
5333
+ post_body = @api_client.object_to_http_body(custom_fields)
5334
+ auth_names = []
5335
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
5336
+ :header_params => header_params,
5337
+ :query_params => query_params,
5338
+ :form_params => form_params,
5339
+ :body => post_body,
5340
+ :auth_names => auth_names,
5341
+ :return_type => 'CustomFields')
5342
+ if @api_client.config.debugging
5343
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5344
+ end
5345
+ return data, status_code, headers
5346
+ end
5347
+
5348
+ # Adds a document to an existing draft envelope.
5349
+ # Adds a document to an existing draft envelope.
5350
+ # @param account_id The external account number (int) or account ID Guid.
5351
+ # @param document_id The ID of the document being accessed.
5352
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5353
+ # @return [EnvelopeDocument]
5354
+ def update_document(account_id, document_id, envelope_id)
5355
+ data, _status_code, _headers = update_document_with_http_info(account_id, document_id, envelope_id)
5356
+ return data
5357
+ end
5358
+
5359
+ # Adds a document to an existing draft envelope.
5360
+ # Adds a document to an existing draft envelope.
5361
+ # @param account_id The external account number (int) or account ID Guid.
5362
+ # @param document_id The ID of the document being accessed.
5363
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5364
+ # @return [Array<(EnvelopeDocument, Fixnum, Hash)>] EnvelopeDocument data, response status code and response headers
5365
+ def update_document_with_http_info(account_id, document_id, envelope_id)
5366
+ if @api_client.config.debugging
5367
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document ..."
5368
+ end
5369
+ # verify the required parameter 'account_id' is set
5370
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_document" if account_id.nil?
5371
+ # verify the required parameter 'document_id' is set
5372
+ fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document" if document_id.nil?
5373
+ # verify the required parameter 'envelope_id' is set
5374
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document" if envelope_id.nil?
5375
+ # resource path
5376
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5377
+
5378
+ # query parameters
5379
+ query_params = {}
5380
+
5381
+ # header parameters
5382
+ header_params = {}
5383
+ # HTTP header 'Accept' (if needed)
5384
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5385
+
5386
+ # form parameters
5387
+ form_params = {}
5388
+
5389
+ # http body (model)
5390
+ post_body = nil
5391
+ auth_names = []
5392
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
5393
+ :header_params => header_params,
5394
+ :query_params => query_params,
5395
+ :form_params => form_params,
5396
+ :body => post_body,
5397
+ :auth_names => auth_names,
5398
+ :return_type => 'EnvelopeDocument')
5399
+ if @api_client.config.debugging
5400
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5401
+ end
5402
+ return data, status_code, headers
5403
+ end
5404
+
5405
+ # Updates existing custom document fields in an existing envelope document.
5406
+ # Updates existing custom document fields in an existing envelope document.
5407
+ # @param account_id The external account number (int) or account ID Guid.
5408
+ # @param document_id The ID of the document being accessed.
5409
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5410
+ # @param document_fields_information (optional parameter)
5411
+ # @return [DocumentFieldsInformation]
5412
+ def update_document_fields(account_id, document_id, envelope_id, document_fields_information)
5413
+ data, _status_code, _headers = update_document_fields_with_http_info(account_id, document_id, envelope_id, document_fields_information)
5414
+ return data
5415
+ end
5416
+
5417
+ # Updates existing custom document fields in an existing envelope document.
5418
+ # Updates existing custom document fields in an existing envelope document.
5419
+ # @param account_id The external account number (int) or account ID Guid.
5420
+ # @param document_id The ID of the document being accessed.
5421
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5422
+ # @param document_fields_information (optional parameter)
5423
+ # @return [Array<(DocumentFieldsInformation, Fixnum, Hash)>] DocumentFieldsInformation data, response status code and response headers
5424
+ def update_document_fields_with_http_info(account_id, document_id, envelope_id, document_fields_information)
5425
+ if @api_client.config.debugging
5426
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document_fields ..."
5427
+ end
5428
+ # verify the required parameter 'account_id' is set
5429
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_document_fields" if account_id.nil?
5430
+ # verify the required parameter 'document_id' is set
5431
+ fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document_fields" if document_id.nil?
5432
+ # verify the required parameter 'envelope_id' is set
5433
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document_fields" if envelope_id.nil?
5434
+ # resource path
5435
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5436
+
5437
+ # query parameters
5438
+ query_params = {}
5439
+
5440
+ # header parameters
5441
+ header_params = {}
5442
+ # HTTP header 'Accept' (if needed)
5443
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5444
+
5445
+ # form parameters
5446
+ form_params = {}
5447
+
5448
+ # http body (model)
5449
+ post_body = @api_client.object_to_http_body(document_fields_information)
5450
+ auth_names = []
5451
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
5452
+ :header_params => header_params,
5453
+ :query_params => query_params,
5454
+ :form_params => form_params,
5455
+ :body => post_body,
5456
+ :auth_names => auth_names,
5457
+ :return_type => 'DocumentFieldsInformation')
5458
+ if @api_client.config.debugging
5459
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5460
+ end
5461
+ return data, status_code, headers
5462
+ end
5463
+
5464
+ # Updates the tabs for an envelope document
5465
+ #
5466
+ # @param account_id The external account number (int) or account ID Guid.
5467
+ # @param document_id The ID of the document being accessed.
5468
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5469
+ # @param tabs (optional parameter)
5470
+ # @return [Tabs]
5471
+ def update_document_tabs(account_id, document_id, envelope_id, tabs)
5472
+ data, _status_code, _headers = update_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs)
5473
+ return data
5474
+ end
5475
+
5476
+ # Updates the tabs for an envelope document
5477
+ #
5478
+ # @param account_id The external account number (int) or account ID Guid.
5479
+ # @param document_id The ID of the document being accessed.
5480
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5481
+ # @param tabs (optional parameter)
5482
+ # @return [Array<(Tabs, Fixnum, Hash)>] Tabs data, response status code and response headers
5483
+ def update_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs)
5484
+ if @api_client.config.debugging
5485
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document_tabs ..."
5486
+ end
5487
+ # verify the required parameter 'account_id' is set
5488
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_document_tabs" if account_id.nil?
5489
+ # verify the required parameter 'document_id' is set
5490
+ fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document_tabs" if document_id.nil?
5491
+ # verify the required parameter 'envelope_id' is set
5492
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document_tabs" if envelope_id.nil?
5493
+ # resource path
5494
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5495
+
5496
+ # query parameters
5497
+ query_params = {}
5498
+
5499
+ # header parameters
5500
+ header_params = {}
5501
+ # HTTP header 'Accept' (if needed)
5502
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5503
+
5504
+ # form parameters
5505
+ form_params = {}
5506
+
5507
+ # http body (model)
5508
+ post_body = @api_client.object_to_http_body(tabs)
5509
+ auth_names = []
5510
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
5511
+ :header_params => header_params,
5512
+ :query_params => query_params,
5513
+ :form_params => form_params,
5514
+ :body => post_body,
5515
+ :auth_names => auth_names,
5516
+ :return_type => 'Tabs')
5517
+ if @api_client.config.debugging
5518
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5519
+ end
5520
+ return data, status_code, headers
5521
+ end
5522
+
5523
+ # Adds one or more documents to an existing envelope document.
5524
+ # Adds one or more documents to an existing envelope document.
5525
+ # @param account_id The external account number (int) or account ID Guid.
5526
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5527
+ # @param envelope_definition (optional parameter)
5528
+ # @return [EnvelopeDocumentsResult]
5529
+ def update_documents(account_id, envelope_id, envelope_definition)
5530
+ data, _status_code, _headers = update_documents_with_http_info(account_id, envelope_id, envelope_definition)
5531
+ return data
5532
+ end
5533
+
5534
+ # Adds one or more documents to an existing envelope document.
5535
+ # Adds one or more documents to an existing envelope document.
5536
+ # @param account_id The external account number (int) or account ID Guid.
5537
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5538
+ # @param envelope_definition (optional parameter)
5539
+ # @return [Array<(EnvelopeDocumentsResult, Fixnum, Hash)>] EnvelopeDocumentsResult data, response status code and response headers
5540
+ def update_documents_with_http_info(account_id, envelope_id, envelope_definition)
5541
+ if @api_client.config.debugging
5542
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_documents ..."
5543
+ end
5544
+ # verify the required parameter 'account_id' is set
5545
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_documents" if account_id.nil?
5546
+ # verify the required parameter 'envelope_id' is set
5547
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_documents" if envelope_id.nil?
5548
+ # resource path
5549
+ 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)
5550
+
5551
+ # query parameters
5552
+ query_params = {}
5553
+
5554
+ # header parameters
5555
+ header_params = {}
5556
+ # HTTP header 'Accept' (if needed)
5557
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5558
+
5559
+ # form parameters
5560
+ form_params = {}
5561
+
5562
+ # http body (model)
5563
+ post_body = @api_client.object_to_http_body(envelope_definition)
5564
+ auth_names = []
5565
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
5566
+ :header_params => header_params,
5567
+ :query_params => query_params,
5568
+ :form_params => form_params,
5569
+ :body => post_body,
5570
+ :auth_names => auth_names,
5571
+ :return_type => 'EnvelopeDocumentsResult')
5572
+ if @api_client.config.debugging
5573
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5574
+ end
5575
+ return data, status_code, headers
5576
+ end
5577
+
5578
+ # Updates the email setting overrides for an envelope.
5579
+ # 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.
5580
+ # @param account_id The external account number (int) or account ID Guid.
5581
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5582
+ # @param email_settings (optional parameter)
5583
+ # @return [EmailSettings]
5584
+ def update_email_settings(account_id, envelope_id, email_settings)
5585
+ data, _status_code, _headers = update_email_settings_with_http_info(account_id, envelope_id, email_settings)
5586
+ return data
5587
+ end
5588
+
5589
+ # Updates the email setting overrides for an envelope.
5590
+ # 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.
5591
+ # @param account_id The external account number (int) or account ID Guid.
5592
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5593
+ # @param email_settings (optional parameter)
5594
+ # @return [Array<(EmailSettings, Fixnum, Hash)>] EmailSettings data, response status code and response headers
5595
+ def update_email_settings_with_http_info(account_id, envelope_id, email_settings)
5596
+ if @api_client.config.debugging
5597
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_email_settings ..."
5598
+ end
5599
+ # verify the required parameter 'account_id' is set
5600
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_email_settings" if account_id.nil?
5601
+ # verify the required parameter 'envelope_id' is set
5602
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_email_settings" if envelope_id.nil?
5603
+ # resource path
5604
+ 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)
5605
+
5606
+ # query parameters
5607
+ query_params = {}
5608
+
5609
+ # header parameters
5610
+ header_params = {}
5611
+ # HTTP header 'Accept' (if needed)
5612
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5613
+
5614
+ # form parameters
5615
+ form_params = {}
5616
+
5617
+ # http body (model)
5618
+ post_body = @api_client.object_to_http_body(email_settings)
5619
+ auth_names = []
5620
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
5621
+ :header_params => header_params,
5622
+ :query_params => query_params,
5623
+ :form_params => form_params,
5624
+ :body => post_body,
5625
+ :auth_names => auth_names,
5626
+ :return_type => 'EmailSettings')
5627
+ if @api_client.config.debugging
5628
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_email_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5629
+ end
5630
+ return data, status_code, headers
5631
+ end
5632
+
5633
+ # Update an envelope transfer rule for an account.
5634
+ #
5635
+ # @param account_id The external account number (int) or account ID Guid.
5636
+ # @param envelope_transfer_rule_id
5637
+ # @param envelope_transfer_rule (optional parameter)
5638
+ # @return [EnvelopeTransferRule]
5639
+ def update_envelope_transfer_rule(account_id, envelope_transfer_rule_id, envelope_transfer_rule)
5640
+ data, _status_code, _headers = update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, envelope_transfer_rule)
5641
+ return data
5642
+ end
5643
+
5644
+ # Update an envelope transfer rule for an account.
5645
+ #
5646
+ # @param account_id The external account number (int) or account ID Guid.
5647
+ # @param envelope_transfer_rule_id
5648
+ # @param envelope_transfer_rule (optional parameter)
5649
+ # @return [Array<(EnvelopeTransferRule, Fixnum, Hash)>] EnvelopeTransferRule data, response status code and response headers
5650
+ def update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, envelope_transfer_rule)
5651
+ if @api_client.config.debugging
5652
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_transfer_rule ..."
5653
+ end
5654
+ # verify the required parameter 'account_id' is set
5655
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_transfer_rule" if account_id.nil?
5656
+ # verify the required parameter 'envelope_transfer_rule_id' is set
5657
+ fail ArgumentError, "Missing the required parameter 'envelope_transfer_rule_id' when calling EnvelopesApi.update_envelope_transfer_rule" if envelope_transfer_rule_id.nil?
5658
+ # resource path
5659
+ 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)
4423
5660
 
4424
5661
  # query parameters
4425
5662
  query_params = {}
@@ -4433,7 +5670,7 @@ module DocuSign_eSign
4433
5670
  form_params = {}
4434
5671
 
4435
5672
  # http body (model)
4436
- post_body = @api_client.object_to_http_body(custom_fields)
5673
+ post_body = @api_client.object_to_http_body(envelope_transfer_rule)
4437
5674
  auth_names = []
4438
5675
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4439
5676
  :header_params => header_params,
@@ -4441,48 +5678,39 @@ module DocuSign_eSign
4441
5678
  :form_params => form_params,
4442
5679
  :body => post_body,
4443
5680
  :auth_names => auth_names,
4444
- :return_type => 'CustomFields')
5681
+ :return_type => 'EnvelopeTransferRule')
4445
5682
  if @api_client.config.debugging
4446
- @api_client.config.logger.debug "API called: EnvelopesApi#update_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5683
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_transfer_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4447
5684
  end
4448
5685
  return data, status_code, headers
4449
5686
  end
4450
5687
 
4451
- # Adds a document to an existing draft envelope.
4452
- # Adds a document to an existing draft envelope.
5688
+ # Update envelope transfer rules for an account.
5689
+ #
4453
5690
  # @param account_id The external account number (int) or account ID Guid.
4454
- # @param document_id The ID of the document being accessed.
4455
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
4456
- # @param DocuSign_eSign::UpdateDocumentOptions Options for modifying the behavior of the function.
4457
- # @return [nil]
4458
- def update_document(account_id, document_id, envelope_id, options = DocuSign_eSign::UpdateDocumentOptions.default)
4459
- update_document_with_http_info(account_id, document_id, envelope_id, options)
4460
- return nil
5691
+ # @param envelope_transfer_rule_information (optional parameter)
5692
+ # @return [EnvelopeTransferRuleInformation]
5693
+ def update_envelope_transfer_rules(account_id, envelope_transfer_rule_information)
5694
+ data, _status_code, _headers = update_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_information)
5695
+ return data
4461
5696
  end
4462
5697
 
4463
- # Adds a document to an existing draft envelope.
4464
- # Adds a document to an existing draft envelope.
5698
+ # Update envelope transfer rules for an account.
5699
+ #
4465
5700
  # @param account_id The external account number (int) or account ID Guid.
4466
- # @param document_id The ID of the document being accessed.
4467
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
4468
- # @param DocuSign_eSign::UpdateDocumentOptions Options for modifying the behavior of the function.
4469
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
4470
- def update_document_with_http_info(account_id, document_id, envelope_id, options = DocuSign_eSign::UpdateDocumentOptions.default)
5701
+ # @param envelope_transfer_rule_information (optional parameter)
5702
+ # @return [Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>] EnvelopeTransferRuleInformation data, response status code and response headers
5703
+ def update_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_information)
4471
5704
  if @api_client.config.debugging
4472
- @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document ..."
5705
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_transfer_rules ..."
4473
5706
  end
4474
5707
  # verify the required parameter 'account_id' is set
4475
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_document" if account_id.nil?
4476
- # verify the required parameter 'document_id' is set
4477
- fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document" if document_id.nil?
4478
- # verify the required parameter 'envelope_id' is set
4479
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document" if envelope_id.nil?
5708
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_transfer_rules" if account_id.nil?
4480
5709
  # resource path
4481
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5710
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
4482
5711
 
4483
5712
  # query parameters
4484
5713
  query_params = {}
4485
- query_params[:'apply_document_fields'] = options.apply_document_fields if !options.apply_document_fields.nil?
4486
5714
 
4487
5715
  # header parameters
4488
5716
  header_params = {}
@@ -4493,51 +5721,48 @@ module DocuSign_eSign
4493
5721
  form_params = {}
4494
5722
 
4495
5723
  # http body (model)
4496
- post_body = nil
5724
+ post_body = @api_client.object_to_http_body(envelope_transfer_rule_information)
4497
5725
  auth_names = []
4498
5726
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4499
5727
  :header_params => header_params,
4500
5728
  :query_params => query_params,
4501
5729
  :form_params => form_params,
4502
5730
  :body => post_body,
4503
- :auth_names => auth_names)
5731
+ :auth_names => auth_names,
5732
+ :return_type => 'EnvelopeTransferRuleInformation')
4504
5733
  if @api_client.config.debugging
4505
- @api_client.config.logger.debug "API called: EnvelopesApi#update_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5734
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_transfer_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4506
5735
  end
4507
5736
  return data, status_code, headers
4508
5737
  end
4509
5738
 
4510
- # Updates existing custom document fields in an existing envelope document.
4511
- # Updates existing custom document fields in an existing envelope document.
5739
+ # Updates an envelope lock.
5740
+ # 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.
4512
5741
  # @param account_id The external account number (int) or account ID Guid.
4513
- # @param document_id The ID of the document being accessed.
4514
5742
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4515
- # @param document_fields_information (optional parameter)
4516
- # @return [DocumentFieldsInformation]
4517
- def update_document_fields(account_id, document_id, envelope_id, document_fields_information)
4518
- data, _status_code, _headers = update_document_fields_with_http_info(account_id, document_id, envelope_id, document_fields_information)
5743
+ # @param lock_request (optional parameter)
5744
+ # @return [LockInformation]
5745
+ def update_lock(account_id, envelope_id, lock_request)
5746
+ data, _status_code, _headers = update_lock_with_http_info(account_id, envelope_id, lock_request)
4519
5747
  return data
4520
5748
  end
4521
5749
 
4522
- # Updates existing custom document fields in an existing envelope document.
4523
- # Updates existing custom document fields in an existing envelope document.
5750
+ # Updates an envelope lock.
5751
+ # Updates the lock duration time or update the &#x60;lockedByApp&#x60; property information for the specified envelope. The user and integrator key must match the user specified by the &#x60;lockByUser&#x60; property and integrator key information and the &#x60;X-DocuSign-Edit&#x60; header must be included or an error will be generated.
4524
5752
  # @param account_id The external account number (int) or account ID Guid.
4525
- # @param document_id The ID of the document being accessed.
4526
5753
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4527
- # @param document_fields_information (optional parameter)
4528
- # @return [Array<(DocumentFieldsInformation, Fixnum, Hash)>] DocumentFieldsInformation data, response status code and response headers
4529
- def update_document_fields_with_http_info(account_id, document_id, envelope_id, document_fields_information)
5754
+ # @param lock_request (optional parameter)
5755
+ # @return [Array<(LockInformation, Fixnum, Hash)>] LockInformation data, response status code and response headers
5756
+ def update_lock_with_http_info(account_id, envelope_id, lock_request)
4530
5757
  if @api_client.config.debugging
4531
- @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document_fields ..."
5758
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_lock ..."
4532
5759
  end
4533
5760
  # verify the required parameter 'account_id' is set
4534
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_document_fields" if account_id.nil?
4535
- # verify the required parameter 'document_id' is set
4536
- fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document_fields" if document_id.nil?
5761
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_lock" if account_id.nil?
4537
5762
  # verify the required parameter 'envelope_id' is set
4538
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document_fields" if envelope_id.nil?
5763
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_lock" if envelope_id.nil?
4539
5764
  # resource path
4540
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5765
+ 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)
4541
5766
 
4542
5767
  # query parameters
4543
5768
  query_params = {}
@@ -4551,7 +5776,7 @@ module DocuSign_eSign
4551
5776
  form_params = {}
4552
5777
 
4553
5778
  # http body (model)
4554
- post_body = @api_client.object_to_http_body(document_fields_information)
5779
+ post_body = @api_client.object_to_http_body(lock_request)
4555
5780
  auth_names = []
4556
5781
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4557
5782
  :header_params => header_params,
@@ -4559,47 +5784,43 @@ module DocuSign_eSign
4559
5784
  :form_params => form_params,
4560
5785
  :body => post_body,
4561
5786
  :auth_names => auth_names,
4562
- :return_type => 'DocumentFieldsInformation')
5787
+ :return_type => 'LockInformation')
4563
5788
  if @api_client.config.debugging
4564
- @api_client.config.logger.debug "API called: EnvelopesApi#update_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5789
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4565
5790
  end
4566
5791
  return data, status_code, headers
4567
5792
  end
4568
5793
 
4569
- # Adds one or more documents to an existing envelope document.
4570
- # Adds one or more documents to an existing envelope document.
5794
+ # Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
5795
+ #
4571
5796
  # @param account_id The external account number (int) or account ID Guid.
4572
5797
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4573
- # @param envelope_definition (optional parameter)
4574
- # @param DocuSign_eSign::UpdateDocumentsOptions Options for modifying the behavior of the function.
4575
- # @return [EnvelopeDocumentsResult]
4576
- def update_documents(account_id, envelope_id, envelope_definition, options = DocuSign_eSign::UpdateDocumentsOptions.default)
4577
- data, _status_code, _headers = update_documents_with_http_info(account_id, envelope_id, envelope_definition, options)
5798
+ # @param envelope_notification_request (optional parameter)
5799
+ # @return [Notification]
5800
+ def update_notification_settings(account_id, envelope_id, envelope_notification_request)
5801
+ data, _status_code, _headers = update_notification_settings_with_http_info(account_id, envelope_id, envelope_notification_request)
4578
5802
  return data
4579
5803
  end
4580
5804
 
4581
- # Adds one or more documents to an existing envelope document.
4582
- # Adds one or more documents to an existing envelope document.
5805
+ # Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
5806
+ #
4583
5807
  # @param account_id The external account number (int) or account ID Guid.
4584
5808
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4585
- # @param envelope_definition (optional parameter)
4586
- # @param DocuSign_eSign::UpdateDocumentsOptions Options for modifying the behavior of the function.
4587
- # @return [Array<(EnvelopeDocumentsResult, Fixnum, Hash)>] EnvelopeDocumentsResult data, response status code and response headers
4588
- def update_documents_with_http_info(account_id, envelope_id, envelope_definition, options = DocuSign_eSign::UpdateDocumentsOptions.default)
5809
+ # @param envelope_notification_request (optional parameter)
5810
+ # @return [Array<(Notification, Fixnum, Hash)>] Notification data, response status code and response headers
5811
+ def update_notification_settings_with_http_info(account_id, envelope_id, envelope_notification_request)
4589
5812
  if @api_client.config.debugging
4590
- @api_client.config.logger.debug "Calling API: EnvelopesApi.update_documents ..."
5813
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_notification_settings ..."
4591
5814
  end
4592
5815
  # verify the required parameter 'account_id' is set
4593
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_documents" if account_id.nil?
5816
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_notification_settings" if account_id.nil?
4594
5817
  # verify the required parameter 'envelope_id' is set
4595
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_documents" if envelope_id.nil?
5818
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_notification_settings" if envelope_id.nil?
4596
5819
  # resource path
4597
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5820
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4598
5821
 
4599
5822
  # query parameters
4600
5823
  query_params = {}
4601
- query_params[:'apply_document_fields'] = options.apply_document_fields if !options.apply_document_fields.nil?
4602
- query_params[:'persist_tabs'] = options.persist_tabs if !options.persist_tabs.nil?
4603
5824
 
4604
5825
  # header parameters
4605
5826
  header_params = {}
@@ -4610,7 +5831,7 @@ module DocuSign_eSign
4610
5831
  form_params = {}
4611
5832
 
4612
5833
  # http body (model)
4613
- post_body = @api_client.object_to_http_body(envelope_definition)
5834
+ post_body = @api_client.object_to_http_body(envelope_notification_request)
4614
5835
  auth_names = []
4615
5836
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4616
5837
  :header_params => header_params,
@@ -4618,40 +5839,38 @@ module DocuSign_eSign
4618
5839
  :form_params => form_params,
4619
5840
  :body => post_body,
4620
5841
  :auth_names => auth_names,
4621
- :return_type => 'EnvelopeDocumentsResult')
5842
+ :return_type => 'Notification')
4622
5843
  if @api_client.config.debugging
4623
- @api_client.config.logger.debug "API called: EnvelopesApi#update_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5844
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_notification_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4624
5845
  end
4625
5846
  return data, status_code, headers
4626
5847
  end
4627
5848
 
4628
- # Updates the email setting overrides for an envelope.
4629
- # 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.
5849
+ # Update page information for Display Appliance
5850
+ #
4630
5851
  # @param account_id The external account number (int) or account ID Guid.
4631
5852
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4632
- # @param email_settings (optional parameter)
4633
- # @return [EmailSettings]
4634
- def update_email_settings(account_id, envelope_id, email_settings)
4635
- data, _status_code, _headers = update_email_settings_with_http_info(account_id, envelope_id, email_settings)
4636
- return data
5853
+ # @return [nil]
5854
+ def update_page_info(account_id, envelope_id)
5855
+ update_page_info_with_http_info(account_id, envelope_id)
5856
+ return nil
4637
5857
  end
4638
5858
 
4639
- # Updates the email setting overrides for an envelope.
4640
- # 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.
5859
+ # Update page information for Display Appliance
5860
+ #
4641
5861
  # @param account_id The external account number (int) or account ID Guid.
4642
5862
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4643
- # @param email_settings (optional parameter)
4644
- # @return [Array<(EmailSettings, Fixnum, Hash)>] EmailSettings data, response status code and response headers
4645
- def update_email_settings_with_http_info(account_id, envelope_id, email_settings)
5863
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
5864
+ def update_page_info_with_http_info(account_id, envelope_id)
4646
5865
  if @api_client.config.debugging
4647
- @api_client.config.logger.debug "Calling API: EnvelopesApi.update_email_settings ..."
5866
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_page_info ..."
4648
5867
  end
4649
5868
  # verify the required parameter 'account_id' is set
4650
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_email_settings" if account_id.nil?
5869
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_page_info" if account_id.nil?
4651
5870
  # verify the required parameter 'envelope_id' is set
4652
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_email_settings" if envelope_id.nil?
5871
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_page_info" if envelope_id.nil?
4653
5872
  # resource path
4654
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5873
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4655
5874
 
4656
5875
  # query parameters
4657
5876
  query_params = {}
@@ -4665,48 +5884,45 @@ module DocuSign_eSign
4665
5884
  form_params = {}
4666
5885
 
4667
5886
  # http body (model)
4668
- post_body = @api_client.object_to_http_body(email_settings)
5887
+ post_body = nil
4669
5888
  auth_names = []
4670
5889
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4671
5890
  :header_params => header_params,
4672
5891
  :query_params => query_params,
4673
5892
  :form_params => form_params,
4674
5893
  :body => post_body,
4675
- :auth_names => auth_names,
4676
- :return_type => 'EmailSettings')
5894
+ :auth_names => auth_names)
4677
5895
  if @api_client.config.debugging
4678
- @api_client.config.logger.debug "API called: EnvelopesApi#update_email_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5896
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_page_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4679
5897
  end
4680
5898
  return data, status_code, headers
4681
5899
  end
4682
5900
 
4683
- # Updates an envelope lock.
4684
- # 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.
5901
+ # Update pdf blobs for Display Appliance
5902
+ #
4685
5903
  # @param account_id The external account number (int) or account ID Guid.
4686
5904
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4687
- # @param lock_request (optional parameter)
4688
- # @return [LockInformation]
4689
- def update_lock(account_id, envelope_id, lock_request)
4690
- data, _status_code, _headers = update_lock_with_http_info(account_id, envelope_id, lock_request)
4691
- return data
5905
+ # @return [nil]
5906
+ def update_pdf_blob(account_id, envelope_id)
5907
+ update_pdf_blob_with_http_info(account_id, envelope_id)
5908
+ return nil
4692
5909
  end
4693
5910
 
4694
- # Updates an envelope lock.
4695
- # Updates the lock duration time or update the &#x60;lockedByApp&#x60; property information for the specified envelope. The user and integrator key must match the user specified by the &#x60;lockByUser&#x60; property and integrator key information and the &#x60;X-DocuSign-Edit&#x60; header must be included or an error will be generated.
5911
+ # Update pdf blobs for Display Appliance
5912
+ #
4696
5913
  # @param account_id The external account number (int) or account ID Guid.
4697
5914
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4698
- # @param lock_request (optional parameter)
4699
- # @return [Array<(LockInformation, Fixnum, Hash)>] LockInformation data, response status code and response headers
4700
- def update_lock_with_http_info(account_id, envelope_id, lock_request)
5915
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
5916
+ def update_pdf_blob_with_http_info(account_id, envelope_id)
4701
5917
  if @api_client.config.debugging
4702
- @api_client.config.logger.debug "Calling API: EnvelopesApi.update_lock ..."
5918
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_pdf_blob ..."
4703
5919
  end
4704
5920
  # verify the required parameter 'account_id' is set
4705
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_lock" if account_id.nil?
5921
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_pdf_blob" if account_id.nil?
4706
5922
  # verify the required parameter 'envelope_id' is set
4707
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_lock" if envelope_id.nil?
5923
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_pdf_blob" if envelope_id.nil?
4708
5924
  # resource path
4709
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5925
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4710
5926
 
4711
5927
  # query parameters
4712
5928
  query_params = {}
@@ -4720,48 +5936,45 @@ module DocuSign_eSign
4720
5936
  form_params = {}
4721
5937
 
4722
5938
  # http body (model)
4723
- post_body = @api_client.object_to_http_body(lock_request)
5939
+ post_body = nil
4724
5940
  auth_names = []
4725
5941
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4726
5942
  :header_params => header_params,
4727
5943
  :query_params => query_params,
4728
5944
  :form_params => form_params,
4729
5945
  :body => post_body,
4730
- :auth_names => auth_names,
4731
- :return_type => 'LockInformation')
5946
+ :auth_names => auth_names)
4732
5947
  if @api_client.config.debugging
4733
- @api_client.config.logger.debug "API called: EnvelopesApi#update_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5948
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_pdf_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4734
5949
  end
4735
5950
  return data, status_code, headers
4736
5951
  end
4737
5952
 
4738
- # Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
5953
+ # Update RecipientDeniedDocumentCopy for Display Appliance
4739
5954
  #
4740
5955
  # @param account_id The external account number (int) or account ID Guid.
4741
5956
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4742
- # @param envelope_notification_request (optional parameter)
4743
- # @return [Notification]
4744
- def update_notification_settings(account_id, envelope_id, envelope_notification_request)
4745
- data, _status_code, _headers = update_notification_settings_with_http_info(account_id, envelope_id, envelope_notification_request)
4746
- return data
5957
+ # @return [nil]
5958
+ def update_recipient_denied_document_copy(account_id, envelope_id)
5959
+ update_recipient_denied_document_copy_with_http_info(account_id, envelope_id)
5960
+ return nil
4747
5961
  end
4748
5962
 
4749
- # Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
5963
+ # Update RecipientDeniedDocumentCopy for Display Appliance
4750
5964
  #
4751
5965
  # @param account_id The external account number (int) or account ID Guid.
4752
5966
  # @param envelope_id The envelopeId Guid of the envelope being accessed.
4753
- # @param envelope_notification_request (optional parameter)
4754
- # @return [Array<(Notification, Fixnum, Hash)>] Notification data, response status code and response headers
4755
- def update_notification_settings_with_http_info(account_id, envelope_id, envelope_notification_request)
5967
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
5968
+ def update_recipient_denied_document_copy_with_http_info(account_id, envelope_id)
4756
5969
  if @api_client.config.debugging
4757
- @api_client.config.logger.debug "Calling API: EnvelopesApi.update_notification_settings ..."
5970
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_recipient_denied_document_copy ..."
4758
5971
  end
4759
5972
  # verify the required parameter 'account_id' is set
4760
- fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_notification_settings" if account_id.nil?
5973
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_recipient_denied_document_copy" if account_id.nil?
4761
5974
  # verify the required parameter 'envelope_id' is set
4762
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_notification_settings" if envelope_id.nil?
5975
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_recipient_denied_document_copy" if envelope_id.nil?
4763
5976
  # resource path
4764
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/notification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5977
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/recipient_denied_copy".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4765
5978
 
4766
5979
  # query parameters
4767
5980
  query_params = {}
@@ -4775,17 +5988,16 @@ module DocuSign_eSign
4775
5988
  form_params = {}
4776
5989
 
4777
5990
  # http body (model)
4778
- post_body = @api_client.object_to_http_body(envelope_notification_request)
5991
+ post_body = nil
4779
5992
  auth_names = []
4780
5993
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4781
5994
  :header_params => header_params,
4782
5995
  :query_params => query_params,
4783
5996
  :form_params => form_params,
4784
5997
  :body => post_body,
4785
- :auth_names => auth_names,
4786
- :return_type => 'Notification')
5998
+ :auth_names => auth_names)
4787
5999
  if @api_client.config.debugging
4788
- @api_client.config.logger.debug "API called: EnvelopesApi#update_notification_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6000
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_recipient_denied_document_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4789
6001
  end
4790
6002
  return data, status_code, headers
4791
6003
  end
@@ -4820,7 +6032,7 @@ module DocuSign_eSign
4820
6032
  # verify the required parameter 'recipient_id' is set
4821
6033
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.update_recipient_document_visibility" if recipient_id.nil?
4822
6034
  # resource path
4823
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
6035
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
4824
6036
 
4825
6037
  # query parameters
4826
6038
  query_params = {}
@@ -4877,7 +6089,7 @@ module DocuSign_eSign
4877
6089
  # verify the required parameter 'recipient_id' is set
4878
6090
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.update_recipient_initials_image" if recipient_id.nil?
4879
6091
  # resource path
4880
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
6092
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
4881
6093
 
4882
6094
  # query parameters
4883
6095
  query_params = {}
@@ -4935,7 +6147,7 @@ module DocuSign_eSign
4935
6147
  # verify the required parameter 'recipient_id' is set
4936
6148
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.update_recipient_signature_image" if recipient_id.nil?
4937
6149
  # resource path
4938
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
6150
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
4939
6151
 
4940
6152
  # query parameters
4941
6153
  query_params = {}
@@ -4993,10 +6205,11 @@ module DocuSign_eSign
4993
6205
  # verify the required parameter 'envelope_id' is set
4994
6206
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_recipients" if envelope_id.nil?
4995
6207
  # resource path
4996
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
6208
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
4997
6209
 
4998
6210
  # query parameters
4999
6211
  query_params = {}
6212
+ query_params[:'combine_same_order_recipients'] = options.combine_same_order_recipients if !options.combine_same_order_recipients.nil?
5000
6213
  query_params[:'offline_signing'] = options.offline_signing if !options.offline_signing.nil?
5001
6214
  query_params[:'resend_envelope'] = options.resend_envelope if !options.resend_envelope.nil?
5002
6215
 
@@ -5050,7 +6263,7 @@ module DocuSign_eSign
5050
6263
  # verify the required parameter 'envelope_id' is set
5051
6264
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_recipients_document_visibility" if envelope_id.nil?
5052
6265
  # resource path
5053
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
6266
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
5054
6267
 
5055
6268
  # query parameters
5056
6269
  query_params = {}
@@ -5079,6 +6292,58 @@ module DocuSign_eSign
5079
6292
  return data, status_code, headers
5080
6293
  end
5081
6294
 
6295
+ # Update signer attachment information for Display Appliance
6296
+ #
6297
+ # @param account_id The external account number (int) or account ID Guid.
6298
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6299
+ # @return [nil]
6300
+ def update_signer_attachment(account_id, envelope_id)
6301
+ update_signer_attachment_with_http_info(account_id, envelope_id)
6302
+ return nil
6303
+ end
6304
+
6305
+ # Update signer attachment information for Display Appliance
6306
+ #
6307
+ # @param account_id The external account number (int) or account ID Guid.
6308
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6309
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
6310
+ def update_signer_attachment_with_http_info(account_id, envelope_id)
6311
+ if @api_client.config.debugging
6312
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_signer_attachment ..."
6313
+ end
6314
+ # verify the required parameter 'account_id' is set
6315
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_signer_attachment" if account_id.nil?
6316
+ # verify the required parameter 'envelope_id' is set
6317
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_signer_attachment" if envelope_id.nil?
6318
+ # resource path
6319
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/signer_attachment_info".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
6320
+
6321
+ # query parameters
6322
+ query_params = {}
6323
+
6324
+ # header parameters
6325
+ header_params = {}
6326
+ # HTTP header 'Accept' (if needed)
6327
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6328
+
6329
+ # form parameters
6330
+ form_params = {}
6331
+
6332
+ # http body (model)
6333
+ post_body = nil
6334
+ auth_names = []
6335
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6336
+ :header_params => header_params,
6337
+ :query_params => query_params,
6338
+ :form_params => form_params,
6339
+ :body => post_body,
6340
+ :auth_names => auth_names)
6341
+ if @api_client.config.debugging
6342
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_signer_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6343
+ end
6344
+ return data, status_code, headers
6345
+ end
6346
+
5082
6347
  # Updates the tabs for a recipient.
5083
6348
  # Updates one or more tabs for a recipient in a draft envelope.
5084
6349
  # @param account_id The external account number (int) or account ID Guid.
@@ -5109,7 +6374,7 @@ module DocuSign_eSign
5109
6374
  # verify the required parameter 'recipient_id' is set
5110
6375
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.update_tabs" if recipient_id.nil?
5111
6376
  # resource path
5112
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
6377
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
5113
6378
 
5114
6379
  # query parameters
5115
6380
  query_params = {}
@@ -5138,6 +6403,58 @@ module DocuSign_eSign
5138
6403
  return data, status_code, headers
5139
6404
  end
5140
6405
 
6406
+ # Update ecrypted tabs blob.
6407
+ #
6408
+ # @param account_id The external account number (int) or account ID Guid.
6409
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6410
+ # @return [nil]
6411
+ def update_tabs_blob(account_id, envelope_id)
6412
+ update_tabs_blob_with_http_info(account_id, envelope_id)
6413
+ return nil
6414
+ end
6415
+
6416
+ # Update ecrypted tabs blob.
6417
+ #
6418
+ # @param account_id The external account number (int) or account ID Guid.
6419
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
6420
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
6421
+ def update_tabs_blob_with_http_info(account_id, envelope_id)
6422
+ if @api_client.config.debugging
6423
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_tabs_blob ..."
6424
+ end
6425
+ # verify the required parameter 'account_id' is set
6426
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_tabs_blob" if account_id.nil?
6427
+ # verify the required parameter 'envelope_id' is set
6428
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_tabs_blob" if envelope_id.nil?
6429
+ # resource path
6430
+ local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
6431
+
6432
+ # query parameters
6433
+ query_params = {}
6434
+
6435
+ # header parameters
6436
+ header_params = {}
6437
+ # HTTP header 'Accept' (if needed)
6438
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6439
+
6440
+ # form parameters
6441
+ form_params = {}
6442
+
6443
+ # http body (model)
6444
+ post_body = nil
6445
+ auth_names = []
6446
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6447
+ :header_params => header_params,
6448
+ :query_params => query_params,
6449
+ :form_params => form_params,
6450
+ :body => post_body,
6451
+ :auth_names => auth_names)
6452
+ if @api_client.config.debugging
6453
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_tabs_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6454
+ end
6455
+ return data, status_code, headers
6456
+ end
6457
+
5141
6458
  # Updates document visibility for the recipients
5142
6459
  #
5143
6460
  # @param account_id The external account number (int) or account ID Guid.
@@ -5168,7 +6485,7 @@ module DocuSign_eSign
5168
6485
  # verify the required parameter 'template_id' is set
5169
6486
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_recipient_document_visibility" if template_id.nil?
5170
6487
  # resource path
5171
- local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
6488
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
5172
6489
 
5173
6490
  # query parameters
5174
6491
  query_params = {}
@@ -5223,7 +6540,7 @@ module DocuSign_eSign
5223
6540
  # verify the required parameter 'template_id' is set
5224
6541
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_recipients_document_visibility" if template_id.nil?
5225
6542
  # resource path
5226
- local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
6543
+ local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
5227
6544
 
5228
6545
  # query parameters
5229
6546
  query_params = {}
@@ -5252,4 +6569,4 @@ module DocuSign_eSign
5252
6569
  return data, status_code, headers
5253
6570
  end
5254
6571
  end
5255
- end
6572
+ end