docusign_esign 3.6.0 → 3.10.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (521) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/Gemfile.lock +8 -9
  4. data/README.md +24 -53
  5. data/docusign_esign-2.10.0.rc1.gem +0 -0
  6. data/lib/docusign_esign.rb +12 -3
  7. data/lib/docusign_esign/api/accounts_api.rb +17 -13
  8. data/lib/docusign_esign/api/authentication_api.rb +0 -1
  9. data/lib/docusign_esign/api/billing_api.rb +0 -1
  10. data/lib/docusign_esign/api/bulk_envelopes_api.rb +69 -249
  11. data/lib/docusign_esign/api/cloud_storage_api.rb +0 -1
  12. data/lib/docusign_esign/api/connect_api.rb +0 -54
  13. data/lib/docusign_esign/api/custom_tabs_api.rb +0 -1
  14. data/lib/docusign_esign/api/data_feed_api.rb +0 -1
  15. data/lib/docusign_esign/api/diagnostics_api.rb +0 -1
  16. data/lib/docusign_esign/api/email_archive_api.rb +0 -1
  17. data/lib/docusign_esign/api/envelopes_api.rb +350 -3
  18. data/lib/docusign_esign/api/folders_api.rb +0 -1
  19. data/lib/docusign_esign/api/groups_api.rb +9 -10
  20. data/lib/docusign_esign/api/notary_api.rb +0 -1
  21. data/lib/docusign_esign/api/organizations_api.rb +0 -1
  22. data/lib/docusign_esign/api/power_forms_api.rb +0 -1
  23. data/lib/docusign_esign/api/signature_api.rb +256 -0
  24. data/lib/docusign_esign/api/signing_groups_api.rb +0 -1
  25. data/lib/docusign_esign/api/templates_api.rb +4 -1
  26. data/lib/docusign_esign/api/trust_service_providers_api.rb +0 -1
  27. data/lib/docusign_esign/api/users_api.rb +0 -1
  28. data/lib/docusign_esign/api/workspaces_api.rb +0 -1
  29. data/lib/docusign_esign/configuration.rb +0 -1
  30. data/lib/docusign_esign/models/access_code_format.rb +0 -1
  31. data/lib/docusign_esign/models/account_address.rb +0 -1
  32. data/lib/docusign_esign/models/account_billing_plan.rb +31 -2
  33. data/lib/docusign_esign/models/account_billing_plan_response.rb +0 -1
  34. data/lib/docusign_esign/models/account_identity_input_option.rb +0 -1
  35. data/lib/docusign_esign/models/account_identity_verification_response.rb +0 -1
  36. data/lib/docusign_esign/models/account_identity_verification_step.rb +0 -1
  37. data/lib/docusign_esign/models/account_identity_verification_workflow.rb +0 -1
  38. data/lib/docusign_esign/models/account_information.rb +34 -5
  39. data/lib/docusign_esign/models/account_minimum_password_length.rb +0 -1
  40. data/lib/docusign_esign/models/account_notification.rb +0 -1
  41. data/lib/docusign_esign/models/account_password_expire_password_days.rb +0 -1
  42. data/lib/docusign_esign/models/account_password_lockout_duration_minutes.rb +0 -1
  43. data/lib/docusign_esign/models/account_password_lockout_duration_type.rb +0 -1
  44. data/lib/docusign_esign/models/account_password_minimum_password_age_days.rb +0 -1
  45. data/lib/docusign_esign/models/account_password_questions_required.rb +0 -1
  46. data/lib/docusign_esign/models/account_password_rules.rb +0 -1
  47. data/lib/docusign_esign/models/account_password_strength_type.rb +0 -1
  48. data/lib/docusign_esign/models/account_password_strength_type_option.rb +0 -1
  49. data/lib/docusign_esign/models/account_role_settings.rb +20 -2
  50. data/lib/docusign_esign/models/account_seals.rb +0 -1
  51. data/lib/docusign_esign/models/account_settings_information.rb +355 -2
  52. data/lib/docusign_esign/models/account_shared_access.rb +0 -1
  53. data/lib/docusign_esign/models/account_signature.rb +0 -1
  54. data/lib/docusign_esign/models/account_signature_definition.rb +0 -1
  55. data/lib/docusign_esign/models/account_signature_provider.rb +0 -1
  56. data/lib/docusign_esign/models/account_signature_provider_option.rb +0 -1
  57. data/lib/docusign_esign/models/account_signature_providers.rb +0 -1
  58. data/lib/docusign_esign/models/account_signatures_information.rb +0 -1
  59. data/lib/docusign_esign/models/account_ui_settings.rb +39 -2
  60. data/lib/docusign_esign/models/add_on.rb +0 -1
  61. data/lib/docusign_esign/models/address_information.rb +0 -1
  62. data/lib/docusign_esign/models/address_information_input.rb +0 -1
  63. data/lib/docusign_esign/models/admin_message.rb +0 -1
  64. data/lib/docusign_esign/models/agent.rb +1 -11
  65. data/lib/docusign_esign/models/api_request_log.rb +0 -1
  66. data/lib/docusign_esign/models/api_request_logs_result.rb +0 -1
  67. data/lib/docusign_esign/models/app_store_product.rb +0 -1
  68. data/lib/docusign_esign/models/app_store_receipt.rb +0 -1
  69. data/lib/docusign_esign/models/approve.rb +11 -2
  70. data/lib/docusign_esign/models/ask_an_admin.rb +0 -1
  71. data/lib/docusign_esign/models/attachment.rb +0 -1
  72. data/lib/docusign_esign/models/authentication_method.rb +0 -1
  73. data/lib/docusign_esign/models/authentication_status.rb +0 -1
  74. data/lib/docusign_esign/models/bcc_email_address.rb +0 -1
  75. data/lib/docusign_esign/models/bcc_email_archive.rb +0 -1
  76. data/lib/docusign_esign/models/bcc_email_archive_history.rb +0 -1
  77. data/lib/docusign_esign/models/bcc_email_archive_history_list.rb +0 -1
  78. data/lib/docusign_esign/models/bcc_email_archive_list.rb +0 -1
  79. data/lib/docusign_esign/models/billing_charge.rb +0 -1
  80. data/lib/docusign_esign/models/billing_charge_response.rb +0 -1
  81. data/lib/docusign_esign/models/billing_discount.rb +0 -1
  82. data/lib/docusign_esign/models/billing_invoice.rb +0 -1
  83. data/lib/docusign_esign/models/billing_invoice_item.rb +0 -1
  84. data/lib/docusign_esign/models/billing_invoices_response.rb +0 -1
  85. data/lib/docusign_esign/models/billing_invoices_summary.rb +0 -1
  86. data/lib/docusign_esign/models/billing_payment.rb +0 -1
  87. data/lib/docusign_esign/models/billing_payment_item.rb +0 -1
  88. data/lib/docusign_esign/models/billing_payment_request.rb +0 -1
  89. data/lib/docusign_esign/models/billing_payment_response.rb +0 -1
  90. data/lib/docusign_esign/models/billing_payments_response.rb +0 -1
  91. data/lib/docusign_esign/models/billing_plan.rb +0 -1
  92. data/lib/docusign_esign/models/billing_plan_information.rb +0 -1
  93. data/lib/docusign_esign/models/billing_plan_preview.rb +0 -1
  94. data/lib/docusign_esign/models/billing_plan_response.rb +0 -1
  95. data/lib/docusign_esign/models/billing_plan_update_response.rb +0 -1
  96. data/lib/docusign_esign/models/billing_plans_response.rb +0 -1
  97. data/lib/docusign_esign/models/billing_price.rb +0 -1
  98. data/lib/docusign_esign/models/brand.rb +0 -1
  99. data/lib/docusign_esign/models/brand_email_content.rb +0 -1
  100. data/lib/docusign_esign/models/brand_link.rb +0 -1
  101. data/lib/docusign_esign/models/brand_logos.rb +0 -1
  102. data/lib/docusign_esign/models/brand_request.rb +0 -1
  103. data/lib/docusign_esign/models/brand_resource_urls.rb +0 -1
  104. data/lib/docusign_esign/models/brand_resources.rb +0 -1
  105. data/lib/docusign_esign/models/brand_resources_list.rb +0 -1
  106. data/lib/docusign_esign/models/brands_request.rb +0 -1
  107. data/lib/docusign_esign/models/brands_response.rb +0 -1
  108. data/lib/docusign_esign/models/bulk_envelope.rb +0 -1
  109. data/lib/docusign_esign/models/bulk_envelope_status.rb +0 -1
  110. data/lib/docusign_esign/models/bulk_envelopes_response.rb +0 -1
  111. data/lib/docusign_esign/models/bulk_recipient.rb +0 -1
  112. data/lib/docusign_esign/models/bulk_recipient_signature_provider.rb +0 -1
  113. data/lib/docusign_esign/models/bulk_recipient_tab_label.rb +0 -1
  114. data/lib/docusign_esign/models/bulk_recipients_request.rb +0 -1
  115. data/lib/docusign_esign/models/bulk_recipients_response.rb +0 -1
  116. data/lib/docusign_esign/models/bulk_recipients_summary_response.rb +0 -1
  117. data/lib/docusign_esign/models/bulk_recipients_update_response.rb +0 -1
  118. data/lib/docusign_esign/models/bulk_send_batch_request.rb +184 -0
  119. data/lib/docusign_esign/models/bulk_send_batch_status.rb +31 -2
  120. data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +0 -1
  121. data/lib/docusign_esign/models/bulk_send_batch_summary.rb +0 -1
  122. data/lib/docusign_esign/models/bulk_send_error_status.rb +0 -1
  123. data/lib/docusign_esign/models/bulk_send_request.rb +11 -2
  124. data/lib/docusign_esign/models/bulk_send_response.rb +11 -2
  125. data/lib/docusign_esign/models/bulk_send_test_response.rb +0 -1
  126. data/lib/docusign_esign/models/bulk_sending_copy.rb +0 -1
  127. data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +0 -1
  128. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +41 -2
  129. data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +0 -1
  130. data/lib/docusign_esign/models/bulk_sending_list.rb +0 -1
  131. data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +0 -1
  132. data/lib/docusign_esign/models/bulk_sending_list_summary.rb +0 -1
  133. data/lib/docusign_esign/models/captive_recipient.rb +0 -1
  134. data/lib/docusign_esign/models/captive_recipient_information.rb +0 -1
  135. data/lib/docusign_esign/models/carbon_copy.rb +11 -11
  136. data/lib/docusign_esign/models/certified_delivery.rb +1 -11
  137. data/lib/docusign_esign/models/checkbox.rb +11 -2
  138. data/lib/docusign_esign/models/chunked_upload_part.rb +0 -1
  139. data/lib/docusign_esign/models/chunked_upload_request.rb +0 -1
  140. data/lib/docusign_esign/models/chunked_upload_response.rb +0 -1
  141. data/lib/docusign_esign/models/cloud_storage_provider.rb +0 -1
  142. data/lib/docusign_esign/models/cloud_storage_providers.rb +0 -1
  143. data/lib/docusign_esign/models/comment.rb +0 -1
  144. data/lib/docusign_esign/models/comment_history_result.rb +0 -1
  145. data/lib/docusign_esign/models/comment_publish.rb +0 -1
  146. data/lib/docusign_esign/models/comment_thread.rb +11 -2
  147. data/lib/docusign_esign/models/comments_publish.rb +0 -1
  148. data/lib/docusign_esign/models/commission_county.rb +1125 -0
  149. data/lib/docusign_esign/models/commission_expiration.rb +1125 -0
  150. data/lib/docusign_esign/models/commission_number.rb +1125 -0
  151. data/lib/docusign_esign/models/commission_state.rb +1125 -0
  152. data/lib/docusign_esign/models/company.rb +11 -2
  153. data/lib/docusign_esign/models/complete_sign_hash_response.rb +7 -11
  154. data/lib/docusign_esign/models/complete_sign_request.rb +7 -11
  155. data/lib/docusign_esign/models/composite_template.rb +0 -1
  156. data/lib/docusign_esign/models/conditional_recipient_rule.rb +0 -1
  157. data/lib/docusign_esign/models/conditional_recipient_rule_condition.rb +0 -1
  158. data/lib/docusign_esign/models/conditional_recipient_rule_filter.rb +11 -2
  159. data/lib/docusign_esign/models/connect_config_results.rb +0 -1
  160. data/lib/docusign_esign/models/connect_custom_configuration.rb +0 -1
  161. data/lib/docusign_esign/models/connect_debug_log.rb +0 -1
  162. data/lib/docusign_esign/models/connect_event_data.rb +0 -1
  163. data/lib/docusign_esign/models/connect_failure_filter.rb +0 -1
  164. data/lib/docusign_esign/models/connect_failure_result.rb +0 -1
  165. data/lib/docusign_esign/models/connect_failure_results.rb +0 -1
  166. data/lib/docusign_esign/models/connect_log.rb +0 -1
  167. data/lib/docusign_esign/models/connect_logs.rb +0 -1
  168. data/lib/docusign_esign/models/connect_salesforce_field.rb +0 -1
  169. data/lib/docusign_esign/models/connect_salesforce_object.rb +0 -1
  170. data/lib/docusign_esign/models/connect_user_object.rb +0 -1
  171. data/lib/docusign_esign/models/console_view_request.rb +0 -1
  172. data/lib/docusign_esign/models/consumer_disclosure.rb +0 -1
  173. data/lib/docusign_esign/models/contact.rb +0 -1
  174. data/lib/docusign_esign/models/contact_get_response.rb +0 -1
  175. data/lib/docusign_esign/models/contact_mod_request.rb +0 -1
  176. data/lib/docusign_esign/models/contact_phone_number.rb +0 -1
  177. data/lib/docusign_esign/models/contact_update_response.rb +0 -1
  178. data/lib/docusign_esign/models/correct_view_request.rb +0 -1
  179. data/lib/docusign_esign/models/country.rb +0 -1
  180. data/lib/docusign_esign/models/credential.rb +7 -11
  181. data/lib/docusign_esign/models/credit_card_information.rb +0 -1
  182. data/lib/docusign_esign/models/credit_card_types.rb +0 -1
  183. data/lib/docusign_esign/models/currency.rb +1211 -0
  184. data/lib/docusign_esign/models/currency_feature_set_price.rb +0 -1
  185. data/lib/docusign_esign/models/currency_plan_price.rb +0 -1
  186. data/lib/docusign_esign/models/custom_field.rb +0 -1
  187. data/lib/docusign_esign/models/custom_fields.rb +0 -1
  188. data/lib/docusign_esign/models/custom_fields_envelope.rb +0 -1
  189. data/lib/docusign_esign/models/custom_settings_information.rb +0 -1
  190. data/lib/docusign_esign/models/date.rb +11 -2
  191. data/lib/docusign_esign/models/date_signed.rb +11 -2
  192. data/lib/docusign_esign/models/date_stamp_properties.rb +0 -1
  193. data/lib/docusign_esign/models/decline.rb +11 -2
  194. data/lib/docusign_esign/models/diagnostics_settings_information.rb +0 -1
  195. data/lib/docusign_esign/models/direct_debit_processor_information.rb +0 -1
  196. data/lib/docusign_esign/models/display_appliance_account.rb +224 -0
  197. data/lib/docusign_esign/models/display_appliance_info.rb +174 -0
  198. data/lib/docusign_esign/models/display_appliance_pdf.rb +174 -0
  199. data/lib/docusign_esign/models/display_appliance_signer_attachment.rb +174 -0
  200. data/lib/docusign_esign/models/dob_information_input.rb +0 -1
  201. data/lib/docusign_esign/models/document.rb +11 -2
  202. data/lib/docusign_esign/models/document_fields_information.rb +0 -1
  203. data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +0 -1
  204. data/lib/docusign_esign/models/document_html_definition.rb +0 -1
  205. data/lib/docusign_esign/models/document_html_definition_original.rb +0 -1
  206. data/lib/docusign_esign/models/document_html_definition_originals.rb +0 -1
  207. data/lib/docusign_esign/models/document_html_definitions.rb +0 -1
  208. data/lib/docusign_esign/models/document_html_display_anchor.rb +0 -1
  209. data/lib/docusign_esign/models/document_html_display_settings.rb +0 -1
  210. data/lib/docusign_esign/models/document_security_store.rb +7 -11
  211. data/lib/docusign_esign/models/document_template.rb +0 -1
  212. data/lib/docusign_esign/models/document_template_list.rb +0 -1
  213. data/lib/docusign_esign/models/document_update_info.rb +7 -11
  214. data/lib/docusign_esign/models/document_visibility.rb +0 -1
  215. data/lib/docusign_esign/models/document_visibility_list.rb +0 -1
  216. data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +0 -1
  217. data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +0 -1
  218. data/lib/docusign_esign/models/downgrade_plan_update_response.rb +0 -1
  219. data/lib/docusign_esign/models/draw.rb +11 -2
  220. data/lib/docusign_esign/models/e_note_configuration.rb +0 -1
  221. data/lib/docusign_esign/models/editor.rb +1 -11
  222. data/lib/docusign_esign/models/email.rb +11 -2
  223. data/lib/docusign_esign/models/email_address.rb +11 -2
  224. data/lib/docusign_esign/models/email_settings.rb +0 -1
  225. data/lib/docusign_esign/models/envelope.rb +11 -2
  226. data/lib/docusign_esign/models/envelope_attachment.rb +0 -1
  227. data/lib/docusign_esign/models/envelope_attachments_request.rb +0 -1
  228. data/lib/docusign_esign/models/envelope_attachments_result.rb +0 -1
  229. data/lib/docusign_esign/models/envelope_audit_event.rb +0 -1
  230. data/lib/docusign_esign/models/envelope_audit_event_response.rb +0 -1
  231. data/lib/docusign_esign/models/envelope_definition.rb +20 -2
  232. data/lib/docusign_esign/models/envelope_document.rb +11 -2
  233. data/lib/docusign_esign/models/envelope_documents_result.rb +0 -1
  234. data/lib/docusign_esign/models/envelope_event.rb +0 -1
  235. data/lib/docusign_esign/models/envelope_form_data.rb +13 -2
  236. data/lib/docusign_esign/models/envelope_id.rb +11 -2
  237. data/lib/docusign_esign/models/envelope_ids_request.rb +0 -1
  238. data/lib/docusign_esign/models/envelope_metadata.rb +0 -1
  239. data/lib/docusign_esign/models/envelope_notification_request.rb +0 -1
  240. data/lib/docusign_esign/models/envelope_purge_configuration.rb +0 -1
  241. data/lib/docusign_esign/models/envelope_summary.rb +21 -2
  242. data/lib/docusign_esign/models/envelope_template.rb +11 -2
  243. data/lib/docusign_esign/models/envelope_template_results.rb +0 -1
  244. data/lib/docusign_esign/models/envelope_transaction_status.rb +0 -1
  245. data/lib/docusign_esign/models/envelope_transfer_rule.rb +0 -1
  246. data/lib/docusign_esign/models/envelope_transfer_rule_information.rb +0 -1
  247. data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +0 -1
  248. data/lib/docusign_esign/models/envelope_update_summary.rb +0 -1
  249. data/lib/docusign_esign/models/envelopes_information.rb +0 -1
  250. data/lib/docusign_esign/models/error_details.rb +0 -1
  251. data/lib/docusign_esign/models/event_notification.rb +0 -1
  252. data/lib/docusign_esign/models/event_result.rb +0 -1
  253. data/lib/docusign_esign/models/expirations.rb +0 -1
  254. data/lib/docusign_esign/models/external_claim.rb +7 -11
  255. data/lib/docusign_esign/models/external_doc_service_error_details.rb +0 -1
  256. data/lib/docusign_esign/models/external_document_sources.rb +0 -1
  257. data/lib/docusign_esign/models/external_file.rb +21 -2
  258. data/lib/docusign_esign/models/external_folder.rb +0 -1
  259. data/lib/docusign_esign/models/favorite_templates_content_item.rb +0 -1
  260. data/lib/docusign_esign/models/favorite_templates_info.rb +0 -1
  261. data/lib/docusign_esign/models/feature_available_metadata.rb +0 -1
  262. data/lib/docusign_esign/models/feature_set.rb +0 -1
  263. data/lib/docusign_esign/models/file_type.rb +0 -1
  264. data/lib/docusign_esign/models/file_type_list.rb +0 -1
  265. data/lib/docusign_esign/models/filter.rb +0 -1
  266. data/lib/docusign_esign/models/first_name.rb +11 -2
  267. data/lib/docusign_esign/models/folder.rb +0 -1
  268. data/lib/docusign_esign/models/folder_item_response.rb +0 -1
  269. data/lib/docusign_esign/models/folder_item_v2.rb +0 -1
  270. data/lib/docusign_esign/models/folder_items_response.rb +0 -1
  271. data/lib/docusign_esign/models/folder_shared_item.rb +0 -1
  272. data/lib/docusign_esign/models/folders_request.rb +0 -1
  273. data/lib/docusign_esign/models/folders_response.rb +0 -1
  274. data/lib/docusign_esign/models/forgotten_password_information.rb +0 -1
  275. data/lib/docusign_esign/models/form_data_item.rb +11 -2
  276. data/lib/docusign_esign/models/formula_tab.rb +11 -2
  277. data/lib/docusign_esign/models/full_name.rb +11 -2
  278. data/lib/docusign_esign/models/graphics_context.rb +0 -1
  279. data/lib/docusign_esign/models/group.rb +0 -1
  280. data/lib/docusign_esign/models/group_brands.rb +207 -0
  281. data/lib/docusign_esign/models/group_information.rb +0 -1
  282. data/lib/docusign_esign/models/id_check_configuration.rb +0 -1
  283. data/lib/docusign_esign/models/id_check_information_input.rb +0 -1
  284. data/lib/docusign_esign/models/id_check_security_step.rb +0 -1
  285. data/lib/docusign_esign/models/in_person_signer.rb +0 -1
  286. data/lib/docusign_esign/models/initial_here.rb +11 -2
  287. data/lib/docusign_esign/models/inline_template.rb +0 -1
  288. data/lib/docusign_esign/models/integrated_user_info_list.rb +0 -1
  289. data/lib/docusign_esign/models/intermediary.rb +1 -11
  290. data/lib/docusign_esign/models/jurisdiction.rb +0 -1
  291. data/lib/docusign_esign/models/last_name.rb +11 -2
  292. data/lib/docusign_esign/models/linked_external_primary_account.rb +234 -0
  293. data/lib/docusign_esign/models/list.rb +11 -2
  294. data/lib/docusign_esign/models/list_custom_field.rb +0 -1
  295. data/lib/docusign_esign/models/list_item.rb +0 -1
  296. data/lib/docusign_esign/models/locale_policy.rb +0 -1
  297. data/lib/docusign_esign/models/locale_policy_tab.rb +11 -2
  298. data/lib/docusign_esign/models/lock_information.rb +0 -1
  299. data/lib/docusign_esign/models/lock_request.rb +0 -1
  300. data/lib/docusign_esign/models/login_account.rb +0 -1
  301. data/lib/docusign_esign/models/login_information.rb +0 -1
  302. data/lib/docusign_esign/models/match_box.rb +0 -1
  303. data/lib/docusign_esign/models/member_group_shared_item.rb +0 -1
  304. data/lib/docusign_esign/models/member_shared_items.rb +0 -1
  305. data/lib/docusign_esign/models/merge_field.rb +0 -1
  306. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +0 -1
  307. data/lib/docusign_esign/models/mobile_notifier_configuration_information.rb +0 -1
  308. data/lib/docusign_esign/models/money.rb +0 -1
  309. data/lib/docusign_esign/models/name_value.rb +0 -1
  310. data/lib/docusign_esign/models/new_account_definition.rb +0 -1
  311. data/lib/docusign_esign/models/new_account_summary.rb +0 -1
  312. data/lib/docusign_esign/models/new_user.rb +0 -1
  313. data/lib/docusign_esign/models/new_users_definition.rb +0 -1
  314. data/lib/docusign_esign/models/new_users_summary.rb +0 -1
  315. data/lib/docusign_esign/models/notarize.rb +11 -2
  316. data/lib/docusign_esign/models/notary.rb +0 -1
  317. data/lib/docusign_esign/models/notary_host.rb +0 -1
  318. data/lib/docusign_esign/models/notary_journal.rb +0 -1
  319. data/lib/docusign_esign/models/notary_journal_credible_witness.rb +0 -1
  320. data/lib/docusign_esign/models/notary_journal_list.rb +0 -1
  321. data/lib/docusign_esign/models/notary_journal_meta_data.rb +0 -1
  322. data/lib/docusign_esign/models/notary_jurisdiction.rb +0 -1
  323. data/lib/docusign_esign/models/notary_jurisdiction_list.rb +0 -1
  324. data/lib/docusign_esign/models/notary_recipient.rb +11 -11
  325. data/lib/docusign_esign/models/notary_result.rb +0 -1
  326. data/lib/docusign_esign/models/notary_seal.rb +30 -125
  327. data/lib/docusign_esign/models/note.rb +11 -2
  328. data/lib/docusign_esign/models/notification.rb +0 -1
  329. data/lib/docusign_esign/models/notification_default_settings.rb +0 -1
  330. data/lib/docusign_esign/models/notification_defaults.rb +0 -1
  331. data/lib/docusign_esign/models/number.rb +11 -2
  332. data/lib/docusign_esign/models/oauth_access.rb +0 -1
  333. data/lib/docusign_esign/models/offline_attributes.rb +0 -1
  334. data/lib/docusign_esign/models/page.rb +0 -1
  335. data/lib/docusign_esign/models/page_images.rb +0 -1
  336. data/lib/docusign_esign/models/page_request.rb +0 -1
  337. data/lib/docusign_esign/models/path_extended_element.rb +0 -1
  338. data/lib/docusign_esign/models/pay_pal_legacy_settings.rb +0 -1
  339. data/lib/docusign_esign/models/payment_details.rb +10 -2
  340. data/lib/docusign_esign/models/payment_gateway_account.rb +0 -1
  341. data/lib/docusign_esign/models/payment_gateway_account_setting.rb +0 -1
  342. data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +0 -1
  343. data/lib/docusign_esign/models/payment_line_item.rb +0 -1
  344. data/lib/docusign_esign/models/payment_method_with_options.rb +0 -1
  345. data/lib/docusign_esign/models/payment_processor_information.rb +0 -1
  346. data/lib/docusign_esign/models/payment_signer_values.rb +184 -0
  347. data/lib/docusign_esign/models/permission_profile.rb +0 -1
  348. data/lib/docusign_esign/models/permission_profile_information.rb +0 -1
  349. data/lib/docusign_esign/models/phone_number.rb +1125 -0
  350. data/lib/docusign_esign/models/plan_information.rb +0 -1
  351. data/lib/docusign_esign/models/poly_line.rb +0 -1
  352. data/lib/docusign_esign/models/poly_line_overlay.rb +11 -2
  353. data/lib/docusign_esign/models/power_form.rb +0 -1
  354. data/lib/docusign_esign/models/power_form_form_data_envelope.rb +0 -1
  355. data/lib/docusign_esign/models/power_form_form_data_recipient.rb +0 -1
  356. data/lib/docusign_esign/models/power_form_recipient.rb +0 -1
  357. data/lib/docusign_esign/models/power_form_senders_response.rb +0 -1
  358. data/lib/docusign_esign/models/power_forms_form_data_response.rb +0 -1
  359. data/lib/docusign_esign/models/power_forms_request.rb +0 -1
  360. data/lib/docusign_esign/models/power_forms_response.rb +0 -1
  361. data/lib/docusign_esign/models/prefill_tabs.rb +222 -0
  362. data/lib/docusign_esign/models/proof_service_resource_token.rb +0 -1
  363. data/lib/docusign_esign/models/proof_service_view_link.rb +0 -1
  364. data/lib/docusign_esign/models/property_metadata.rb +0 -1
  365. data/lib/docusign_esign/models/province.rb +0 -1
  366. data/lib/docusign_esign/models/provisioning_information.rb +0 -1
  367. data/lib/docusign_esign/models/purchased_envelopes_information.rb +0 -1
  368. data/lib/docusign_esign/models/radio.rb +0 -1
  369. data/lib/docusign_esign/models/radio_group.rb +0 -1
  370. data/lib/docusign_esign/models/recipient_additional_notification.rb +0 -1
  371. data/lib/docusign_esign/models/recipient_attachment.rb +0 -1
  372. data/lib/docusign_esign/models/recipient_domain.rb +0 -1
  373. data/lib/docusign_esign/models/recipient_email_notification.rb +0 -1
  374. data/lib/docusign_esign/models/recipient_event.rb +0 -1
  375. data/lib/docusign_esign/models/recipient_form_data.rb +0 -1
  376. data/lib/docusign_esign/models/recipient_group.rb +0 -1
  377. data/lib/docusign_esign/models/recipient_identity_input_option.rb +0 -1
  378. data/lib/docusign_esign/models/recipient_identity_phone_number.rb +0 -1
  379. data/lib/docusign_esign/models/recipient_identity_verification.rb +0 -1
  380. data/lib/docusign_esign/models/recipient_names_response.rb +0 -1
  381. data/lib/docusign_esign/models/recipient_option.rb +0 -1
  382. data/lib/docusign_esign/models/recipient_phone_authentication.rb +0 -1
  383. data/lib/docusign_esign/models/recipient_phone_number.rb +0 -1
  384. data/lib/docusign_esign/models/recipient_preview_request.rb +0 -1
  385. data/lib/docusign_esign/models/recipient_proof_file.rb +0 -1
  386. data/lib/docusign_esign/models/recipient_routing.rb +0 -1
  387. data/lib/docusign_esign/models/recipient_rules.rb +0 -1
  388. data/lib/docusign_esign/models/recipient_signature_information.rb +0 -1
  389. data/lib/docusign_esign/models/recipient_signature_provider.rb +0 -1
  390. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +0 -1
  391. data/lib/docusign_esign/models/recipient_sms_authentication.rb +0 -1
  392. data/lib/docusign_esign/models/recipient_update_response.rb +0 -1
  393. data/lib/docusign_esign/models/recipient_view_request.rb +0 -1
  394. data/lib/docusign_esign/models/recipients.rb +0 -1
  395. data/lib/docusign_esign/models/recipients_update_summary.rb +0 -1
  396. data/lib/docusign_esign/models/referral_information.rb +0 -1
  397. data/lib/docusign_esign/models/reminders.rb +0 -1
  398. data/lib/docusign_esign/models/report_in_product_csv_run_request.rb +24 -5
  399. data/lib/docusign_esign/models/report_in_product_field.rb +0 -1
  400. data/lib/docusign_esign/models/report_in_product_get.rb +24 -5
  401. data/lib/docusign_esign/models/report_in_product_list.rb +0 -1
  402. data/lib/docusign_esign/models/report_in_product_list_item.rb +0 -1
  403. data/lib/docusign_esign/models/report_in_product_run_request.rb +24 -5
  404. data/lib/docusign_esign/models/report_in_product_run_response.rb +0 -1
  405. data/lib/docusign_esign/models/report_in_product_run_response_row.rb +0 -1
  406. data/lib/docusign_esign/models/report_in_product_run_response_row_fields.rb +101 -2
  407. data/lib/docusign_esign/models/report_in_product_save_response.rb +0 -1
  408. data/lib/docusign_esign/models/report_in_product_sent_by_details.rb +0 -1
  409. data/lib/docusign_esign/models/resource_information.rb +0 -1
  410. data/lib/docusign_esign/models/return_url_request.rb +0 -1
  411. data/lib/docusign_esign/models/revision.rb +7 -11
  412. data/lib/docusign_esign/models/seal.rb +8 -12
  413. data/lib/docusign_esign/models/seal_identifier.rb +0 -1
  414. data/lib/docusign_esign/models/seal_sign.rb +0 -1
  415. data/lib/docusign_esign/models/seat_discount.rb +0 -1
  416. data/lib/docusign_esign/models/sender.rb +7 -11
  417. data/lib/docusign_esign/models/sender_email_notifications.rb +0 -1
  418. data/lib/docusign_esign/models/server_template.rb +0 -1
  419. data/lib/docusign_esign/models/service_information.rb +0 -1
  420. data/lib/docusign_esign/models/service_version.rb +0 -1
  421. data/lib/docusign_esign/models/settings_metadata.rb +0 -1
  422. data/lib/docusign_esign/models/shared_item.rb +0 -1
  423. data/lib/docusign_esign/models/sign_hash_document.rb +7 -11
  424. data/lib/docusign_esign/models/sign_hash_session_info_response.rb +7 -11
  425. data/lib/docusign_esign/models/sign_here.rb +11 -2
  426. data/lib/docusign_esign/models/sign_session_info_request.rb +7 -11
  427. data/lib/docusign_esign/models/signature_data_info.rb +7 -11
  428. data/lib/docusign_esign/models/signature_group.rb +0 -1
  429. data/lib/docusign_esign/models/signature_group_def.rb +0 -1
  430. data/lib/docusign_esign/models/signature_properties.rb +7 -11
  431. data/lib/docusign_esign/models/signature_provider_required_option.rb +0 -1
  432. data/lib/docusign_esign/models/signature_type.rb +0 -1
  433. data/lib/docusign_esign/models/signature_user.rb +0 -1
  434. data/lib/docusign_esign/models/signature_user_def.rb +0 -1
  435. data/lib/docusign_esign/models/signer.rb +1 -11
  436. data/lib/docusign_esign/models/signer_attachment.rb +11 -2
  437. data/lib/docusign_esign/models/signer_email_notifications.rb +0 -1
  438. data/lib/docusign_esign/models/signing_group.rb +0 -1
  439. data/lib/docusign_esign/models/signing_group_information.rb +0 -1
  440. data/lib/docusign_esign/models/signing_group_user.rb +0 -1
  441. data/lib/docusign_esign/models/signing_group_users.rb +0 -1
  442. data/lib/docusign_esign/models/smart_contract_information.rb +0 -1
  443. data/lib/docusign_esign/models/smart_section.rb +11 -2
  444. data/lib/docusign_esign/models/smart_section_anchor_position.rb +0 -1
  445. data/lib/docusign_esign/models/smart_section_collapsible_display_settings.rb +0 -1
  446. data/lib/docusign_esign/models/smart_section_display_settings.rb +0 -1
  447. data/lib/docusign_esign/models/social_account_information.rb +0 -1
  448. data/lib/docusign_esign/models/social_authentication.rb +0 -1
  449. data/lib/docusign_esign/models/ssn.rb +11 -2
  450. data/lib/docusign_esign/models/ssn4_information_input.rb +0 -1
  451. data/lib/docusign_esign/models/ssn9_information_input.rb +0 -1
  452. data/lib/docusign_esign/models/stamp.rb +0 -1
  453. data/lib/docusign_esign/models/supported_languages.rb +0 -1
  454. data/lib/docusign_esign/models/tab_account_settings.rb +20 -2
  455. data/lib/docusign_esign/models/tab_group.rb +11 -2
  456. data/lib/docusign_esign/models/tab_metadata.rb +20 -2
  457. data/lib/docusign_esign/models/tab_metadata_list.rb +0 -1
  458. data/lib/docusign_esign/models/tabs.rb +82 -14
  459. data/lib/docusign_esign/models/template_custom_fields.rb +0 -1
  460. data/lib/docusign_esign/models/template_document_visibility_list.rb +0 -1
  461. data/lib/docusign_esign/models/template_documents_result.rb +0 -1
  462. data/lib/docusign_esign/models/template_information.rb +0 -1
  463. data/lib/docusign_esign/models/template_match.rb +0 -1
  464. data/lib/docusign_esign/models/template_notification_request.rb +0 -1
  465. data/lib/docusign_esign/models/template_recipients.rb +0 -1
  466. data/lib/docusign_esign/models/template_role.rb +13 -2
  467. data/lib/docusign_esign/models/template_shared_item.rb +0 -1
  468. data/lib/docusign_esign/models/template_summary.rb +0 -1
  469. data/lib/docusign_esign/models/template_tabs.rb +82 -14
  470. data/lib/docusign_esign/models/template_update_summary.rb +0 -1
  471. data/lib/docusign_esign/models/text.rb +11 -2
  472. data/lib/docusign_esign/models/text_custom_field.rb +0 -1
  473. data/lib/docusign_esign/models/time_stamp_field.rb +7 -11
  474. data/lib/docusign_esign/models/title.rb +11 -2
  475. data/lib/docusign_esign/models/tsp_health_check_request.rb +7 -11
  476. data/lib/docusign_esign/models/tsp_health_check_status_description.rb +7 -11
  477. data/lib/docusign_esign/models/update_transaction_request.rb +7 -11
  478. data/lib/docusign_esign/models/update_transaction_response.rb +7 -11
  479. data/lib/docusign_esign/models/usage_history.rb +0 -1
  480. data/lib/docusign_esign/models/user.rb +7 -11
  481. data/lib/docusign_esign/models/user_account_management_granular_information.rb +0 -1
  482. data/lib/docusign_esign/models/user_info.rb +0 -1
  483. data/lib/docusign_esign/models/user_info_list.rb +0 -1
  484. data/lib/docusign_esign/models/user_info_response.rb +7 -11
  485. data/lib/docusign_esign/models/user_information.rb +11 -2
  486. data/lib/docusign_esign/models/user_information_list.rb +0 -1
  487. data/lib/docusign_esign/models/user_password_information.rb +0 -1
  488. data/lib/docusign_esign/models/user_password_rules.rb +0 -1
  489. data/lib/docusign_esign/models/user_profile.rb +0 -1
  490. data/lib/docusign_esign/models/user_settings_information.rb +20 -2
  491. data/lib/docusign_esign/models/user_shared_item.rb +0 -1
  492. data/lib/docusign_esign/models/user_signature.rb +0 -1
  493. data/lib/docusign_esign/models/user_signature_definition.rb +0 -1
  494. data/lib/docusign_esign/models/user_signatures_information.rb +0 -1
  495. data/lib/docusign_esign/models/user_social_id_result.rb +0 -1
  496. data/lib/docusign_esign/models/users_response.rb +0 -1
  497. data/lib/docusign_esign/models/view.rb +11 -2
  498. data/lib/docusign_esign/models/view_url.rb +0 -1
  499. data/lib/docusign_esign/models/watermark.rb +0 -1
  500. data/lib/docusign_esign/models/witness.rb +1 -11
  501. data/lib/docusign_esign/models/workflow.rb +0 -1
  502. data/lib/docusign_esign/models/workflow_step.rb +0 -1
  503. data/lib/docusign_esign/models/workspace.rb +0 -1
  504. data/lib/docusign_esign/models/workspace_folder_contents.rb +0 -1
  505. data/lib/docusign_esign/models/workspace_item.rb +0 -1
  506. data/lib/docusign_esign/models/workspace_item_list.rb +0 -1
  507. data/lib/docusign_esign/models/workspace_list.rb +0 -1
  508. data/lib/docusign_esign/models/workspace_settings.rb +0 -1
  509. data/lib/docusign_esign/models/workspace_user.rb +0 -1
  510. data/lib/docusign_esign/models/workspace_user_authorization.rb +0 -1
  511. data/lib/docusign_esign/models/zip.rb +11 -2
  512. data/lib/docusign_esign/version.rb +1 -2
  513. data/tests/.DS_Store +0 -0
  514. data/tests/Gemfile.lock +5 -5
  515. metadata +22 -10
  516. data/docusign_esign-2.6.0.gem +0 -0
  517. data/docusign_esign-2.6.0.rc1.gem +0 -0
  518. data/docusign_esign-2.7.0.rc1.gem +0 -0
  519. data/docusign_esign-3.5.0.gem +0 -0
  520. data/docusign_esign-3.5.0.rc1.gem +0 -0
  521. data/docusign_esign-3.6.0.rc1.gem +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 22e9083ff6332eb2de919309e6811019e3bdce2ebb5da85f7da7a11efcfa5cd9
