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
@@ -390,4 +390,4 @@ module DocuSign_eSign
390
390
  return data, status_code, headers
391
391
  end
392
392
  end
393
- end
393
+ 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
 
@@ -89,7 +89,7 @@ module DocuSign_eSign
89
89
  # verify the required parameter 'billing_plan_id' is set
90
90
  fail ArgumentError, "Missing the required parameter 'billing_plan_id' when calling BillingApi.get_billing_plan" if billing_plan_id.nil?
91
91
  # resource path
92
- local_var_path = "/v2/billing_plans/{billingPlanId}".sub('{format}','json').sub('{' + 'billingPlanId' + '}', billing_plan_id.to_s)
92
+ local_var_path = "/v2.1/billing_plans/{billingPlanId}".sub('{format}','json').sub('{' + 'billingPlanId' + '}', billing_plan_id.to_s)
93
93
 
94
94
  # query parameters
95
95
  query_params = {}
@@ -138,7 +138,7 @@ module DocuSign_eSign
138
138
  # verify the required parameter 'account_id' is set
139
139
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_credit_card_info" if account_id.nil?
140
140
  # resource path
141
- local_var_path = "/v2/accounts/{accountId}/billing_plan/credit_card".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
141
+ local_var_path = "/v2.1/accounts/{accountId}/billing_plan/credit_card".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
142
142
 
143
143
  # query parameters
144
144
  query_params = {}
@@ -191,7 +191,7 @@ module DocuSign_eSign
191
191
  # verify the required parameter 'invoice_id' is set
192
192
  fail ArgumentError, "Missing the required parameter 'invoice_id' when calling BillingApi.get_invoice" if invoice_id.nil?
193
193
  # resource path
194
- local_var_path = "/v2/accounts/{accountId}/billing_invoices/{invoiceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'invoiceId' + '}', invoice_id.to_s)
194
+ local_var_path = "/v2.1/accounts/{accountId}/billing_invoices/{invoiceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'invoiceId' + '}', invoice_id.to_s)
195
195
 
196
196
  # query parameters
197
197
  query_params = {}
@@ -244,7 +244,7 @@ module DocuSign_eSign
244
244
  # verify the required parameter 'payment_id' is set
245
245
  fail ArgumentError, "Missing the required parameter 'payment_id' when calling BillingApi.get_payment" if payment_id.nil?
246
246
  # resource path
247
- local_var_path = "/v2/accounts/{accountId}/billing_payments/{paymentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'paymentId' + '}', payment_id.to_s)
247
+ local_var_path = "/v2.1/accounts/{accountId}/billing_payments/{paymentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'paymentId' + '}', payment_id.to_s)
248
248
 
249
249
  # query parameters
250
250
  query_params = {}
@@ -295,7 +295,7 @@ module DocuSign_eSign
295
295
  # verify the required parameter 'account_id' is set
296
296
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_plan" if account_id.nil?
297
297
  # resource path
298
- local_var_path = "/v2/accounts/{accountId}/billing_plan".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
298
+ local_var_path = "/v2.1/accounts/{accountId}/billing_plan".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
299
299
 
300
300
  # query parameters
301
301
  query_params = {}
@@ -343,7 +343,7 @@ module DocuSign_eSign
343
343
  @api_client.config.logger.debug "Calling API: BillingApi.list_billing_plans ..."
344
344
  end
345
345
  # resource path
346
- local_var_path = "/v2/billing_plans".sub('{format}','json')
346
+ local_var_path = "/v2.1/billing_plans".sub('{format}','json')
347
347
 
348
348
  # query parameters
349
349
  query_params = {}
@@ -394,7 +394,7 @@ module DocuSign_eSign
394
394
  # verify the required parameter 'account_id' is set
395
395
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.list_invoices" if account_id.nil?
396
396
  # resource path
397
- local_var_path = "/v2/accounts/{accountId}/billing_invoices".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
397
+ local_var_path = "/v2.1/accounts/{accountId}/billing_invoices".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
398
398
 
399
399
  # query parameters
400
400
  query_params = {}
@@ -445,7 +445,7 @@ module DocuSign_eSign
445
445
  # verify the required parameter 'account_id' is set
