docusign_esign 3.12.0 → 3.19.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (355) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +54 -0
  3. data/docusign_esign.gemspec +5 -5
  4. data/lib/docusign_esign/api/accounts_api.rb +83 -433
  5. data/lib/docusign_esign/api/billing_api.rb +12 -4
  6. data/lib/docusign_esign/api/bulk_envelopes_api.rb +93 -26
  7. data/lib/docusign_esign/api/bulk_process_data_api.rb +412 -0
  8. data/lib/docusign_esign/api/bulk_process_data_send_api.rb +252 -0
  9. data/lib/docusign_esign/api/connect_api.rb +239 -5
  10. data/lib/docusign_esign/api/email_archive_api.rb +8 -8
  11. data/lib/docusign_esign/api/envelopes_api.rb +1435 -207
  12. data/lib/docusign_esign/api/notary_api.rb +16 -16
  13. data/lib/docusign_esign/api/organizations_api.rb +8 -60
  14. data/lib/docusign_esign/api/power_forms_api.rb +24 -16
  15. data/lib/docusign_esign/api/templates_api.rb +20 -79
  16. data/lib/docusign_esign/api/users_api.rb +22 -14
  17. data/lib/docusign_esign/api/workspaces_api.rb +4 -4
  18. data/lib/docusign_esign/client/api_client.rb +16 -10
  19. data/lib/docusign_esign/client/api_error.rb +1 -1
  20. data/lib/docusign_esign/client/auth/oauth.rb +1 -1
  21. data/lib/docusign_esign/models/access_code_format.rb +6 -0
  22. data/lib/docusign_esign/models/account_billing_plan.rb +25 -4
  23. data/lib/docusign_esign/models/account_billing_plan_response.rb +37 -10
  24. data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
  25. data/lib/docusign_esign/models/account_identity_verification_workflow.rb +2 -0
  26. data/lib/docusign_esign/models/account_information.rb +11 -1
  27. data/lib/docusign_esign/models/account_notification.rb +3 -0
  28. data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
  29. data/lib/docusign_esign/models/account_password_rules.rb +7 -0
  30. data/lib/docusign_esign/models/account_role_settings.rb +81 -4
  31. data/lib/docusign_esign/models/account_settings_information.rb +1075 -13
  32. data/lib/docusign_esign/models/account_shared_access.rb +1 -0
  33. data/lib/docusign_esign/models/account_signature.rb +2 -0
  34. data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
  35. data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
  36. data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
  37. data/lib/docusign_esign/models/account_ui_settings.rb +28 -13
  38. data/lib/docusign_esign/models/address_information_input.rb +1 -0
  39. data/lib/docusign_esign/models/agent.rb +45 -1
  40. data/lib/docusign_esign/models/app_store_receipt.rb +21 -1
  41. data/lib/docusign_esign/models/approve.rb +65 -1
  42. data/lib/docusign_esign/models/authentication_status.rb +19 -0
  43. data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
  44. data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
  45. data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
  46. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  47. data/lib/docusign_esign/models/billing_entity_information_response.rb +214 -0
  48. data/lib/docusign_esign/models/billing_invoice_item.rb +21 -1
  49. data/lib/docusign_esign/models/billing_invoices_summary.rb +21 -1
  50. data/lib/docusign_esign/models/billing_plan_information.rb +52 -4
  51. data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
  52. data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
  53. data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
  54. data/lib/docusign_esign/models/brand.rb +4 -0
  55. data/lib/docusign_esign/models/brand_email_content.rb +1 -0
  56. data/lib/docusign_esign/models/brand_link.rb +1 -0
  57. data/lib/docusign_esign/models/brand_logos.rb +1 -0
  58. data/lib/docusign_esign/models/brand_request.rb +1 -0
  59. data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
  60. data/lib/docusign_esign/models/brand_resources.rb +3 -0
  61. data/lib/docusign_esign/models/brands_request.rb +1 -0
  62. data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
  63. data/lib/docusign_esign/models/bulk_process_request.rb +194 -0
  64. data/lib/docusign_esign/models/bulk_process_response.rb +248 -0
  65. data/lib/docusign_esign/models/bulk_process_result.rb +206 -0
  66. data/lib/docusign_esign/models/bulk_processing_list_summaries.rb +186 -0
  67. data/lib/docusign_esign/models/bulk_processing_list_summary.rb +214 -0
  68. data/lib/docusign_esign/models/bulk_processing_lists.rb +186 -0
  69. data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
  70. data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +204 -0
  71. data/lib/docusign_esign/models/bulk_send_batch_error.rb +194 -0
  72. data/lib/docusign_esign/models/bulk_send_batch_status.rb +42 -1
  73. data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +22 -1
  74. data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
  75. data/lib/docusign_esign/models/bulk_send_envelopes_info.rb +304 -0
  76. data/lib/docusign_esign/models/bulk_send_error_status.rb +12 -1
  77. data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
  78. data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
  79. data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
  80. data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
  81. data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
  82. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
  83. data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
  84. data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
  85. data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
  86. data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
  87. data/lib/docusign_esign/models/captive_recipient.rb +2 -0
  88. data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
  89. data/lib/docusign_esign/models/carbon_copy.rb +48 -1
  90. data/lib/docusign_esign/models/certified_delivery.rb +47 -1
  91. data/lib/docusign_esign/models/checkbox.rb +109 -1
  92. data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
  93. data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
  94. data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
  95. data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
  96. data/lib/docusign_esign/models/comment_thread.rb +63 -1
  97. data/lib/docusign_esign/models/commission_county.rb +72 -1
  98. data/lib/docusign_esign/models/commission_expiration.rb +72 -1
  99. data/lib/docusign_esign/models/commission_number.rb +72 -1
  100. data/lib/docusign_esign/models/commission_state.rb +72 -1
  101. data/lib/docusign_esign/models/company.rb +72 -1
  102. data/lib/docusign_esign/models/composite_template.rb +2 -0
  103. data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
  104. data/lib/docusign_esign/models/connect_config_results.rb +1 -0
  105. data/lib/docusign_esign/models/connect_custom_configuration.rb +60 -4
  106. data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
  107. data/lib/docusign_esign/models/connect_delete_failure_result.rb +174 -0
  108. data/lib/docusign_esign/models/connect_event_data.rb +1 -0
  109. data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
  110. data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
  111. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +195 -0
  112. data/lib/docusign_esign/models/connect_log.rb +1 -0
  113. data/lib/docusign_esign/models/connect_o_auth_config.rb +214 -0
  114. data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
  115. data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
  116. data/lib/docusign_esign/models/connect_user_info.rb +214 -0
  117. data/lib/docusign_esign/models/consent_details.rb +204 -0
  118. data/lib/docusign_esign/models/console_view_request.rb +1 -0
  119. data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
  120. data/lib/docusign_esign/models/contact.rb +12 -1
  121. data/lib/docusign_esign/models/contact_get_response.rb +1 -0
  122. data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
  123. data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
  124. data/lib/docusign_esign/models/contact_update_response.rb +1 -0
  125. data/lib/docusign_esign/models/correct_view_request.rb +12 -1
  126. data/lib/docusign_esign/models/credit_card_information.rb +2 -0
  127. data/lib/docusign_esign/models/currency.rb +95 -1
  128. data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
  129. data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
  130. data/lib/docusign_esign/models/custom_field.rb +2 -0
  131. data/lib/docusign_esign/models/date.rb +98 -1
  132. data/lib/docusign_esign/models/date_signed.rb +66 -1
  133. data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
  134. data/lib/docusign_esign/models/decline.rb +66 -1
  135. data/lib/docusign_esign/models/delayed_routing.rb +206 -0
  136. data/lib/docusign_esign/models/delayed_routing_api_model.rb +206 -0
  137. data/lib/docusign_esign/models/delegation_info.rb +214 -0
  138. data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
  139. data/lib/docusign_esign/models/document.rb +3 -0
  140. data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
  141. data/lib/docusign_esign/models/document_html_definition.rb +1 -0
  142. data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
  143. data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
  144. data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
  145. data/lib/docusign_esign/models/document_template.rb +1 -0
  146. data/lib/docusign_esign/models/document_visibility.rb +2 -0
  147. data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
  148. data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
  149. data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
  150. data/lib/docusign_esign/models/downgrade_plan_update_response.rb +11 -1
  151. data/lib/docusign_esign/models/downgrade_request_information.rb +204 -0
  152. data/lib/docusign_esign/models/draw.rb +60 -1
  153. data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
  154. data/lib/docusign_esign/models/editor.rb +46 -1
  155. data/lib/docusign_esign/models/email.rb +98 -1
  156. data/lib/docusign_esign/models/email_address.rb +66 -1
  157. data/lib/docusign_esign/models/envelope.rb +20 -1
  158. data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
  159. data/lib/docusign_esign/models/envelope_custom_metadata.rb +186 -0
  160. data/lib/docusign_esign/models/envelope_definition.rb +23 -1
  161. data/lib/docusign_esign/models/envelope_delay_rule.rb +194 -0
  162. data/lib/docusign_esign/models/envelope_delay_rule_api_model.rb +195 -0
  163. data/lib/docusign_esign/models/envelope_document.rb +7 -0
  164. data/lib/docusign_esign/models/envelope_event.rb +1 -0
  165. data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
  166. data/lib/docusign_esign/models/envelope_id.rb +65 -1
  167. data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
  168. data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
  169. data/lib/docusign_esign/models/envelope_publish_transaction.rb +307 -0
  170. data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -0
  171. data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
  172. data/lib/docusign_esign/models/envelope_summary.rb +3 -0
  173. data/lib/docusign_esign/models/envelope_template.rb +22 -1
  174. data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
  175. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
  176. data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
  177. data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
  178. data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
  179. data/lib/docusign_esign/models/envelopes_information.rb +1 -0
  180. data/lib/docusign_esign/models/event_notification.rb +24 -1
  181. data/lib/docusign_esign/models/event_result.rb +1 -0
  182. data/lib/docusign_esign/models/external_document_sources.rb +6 -0
  183. data/lib/docusign_esign/models/external_file.rb +1 -0
  184. data/lib/docusign_esign/models/external_folder.rb +1 -0
  185. data/lib/docusign_esign/models/external_primary_account_recipient_auth_requirements.rb +214 -0
  186. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
  187. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
  188. data/lib/docusign_esign/models/feature_set.rb +1 -0
  189. data/lib/docusign_esign/models/filter.rb +1 -0
  190. data/lib/docusign_esign/models/first_name.rb +66 -1
  191. data/lib/docusign_esign/models/folder.rb +4 -0
  192. data/lib/docusign_esign/models/folder_item_response.rb +1 -0
  193. data/lib/docusign_esign/models/folder_item_v2.rb +13 -1
  194. data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
  195. data/lib/docusign_esign/models/folders_request.rb +1 -0
  196. data/lib/docusign_esign/models/form_data_item.rb +1 -0
  197. data/lib/docusign_esign/models/formula_tab.rb +103 -1
  198. data/lib/docusign_esign/models/full_name.rb +66 -1
  199. data/lib/docusign_esign/models/group.rb +13 -1
  200. data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
  201. data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
  202. data/lib/docusign_esign/models/id_evidence_resource_token.rb +194 -0
  203. data/lib/docusign_esign/models/id_evidence_view_link.rb +184 -0
  204. data/lib/docusign_esign/models/in_person_signer.rb +31 -0
  205. data/lib/docusign_esign/models/initial_here.rb +60 -1
  206. data/lib/docusign_esign/models/inline_template.rb +3 -0
  207. data/lib/docusign_esign/models/integrated_connect_user_info_list.rb +246 -0
  208. data/lib/docusign_esign/models/intermediary.rb +46 -1
  209. data/lib/docusign_esign/models/jurisdiction.rb +1 -0
  210. data/lib/docusign_esign/models/last_name.rb +66 -1
  211. data/lib/docusign_esign/models/linked_external_primary_account.rb +21 -1
  212. data/lib/docusign_esign/models/list.rb +112 -1
  213. data/lib/docusign_esign/models/list_custom_field.rb +2 -0
  214. data/lib/docusign_esign/models/list_item.rb +4 -0
  215. data/lib/docusign_esign/models/locale_policy.rb +13 -0
  216. data/lib/docusign_esign/models/lock_information.rb +2 -0
  217. data/lib/docusign_esign/models/lock_request.rb +1 -0
  218. data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
  219. data/lib/docusign_esign/models/member_shared_items.rb +3 -0
  220. data/lib/docusign_esign/models/merge_field.rb +6 -0
  221. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
  222. data/lib/docusign_esign/models/money.rb +1 -0
  223. data/lib/docusign_esign/models/name_value.rb +2 -0
  224. data/lib/docusign_esign/models/new_account_definition.rb +53 -4
  225. data/lib/docusign_esign/models/new_account_summary.rb +1 -0
  226. data/lib/docusign_esign/models/new_user.rb +2 -0
  227. data/lib/docusign_esign/models/new_users_summary.rb +1 -0
  228. data/lib/docusign_esign/models/notarize.rb +58 -1
  229. data/lib/docusign_esign/models/notary.rb +1 -0
  230. data/lib/docusign_esign/models/notary_host.rb +20 -0
  231. data/lib/docusign_esign/models/notary_journal.rb +2 -0
  232. data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
  233. data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
  234. data/lib/docusign_esign/models/notary_recipient.rb +93 -1
  235. data/lib/docusign_esign/models/notary_result.rb +2 -0
  236. data/lib/docusign_esign/models/notary_seal.rb +59 -1
  237. data/lib/docusign_esign/models/note.rb +67 -1
  238. data/lib/docusign_esign/models/notification.rb +2 -0
  239. data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
  240. data/lib/docusign_esign/models/notification_defaults.rb +2 -0
  241. data/lib/docusign_esign/models/number.rb +100 -1
  242. data/lib/docusign_esign/models/page.rb +1 -0
  243. data/lib/docusign_esign/models/participant.rb +908 -0
  244. data/lib/docusign_esign/models/payment_details.rb +16 -1
  245. data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
  246. data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
  247. data/lib/docusign_esign/models/payment_line_item.rb +1 -0
  248. data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
  249. data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
  250. data/lib/docusign_esign/models/permission_profile.rb +2 -0
  251. data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
  252. data/lib/docusign_esign/models/phone_number.rb +72 -1
  253. data/lib/docusign_esign/models/poly_line_overlay.rb +60 -1
  254. data/lib/docusign_esign/models/power_form.rb +2 -0
  255. data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
  256. data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
  257. data/lib/docusign_esign/models/power_forms_response.rb +1 -0
  258. data/lib/docusign_esign/models/prefill_tabs.rb +65 -4
  259. data/lib/docusign_esign/models/property_metadata.rb +1 -0
  260. data/lib/docusign_esign/models/radio.rb +48 -1
  261. data/lib/docusign_esign/models/radio_group.rb +78 -4
  262. data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
  263. data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
  264. data/lib/docusign_esign/models/recipient_group.rb +1 -0
  265. data/lib/docusign_esign/models/recipient_identity_phone_number.rb +44 -4
  266. data/lib/docusign_esign/models/recipient_identity_verification.rb +15 -4
  267. data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
  268. data/lib/docusign_esign/models/recipient_option.rb +1 -0
  269. data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
  270. data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
  271. data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
  272. data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
  273. data/lib/docusign_esign/models/recipient_routing.rb +2 -0
  274. data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
  275. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
  276. data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
  277. data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +102 -2
  278. data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
  279. data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
  280. data/lib/docusign_esign/models/recipients.rb +14 -1
  281. data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
  282. data/lib/docusign_esign/models/reserved_domain_existence.rb +194 -0
  283. data/lib/docusign_esign/models/return_url_request.rb +1 -0
  284. data/lib/docusign_esign/models/scheduled_sending.rb +216 -0
  285. data/lib/docusign_esign/models/scheduled_sending_api_model.rb +206 -0
  286. data/lib/docusign_esign/models/seal_sign.rb +17 -0
  287. data/lib/docusign_esign/models/seat_discount.rb +1 -0
  288. data/lib/docusign_esign/models/sender_company.rb +65 -1
  289. data/lib/docusign_esign/models/sender_email_notifications.rb +12 -1
  290. data/lib/docusign_esign/models/sender_name.rb +65 -1
  291. data/lib/docusign_esign/models/settings_metadata.rb +1 -0
  292. data/lib/docusign_esign/models/shared_item.rb +3 -0
  293. data/lib/docusign_esign/models/sign_here.rb +62 -1
  294. data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
  295. data/lib/docusign_esign/models/signature_type.rb +1 -0
  296. data/lib/docusign_esign/models/signer.rb +84 -1
  297. data/lib/docusign_esign/models/signer_attachment.rb +60 -1
  298. data/lib/docusign_esign/models/signing_group.rb +2 -0
  299. data/lib/docusign_esign/models/signing_group_user.rb +1 -0
  300. data/lib/docusign_esign/models/smart_section.rb +61 -1
  301. data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
  302. data/lib/docusign_esign/models/social_account_information.rb +1 -0
  303. data/lib/docusign_esign/models/ssn.rb +98 -1
  304. data/lib/docusign_esign/models/stamp.rb +2 -0
  305. data/lib/docusign_esign/models/supported_languages.rb +1 -0
  306. data/lib/docusign_esign/models/tab_account_settings.rb +42 -1
  307. data/lib/docusign_esign/models/tab_group.rb +61 -1
  308. data/lib/docusign_esign/models/tab_metadata.rb +34 -1
  309. data/lib/docusign_esign/models/tabs.rb +2 -0
  310. data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
  311. data/lib/docusign_esign/models/template_notification_request.rb +2 -0
  312. data/lib/docusign_esign/models/template_recipients.rb +14 -1
  313. data/lib/docusign_esign/models/template_role.rb +4 -0
  314. data/lib/docusign_esign/models/template_shared_item.rb +3 -0
  315. data/lib/docusign_esign/models/template_summary.rb +3 -0
  316. data/lib/docusign_esign/models/template_tabs.rb +1 -0
  317. data/lib/docusign_esign/models/template_update_summary.rb +4 -0
  318. data/lib/docusign_esign/models/text.rb +100 -1
  319. data/lib/docusign_esign/models/text_custom_field.rb +2 -0
  320. data/lib/docusign_esign/models/title.rb +72 -1
  321. data/lib/docusign_esign/models/user_account_management_granular_information.rb +70 -1
  322. data/lib/docusign_esign/models/user_info.rb +1 -0
  323. data/lib/docusign_esign/models/user_information.rb +17 -1
  324. data/lib/docusign_esign/models/user_information_list.rb +1 -0
  325. data/lib/docusign_esign/models/user_password_information.rb +1 -0
  326. data/lib/docusign_esign/models/user_password_rules.rb +2 -0
  327. data/lib/docusign_esign/models/user_profile.rb +3 -0
  328. data/lib/docusign_esign/models/user_settings_information.rb +103 -4
  329. data/lib/docusign_esign/models/user_shared_item.rb +3 -0
  330. data/lib/docusign_esign/models/user_signature.rb +2 -0
  331. data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
  332. data/lib/docusign_esign/models/view.rb +66 -1
  333. data/lib/docusign_esign/models/witness.rb +84 -1
  334. data/lib/docusign_esign/models/workflow.rb +32 -1
  335. data/lib/docusign_esign/models/workflow_step.rb +13 -1
  336. data/lib/docusign_esign/models/workspace.rb +4 -0
  337. data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
  338. data/lib/docusign_esign/models/workspace_item.rb +5 -0
  339. data/lib/docusign_esign/models/workspace_settings.rb +1 -0
  340. data/lib/docusign_esign/models/workspace_user.rb +1 -0
  341. data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
  342. data/lib/docusign_esign/models/zip.rb +99 -1
  343. data/lib/docusign_esign/version.rb +1 -1
  344. data/lib/docusign_esign.rb +30 -17
  345. data/tests/spec/unit_tests_using_jwt_spec.rb +605 -449
  346. metadata +70 -44
  347. data/Gemfile.lock +0 -73
  348. data/docusign_esign-2.12.0.rc1.gem +0 -0
  349. data/docusign_esign-3.12.0.rc1.gem +0 -0
  350. data/lib/docusign_esign/.DS_Store +0 -0
  351. data/lib/docusign_esign/api/.DS_Store +0 -0
  352. data/lib/docusign_esign/client/.DS_Store +0 -0
  353. data/tests/.DS_Store +0 -0
  354. data/tests/Gemfile.lock +0 -46
  355. data/tests/docs/private.pem +0 -27