4
- data.tar.gz: 1c0cc8001de140b6a75b5efbafc3eb0ad6dbd974b6e69f3f0c81098efcdf13e8
3
+ metadata.gz: 2c188310931f3ef6990d2f2fc9c1e8879335345fa52a7e88d47e1276267ff3c4
4
+ data.tar.gz: e53fa8ccc56439c2047832c2f6d35b0950f9a0e223fb17aa275f049ea4183621
5
5
  SHA512:
6
- metadata.gz: 1e88b1e9bb3133dda333a4cdd7f8981bedf5aabb27da2129aeaa985b8daff7da2a6614687c6419abb73c8226069b11addf65f079cda4643f52dda1b210da66b2
7
- data.tar.gz: 53d0a327855e8d286f9dd7fdf6a29c8ba0782e729c20db06c0b4cf19c630597793c612855c8ac41afe878c8b6fa527f0b39371dfb0a5ef31e4af433172fdb01d
6
+ metadata.gz: 240e3a3026aa3d668cabb7f5fd2afa12f33711eeed33fd76d99b29eeb17697618dc1b239939f675223358711f716a70ed92bde27d1c6d2780b53454300110d81
7
+ data.tar.gz: cd821c0b14c7acac7b340c1d3ab7edb5221b649e9e0d11d9a4ee37b0f109f6db7f13757bee9cbf1c1c2a48b3f4b7a1e60bf8052efd3122927c3f49f9a20f5eec
data/CHANGELOG.md CHANGED
@@ -3,6 +3,27 @@ All notable changes to this project will be documented in this file.
3
3
 