446
446
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.list_invoices_past_due" if account_id.nil?
447
447
  # resource path
448
- local_var_path = "/v2/accounts/{accountId}/billing_invoices_past_due".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
448
+ local_var_path = "/v2.1/accounts/{accountId}/billing_invoices_past_due".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
449
449
 
450
450
  # query parameters
451
451
  query_params = {}
@@ -496,7 +496,7 @@ module DocuSign_eSign
496
496
  # verify the required parameter 'account_id' is set
497
497
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.list_payments" if account_id.nil?
498
498
  # resource path
499
- local_var_path = "/v2/accounts/{accountId}/billing_payments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
499
+ local_var_path = "/v2.1/accounts/{accountId}/billing_payments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
500
500
 
501
501
  # query parameters
502
502
  query_params = {}
@@ -549,7 +549,7 @@ module DocuSign_eSign
549
549
  # verify the required parameter 'account_id' is set
550
550
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.make_payment" if account_id.nil?
551
551
  # resource path
552
- local_var_path = "/v2/accounts/{accountId}/billing_payments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
552
+ local_var_path = "/v2.1/accounts/{accountId}/billing_payments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
553
553
 
554
554
  # query parameters
555
555
  query_params = {}
@@ -600,7 +600,7 @@ module DocuSign_eSign
600
600
  # verify the required parameter 'account_id' is set
601
601
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.purchase_envelopes" if account_id.nil?
602
602
  # resource path
603
- local_var_path = "/v2/accounts/{accountId}/billing_plan/purchased_envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
603
+ local_var_path = "/v2.1/accounts/{accountId}/billing_plan/purchased_envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
604
604
 
605
605
  # query parameters
606
606
  query_params = {}
@@ -652,7 +652,7 @@ module DocuSign_eSign
652
652
  # verify the required parameter 'account_id' is set
653
653
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.update_plan" if account_id.nil?
654
654
  # resource path
655
- local_var_path = "/v2/accounts/{accountId}/billing_plan".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
655
+ local_var_path = "/v2.1/accounts/{accountId}/billing_plan".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
656
656
 
657
657
  # query parameters
658
658
  query_params = {}
@@ -682,4 +682,4 @@ module DocuSign_eSign
682
682
  return data, status_code, headers
683
683
  end
684
684
  end
685
- end
685
+ 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
 
@@ -13,82 +13,147 @@ require "uri"
13
13
 
14
14
  module DocuSign_eSign
15
15
 
16
- class GetOptions
17
- # Specifies the number of entries to return.
18
- attr_accessor :count
19
16
 
20
- # Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=\"failed,queued\") Valid values are: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - This only returns entries with a failed status. * queued - This only returns entries with a queued status. * sent - This only returns entries with a sent status.
21
- attr_accessor :include
22
-
23
- # Specifies the location in the list of envelopes from which to start.
24
- attr_accessor :start_position
17
+ class BulkEnvelopesApi
18
+ attr_accessor :api_client
25
19
 
26
- def self.default
27
- @@default ||= GetOptions.new
20
+ def initialize(api_client = BulkEnvelopesApi.default)
21
+ @api_client = api_client
28
22
  end
29
- end
30
23
 
31
- class GetRecipientsOptions
24
+ # Creates a new bulk send list
32
25
  #
33
- attr_accessor :include_tabs
26
+ # @param account_id The external account number (int) or account ID Guid.
27
+ # @param bulk_sending_list (optional parameter)
28
+ # @return [BulkSendingList]
29
+ def create_bulk_send_list(account_id, bulk_sending_list)
30
+ data, _status_code, _headers = create_bulk_send_list_with_http_info(account_id, bulk_sending_list)
31
+ return data
32
+ end
34
33
 
34
+ # Creates a new bulk send list
35
35
  #
36
- attr_accessor :start_position
36
+ # @param account_id The external account number (int) or account ID Guid.
37
+ # @param bulk_sending_list (optional parameter)
38
+ # @return [Array<(BulkSendingList, Fixnum, Hash)>] BulkSendingList data, response status code and response headers
39
+ def create_bulk_send_list_with_http_info(account_id, bulk_sending_list)
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.create_bulk_send_list ..."
42
+ end
43
+ # verify the required parameter 'account_id' is set
44
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.create_bulk_send_list" if account_id.nil?
45
+ # resource path
46
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_send_lists".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
37
47
 