@@ -0,0 +1,412 @@
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
+
17
+ class BulkProcessDataApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = BulkProcessDataApi.default)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Uses the specified bulk envelopes list to update the envelopes specified in the payload
25
+ #
26
+ # @param account_id The external account number (int) or account ID Guid.
27
+ # @param process_action
28
+ # @return [nil]
29
+ def create_bulk_process_request(account_id, process_action)
30
+ create_bulk_process_request_with_http_info(account_id, process_action)
31
+ return nil
32
+ end
33
+
34
+ # Uses the specified bulk envelopes list to update the envelopes specified in the payload
35
+ #
36
+ # @param account_id The external account number (int) or account ID Guid.
37
+ # @param process_action
38
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
39
+ def create_bulk_process_request_with_http_info(account_id, process_action)
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug "Calling API: BulkProcessDataApi.create_bulk_process_request ..."
42
+ end
43
+ # verify the required parameter 'account_id' is set
44
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.create_bulk_process_request" if account_id.nil?
45
+ # verify the required parameter 'process_action' is set
46
+ fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.create_bulk_process_request" if process_action.nil?
47
+ # resource path
48
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)
49
+
50
+ # query parameters
51
+ query_params = {}
52
+
53
+ # header parameters
54
+ header_params = {}
55
+ # HTTP header 'Accept' (if needed)
56
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
57
+
58
+ # form parameters
59
+ form_params = {}
60
+
61
+ # http body (model)
62
+ post_body = nil
63
+ auth_names = []
64
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
65
+ :header_params => header_params,
66
+ :query_params => query_params,
67
+ :form_params => form_params,
68
+ :body => post_body,
69
+ :auth_names => auth_names)
70
+ if @api_client.config.debugging
71
+ @api_client.config.logger.debug "API called: BulkProcessDataApi#create_bulk_process_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
72
+ end
73
+ return data, status_code, headers
74
+ end
75
+
76
+ # Uses the specified bulk envelopes list to update the envelopes specified in the payload
77
+ #
78
+ # @param account_id The external account number (int) or account ID Guid.
79
+ # @param bulk_process_list_id
80
+ # @param process_action
81
+ # @param bulk_process_request (optional parameter)
82
+ # @return [BulkProcessResponse]
83
+ def create_bulk_process_request_to_queue(account_id, bulk_process_list_id, process_action, bulk_process_request)
84
+ data, _status_code, _headers = create_bulk_process_request_to_queue_with_http_info(account_id, bulk_process_list_id, process_action, bulk_process_request)
85
+ return data
86
+ end
87
+
88
+ # Uses the specified bulk envelopes list to update the envelopes specified in the payload
89
+ #
90
+ # @param account_id The external account number (int) or account ID Guid.
91
+ # @param bulk_process_list_id
92
+ # @param process_action
93
+ # @param bulk_process_request (optional parameter)
94
+ # @return [Array<(BulkProcessResponse, Fixnum, Hash)>] BulkProcessResponse data, response status code and response headers
95
+ def create_bulk_process_request_to_queue_with_http_info(account_id, bulk_process_list_id, process_action, bulk_process_request)
96
+ if @api_client.config.debugging
97
+ @api_client.config.logger.debug "Calling API: BulkProcessDataApi.create_bulk_process_request_to_queue ..."
98
+ end
99
+ # verify the required parameter 'account_id' is set
100
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.create_bulk_process_request_to_queue" if account_id.nil?
101
+ # verify the required parameter 'bulk_process_list_id' is set
102
+ fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataApi.create_bulk_process_request_to_queue" if bulk_process_list_id.nil?
103
+ # verify the required parameter 'process_action' is set
104
+ fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.create_bulk_process_request_to_queue" if process_action.nil?
105
+ # resource path
106
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)
107
+
108
+ # query parameters
109
+ query_params = {}
110
+
111
+ # header parameters
112
+ header_params = {}
113
+ # HTTP header 'Accept' (if needed)
114
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
115
+
116
+ # form parameters
117
+ form_params = {}
118
+
119
+ # http body (model)
120
+ post_body = @api_client.object_to_http_body(bulk_process_request)
121
+ auth_names = []
122
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
123
+ :header_params => header_params,
124
+ :query_params => query_params,
125
+ :form_params => form_params,
126
+ :body => post_body,
127
+ :auth_names => auth_names,
128
+ :return_type => 'BulkProcessResponse')
129
+ if @api_client.config.debugging
130
+ @api_client.config.logger.debug "API called: BulkProcessDataApi#create_bulk_process_request_to_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
131
+ end
132
+ return data, status_code, headers
133
+ end
134
+
135
+ # Deletes a specific bulk process list
136
+ #
137
+ # @param account_id The external account number (int) or account ID Guid.
138
+ # @param bulk_process_list_id
139
+ # @param process_action
140
+ # @return [BulkProcessResult]
141
+ def delete_bulk_process_list(account_id, bulk_process_list_id, process_action)
142
+ data, _status_code, _headers = delete_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
143
+ return data
144
+ end
145
+
146
+ # Deletes a specific bulk process list
147
+ #
148
+ # @param account_id The external account number (int) or account ID Guid.
149
+ # @param bulk_process_list_id
150
+ # @param process_action
151
+ # @return [Array<(BulkProcessResult, Fixnum, Hash)>] BulkProcessResult data, response status code and response headers
152
+ def delete_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
153
+ if @api_client.config.debugging
154
+ @api_client.config.logger.debug "Calling API: BulkProcessDataApi.delete_bulk_process_list ..."
155
+ end
156
+ # verify the required parameter 'account_id' is set
157
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.delete_bulk_process_list" if account_id.nil?
158
+ # verify the required parameter 'bulk_process_list_id' is set
159
+ fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataApi.delete_bulk_process_list" if bulk_process_list_id.nil?
160
+ # verify the required parameter 'process_action' is set
161
+ fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.delete_bulk_process_list" if process_action.nil?
162
+ # resource path
163
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)
164
+
165
+ # query parameters
166
+ query_params = {}
167
+
168
+ # header parameters
169
+ header_params = {}
170
+ # HTTP header 'Accept' (if needed)
171
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
172
+
173
+ # form parameters
174
+ form_params = {}
175
+
176
+ # http body (model)
177
+ post_body = nil
178
+ auth_names = []
179
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
180
+ :header_params => header_params,
181
+ :query_params => query_params,
182
+ :form_params => form_params,
183
+ :body => post_body,
184
+ :auth_names => auth_names,
185
+ :return_type => 'BulkProcessResult')
186
+ if @api_client.config.debugging
187
+ @api_client.config.logger.debug "API called: BulkProcessDataApi#delete_bulk_process_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
188
+ end
189
+ return data, status_code, headers
190
+ end
191
+
192
+ # Deletes a specific bulk process list
193
+ #
194
+ # @param account_id The external account number (int) or account ID Guid.
195
+ # @param process_action
196
+ # @param bulk_processing_lists (optional parameter)
197
+ # @return [BulkProcessResult]
198
+ def delete_bulk_process_lists(account_id, process_action, bulk_processing_lists)
199
+ data, _status_code, _headers = delete_bulk_process_lists_with_http_info(account_id, process_action, bulk_processing_lists)
200
+ return data
201
+ end
202
+
203
+ # Deletes a specific bulk process list
204
+ #
205
+ # @param account_id The external account number (int) or account ID Guid.
206
+ # @param process_action
207
+ # @param bulk_processing_lists (optional parameter)
208
+ # @return [Array<(BulkProcessResult, Fixnum, Hash)>] BulkProcessResult data, response status code and response headers
209
+ def delete_bulk_process_lists_with_http_info(account_id, process_action, bulk_processing_lists)
210
+ if @api_client.config.debugging
211
+ @api_client.config.logger.debug "Calling API: BulkProcessDataApi.delete_bulk_process_lists ..."
212
+ end
213
+ # verify the required parameter 'account_id' is set
214
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.delete_bulk_process_lists" if account_id.nil?
215
+ # verify the required parameter 'process_action' is set
216
+ fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.delete_bulk_process_lists" if process_action.nil?
217
+ # resource path
218
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)
219
+
220
+ # query parameters
221
+ query_params = {}
222
+
223
+ # header parameters
224
+ header_params = {}
225
+ # HTTP header 'Accept' (if needed)
226
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
227
+
228
+ # form parameters
229
+ form_params = {}
230
+
231
+ # http body (model)
232
+ post_body = @api_client.object_to_http_body(bulk_processing_lists)
233
+ auth_names = []
234
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
235
+ :header_params => header_params,
236
+ :query_params => query_params,
237
+ :form_params => form_params,
238
+ :body => post_body,
239
+ :auth_names => auth_names,
240
+ :return_type => 'BulkProcessResult')
241
+ if @api_client.config.debugging
242
+ @api_client.config.logger.debug "API called: BulkProcessDataApi#delete_bulk_process_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
243
+ end
244
+ return data, status_code, headers
245
+ end
246
+
247
+ # Gets a specific bulk process list
248
+ #
249
+ # @param account_id The external account number (int) or account ID Guid.
250
+ # @param bulk_process_list_id
251
+ # @param process_action
252
+ # @return [nil]
253
+ def get_bulk_process_list(account_id, bulk_process_list_id, process_action)
254
+ get_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
255
+ return nil
256
+ end
257
+
258
+ # Gets a specific bulk process list
259
+ #
260
+ # @param account_id The external account number (int) or account ID Guid.
261
+ # @param bulk_process_list_id
262
+ # @param process_action
263
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
264
+ def get_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
265
+ if @api_client.config.debugging
266
+ @api_client.config.logger.debug "Calling API: BulkProcessDataApi.get_bulk_process_list ..."
267
+ end
268
+ # verify the required parameter 'account_id' is set
269
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.get_bulk_process_list" if account_id.nil?
270
+ # verify the required parameter 'bulk_process_list_id' is set
271
+ fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataApi.get_bulk_process_list" if bulk_process_list_id.nil?
272
+ # verify the required parameter 'process_action' is set
273
+ fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.get_bulk_process_list" if process_action.nil?
274
+ # resource path
275
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)
276
+
277
+ # query parameters
278
+ query_params = {}
279
+
280
+ # header parameters
281
+ header_params = {}
282
+ # HTTP header 'Accept' (if needed)
283
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
284
+
285
+ # form parameters
286
+ form_params = {}
287
+
288
+ # http body (model)
289
+ post_body = nil
290
+ auth_names = []
291
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
292
+ :header_params => header_params,
293
+ :query_params => query_params,
294
+ :form_params => form_params,
295
+ :body => post_body,
296
+ :auth_names => auth_names)
297
+ if @api_client.config.debugging
298
+ @api_client.config.logger.debug "API called: BulkProcessDataApi#get_bulk_process_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
299
+ end
300
+ return data, status_code, headers
301
+ end
302
+
303
+ # Lists top-level details for all bulk process lists visible to the current user
304
+ #
305
+ # @param account_id The external account number (int) or account ID Guid.
306
+ # @param process_action
307
+ # @return [BulkProcessingListSummaries]
308
+ def get_bulk_process_lists(account_id, process_action)
309
+ data, _status_code, _headers = get_bulk_process_lists_with_http_info(account_id, process_action)
310
+ return data
311
+ end
312
+
313
+ # Lists top-level details for all bulk process lists visible to the current user
314
+ #
315
+ # @param account_id The external account number (int) or account ID Guid.
316
+ # @param process_action
317
+ # @return [Array<(BulkProcessingListSummaries, Fixnum, Hash)>] BulkProcessingListSummaries data, response status code and response headers
318
+ def get_bulk_process_lists_with_http_info(account_id, process_action)
319
+ if @api_client.config.debugging
320
+ @api_client.config.logger.debug "Calling API: BulkProcessDataApi.get_bulk_process_lists ..."
321
+ end
322
+ # verify the required parameter 'account_id' is set
323
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.get_bulk_process_lists" if account_id.nil?
324
+ # verify the required parameter 'process_action' is set
325
+ fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.get_bulk_process_lists" if process_action.nil?
326
+ # resource path
327
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)
328
+
329
+ # query parameters
330
+ query_params = {}
331
+
332
+ # header parameters
333
+ header_params = {}
334
+ # HTTP header 'Accept' (if needed)
335
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
336
+
337
+ # form parameters
338
+ form_params = {}
339
+
340
+ # http body (model)
341
+ post_body = nil
342
+ auth_names = []
343
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
344
+ :header_params => header_params,
345
+ :query_params => query_params,
346
+ :form_params => form_params,
347
+ :body => post_body,
348
+ :auth_names => auth_names,
349
+ :return_type => 'BulkProcessingListSummaries')
350
+ if @api_client.config.debugging
351
+ @api_client.config.logger.debug "API called: BulkProcessDataApi#get_bulk_process_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
352
+ end
353
+ return data, status_code, headers
354
+ end
355
+
356
+ # Updates a specific bulk process list
357
+ #
358
+ # @param account_id The external account number (int) or account ID Guid.
359
+ # @param bulk_process_list_id
360
+ # @param process_action
361
+ # @return [nil]
362
+ def update_bulk_process_list(account_id, bulk_process_list_id, process_action)
363
+ update_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
364
+ return nil
365
+ end
366
+
367
+ # Updates a specific bulk process list
368
+ #
369
+ # @param account_id The external account number (int) or account ID Guid.
370
+ # @param bulk_process_list_id
371
+ # @param process_action
372
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
373
+ def update_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
374
+ if @api_client.config.debugging
375
+ @api_client.config.logger.debug "Calling API: BulkProcessDataApi.update_bulk_process_list ..."
376
+ end
377
+ # verify the required parameter 'account_id' is set
378
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.update_bulk_process_list" if account_id.nil?
379
+ # verify the required parameter 'bulk_process_list_id' is set
380
+ fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataApi.update_bulk_process_list" if bulk_process_list_id.nil?
381
+ # verify the required parameter 'process_action' is set
382
+ fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.update_bulk_process_list" if process_action.nil?
383
+ # resource path
384
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)
385
+
386
+ # query parameters
387
+ query_params = {}
388
+
389
+ # header parameters
390
+ header_params = {}
391
+ # HTTP header 'Accept' (if needed)
392
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
393
+
394
+ # form parameters
395
+ form_params = {}
396
+
397
+ # http body (model)
398
+ post_body = nil
399
+ auth_names = []
400
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
401
+ :header_params => header_params,
402
+ :query_params => query_params,
403
+ :form_params => form_params,
404
+ :body => post_body,
405
+ :auth_names => auth_names)
406
+ if @api_client.config.debugging
407
+ @api_client.config.logger.debug "API called: BulkProcessDataApi#update_bulk_process_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
408
+ end
409
+ return data, status_code, headers
410
+ end
411
+ end
412
+ end
@@ -0,0 +1,252 @@
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
+
17
+ class BulkProcessDataSendApi
18
+ attr_accessor :api_client
19
+
20
+ def initialize(api_client = BulkProcessDataSendApi.default)
21
+ @api_client = api_client
22
+ end
23
+
24
+ # Uses the specified bulk envelopes list to update the envelopes specified in the payload
25
+ #
26
+ # @param account_id The external account number (int) or account ID Guid.
27
+ # @param bulk_process_list_id
28
+ # @param process_action
29
+ # @param bulk_process_request (optional parameter)
30
+ # @return [BulkProcessResponse]
31
+ def create_bulk_process_request_to_queue(account_id, bulk_process_list_id, process_action, bulk_process_request)
32
+ data, _status_code, _headers = create_bulk_process_request_to_queue_with_http_info(account_id, bulk_process_list_id, process_action, bulk_process_request)
33
+ return data
34
+ end
35
+
36
+ # Uses the specified bulk envelopes list to update the envelopes specified in the payload
37
+ #
38
+ # @param account_id The external account number (int) or account ID Guid.
39
+ # @param bulk_process_list_id
40
+ # @param process_action
41
+ # @param bulk_process_request (optional parameter)
42
+ # @return [Array<(BulkProcessResponse, Fixnum, Hash)>] BulkProcessResponse data, response status code and response headers
43
+ def create_bulk_process_request_to_queue_with_http_info(account_id, bulk_process_list_id, process_action, bulk_process_request)
44
+ if @api_client.config.debugging
45
+ @api_client.config.logger.debug "Calling API: BulkProcessDataSendApi.create_bulk_process_request_to_queue ..."
46
+ end
47
+ # verify the required parameter 'account_id' is set
48
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataSendApi.create_bulk_process_request_to_queue" if account_id.nil?
49
+ # verify the required parameter 'bulk_process_list_id' is set
50
+ fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataSendApi.create_bulk_process_request_to_queue" if bulk_process_list_id.nil?
51
+ # verify the required parameter 'process_action' is set
52
+ fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataSendApi.create_bulk_process_request_to_queue" if process_action.nil?
53
+ # resource path
54
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}/send".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)
55
+
56
+ # query parameters
57
+ query_params = {}
58
+
59
+ # header parameters
60
+ header_params = {}
61
+ # HTTP header 'Accept' (if needed)
62
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
63
+
64
+ # form parameters
65
+ form_params = {}
66
+
67
+ # http body (model)
68
+ post_body = @api_client.object_to_http_body(bulk_process_request)
69
+ auth_names = []
70
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => 'BulkProcessResponse')
77
+ if @api_client.config.debugging
78
+ @api_client.config.logger.debug "API called: BulkProcessDataSendApi#create_bulk_process_request_to_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
79
+ end
80
+ return data, status_code, headers
81
+ end
82
+
83
+ # Deletes a specific bulk process list
84
+ #
85
+ # @param account_id The external account number (int) or account ID Guid.
86
+ # @param bulk_process_list_id
87
+ # @param process_action
88
+ # @return [BulkProcessResult]
89
+ def delete_bulk_process_list(account_id, bulk_process_list_id, process_action)
90
+ data, _status_code, _headers = delete_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
91
+ return data
92
+ end
93
+
94
+ # Deletes a specific bulk process list
95
+ #
96
+ # @param account_id The external account number (int) or account ID Guid.
97
+ # @param bulk_process_list_id
98
+ # @param process_action
99
+ # @return [Array<(BulkProcessResult, Fixnum, Hash)>] BulkProcessResult data, response status code and response headers
100
+ def delete_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
101
+ if @api_client.config.debugging
102
+ @api_client.config.logger.debug "Calling API: BulkProcessDataSendApi.delete_bulk_process_list ..."
103
+ end
104
+ # verify the required parameter 'account_id' is set
105
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataSendApi.delete_bulk_process_list" if account_id.nil?
106
+ # verify the required parameter 'bulk_process_list_id' is set
107
+ fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataSendApi.delete_bulk_process_list" if bulk_process_list_id.nil?
108
+ # verify the required parameter 'process_action' is set
109
+ fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataSendApi.delete_bulk_process_list" if process_action.nil?
110
+ # resource path
111
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}/send".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)
112
+
113
+ # query parameters
114
+ query_params = {}
115
+
116
+ # header parameters
117
+ header_params = {}
118
+ # HTTP header 'Accept' (if needed)
119
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
120
+
121
+ # form parameters
122
+ form_params = {}
123
+
124
+ # http body (model)
125
+ post_body = nil
126
+ auth_names = []
127
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
128
+ :header_params => header_params,
129
+ :query_params => query_params,
130
+ :form_params => form_params,
131
+ :body => post_body,
132
+ :auth_names => auth_names,
133
+ :return_type => 'BulkProcessResult')
134
+ if @api_client.config.debugging
135
+ @api_client.config.logger.debug "API called: BulkProcessDataSendApi#delete_bulk_process_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
136
+ end
137
+ return data, status_code, headers
138
+ end
139
+
140
+ # Gets a specific bulk process list
141
+ #
142
+ # @param account_id The external account number (int) or account ID Guid.
143
+ # @param bulk_process_list_id
144
+ # @param process_action
145
+ # @return [nil]
146
+ def get_bulk_process_list(account_id, bulk_process_list_id, process_action)
147
+ get_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
148
+ return nil
149
+ end
150
+
151
+ # Gets a specific bulk process list
152
+ #
153
+ # @param account_id The external account number (int) or account ID Guid.
154
+ # @param bulk_process_list_id
155
+ # @param process_action
156
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
157
+ def get_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
158
+ if @api_client.config.debugging
159
+ @api_client.config.logger.debug "Calling API: BulkProcessDataSendApi.get_bulk_process_list ..."
160
+ end
161
+ # verify the required parameter 'account_id' is set
162
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataSendApi.get_bulk_process_list" if account_id.nil?
163
+ # verify the required parameter 'bulk_process_list_id' is set
164
+ fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataSendApi.get_bulk_process_list" if bulk_process_list_id.nil?
165
+ # verify the required parameter 'process_action' is set
166
+ fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataSendApi.get_bulk_process_list" if process_action.nil?
167
+ # resource path
168
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}/send".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)
169
+
170
+ # query parameters
171
+ query_params = {}
172
+
173
+ # header parameters
174
+ header_params = {}
175
+ # HTTP header 'Accept' (if needed)
176
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
177
+
178
+ # form parameters
179
+ form_params = {}
180
+
181
+ # http body (model)
182
+ post_body = nil
183
+ auth_names = []
184
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
185
+ :header_params => header_params,
186
+ :query_params => query_params,
187
+ :form_params => form_params,
188
+ :body => post_body,
189
+ :auth_names => auth_names)
190
+ if @api_client.config.debugging
191
+ @api_client.config.logger.debug "API called: BulkProcessDataSendApi#get_bulk_process_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
192
+ end
193
+ return data, status_code, headers
194
+ end
195
+
196
+ # Updates a specific bulk process list
197
+ #
198
+ # @param account_id The external account number (int) or account ID Guid.
199
+ # @param bulk_process_list_id
200
+ # @param process_action
201
+ # @return [nil]
202
+ def update_bulk_process_list(account_id, bulk_process_list_id, process_action)
203
+ update_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
204
+ return nil
205
+ end
206
+
207
+ # Updates a specific bulk process list
208
+ #
209
+ # @param account_id The external account number (int) or account ID Guid.
210
+ # @param bulk_process_list_id
211
+ # @param process_action
212
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
213
+ def update_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action)
214
+ if @api_client.config.debugging
215
+ @api_client.config.logger.debug "Calling API: BulkProcessDataSendApi.update_bulk_process_list ..."
216
+ end
217
+ # verify the required parameter 'account_id' is set
218
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataSendApi.update_bulk_process_list" if account_id.nil?
219
+ # verify the required parameter 'bulk_process_list_id' is set
220
+ fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataSendApi.update_bulk_process_list" if bulk_process_list_id.nil?
221
+ # verify the required parameter 'process_action' is set
222
+ fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataSendApi.update_bulk_process_list" if process_action.nil?
223
+ # resource path
224
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}/send".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)
225
+
226
+ # query parameters
227
+ query_params = {}
228
+
229
+ # header parameters
230
+ header_params = {}
231
+ # HTTP header 'Accept' (if needed)
232
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
233
+
234
+ # form parameters
235
+ form_params = {}
236
+
237
+ # http body (model)
238
+ post_body = nil
239
+ auth_names = []
240
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
241
+ :header_params => header_params,
242
+ :query_params => query_params,
243
+ :form_params => form_params,
244
+ :body => post_body,
245
+ :auth_names => auth_names)
246
+ if @api_client.config.debugging
247
+ @api_client.config.logger.debug "API called: BulkProcessDataSendApi#update_bulk_process_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
248
+ end
249
+ return data, status_code, headers
250
+ end
251
+ end
252
+ end