4
4
  See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
5
5
 
6
+ ## [v3.10.0.rc1] - eSignature API v2.1-21.1.02.00 - 2021-05-20
7
+ ### Breaking
8
+ - Removed methods `get_account_settings_export`,`get_seal_providers` from Accounts.
9
+ - Removed methods `create_connect_secret`,`delete_connect_secret`,`generate_connect_secret`,`get_connect_secrets` from Connect.
10
+ - Removed methods `create_page_info`, `create_pdf_blob`, `delete_custom_fields_0`, `delete_custom_fields_v2`, `delete_document`, `delete_page_info`, `delete_recipient_denied_document_copy`, `delete_signer_attachment`, `get_account`, `get_appliance_info`, `get_custom_fields`, `get_document_pages`, `get_dynamic_system_settings`, `get_image`, `get_locale_policy`, `get_pdf`, `get_pdf_blob`, `get_signer_attachment`, `get_tabs_blob`, `update_document`, `update_document_0`, `update_page_info`, `update_pdf`, `update_pdf_blob`, `update_recipient_denied_document_copy` from Envelopes.
11
+ - Removed methods `complete_sign_hash`,`get_user_info`,`health_check`,`sign_hash_session_info`,`update_transaction` from TrustServiceProviders.
12
+ - Removed methods `get_user_list_export` from Users.
13
+ ### Added
14
+ - Added new methods `get_bulk_send_batch_envelopes` to BulkEnvelopes.
15
+ ### Changed
16
+ - Added support for version v2.1-21.1.02.00 of the DocuSign eSignature API.
17
+ - Updated the SDK release version.
18
+
19
+ ## [v3.9.0] - eSignature API v2.1-21.1.01.03 - 2021-04-25
20
+ ### Added
21
+ - Added new methods `delete_custom_fields_v2`, `delete_page_info_v2`, `get_appliance_envelope_info`, `get_template_info` to envelopes.
22
+ - Added new method `delete_connect_secret` to connect.
23
+ ### Changed
24
+ - Added support for version v2.1-21.1.01.03 of the DocuSign eSignature API.
25
+ - Updated the SDK release version.
26
+
6
27
  ## [v3.3.0] - eSignature API v2.1-20.1.02 - 2020-05-31