38
- def self.default
39
- @@default ||= GetRecipientsOptions.new
40
- end
41
- end
48
+ # query parameters
49
+ query_params = {}
42
50
 
43
- class ListOptions
44
- # The number of results to return. This can be 1 to 20.
45
- attr_accessor :count
51
+ # header parameters
52
+ header_params = {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
46
55
 
47
- # The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0.
48
- attr_accessor :start_position
56
+ # form parameters
57
+ form_params = {}
49
58
 
50
- def self.default
51
- @@default ||= ListOptions.new
59
+ # http body (model)
60
+ post_body = @api_client.object_to_http_body(bulk_sending_list)
61
+ auth_names = []
62
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
63
+ :header_params => header_params,
64
+ :query_params => query_params,
65
+ :form_params => form_params,
66
+ :body => post_body,
67
+ :auth_names => auth_names,
68
+ :return_type => 'BulkSendingList')
69
+ if @api_client.config.debugging
70
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#create_bulk_send_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
71
+ end
72
+ return data, status_code, headers
52
73
  end
53
- end
54
74
 
75
+ # Uses the specified bulk send list to send the envelope specified in the payload
76
+ #
77
+ # @param account_id The external account number (int) or account ID Guid.
78
+ # @param bulk_send_list_id
79
+ # @param bulk_send_request (optional parameter)
80
+ # @return [BulkSendResponse]
81
+ def create_bulk_send_request(account_id, bulk_send_list_id, bulk_send_request)
82
+ data, _status_code, _headers = create_bulk_send_request_with_http_info(account_id, bulk_send_list_id, bulk_send_request)
83
+ return data
84
+ end
55
85
 
56
- class BulkEnvelopesApi
57
- attr_accessor :api_client
86
+ # Uses the specified bulk send list to send the envelope specified in the payload
87
+ #
88
+ # @param account_id The external account number (int) or account ID Guid.
89
+ # @param bulk_send_list_id
90
+ # @param bulk_send_request (optional parameter)
91
+ # @return [Array<(BulkSendResponse, Fixnum, Hash)>] BulkSendResponse data, response status code and response headers
92
+ def create_bulk_send_request_with_http_info(account_id, bulk_send_list_id, bulk_send_request)
93
+ if @api_client.config.debugging
94
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.create_bulk_send_request ..."
95
+ end
96
+ # verify the required parameter 'account_id' is set
97
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.create_bulk_send_request" if account_id.nil?
98
+ # verify the required parameter 'bulk_send_list_id' is set
99
+ fail ArgumentError, "Missing the required parameter 'bulk_send_list_id' when calling BulkEnvelopesApi.create_bulk_send_request" if bulk_send_list_id.nil?
100
+ # resource path
101
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkSendListId' + '}', bulk_send_list_id.to_s)
58
102
 
59
- def initialize(api_client = BulkEnvelopesApi.default)
60
- @api_client = api_client
103
+ # query parameters
104
+ query_params = {}
105
+
106
+ # header parameters
107
+ header_params = {}
108
+ # HTTP header 'Accept' (if needed)
109
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
110
+
111
+ # form parameters
112
+ form_params = {}
113
+
114
+ # http body (model)
115
+ post_body = @api_client.object_to_http_body(bulk_send_request)
116
+ auth_names = []
117
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
118
+ :header_params => header_params,
119
+ :query_params => query_params,
120
+ :form_params => form_params,
121
+ :body => post_body,
122
+ :auth_names => auth_names,
123
+ :return_type => 'BulkSendResponse')
124
+ if @api_client.config.debugging
125
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#create_bulk_send_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
126
+ end
127
+ return data, status_code, headers
61
128
  end
62
129
 
63
- # Deletes the bulk recipient file from an envelope.
64
- # Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the `bulkRecipientsUri` property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.
130
+ # Tests whether the specified bulk sending list can be used to send an envelope
131
+ #
65
132
  # @param account_id The external account number (int) or account ID Guid.
66
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
67
- # @param recipient_id The ID of the recipient being accessed.
68
- # @return [BulkRecipientsUpdateResponse]
69
- def delete_recipients(account_id, envelope_id, recipient_id)
70
- data, _status_code, _headers = delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
133
+ # @param bulk_send_list_id
134
+ # @param bulk_send_request (optional parameter)
135
+ # @return [BulkSendTestResponse]
136
+ def create_bulk_send_test_request(account_id, bulk_send_list_id, bulk_send_request)
137
+ data, _status_code, _headers = create_bulk_send_test_request_with_http_info(account_id, bulk_send_list_id, bulk_send_request)
71
138
  return data
72
139
  end
73
140
 
74
- # Deletes the bulk recipient file from an envelope.
75
- # Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the &#x60;bulkRecipientsUri&#x60; property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.
141
+ # Tests whether the specified bulk sending list can be used to send an envelope
142
+ #
76
143
  # @param account_id The external account number (int) or account ID Guid.
77
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
78
- # @param recipient_id The ID of the recipient being accessed.
79
- # @return [Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>] BulkRecipientsUpdateResponse data, response status code and response headers
80
- def delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
144
+ # @param bulk_send_list_id
145
+ # @param bulk_send_request (optional parameter)
146
+ # @return [Array<(BulkSendTestResponse, Fixnum, Hash)>] BulkSendTestResponse data, response status code and response headers
147
+ def create_bulk_send_test_request_with_http_info(account_id, bulk_send_list_id, bulk_send_request)
81
148
  if @api_client.config.debugging
82
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.delete_recipients ..."
149
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.create_bulk_send_test_request ..."
83
150
  end
84
151
  # verify the required parameter 'account_id' is set
85
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.delete_recipients" if account_id.nil?
86
- # verify the required parameter 'envelope_id' is set
87
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.delete_recipients" if envelope_id.nil?
88
- # verify the required parameter 'recipient_id' is set
89
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.delete_recipients" if recipient_id.nil?
152
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.create_bulk_send_test_request" if account_id.nil?
153
+ # verify the required parameter 'bulk_send_list_id' is set
154
+ fail ArgumentError, "Missing the required parameter 'bulk_send_list_id' when calling BulkEnvelopesApi.create_bulk_send_test_request" if bulk_send_list_id.nil?
90
155
  # resource path
91
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
156
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkSendListId' + '}', bulk_send_list_id.to_s)
92
157
 
93
158
  # query parameters
94
159
  query_params = {}
@@ -102,54 +167,49 @@ module DocuSign_eSign
102
167
  form_params = {}
103
168
 
104
169
  # http body (model)
105
- post_body = nil
170
+ post_body = @api_client.object_to_http_body(bulk_send_request)
106
171
  auth_names = []
107
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
172
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
108
173
  :header_params => header_params,
109
174
  :query_params => query_params,
110
175
  :form_params => form_params,
111
176
  :body => post_body,
112
177
  :auth_names => auth_names,
113
- :return_type => 'BulkRecipientsUpdateResponse')
178
+ :return_type => 'BulkSendTestResponse')
114
179
  if @api_client.config.debugging
115
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#delete_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
180
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#create_bulk_send_test_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
116
181
  end
117
182
  return data, status_code, headers
118
183
  end
119
184
 
120
- # Gets the status of a specified bulk send operation.
121
- # Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.
185
+ # Deletes an existing bulk send list
186
+ #
122
187
  # @param account_id The external account number (int) or account ID Guid.