7
28
  ### Changed
8
29
  - Added support for version v2.1-20.1.02 of the DocuSign eSignature API.
data/Gemfile.lock CHANGED
@@ -1,7 +1,8 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- docusign_esign (3.6.0.rc1)
4
+ docusign_esign (3.7.0.rc1)
5
+ addressable (~> 2.7, >= 2.7.0)
5
6
  json (~> 2.1, >= 2.1.0)
6
7
  jwt (~> 2.2, >= 2.2.1)
7
8
  typhoeus (~> 1.0, >= 1.0.1)
@@ -18,31 +19,29 @@ GEM
18
19
  sys-uname
19
20
  autotest-growl (0.2.16)
20
21
  autotest-rails-pure (4.1.2)
21
- crack (0.4.3)
22
- safe_yaml (~> 1.0.0)
22
+ crack (0.4.4)
23
23
  diff-lcs (1.4.4)
24
24
  ethon (0.12.0)
25
25
  ffi (>= 1.3.0)
26
26
  ffi (1.13.1)
27
27
  hashdiff (1.0.1)
28
28
  json (2.3.1)
29
- jwt (2.2.1)
30
- public_suffix (4.0.5)
29
+ jwt (2.2.2)
30
+ public_suffix (4.0.6)
31
31
  rake (12.3.3)