123
- # @param batch_id
124
- # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
125
- # @return [BulkEnvelopeStatus]
126
- def get(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
127
- data, _status_code, _headers = get_with_http_info(account_id, batch_id, options)
188
+ # @param bulk_send_list_id
189
+ # @return [BulkSendingListSummaries]
190
+ def delete_bulk_send_list(account_id, bulk_send_list_id)
191
+ data, _status_code, _headers = delete_bulk_send_list_with_http_info(account_id, bulk_send_list_id)
128
192
  return data
129
193
  end
130
194
 
131
- # Gets the status of a specified bulk send operation.
132
- # Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.
195
+ # Deletes an existing bulk send list
196
+ #
133
197
  # @param account_id The external account number (int) or account ID Guid.
134
- # @param batch_id
135
- # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
136
- # @return [Array<(BulkEnvelopeStatus, Fixnum, Hash)>] BulkEnvelopeStatus data, response status code and response headers
137
- def get_with_http_info(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
198
+ # @param bulk_send_list_id
199
+ # @return [Array<(BulkSendingListSummaries, Fixnum, Hash)>] BulkSendingListSummaries data, response status code and response headers
200
+ def delete_bulk_send_list_with_http_info(account_id, bulk_send_list_id)
138
201
  if @api_client.config.debugging
139
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get ..."
202
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.delete_bulk_send_list ..."
140
203
  end
141
204
  # verify the required parameter 'account_id' is set
142
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get" if account_id.nil?
143
- # verify the required parameter 'batch_id' is set
144
- fail ArgumentError, "Missing the required parameter 'batch_id' when calling BulkEnvelopesApi.get" if batch_id.nil?
205
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.delete_bulk_send_list" if account_id.nil?
206
+ # verify the required parameter 'bulk_send_list_id' is set
207
+ fail ArgumentError, "Missing the required parameter 'bulk_send_list_id' when calling BulkEnvelopesApi.delete_bulk_send_list" if bulk_send_list_id.nil?
145
208
  # resource path
146
- local_var_path = "/v2/accounts/{accountId}/bulk_envelopes/{batchId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'batchId' + '}', batch_id.to_s)
209
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkSendListId' + '}', bulk_send_list_id.to_s)
147
210
 
148
211
  # query parameters
149
212
  query_params = {}
150
- query_params[:'count'] = options.count if !options.count.nil?
151
- query_params[:'include'] = options.include if !options.include.nil?
152
- query_params[:'start_position'] = options.start_position if !options.start_position.nil?
153
213
 
154
214
  # header parameters
155
215
  header_params = {}
@@ -162,55 +222,47 @@ module DocuSign_eSign
162
222
  # http body (model)
163
223
  post_body = nil
164
224
  auth_names = []
165
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
225
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
166
226
  :header_params => header_params,
167
227
  :query_params => query_params,
168
228
  :form_params => form_params,
169
229
  :body => post_body,
170
230
  :auth_names => auth_names,
171
- :return_type => 'BulkEnvelopeStatus')
231
+ :return_type => 'BulkSendingListSummaries')
172
232
  if @api_client.config.debugging
173
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
233
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#delete_bulk_send_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
174
234
  end
175
235
  return data, status_code, headers
176
236
  end
177
237
 
178
- # Gets the bulk recipient file from an envelope.
179
- # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
238
+ # Gets a specific bulk send list
239
+ #
180
240
  # @param account_id The external account number (int) or account ID Guid.
181
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
182
- # @param recipient_id The ID of the recipient being accessed.
183
- # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
184
- # @return [BulkRecipientsResponse]
185
- def get_recipients(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
186
- data, _status_code, _headers = get_recipients_with_http_info(account_id, envelope_id, recipient_id, options)
241
+ # @param bulk_send_list_id
242
+ # @return [BulkSendingList]
243
+ def get_bulk_send_list(account_id, bulk_send_list_id)
244
+ data, _status_code, _headers = get_bulk_send_list_with_http_info(account_id, bulk_send_list_id)
187
245
  return data
188
246
  end
189
247
 
190
- # Gets the bulk recipient file from an envelope.
191
- # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
248
+ # Gets a specific bulk send list
249
+ #
192
250
  # @param account_id The external account number (int) or account ID Guid.
193
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
194
- # @param recipient_id The ID of the recipient being accessed.
195
- # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
196
- # @return [Array<(BulkRecipientsResponse, Fixnum, Hash)>] BulkRecipientsResponse data, response status code and response headers
197
- def get_recipients_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
251
+ # @param bulk_send_list_id
252
+ # @return [Array<(BulkSendingList, Fixnum, Hash)>] BulkSendingList data, response status code and response headers
253
+ def get_bulk_send_list_with_http_info(account_id, bulk_send_list_id)
198
254
  if @api_client.config.debugging
199
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_recipients ..."
255
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_bulk_send_list ..."
200
256
  end
201
257
  # verify the required parameter 'account_id' is set
202
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_recipients" if account_id.nil?
203
- # verify the required parameter 'envelope_id' is set
204
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.get_recipients" if envelope_id.nil?
205
- # verify the required parameter 'recipient_id' is set
206
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.get_recipients" if recipient_id.nil?
258
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_bulk_send_list" if account_id.nil?
259
+ # verify the required parameter 'bulk_send_list_id' is set
260
+ fail ArgumentError, "Missing the required parameter 'bulk_send_list_id' when calling BulkEnvelopesApi.get_bulk_send_list" if bulk_send_list_id.nil?
207
261
  # resource path
208
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
262
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkSendListId' + '}', bulk_send_list_id.to_s)
209
263
 
210
264
  # query parameters
211
265
  query_params = {}
212
- query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
213
- query_params[:'start_position'] = options.start_position if !options.start_position.nil?
214
266
 
215
267
  # header parameters
216
268
  header_params = {}
@@ -229,41 +281,37 @@ module DocuSign_eSign
229
281
  :form_params => form_params,
230
282
  :body => post_body,
231
283
  :auth_names => auth_names,
232
- :return_type => 'BulkRecipientsResponse')
284
+ :return_type => 'BulkSendingList')
233
285
  if @api_client.config.debugging
234
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
286
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_bulk_send_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
235
287
  end
236
288
  return data, status_code, headers
237
289
  end
238
290
 
239
- # Gets status information about bulk recipient batches.
240
- # Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the `batchId` property, which can be used to retrieve a more detailed status of individual bulk recipient batches.
291
+ # Lists top-level details for all bulk send lists visible to the current user
292
+ #
241
293
  # @param account_id The external account number (int) or account ID Guid.
242
- # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
243
- # @return [BulkEnvelopesResponse]
244
- def list(account_id, options = DocuSign_eSign::ListOptions.default)
245
- data, _status_code, _headers = list_with_http_info(account_id, options)
294
+ # @return [BulkSendingListSummaries]
295
+ def get_bulk_send_lists(account_id)
296
+ data, _status_code, _headers = get_bulk_send_lists_with_http_info(account_id)
246
297
  return data
247
298
  end
248
299
 
249
- # Gets status information about bulk recipient batches.
250
- # Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the &#x60;batchId&#x60; property, which can be used to retrieve a more detailed status of individual bulk recipient batches.
300
+ # Lists top-level details for all bulk send lists visible to the current user
301
+ #
251
302
  # @param account_id The external account number (int) or account ID Guid.
252
- # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
253
- # @return [Array<(BulkEnvelopesResponse, Fixnum, Hash)>] BulkEnvelopesResponse data, response status code and response headers
254
- def list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default)
303
+ # @return [Array<(BulkSendingListSummaries, Fixnum, Hash)>] BulkSendingListSummaries data, response status code and response headers
304
+ def get_bulk_send_lists_with_http_info(account_id)
255
305
  if @api_client.config.debugging
256
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.list ..."
306
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_bulk_send_lists ..."
257
307
  end
258
308
  # verify the required parameter 'account_id' is set
259
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.list" if account_id.nil?
309
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_bulk_send_lists" if account_id.nil?
260
310
  # resource path
261
- local_var_path = "/v2/accounts/{accountId}/bulk_envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
311
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_send_lists".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
262
312
 
263
313
  # query parameters
264
314
  query_params = {}
265
- query_params[:'count'] = options.count if !options.count.nil?
266
- query_params[:'start_position'] = options.start_position if !options.start_position.nil?
267
315
 
268
316
  # header parameters
269
317
  header_params = {}
@@ -282,46 +330,40 @@ module DocuSign_eSign
282
330
  :form_params => form_params,
283
331
  :body => post_body,
284
332
  :auth_names => auth_names,
285
- :return_type => 'BulkEnvelopesResponse')
333
+ :return_type => 'BulkSendingListSummaries')
286
334
  if @api_client.config.debugging
287
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
335
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_bulk_send_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
288
336
  end
289
337
  return data, status_code, headers
290
338
  end
291
339
 