32
32
  rspec (3.9.0)
33
33
  rspec-core (~> 3.9.0)
34
34
  rspec-expectations (~> 3.9.0)
35
35
  rspec-mocks (~> 3.9.0)
36
- rspec-core (3.9.2)
36
+ rspec-core (3.9.3)
37
37
  rspec-support (~> 3.9.3)
38
- rspec-expectations (3.9.2)
38
+ rspec-expectations (3.9.3)
39
39
  diff-lcs (>= 1.2.0, < 2.0)
40
40
  rspec-support (~> 3.9.0)
41
41
  rspec-mocks (3.9.1)
42
42
  diff-lcs (>= 1.2.0, < 2.0)
43
43
  rspec-support (~> 3.9.0)
44
- rspec-support (3.9.3)
45
- safe_yaml (1.0.5)
44
+ rspec-support (3.9.4)
46
45
  sys-uname (1.2.1)
47
46
  ffi (>= 1.0.0)
48
47
  typhoeus (1.4.0)
data/README.md CHANGED
@@ -1,80 +1,51 @@
1
- # The Official DocuSign Ruby Client
1
+ # The Official DocuSign eSignature Ruby Client SDK
2
2
 
3
3
  [![RubyGems version][rubygems-image]][rubygems-url]
4
4
  [![RubyGems downloads][downloads-image]][downloads-url]
5
5
  [![Build status][travis-image]][travis-url]
6
6
 
7
7
  ## Requirements