292
- # Adds or replaces envelope bulk recipients.
293
- # Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
294
- # @param account_id The external account number (int) or account id GUID.
295
- # @param envelope_id The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
296
- # @param recipient_id A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
297
- # @param bulk_recipients_request
298
- # @return [BulkRecipientsSummaryResponse]
299
- def update_recipients(account_id, envelope_id, recipient_id, bulk_recipients_request)
300
- data, _status_code, _headers = update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request)
340
+ # Updates an existing bulk send list. If send_envelope query string value is provided, will accept an empty payload and try to send the specified envelope
341
+ #
342
+ # @param account_id The external account number (int) or account ID Guid.
343
+ # @param bulk_send_list_id
344
+ # @param bulk_sending_list (optional parameter)
345
+ # @return [BulkSendingList]
346
+ def update_bulk_send_list(account_id, bulk_send_list_id, bulk_sending_list)
347
+ data, _status_code, _headers = update_bulk_send_list_with_http_info(account_id, bulk_send_list_id, bulk_sending_list)
301
348
  return data
302
349
  end
303
350
 
304
- # Adds or replaces envelope bulk recipients.
305
- # Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
306
- # @param account_id The external account number (int) or account id GUID.
307
- # @param envelope_id The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
308
- # @param recipient_id A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
309
- # @param bulk_recipients_request
310
- # @return [Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>] BulkRecipientsSummaryResponse data, response status code and response headers
311
- def update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request)
351
+ # Updates an existing bulk send list. If send_envelope query string value is provided, will accept an empty payload and try to send the specified envelope
352
+ #
353
+ # @param account_id The external account number (int) or account ID Guid.
354
+ # @param bulk_send_list_id
355
+ # @param bulk_sending_list (optional parameter)
356
+ # @return [Array<(BulkSendingList, Fixnum, Hash)>] BulkSendingList data, response status code and response headers
357
+ def update_bulk_send_list_with_http_info(account_id, bulk_send_list_id, bulk_sending_list)
312
358
  if @api_client.config.debugging
313
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_recipients ..."
359
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_bulk_send_list ..."
314
360
  end
315
361
  # verify the required parameter 'account_id' is set
316
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_recipients" if account_id.nil?
317
- # verify the required parameter 'envelope_id' is set
318
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.update_recipients" if envelope_id.nil?
319
- # verify the required parameter 'recipient_id' is set
320
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.update_recipients" if recipient_id.nil?
321
- # verify the required parameter 'bulk_recipients_request' is set
322
- fail ArgumentError, "Missing the required parameter 'bulk_recipients_request' when calling BulkEnvelopesApi.update_recipients" if bulk_recipients_request.nil?
362
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_bulk_send_list" if account_id.nil?
363
+ # verify the required parameter 'bulk_send_list_id' is set
364
+ fail ArgumentError, "Missing the required parameter 'bulk_send_list_id' when calling BulkEnvelopesApi.update_bulk_send_list" if bulk_send_list_id.nil?
323
365
  # resource path
324
- local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
366
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkSendListId' + '}', bulk_send_list_id.to_s)
325
367
 
326
368
  # query parameters
327
369
  query_params = {}
@@ -330,14 +372,12 @@ module DocuSign_eSign
330
372
  header_params = {}
331
373
  # HTTP header 'Accept' (if needed)
332
374
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
333
- # HTTP header 'Content-Type'
334
- header_params['Content-Type'] = @api_client.select_header_content_type(['text/csv'])
335
375
 
336
376
  # form parameters
337
377
  form_params = {}
338
378
 
339
379
  # http body (model)
340
- post_body = @api_client.object_to_http_body(bulk_recipients_request)
380
+ post_body = @api_client.object_to_http_body(bulk_sending_list)
341
381
  auth_names = []
342
382
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
343
383
  :header_params => header_params,
@@ -345,11 +385,11 @@ module DocuSign_eSign
345
385
  :form_params => form_params,
346
386
  :body => post_body,
347
387
  :auth_names => auth_names,
348
- :return_type => 'BulkRecipientsSummaryResponse')
388
+ :return_type => 'BulkSendingList')
349
389
  if @api_client.config.debugging
350
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
390
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_bulk_send_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
351
391
  end
352
392
  return data, status_code, headers
353
393
  end
354
394
  end
355
- end
395
+ end