8
-
9
- - Ruby 1.9+
10
- - Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
8
+ * Ruby 1.9+
9
+ * Free [developer account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
11
10
 
12
11
  ## Compatibility
13
-
14
- - Ruby 1.9+
15
-
16
- ## Note
17
-
18
- This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the [Developer Center](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below.
12
+ * Ruby 1.9+
19
13
 
20
14
  ## Installation
15
+ This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our [code examples](https://developers.docusign.com/docs/esign-rest-api/how-to/) from the [DocuSign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.
21
16
 
22
- ### Install via your application's **Gemfile**:
23
-
24
- 1. In your application's **Gemfile**, add:
25
- **gem 'docusign_esign'**
17
+ ### Installation via your application's Gemfile:
18
+ 1. In your application's Gemfile, add:
19
+ `gem 'docusign_esign'`
26
20
  2. Open your preferred console.
27
- 3. In your project directory, execute the installer by typing:
28
- **bundle install**
29
-
30
- ### Manual install:
21
+ 3. In your project directory, execute the installer by typing: **bundle install**
31
22
 
23
+ ### Manual installation:
32
24
  1. Open your preferred console.
33
- 2. In the console, type:
34
- **gem install docusign_esign**
25
+ 2. In the console, type: **gem install docusign_esign**
35
26
 
36
27
  ### Dependencies
37
-
38
28
  This client has the following external dependencies:
29
+ * Jwt>=1.5.2
30
+ * Json>=2.1.0
31
+ * Typhoeus>=1.0.1
39
32
 
40
- - Jwt>=1.5.2
41
- - Json>=2.1.0
42
- - Typhoeus>=1.0.1
43
-
44
- ## Code Examples
45
-
46
- ### Launchers
33
+ ## Code examples
34
+ You can find on our GitHub a self-executing package of code examples for the eSignature C# SDK, called a [Launcher](https://github.com/docusign/code-examples-ruby/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows.
47
35
 
48
- DocuSign provides a sample application code referred to as a [Launcher](https://github.com/docusign/code-examples-ruby). The Launcher contains a set of 31 common use cases and associated source files. These examples use either DocuSign&#39;s [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Tokens (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) flows.
49
-
50
- ### Proof-of-concept applications
51
-
52
- If your goal is to create a proof-of-concept application, DocuSign provides a set of [Quick Start](https://github.com/docusign/qs-ruby) examples. The Quick Start examples are meant to be used with DocuSign's [OAuth Token Generator](https://developers.docusign.com/oauth-token-generator), which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.
53
-
54
- ## OAuth Implementations
55
-
56
- For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/esign-rest-api/guides/authentication).
36
+ ## OAuth implementations
37
+ For details regarding which type of OAuth grant will work best for your DocuSign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [DocuSign Developer Center](https://developers.docusign.com/).
57
38
 
58
39
  For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
59
40
 
60
-
61
41
  ## Support
62
-
63
42
  Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
64
43
 
65
44
  ## License
45
+ The DocuSign eSignature Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
66
46
 
67
- The DocuSign Ruby Client is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
68
-
69
- [rubygems-image]: https://img.shields.io/gem/v/docusign_esign.svg?style=flat
70
- [rubygems-url]: https://rubygems.org/gems/docusign_esign
71
- [downloads-image]: https://img.shields.io/gem/dt/docusign_esign.svg?style=flat
72
- [downloads-url]: https://rubygems.org/gems/docusign_esign
73
- [travis-image]: https://img.shields.io/travis/docusign/docusign-ruby-client.svg?style=flat
74
- [travis-url]: https://travis-ci.org/docusign/docusign-ruby-client
75
-
76
- ### Additional Resources
77
- * [DocuSign Developer Center](https://developers.docusign.com)
78
- * [DocuSign API on Twitter](https://twitter.com/docusignapi)
79
- * [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
80
- * [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
47
+ ### Additional resources
48
+ * [DocuSign Developer Center](https://developers.docusign.com/)
49
+ * [DocuSign API on Twitter](https://twitter.com/docusignapi)
50
+ * [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
51
+ * [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
Binary file
@@ -6,7 +6,6 @@
6
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
- Swagger Codegen version: 2.4.13-SNAPSHOT
10
9
 
11
10
  =end
12
11
 
@@ -100,7 +99,6 @@ require 'docusign_esign/models/brands_request'
100
99
  require 'docusign_esign/models/brands_response'
101
100
  require 'docusign_esign/models/bulk_envelope'
102
101
  require 'docusign_esign/models/bulk_envelope_status'
103
- require 'docusign_esign/models/bulk_envelopes_response'
104
102
  require 'docusign_esign/models/bulk_recipient'
105
103
  require 'docusign_esign/models/bulk_recipient_signature_provider'
106
104
  require 'docusign_esign/models/bulk_recipient_tab_label'
@@ -108,6 +106,7 @@ require 'docusign_esign/models/bulk_recipients_request'
108
106
  require 'docusign_esign/models/bulk_recipients_response'
109
107
  require 'docusign_esign/models/bulk_recipients_summary_response'
110
108
  require 'docusign_esign/models/bulk_recipients_update_response'
109
+ require 'docusign_esign/models/bulk_send_batch_request'
111
110
  require 'docusign_esign/models/bulk_send_batch_status'
112
111
  require 'docusign_esign/models/bulk_send_batch_summaries'
113
112
  require 'docusign_esign/models/bulk_send_batch_summary'
@@ -137,6 +136,10 @@ require 'docusign_esign/models/comment_history_result'
137
136
  require 'docusign_esign/models/comment_publish'
138
137
  require 'docusign_esign/models/comment_thread'
139
138
  require 'docusign_esign/models/comments_publish'
139
+ require 'docusign_esign/models/commission_county'
140
+ require 'docusign_esign/models/commission_expiration'
141
+ require 'docusign_esign/models/commission_number'
142
+ require 'docusign_esign/models/commission_state'
140
143
  require 'docusign_esign/models/company'
141
144
  require 'docusign_esign/models/composite_template'
142
145
  require 'docusign_esign/models/conditional_recipient_rule'
@@ -165,6 +168,7 @@ require 'docusign_esign/models/correct_view_request'
165
168
  require 'docusign_esign/models/country'
166
169
  require 'docusign_esign/models/credit_card_information'
167
170
  require 'docusign_esign/models/credit_card_types'
171
+ require 'docusign_esign/models/currency'
168
172
  require 'docusign_esign/models/currency_feature_set_price'
169
173
  require 'docusign_esign/models/currency_plan_price'
170
174
  require 'docusign_esign/models/custom_field'
@@ -177,6 +181,7 @@ require 'docusign_esign/models/date_stamp_properties'
177
181
  require 'docusign_esign/models/decline'
178
182
  require 'docusign_esign/models/diagnostics_settings_information'
179
183
  require 'docusign_esign/models/direct_debit_processor_information'
184
+ require 'docusign_esign/models/display_appliance_info'
180
185
  require 'docusign_esign/models/dob_information_input'
181
186
  require 'docusign_esign/models/document'
182
187
  require 'docusign_esign/models/document_fields_information'
@@ -254,6 +259,7 @@ require 'docusign_esign/models/formula_tab'
254
259
  require 'docusign_esign/models/full_name'
255
260
  require 'docusign_esign/models/graphics_context'
256
261
  require 'docusign_esign/models/group'
262
+ require 'docusign_esign/models/group_brands'
257
263
  require 'docusign_esign/models/group_information'
258
264
  require 'docusign_esign/models/id_check_configuration'
259
265
  require 'docusign_esign/models/id_check_information_input'
@@ -265,6 +271,7 @@ require 'docusign_esign/models/integrated_user_info_list'
265
271
  require 'docusign_esign/models/intermediary'
266
272
  require 'docusign_esign/models/jurisdiction'
267
273
  require 'docusign_esign/models/last_name'
274
+ require 'docusign_esign/models/linked_external_primary_account'
268
275
  require 'docusign_esign/models/list'
269
276
  require 'docusign_esign/models/list_custom_field'
270
277
  require 'docusign_esign/models/list_item'
@@ -289,7 +296,6 @@ require 'docusign_esign/models/new_users_definition'
289
296
  require 'docusign_esign/models/new_users_summary'
290
297
  require 'docusign_esign/models/notarize'
291
298
  require 'docusign_esign/models/notary'
292
- require 'docusign_esign/models/notary_certificate'
293
299
  require 'docusign_esign/models/notary_host'
294
300
  require 'docusign_esign/models/notary_journal'
295
301
  require 'docusign_esign/models/notary_journal_credible_witness'
@@ -319,8 +325,10 @@ require 'docusign_esign/models/payment_gateway_accounts_info'
319
325
  require 'docusign_esign/models/payment_line_item'
320
326
  require 'docusign_esign/models/payment_method_with_options'
321
327
  require 'docusign_esign/models/payment_processor_information'
328
+ require 'docusign_esign/models/payment_signer_values'
322
329
  require 'docusign_esign/models/permission_profile'
323
330
  require 'docusign_esign/models/permission_profile_information'
331
+ require 'docusign_esign/models/phone_number'
324
332
  require 'docusign_esign/models/plan_information'
325
333
  require 'docusign_esign/models/poly_line'
326
334
  require 'docusign_esign/models/poly_line_overlay'
@@ -332,6 +340,7 @@ require 'docusign_esign/models/power_form_senders_response'
332
340
  require 'docusign_esign/models/power_forms_form_data_response'
333
341
  require 'docusign_esign/models/power_forms_request'
334
342
  require 'docusign_esign/models/power_forms_response'
343
+ require 'docusign_esign/models/prefill_tabs'
335
344
  require 'docusign_esign/models/proof_service_resource_token'
336
345
  require 'docusign_esign/models/proof_service_view_link'
337
346
  require 'docusign_esign/models/property_metadata'
@@ -6,7 +6,6 @@
6
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
- Swagger Codegen version: 2.4.13-SNAPSHOT
10
9
 
11
10
  =end
12
11
 
@@ -386,7 +385,7 @@ module DocuSign_eSign
386
385
 
387
386
  # Creates one or more brand profile files for the account.
388
387
  # Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
389
- # @param account_id The external account number (int) or account ID Guid.
388
+ # @param account_id The external account number (int) or account ID GUID.
390
389
  # @param brand (optional parameter)
391
390
  # @return [BrandsResponse]
392
391
  def create_brand(account_id, brand)
@@ -396,7 +395,7 @@ module DocuSign_eSign
396
395
 
397
396
  # Creates one or more brand profile files for the account.
398
397
  # Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSig&#x60;) must be set to **true** for the account to use this call. An error is returned if &#x60;brandId&#x60; property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the &#x60;Content-Type&#x60; must be &#x60;application/zip&#x60;.
399
- # @param account_id The external account number (int) or account ID Guid.
398
+ # @param account_id The external account number (int) or account ID GUID.
400
399
  # @param brand (optional parameter)
401
400
  # @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
402
401
  def create_brand_with_http_info(account_id, brand)
@@ -1876,7 +1875,7 @@ module DocuSign_eSign
1876
1875
  # Gets the Electronic Record and Signature Disclosure.
1877
1876
  # Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
1878
1877
  # @param account_id The external account number (int) or account ID Guid.
1879
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
1878
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
1880
1879
  # @return [ConsumerDisclosure]
1881
1880
  def get_consumer_disclosure(account_id, lang_code)
1882
1881
  data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
@@ -1886,7 +1885,7 @@ module DocuSign_eSign
1886
1885
  # Gets the Electronic Record and Signature Disclosure.
1887
1886
  # Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
1888
1887
  # @param account_id The external account number (int) or account ID Guid.
1889
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
1888
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
1890
1889
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
1891
1890
  def get_consumer_disclosure_with_http_info(account_id, lang_code)
1892
1891
  if @api_client.config.debugging
@@ -3424,9 +3423,9 @@ module DocuSign_eSign
3424
3423
 
3425
3424
  # Uploads a branding resource file.
3426
3425
  #
3427
- # @param account_id The external account number (int) or account ID Guid.
3428
- # @param brand_id The unique identifier of a brand.
3429
- # @param resource_content_type
3426
+ # @param account_id The external account number (int) or account ID GUID.
3427
+ # @param brand_id The id of the brand.
3428
+ # @param resource_content_type The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`
3430
3429
  # @return [BrandResources]
3431
3430
  def update_brand_resources_by_content_type(account_id, brand_id, resource_content_type)
3432
3431
  data, _status_code, _headers = update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type)
@@ -3435,9 +3434,9 @@ module DocuSign_eSign
3435
3434
 
3436
3435
  # Uploads a branding resource file.
3437
3436
  #
3438
- # @param account_id The external account number (int) or account ID Guid.
3439
- # @param brand_id The unique identifier of a brand.
3440
- # @param resource_content_type
3437
+ # @param account_id The external account number (int) or account ID GUID.
3438
+ # @param brand_id The id of the brand.
3439
+ # @param resource_content_type The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`
3441
3440
  # @return [Array<(BrandResources, Fixnum, Hash)>] BrandResources data, response status code and response headers
3442
3441
  def update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type)
3443
3442
  if @api_client.config.debugging
@@ -3449,6 +3448,8 @@ module DocuSign_eSign
3449
3448
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_resources_by_content_type" if brand_id.nil?
3450
3449
  # verify the required parameter 'resource_content_type' is set
3451
3450
  fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.update_brand_resources_by_content_type" if resource_content_type.nil?
3451
+ # verify the required parameter 'file_xml' is set
3452
+ fail ArgumentError, "Missing the required parameter 'file_xml' when calling AccountsApi.update_brand_resources_by_content_type" if file_xml.nil?
3452
3453
  # resource path
3453
3454
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s)
3454
3455
 
@@ -3459,9 +3460,12 @@ module DocuSign_eSign
3459
3460
  header_params = {}
3460
3461
  # HTTP header 'Accept' (if needed)
3461
3462
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3463
+ # HTTP header 'Content-Type'
3464
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
3462
3465
 
3463
3466
  # form parameters
3464
3467
  form_params = {}
3468
+ form_params["file.xml"] = file_xml
3465
3469
 
3466
3470
  # http body (model)
3467
3471
  post_body = nil
@@ -3482,7 +3486,7 @@ module DocuSign_eSign
3482
3486
  # Update Consumer Disclosure.
3483
3487
  #
3484
3488
  # @param account_id The external account number (int) or account ID Guid.
3485
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3489
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3486
3490
  # @param consumer_disclosure (optional parameter)
3487
3491
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
3488
3492
  # @return [ConsumerDisclosure]
@@ -3494,7 +3498,7 @@ module DocuSign_eSign
3494
3498
  # Update Consumer Disclosure.
3495
3499
  #
3496
3500
  # @param account_id The external account number (int) or account ID Guid.
3497
- # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3501
+ # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
3498
3502
  # @param consumer_disclosure (optional parameter)
3499
3503
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
3500
3504
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
@@ -6,7 +6,6 @@
6
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
- Swagger Codegen version: 2.4.13-SNAPSHOT
10
9
 
11
10
  =end
12
11
 
@@ -6,7 +6,6 @@
6
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
- Swagger Codegen version: 2.4.13-SNAPSHOT
10
9
 
11
10
  =end
12
11
 
@@ -6,7 +6,6 @@
6
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
- Swagger Codegen version: 2.4.13-SNAPSHOT
10
9
 
11
10
  =end
12
11
 
@@ -14,27 +13,21 @@ require "uri"
14
13
 
15
14
  module DocuSign_eSign
16
15
 
17
- class GetOptions
18
- # Specifies the number of entries to return.
16
+ class GetBulkSendBatchEnvelopesOptions
17
+ #
19
18
  attr_accessor :count
20
19
 
21
- # 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.
20
+ #
22
21
  attr_accessor :include
23
22
 
24
- # Specifies the location in the list of envelopes from which to start.
25
- attr_accessor :start_position
26
-
27
- def self.default
28
- @@default ||= GetOptions.new
29
- end
30
- end
23
+ #
24
+ attr_accessor :order
31
25
 
32
- class GetBulkSendBatchesOptions
33
26
  #
34
- attr_accessor :batch_ids
27
+ attr_accessor :order_by
35
28
 
36
29
  #
37
- attr_accessor :count
30
+ attr_accessor :search_text
38
31
 
39
32
  #
40
33
  attr_accessor :start_position
@@ -42,32 +35,32 @@ module DocuSign_eSign
42
35
  #
43
36
  attr_accessor :status
44
37
 
38
+ #
39
+ attr_accessor :user_id
40
+
45
41
  def self.default
46
- @@default ||= GetBulkSendBatchesOptions.new
42
+ @@default ||= GetBulkSendBatchEnvelopesOptions.new
47
43
  end
48
44
  end
49
45
 
50
- class GetRecipientsOptions
46
+ class GetBulkSendBatchesOptions
51
47
  #
52
- attr_accessor :include_tabs
48
+ attr_accessor :batch_ids
53
49
 
54
50
  #
55
- attr_accessor :start_position
56
-
57
- def self.default
58
- @@default ||= GetRecipientsOptions.new
59
- end
60
- end
61
-
62
- class ListOptions
63
- # The number of results to return. This can be 1 to 20.
64
51
  attr_accessor :count
65
52
 
66
- # 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.
53
+ #
54
+ attr_accessor :search_text
55
+
56
+ #
67
57
  attr_accessor :start_position
68
58
 
59
+ #
60
+ attr_accessor :status
61
+
69
62
  def self.default
70
- @@default ||= ListOptions.new
63
+ @@default ||= GetBulkSendBatchesOptions.new
71
64
  end
72
65
  end
73
66
 
@@ -293,96 +286,44 @@ module DocuSign_eSign
293
286
  return data, status_code, headers
294
287
  end
295
288
 
296
- # Deletes the bulk recipient file from an envelope.
297
- # 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.
298
- # @param account_id The external account number (int) or account ID Guid.
299
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
300
- # @param recipient_id The ID of the recipient being accessed.
301
- # @return [BulkRecipientsUpdateResponse]
302
- def delete_recipients(account_id, envelope_id, recipient_id)
303
- data, _status_code, _headers = delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
304
- return data
305
- end
306
-
307
- # Deletes the bulk recipient file from an envelope.
308
- # 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.
309
- # @param account_id The external account number (int) or account ID Guid.
310
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
311
- # @param recipient_id The ID of the recipient being accessed.
312
- # @return [Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>] BulkRecipientsUpdateResponse data, response status code and response headers
313
- def delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
314
- if @api_client.config.debugging
315
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.delete_recipients ..."
316
- end
317
- # verify the required parameter 'account_id' is set
318
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.delete_recipients" if account_id.nil?
319
- # verify the required parameter 'envelope_id' is set
320
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.delete_recipients" if envelope_id.nil?
321
- # verify the required parameter 'recipient_id' is set
322
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.delete_recipients" if recipient_id.nil?
323
- # resource path
324
- local_var_path = "/v2.1/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)
325
-
326
- # query parameters
327
- query_params = {}
328
-
329
- # header parameters
330
- header_params = {}
331
- # HTTP header 'Accept' (if needed)
332
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
333
-
334
- # form parameters
335
- form_params = {}
336
-
337
- # http body (model)
338
- post_body = nil
339
- auth_names = []
340
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
341
- :header_params => header_params,
342
- :query_params => query_params,
343
- :form_params => form_params,
344
- :body => post_body,
345
- :auth_names => auth_names,
346
- :return_type => 'BulkRecipientsUpdateResponse')
347
- if @api_client.config.debugging
348
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#delete_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
349
- end
350
- return data, status_code, headers
351
- end
352
-
353
- # Gets the status of a specified bulk send operation.
354
- # 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.
289
+ # Gets envelopes from a specific bulk send batch
290
+ #
355
291
  # @param account_id The external account number (int) or account ID Guid.
356
- # @param batch_id
357
- # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
358
- # @return [BulkEnvelopeStatus]
359
- def get(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
360
- data, _status_code, _headers = get_with_http_info(account_id, batch_id, options)
292
+ # @param bulk_send_batch_id
293
+ # @param DocuSign_eSign::GetBulkSendBatchEnvelopesOptions Options for modifying the behavior of the function.
294
+ # @return [EnvelopesInformation]
295
+ def get_bulk_send_batch_envelopes(account_id, bulk_send_batch_id, options = DocuSign_eSign::GetBulkSendBatchEnvelopesOptions.default)
296
+ data, _status_code, _headers = get_bulk_send_batch_envelopes_with_http_info(account_id, bulk_send_batch_id, options)
361
297
  return data
362
298
  end
363
299
 
364
- # Gets the status of a specified bulk send operation.
365
- # 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.
300
+ # Gets envelopes from a specific bulk send batch
301
+ #
366
302
  # @param account_id The external account number (int) or account ID Guid.
367
- # @param batch_id
368
- # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
369
- # @return [Array<(BulkEnvelopeStatus, Fixnum, Hash)>] BulkEnvelopeStatus data, response status code and response headers
370
- def get_with_http_info(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
303
+ # @param bulk_send_batch_id
304
+ # @param DocuSign_eSign::GetBulkSendBatchEnvelopesOptions Options for modifying the behavior of the function.
305
+ # @return [Array<(EnvelopesInformation, Fixnum, Hash)>] EnvelopesInformation data, response status code and response headers
306
+ def get_bulk_send_batch_envelopes_with_http_info(account_id, bulk_send_batch_id, options = DocuSign_eSign::GetBulkSendBatchEnvelopesOptions.default)
371
307
  if @api_client.config.debugging
372
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get ..."
308
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_bulk_send_batch_envelopes ..."
373
309
  end
374
310
  # verify the required parameter 'account_id' is set
375
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get" if account_id.nil?
376
- # verify the required parameter 'batch_id' is set
377
- fail ArgumentError, "Missing the required parameter 'batch_id' when calling BulkEnvelopesApi.get" if batch_id.nil?
311
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_bulk_send_batch_envelopes" if account_id.nil?
312
+ # verify the required parameter 'bulk_send_batch_id' is set
313
+ fail ArgumentError, "Missing the required parameter 'bulk_send_batch_id' when calling BulkEnvelopesApi.get_bulk_send_batch_envelopes" if bulk_send_batch_id.nil?
378
314
  # resource path
379
- local_var_path = "/v2.1/accounts/{accountId}/bulk_envelopes/{batchId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'batchId' + '}', batch_id.to_s)
315
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkSendBatchId' + '}', bulk_send_batch_id.to_s)
380
316
 
381
317
  # query parameters
382
318
  query_params = {}
383
319
  query_params[:'count'] = options.count if !options.count.nil?
384
320
  query_params[:'include'] = options.include if !options.include.nil?
321
+ query_params[:'order'] = options.order if !options.order.nil?
322
+ query_params[:'order_by'] = options.order_by if !options.order_by.nil?
323
+ query_params[:'search_text'] = options.search_text if !options.search_text.nil?
385
324
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
325
+ query_params[:'status'] = options.status if !options.status.nil?
326
+ query_params[:'user_id'] = options.user_id if !options.user_id.nil?
386
327
 
387
328
  # header parameters
388
329
  header_params = {}
@@ -401,9 +342,9 @@ module DocuSign_eSign
401
342
  :form_params => form_params,
402
343
  :body => post_body,
403
344
  :auth_names => auth_names,
404
- :return_type => 'BulkEnvelopeStatus')
345
+ :return_type => 'EnvelopesInformation')
405
346
  if @api_client.config.debugging
406
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
347
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_bulk_send_batch_envelopes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
407
348
  end
408
349
  return data, status_code, headers
409
350
  end
@@ -489,6 +430,7 @@ module DocuSign_eSign
489
430
  query_params = {}
490
431
  query_params[:'batch_ids'] = options.batch_ids if !options.batch_ids.nil?
491
432
  query_params[:'count'] = options.count if !options.count.nil?
433
+ query_params[:'search_text'] = options.search_text if !options.search_text.nil?
492
434
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
493
435
  query_params[:'status'] = options.status if !options.status.nil?
494
436
 
@@ -618,95 +560,36 @@ module DocuSign_eSign
618
560
  return data, status_code, headers
619
561
  end
620
562
 
621
- # Gets the bulk recipient file from an envelope.
622
- # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
623
- # @param account_id The external account number (int) or account ID Guid.
624
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
625
- # @param recipient_id The ID of the recipient being accessed.
626
- # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
627
- # @return [BulkRecipientsResponse]
628
- def get_recipients(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
629
- data, _status_code, _headers = get_recipients_with_http_info(account_id, envelope_id, recipient_id, options)
630
- return data
631
- end
632
-
633
- # Gets the bulk recipient file from an envelope.
634
- # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
635
- # @param account_id The external account number (int) or account ID Guid.
636
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
637
- # @param recipient_id The ID of the recipient being accessed.
638
- # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
639
- # @return [Array<(BulkRecipientsResponse, Fixnum, Hash)>] BulkRecipientsResponse data, response status code and response headers
640
- def get_recipients_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
641
- if @api_client.config.debugging
642
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_recipients ..."
643
- end
644
- # verify the required parameter 'account_id' is set
645
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_recipients" if account_id.nil?
646
- # verify the required parameter 'envelope_id' is set
647
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.get_recipients" if envelope_id.nil?
648
- # verify the required parameter 'recipient_id' is set
649
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.get_recipients" if recipient_id.nil?
650
- # resource path
651
- local_var_path = "/v2.1/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)
652
-
653
- # query parameters
654
- query_params = {}
655
- query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
656
- query_params[:'start_position'] = options.start_position if !options.start_position.nil?
657
-
658
- # header parameters
659
- header_params = {}
660
- # HTTP header 'Accept' (if needed)
661
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
662
-
663
- # form parameters
664
- form_params = {}
665
-
666
- # http body (model)
667
- post_body = nil
668
- auth_names = []
669
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
670
- :header_params => header_params,
671
- :query_params => query_params,
672
- :form_params => form_params,
673
- :body => post_body,
674
- :auth_names => auth_names,
675
- :return_type => 'BulkRecipientsResponse')
676
- if @api_client.config.debugging
677
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
678
- end
679
- return data, status_code, headers
680
- end
681
-
682
- # Gets status information about bulk recipient batches.
683
- # 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.
563
+ # Put/Update a specific bulk send batch status
564
+ #
684
565
  # @param account_id The external account number (int) or account ID Guid.
685
- # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
686
- # @return [BulkEnvelopesResponse]
687
- def list(account_id, options = DocuSign_eSign::ListOptions.default)
688
- data, _status_code, _headers = list_with_http_info(account_id, options)
566
+ # @param bulk_send_batch_id
567
+ # @param bulk_send_batch_request (optional parameter)
568
+ # @return [BulkSendBatchStatus]
569
+ def update_bulk_send_batch_status(account_id, bulk_send_batch_id, bulk_send_batch_request)
570
+ data, _status_code, _headers = update_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id, bulk_send_batch_request)
689
571
  return data
690
572
  end
691
573
 
692
- # Gets status information about bulk recipient batches.
693
- # 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.
574
+ # Put/Update a specific bulk send batch status
575
+ #
694
576
  # @param account_id The external account number (int) or account ID Guid.
695
- # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
696
- # @return [Array<(BulkEnvelopesResponse, Fixnum, Hash)>] BulkEnvelopesResponse data, response status code and response headers
697
- def list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default)
577
+ # @param bulk_send_batch_id
578
+ # @param bulk_send_batch_request (optional parameter)
579
+ # @return [Array<(BulkSendBatchStatus, Fixnum, Hash)>] BulkSendBatchStatus data, response status code and response headers
580
+ def update_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id, bulk_send_batch_request)
698
581
  if @api_client.config.debugging
699
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.list ..."
582
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_bulk_send_batch_status ..."
700
583
  end
701
584
  # verify the required parameter 'account_id' is set
702
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.list" if account_id.nil?
585
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_bulk_send_batch_status" if account_id.nil?
586
+ # verify the required parameter 'bulk_send_batch_id' is set
587
+ fail ArgumentError, "Missing the required parameter 'bulk_send_batch_id' when calling BulkEnvelopesApi.update_bulk_send_batch_status" if bulk_send_batch_id.nil?
703
588
  # resource path
704
- local_var_path = "/v2.1/accounts/{accountId}/bulk_envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
589
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkSendBatchId' + '}', bulk_send_batch_id.to_s)
705
590
 
706
591
  # query parameters
707
592
  query_params = {}
708
- query_params[:'count'] = options.count if !options.count.nil?
709
- query_params[:'start_position'] = options.start_position if !options.start_position.nil?
710
593
 
711
594
  # header parameters
712
595
  header_params = {}
@@ -717,17 +600,17 @@ module DocuSign_eSign
717
600
  form_params = {}
718
601
 
719
602
  # http body (model)
720
- post_body = nil
603
+ post_body = @api_client.object_to_http_body(bulk_send_batch_request)
721
604
  auth_names = []
722
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
605
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
723
606
  :header_params => header_params,
724
607
  :query_params => query_params,
725
608
  :form_params => form_params,
726
609
  :body => post_body,
727
610
  :auth_names => auth_names,
728
- :return_type => 'BulkEnvelopesResponse')
611
+ :return_type => 'BulkSendBatchStatus')
729
612
  if @api_client.config.debugging
730
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
613
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_bulk_send_batch_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
731
614
  end
732
615
  return data, status_code, headers
733
616
  end
@@ -786,68 +669,5 @@ module DocuSign_eSign
786
669
  end
787
670
  return data, status_code, headers
788
671
  end
789
-
790
- # Adds or replaces envelope bulk recipients.
791
- # 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.
792
- # @param account_id The external account number (int) or account ID GUID.
793
- # @param envelope_id The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
794
- # @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`.
795
- # @param bulk_recipients_request
796
- # @return [BulkRecipientsSummaryResponse]
797
- def update_recipients(account_id, envelope_id, recipient_id, bulk_recipients_request)
798
- data, _status_code, _headers = update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request)
799
- return data
800
- end
801
-
802
- # Adds or replaces envelope bulk recipients.
803
- # 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.
804
- # @param account_id The external account number (int) or account ID GUID.
805
- # @param envelope_id The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
806
- # @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`.
807
- # @param bulk_recipients_request
808
- # @return [Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>] BulkRecipientsSummaryResponse data, response status code and response headers
809
- def update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request)
810
- if @api_client.config.debugging
811
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_recipients ..."
812
- end
813
- # verify the required parameter 'account_id' is set
814
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_recipients" if account_id.nil?
815
- # verify the required parameter 'envelope_id' is set
816
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.update_recipients" if envelope_id.nil?
817
- # verify the required parameter 'recipient_id' is set
818
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.update_recipients" if recipient_id.nil?
819
- # verify the required parameter 'bulk_recipients_request' is set
820
- fail ArgumentError, "Missing the required parameter 'bulk_recipients_request' when calling BulkEnvelopesApi.update_recipients" if bulk_recipients_request.nil?
821
- # resource path
822
- local_var_path = "/v2.1/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)
823
-
824
- # query parameters
825
- query_params = {}
826
-
827
- # header parameters
828
- header_params = {}
829
- # HTTP header 'Accept' (if needed)
830
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
831
- # HTTP header 'Content-Type'
832
- header_params['Content-Type'] = @api_client.select_header_content_type(['text/csv'])
833
-
834
- # form parameters
835
- form_params = {}
836
-
837
- # http body (model)
838
- post_body = @api_client.object_to_http_body(bulk_recipients_request)
839
- auth_names = []
840
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
841
- :header_params => header_params,
842
- :query_params => query_params,
843
- :form_params => form_params,
844
- :body => post_body,
845
- :auth_names => auth_names,
846
- :return_type => 'BulkRecipientsSummaryResponse')
847
- if @api_client.config.debugging
848
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
849
- end
850
- return data, status_code, headers
851
- end
852
672
  end
853
673
  end