docusign_esign 3.12.0 → 3.19.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (355) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +54 -0
  3. data/docusign_esign.gemspec +5 -5
  4. data/lib/docusign_esign/api/accounts_api.rb +83 -433
  5. data/lib/docusign_esign/api/billing_api.rb +12 -4
  6. data/lib/docusign_esign/api/bulk_envelopes_api.rb +93 -26
  7. data/lib/docusign_esign/api/bulk_process_data_api.rb +412 -0
  8. data/lib/docusign_esign/api/bulk_process_data_send_api.rb +252 -0
  9. data/lib/docusign_esign/api/connect_api.rb +239 -5
  10. data/lib/docusign_esign/api/email_archive_api.rb +8 -8
  11. data/lib/docusign_esign/api/envelopes_api.rb +1435 -207
  12. data/lib/docusign_esign/api/notary_api.rb +16 -16
  13. data/lib/docusign_esign/api/organizations_api.rb +8 -60
  14. data/lib/docusign_esign/api/power_forms_api.rb +24 -16
  15. data/lib/docusign_esign/api/templates_api.rb +20 -79
  16. data/lib/docusign_esign/api/users_api.rb +22 -14
  17. data/lib/docusign_esign/api/workspaces_api.rb +4 -4
  18. data/lib/docusign_esign/client/api_client.rb +16 -10
  19. data/lib/docusign_esign/client/api_error.rb +1 -1
  20. data/lib/docusign_esign/client/auth/oauth.rb +1 -1
  21. data/lib/docusign_esign/models/access_code_format.rb +6 -0
  22. data/lib/docusign_esign/models/account_billing_plan.rb +25 -4
  23. data/lib/docusign_esign/models/account_billing_plan_response.rb +37 -10
  24. data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
  25. data/lib/docusign_esign/models/account_identity_verification_workflow.rb +2 -0
  26. data/lib/docusign_esign/models/account_information.rb +11 -1
  27. data/lib/docusign_esign/models/account_notification.rb +3 -0
  28. data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
  29. data/lib/docusign_esign/models/account_password_rules.rb +7 -0
  30. data/lib/docusign_esign/models/account_role_settings.rb +81 -4
  31. data/lib/docusign_esign/models/account_settings_information.rb +1075 -13
  32. data/lib/docusign_esign/models/account_shared_access.rb +1 -0
  33. data/lib/docusign_esign/models/account_signature.rb +2 -0
  34. data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
  35. data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
  36. data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
  37. data/lib/docusign_esign/models/account_ui_settings.rb +28 -13
  38. data/lib/docusign_esign/models/address_information_input.rb +1 -0
  39. data/lib/docusign_esign/models/agent.rb +45 -1
  40. data/lib/docusign_esign/models/app_store_receipt.rb +21 -1
  41. data/lib/docusign_esign/models/approve.rb +65 -1
  42. data/lib/docusign_esign/models/authentication_status.rb +19 -0
  43. data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
  44. data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
  45. data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
  46. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  47. data/lib/docusign_esign/models/billing_entity_information_response.rb +214 -0
  48. data/lib/docusign_esign/models/billing_invoice_item.rb +21 -1
  49. data/lib/docusign_esign/models/billing_invoices_summary.rb +21 -1
  50. data/lib/docusign_esign/models/billing_plan_information.rb +52 -4
  51. data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
  52. data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
  53. data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
  54. data/lib/docusign_esign/models/brand.rb +4 -0
  55. data/lib/docusign_esign/models/brand_email_content.rb +1 -0
  56. data/lib/docusign_esign/models/brand_link.rb +1 -0
  57. data/lib/docusign_esign/models/brand_logos.rb +1 -0
  58. data/lib/docusign_esign/models/brand_request.rb +1 -0
  59. data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
  60. data/lib/docusign_esign/models/brand_resources.rb +3 -0
  61. data/lib/docusign_esign/models/brands_request.rb +1 -0
  62. data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
  63. data/lib/docusign_esign/models/bulk_process_request.rb +194 -0
  64. data/lib/docusign_esign/models/bulk_process_response.rb +248 -0
  65. data/lib/docusign_esign/models/bulk_process_result.rb +206 -0
  66. data/lib/docusign_esign/models/bulk_processing_list_summaries.rb +186 -0
  67. data/lib/docusign_esign/models/bulk_processing_list_summary.rb +214 -0
  68. data/lib/docusign_esign/models/bulk_processing_lists.rb +186 -0
  69. data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
  70. data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +204 -0
  71. data/lib/docusign_esign/models/bulk_send_batch_error.rb +194 -0
  72. data/lib/docusign_esign/models/bulk_send_batch_status.rb +42 -1
  73. data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +22 -1
  74. data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
  75. data/lib/docusign_esign/models/bulk_send_envelopes_info.rb +304 -0
  76. data/lib/docusign_esign/models/bulk_send_error_status.rb +12 -1
  77. data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
  78. data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
  79. data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
  80. data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
  81. data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
  82. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
  83. data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
  84. data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
  85. data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
  86. data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
  87. data/lib/docusign_esign/models/captive_recipient.rb +2 -0
  88. data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
  89. data/lib/docusign_esign/models/carbon_copy.rb +48 -1
  90. data/lib/docusign_esign/models/certified_delivery.rb +47 -1
  91. data/lib/docusign_esign/models/checkbox.rb +109 -1
  92. data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
  93. data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
  94. data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
  95. data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
  96. data/lib/docusign_esign/models/comment_thread.rb +63 -1
  97. data/lib/docusign_esign/models/commission_county.rb +72 -1
  98. data/lib/docusign_esign/models/commission_expiration.rb +72 -1
  99. data/lib/docusign_esign/models/commission_number.rb +72 -1
  100. data/lib/docusign_esign/models/commission_state.rb +72 -1
  101. data/lib/docusign_esign/models/company.rb +72 -1
  102. data/lib/docusign_esign/models/composite_template.rb +2 -0
  103. data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
  104. data/lib/docusign_esign/models/connect_config_results.rb +1 -0
  105. data/lib/docusign_esign/models/connect_custom_configuration.rb +60 -4
  106. data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
  107. data/lib/docusign_esign/models/connect_delete_failure_result.rb +174 -0
  108. data/lib/docusign_esign/models/connect_event_data.rb +1 -0
  109. data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
  110. data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
  111. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +195 -0
  112. data/lib/docusign_esign/models/connect_log.rb +1 -0
  113. data/lib/docusign_esign/models/connect_o_auth_config.rb +214 -0
  114. data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
  115. data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
  116. data/lib/docusign_esign/models/connect_user_info.rb +214 -0
  117. data/lib/docusign_esign/models/consent_details.rb +204 -0
  118. data/lib/docusign_esign/models/console_view_request.rb +1 -0
  119. data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
  120. data/lib/docusign_esign/models/contact.rb +12 -1
  121. data/lib/docusign_esign/models/contact_get_response.rb +1 -0
  122. data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
  123. data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
  124. data/lib/docusign_esign/models/contact_update_response.rb +1 -0
  125. data/lib/docusign_esign/models/correct_view_request.rb +12 -1
  126. data/lib/docusign_esign/models/credit_card_information.rb +2 -0
  127. data/lib/docusign_esign/models/currency.rb +95 -1
  128. data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
  129. data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
  130. data/lib/docusign_esign/models/custom_field.rb +2 -0
  131. data/lib/docusign_esign/models/date.rb +98 -1
  132. data/lib/docusign_esign/models/date_signed.rb +66 -1
  133. data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
  134. data/lib/docusign_esign/models/decline.rb +66 -1
  135. data/lib/docusign_esign/models/delayed_routing.rb +206 -0
  136. data/lib/docusign_esign/models/delayed_routing_api_model.rb +206 -0
  137. data/lib/docusign_esign/models/delegation_info.rb +214 -0
  138. data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
  139. data/lib/docusign_esign/models/document.rb +3 -0
  140. data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
  141. data/lib/docusign_esign/models/document_html_definition.rb +1 -0
  142. data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
  143. data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
  144. data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
  145. data/lib/docusign_esign/models/document_template.rb +1 -0
  146. data/lib/docusign_esign/models/document_visibility.rb +2 -0
  147. data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
  148. data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
  149. data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
  150. data/lib/docusign_esign/models/downgrade_plan_update_response.rb +11 -1
  151. data/lib/docusign_esign/models/downgrade_request_information.rb +204 -0
  152. data/lib/docusign_esign/models/draw.rb +60 -1
  153. data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
  154. data/lib/docusign_esign/models/editor.rb +46 -1
  155. data/lib/docusign_esign/models/email.rb +98 -1
  156. data/lib/docusign_esign/models/email_address.rb +66 -1
  157. data/lib/docusign_esign/models/envelope.rb +20 -1
  158. data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
  159. data/lib/docusign_esign/models/envelope_custom_metadata.rb +186 -0
  160. data/lib/docusign_esign/models/envelope_definition.rb +23 -1
  161. data/lib/docusign_esign/models/envelope_delay_rule.rb +194 -0
  162. data/lib/docusign_esign/models/envelope_delay_rule_api_model.rb +195 -0
  163. data/lib/docusign_esign/models/envelope_document.rb +7 -0
  164. data/lib/docusign_esign/models/envelope_event.rb +1 -0
  165. data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
  166. data/lib/docusign_esign/models/envelope_id.rb +65 -1
  167. data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
  168. data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
  169. data/lib/docusign_esign/models/envelope_publish_transaction.rb +307 -0
  170. data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -0
  171. data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
  172. data/lib/docusign_esign/models/envelope_summary.rb +3 -0
  173. data/lib/docusign_esign/models/envelope_template.rb +22 -1
  174. data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
  175. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
  176. data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
  177. data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
  178. data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
  179. data/lib/docusign_esign/models/envelopes_information.rb +1 -0
  180. data/lib/docusign_esign/models/event_notification.rb +24 -1
  181. data/lib/docusign_esign/models/event_result.rb +1 -0
  182. data/lib/docusign_esign/models/external_document_sources.rb +6 -0
  183. data/lib/docusign_esign/models/external_file.rb +1 -0
  184. data/lib/docusign_esign/models/external_folder.rb +1 -0
  185. data/lib/docusign_esign/models/external_primary_account_recipient_auth_requirements.rb +214 -0
  186. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
  187. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
  188. data/lib/docusign_esign/models/feature_set.rb +1 -0
  189. data/lib/docusign_esign/models/filter.rb +1 -0
  190. data/lib/docusign_esign/models/first_name.rb +66 -1
  191. data/lib/docusign_esign/models/folder.rb +4 -0
  192. data/lib/docusign_esign/models/folder_item_response.rb +1 -0
  193. data/lib/docusign_esign/models/folder_item_v2.rb +13 -1
  194. data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
  195. data/lib/docusign_esign/models/folders_request.rb +1 -0
  196. data/lib/docusign_esign/models/form_data_item.rb +1 -0
  197. data/lib/docusign_esign/models/formula_tab.rb +103 -1
  198. data/lib/docusign_esign/models/full_name.rb +66 -1
  199. data/lib/docusign_esign/models/group.rb +13 -1
  200. data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
  201. data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
  202. data/lib/docusign_esign/models/id_evidence_resource_token.rb +194 -0
  203. data/lib/docusign_esign/models/id_evidence_view_link.rb +184 -0
  204. data/lib/docusign_esign/models/in_person_signer.rb +31 -0
  205. data/lib/docusign_esign/models/initial_here.rb +60 -1
  206. data/lib/docusign_esign/models/inline_template.rb +3 -0
  207. data/lib/docusign_esign/models/integrated_connect_user_info_list.rb +246 -0
  208. data/lib/docusign_esign/models/intermediary.rb +46 -1
  209. data/lib/docusign_esign/models/jurisdiction.rb +1 -0
  210. data/lib/docusign_esign/models/last_name.rb +66 -1
  211. data/lib/docusign_esign/models/linked_external_primary_account.rb +21 -1
  212. data/lib/docusign_esign/models/list.rb +112 -1
  213. data/lib/docusign_esign/models/list_custom_field.rb +2 -0
  214. data/lib/docusign_esign/models/list_item.rb +4 -0
  215. data/lib/docusign_esign/models/locale_policy.rb +13 -0
  216. data/lib/docusign_esign/models/lock_information.rb +2 -0
  217. data/lib/docusign_esign/models/lock_request.rb +1 -0
  218. data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
  219. data/lib/docusign_esign/models/member_shared_items.rb +3 -0
  220. data/lib/docusign_esign/models/merge_field.rb +6 -0
  221. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
  222. data/lib/docusign_esign/models/money.rb +1 -0
  223. data/lib/docusign_esign/models/name_value.rb +2 -0
  224. data/lib/docusign_esign/models/new_account_definition.rb +53 -4
  225. data/lib/docusign_esign/models/new_account_summary.rb +1 -0
  226. data/lib/docusign_esign/models/new_user.rb +2 -0
  227. data/lib/docusign_esign/models/new_users_summary.rb +1 -0
  228. data/lib/docusign_esign/models/notarize.rb +58 -1
  229. data/lib/docusign_esign/models/notary.rb +1 -0
  230. data/lib/docusign_esign/models/notary_host.rb +20 -0
  231. data/lib/docusign_esign/models/notary_journal.rb +2 -0
  232. data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
  233. data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
  234. data/lib/docusign_esign/models/notary_recipient.rb +93 -1
  235. data/lib/docusign_esign/models/notary_result.rb +2 -0
  236. data/lib/docusign_esign/models/notary_seal.rb +59 -1
  237. data/lib/docusign_esign/models/note.rb +67 -1
  238. data/lib/docusign_esign/models/notification.rb +2 -0
  239. data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
  240. data/lib/docusign_esign/models/notification_defaults.rb +2 -0
  241. data/lib/docusign_esign/models/number.rb +100 -1
  242. data/lib/docusign_esign/models/page.rb +1 -0
  243. data/lib/docusign_esign/models/participant.rb +908 -0
  244. data/lib/docusign_esign/models/payment_details.rb +16 -1
  245. data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
  246. data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
  247. data/lib/docusign_esign/models/payment_line_item.rb +1 -0
  248. data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
  249. data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
  250. data/lib/docusign_esign/models/permission_profile.rb +2 -0
  251. data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
  252. data/lib/docusign_esign/models/phone_number.rb +72 -1
  253. data/lib/docusign_esign/models/poly_line_overlay.rb +60 -1
  254. data/lib/docusign_esign/models/power_form.rb +2 -0
  255. data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
  256. data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
  257. data/lib/docusign_esign/models/power_forms_response.rb +1 -0
  258. data/lib/docusign_esign/models/prefill_tabs.rb +65 -4
  259. data/lib/docusign_esign/models/property_metadata.rb +1 -0
  260. data/lib/docusign_esign/models/radio.rb +48 -1
  261. data/lib/docusign_esign/models/radio_group.rb +78 -4
  262. data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
  263. data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
  264. data/lib/docusign_esign/models/recipient_group.rb +1 -0
  265. data/lib/docusign_esign/models/recipient_identity_phone_number.rb +44 -4
  266. data/lib/docusign_esign/models/recipient_identity_verification.rb +15 -4
  267. data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
  268. data/lib/docusign_esign/models/recipient_option.rb +1 -0
  269. data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
  270. data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
  271. data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
  272. data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
  273. data/lib/docusign_esign/models/recipient_routing.rb +2 -0
  274. data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
  275. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
  276. data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
  277. data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +102 -2
  278. data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
  279. data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
  280. data/lib/docusign_esign/models/recipients.rb +14 -1
  281. data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
  282. data/lib/docusign_esign/models/reserved_domain_existence.rb +194 -0
  283. data/lib/docusign_esign/models/return_url_request.rb +1 -0
  284. data/lib/docusign_esign/models/scheduled_sending.rb +216 -0
  285. data/lib/docusign_esign/models/scheduled_sending_api_model.rb +206 -0
  286. data/lib/docusign_esign/models/seal_sign.rb +17 -0
  287. data/lib/docusign_esign/models/seat_discount.rb +1 -0
  288. data/lib/docusign_esign/models/sender_company.rb +65 -1
  289. data/lib/docusign_esign/models/sender_email_notifications.rb +12 -1
  290. data/lib/docusign_esign/models/sender_name.rb +65 -1
  291. data/lib/docusign_esign/models/settings_metadata.rb +1 -0
  292. data/lib/docusign_esign/models/shared_item.rb +3 -0
  293. data/lib/docusign_esign/models/sign_here.rb +62 -1
  294. data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
  295. data/lib/docusign_esign/models/signature_type.rb +1 -0
  296. data/lib/docusign_esign/models/signer.rb +84 -1
  297. data/lib/docusign_esign/models/signer_attachment.rb +60 -1
  298. data/lib/docusign_esign/models/signing_group.rb +2 -0
  299. data/lib/docusign_esign/models/signing_group_user.rb +1 -0
  300. data/lib/docusign_esign/models/smart_section.rb +61 -1
  301. data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
  302. data/lib/docusign_esign/models/social_account_information.rb +1 -0
  303. data/lib/docusign_esign/models/ssn.rb +98 -1
  304. data/lib/docusign_esign/models/stamp.rb +2 -0
  305. data/lib/docusign_esign/models/supported_languages.rb +1 -0
  306. data/lib/docusign_esign/models/tab_account_settings.rb +42 -1
  307. data/lib/docusign_esign/models/tab_group.rb +61 -1
  308. data/lib/docusign_esign/models/tab_metadata.rb +34 -1
  309. data/lib/docusign_esign/models/tabs.rb +2 -0
  310. data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
  311. data/lib/docusign_esign/models/template_notification_request.rb +2 -0
  312. data/lib/docusign_esign/models/template_recipients.rb +14 -1
  313. data/lib/docusign_esign/models/template_role.rb +4 -0
  314. data/lib/docusign_esign/models/template_shared_item.rb +3 -0
  315. data/lib/docusign_esign/models/template_summary.rb +3 -0
  316. data/lib/docusign_esign/models/template_tabs.rb +1 -0
  317. data/lib/docusign_esign/models/template_update_summary.rb +4 -0
  318. data/lib/docusign_esign/models/text.rb +100 -1
  319. data/lib/docusign_esign/models/text_custom_field.rb +2 -0
  320. data/lib/docusign_esign/models/title.rb +72 -1
  321. data/lib/docusign_esign/models/user_account_management_granular_information.rb +70 -1
  322. data/lib/docusign_esign/models/user_info.rb +1 -0
  323. data/lib/docusign_esign/models/user_information.rb +17 -1
  324. data/lib/docusign_esign/models/user_information_list.rb +1 -0
  325. data/lib/docusign_esign/models/user_password_information.rb +1 -0
  326. data/lib/docusign_esign/models/user_password_rules.rb +2 -0
  327. data/lib/docusign_esign/models/user_profile.rb +3 -0
  328. data/lib/docusign_esign/models/user_settings_information.rb +103 -4
  329. data/lib/docusign_esign/models/user_shared_item.rb +3 -0
  330. data/lib/docusign_esign/models/user_signature.rb +2 -0
  331. data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
  332. data/lib/docusign_esign/models/view.rb +66 -1
  333. data/lib/docusign_esign/models/witness.rb +84 -1
  334. data/lib/docusign_esign/models/workflow.rb +32 -1
  335. data/lib/docusign_esign/models/workflow_step.rb +13 -1
  336. data/lib/docusign_esign/models/workspace.rb +4 -0
  337. data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
  338. data/lib/docusign_esign/models/workspace_item.rb +5 -0
  339. data/lib/docusign_esign/models/workspace_settings.rb +1 -0
  340. data/lib/docusign_esign/models/workspace_user.rb +1 -0
  341. data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
  342. data/lib/docusign_esign/models/zip.rb +99 -1
  343. data/lib/docusign_esign/version.rb +1 -1
  344. data/lib/docusign_esign.rb +30 -17
  345. data/tests/spec/unit_tests_using_jwt_spec.rb +605 -449
  346. metadata +70 -44
  347. data/Gemfile.lock +0 -73
  348. data/docusign_esign-2.12.0.rc1.gem +0 -0
  349. data/docusign_esign-3.12.0.rc1.gem +0 -0
  350. data/lib/docusign_esign/.DS_Store +0 -0
  351. data/lib/docusign_esign/api/.DS_Store +0 -0
  352. data/lib/docusign_esign/client/.DS_Store +0 -0
  353. data/tests/.DS_Store +0 -0
  354. data/tests/Gemfile.lock +0 -46
  355. data/tests/docs/private.pem +0 -27
@@ -0,0 +1,194 @@
1
+ =begin
2
+ #DocuSign REST API
3
+
4
+ #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
+
6
+ OpenAPI spec version: v2.1
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require 'date'
13
+
14
+ module DocuSign_eSign
15
+ class EnvelopePublishTransactionErrorRollup
16
+ #
17
+ attr_accessor :count
18
+
19
+ #
20
+ attr_accessor :error_type
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'count' => :'count',
26
+ :'error_type' => :'errorType'
27
+ }
28
+ end
29
+
30
+ # Attribute type mapping.
31
+ def self.swagger_types
32
+ {
33
+ :'count' => :'String',
34
+ :'error_type' => :'String'
35
+ }
36
+ end
37
+
38
+ # Initializes the object
39
+ # @param [Hash] attributes Model attributes in the form of hash
40
+ def initialize(attributes = {})
41
+ return unless attributes.is_a?(Hash)
42
+
43
+ # convert string to symbol for hash key
44
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
45
+
46
+ if attributes.has_key?(:'count')
47
+ self.count = attributes[:'count']
48
+ end
49
+
50
+ if attributes.has_key?(:'errorType')
51
+ self.error_type = attributes[:'errorType']
52
+ end
53
+ end
54
+
55
+ # Show invalid properties with the reasons. Usually used together with valid?
56
+ # @return Array for valid properties with the reasons
57
+ def list_invalid_properties
58
+ invalid_properties = Array.new
59
+ invalid_properties
60
+ end
61
+
62
+ # Check to see if the all the properties in the model are valid
63
+ # @return true if the model is valid
64
+ def valid?
65
+ true
66
+ end
67
+
68
+ # Checks equality by comparing each attribute.
69
+ # @param [Object] Object to be compared
70
+ def ==(o)
71
+ return true if self.equal?(o)
72
+ self.class == o.class &&
73
+ count == o.count &&
74
+ error_type == o.error_type
75
+ end
76
+
77
+ # @see the `==` method
78
+ # @param [Object] Object to be compared
79
+ def eql?(o)
80
+ self == o
81
+ end
82
+
83
+ # Calculates hash code according to all attributes.
84
+ # @return [Fixnum] Hash code
85
+ def hash
86
+ [count, error_type].hash
87
+ end
88
+
89
+ # Builds the object from hash
90
+ # @param [Hash] attributes Model attributes in the form of hash
91
+ # @return [Object] Returns the model itself
92
+ def build_from_hash(attributes)
93
+ return nil unless attributes.is_a?(Hash)
94
+ self.class.swagger_types.each_pair do |key, type|
95
+ if type =~ /\AArray<(.*)>/i
96
+ # check to ensure the input is an array given that the attribute
97
+ # is documented as an array but the input is not
98
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
99
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
100
+ end
101
+ elsif !attributes[self.class.attribute_map[key]].nil?
102
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
103
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
104
+ end
105
+
106
+ self
107
+ end
108
+
109
+ # Deserializes the data based on type
110
+ # @param string type Data type
111
+ # @param string value Value to be deserialized
112
+ # @return [Object] Deserialized data
113
+ def _deserialize(type, value)
114
+ case type.to_sym
115
+ when :DateTime
116
+ DateTime.parse(value)
117
+ when :Date
118
+ Date.parse(value)
119
+ when :String
120
+ value.to_s
121
+ when :Integer
122
+ value.to_i
123
+ when :Float
124
+ value.to_f
125
+ when :BOOLEAN
126
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
127
+ true
128
+ else
129
+ false
130
+ end
131
+ when :Object
132
+ # generic object (usually a Hash), return directly
133
+ value
134
+ when /\AArray<(?<inner_type>.+)>\z/
135
+ inner_type = Regexp.last_match[:inner_type]
136
+ value.map { |v| _deserialize(inner_type, v) }
137
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
138
+ k_type = Regexp.last_match[:k_type]
139
+ v_type = Regexp.last_match[:v_type]
140
+ {}.tap do |hash|
141
+ value.each do |k, v|
142
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
143
+ end
144
+ end
145
+ else # model
146
+ temp_model = DocuSign_eSign.const_get(type).new
147
+ temp_model.build_from_hash(value)
148
+ end
149
+ end
150
+
151
+ # Returns the string representation of the object
152
+ # @return [String] String presentation of the object
153
+ def to_s
154
+ to_hash.to_s
155
+ end
156
+
157
+ # to_body is an alias to to_hash (backward compatibility)
158
+ # @return [Hash] Returns the object in the form of hash
159
+ def to_body
160
+ to_hash
161
+ end
162
+
163
+ # Returns the object in the form of hash
164
+ # @return [Hash] Returns the object in the form of hash
165
+ def to_hash
166
+ hash = {}
167
+ self.class.attribute_map.each_pair do |attr, param|
168
+ value = self.send(attr)
169
+ next if value.nil?
170
+ hash[param] = _to_hash(value)
171
+ end
172
+ hash
173
+ end
174
+
175
+ # Outputs non-array value in the form of hash
176
+ # For object, use to_hash. Otherwise, just return the value
177
+ # @param [Object] value Any valid value
178
+ # @return [Hash] Returns the value in the form of hash
179
+ def _to_hash(value)
180
+ if value.is_a?(Array)
181
+ value.compact.map { |v| _to_hash(v) }
182
+ elsif value.is_a?(Hash)
183
+ {}.tap do |hash|
184
+ value.each { |k, v| hash[k] = _to_hash(v) }
185
+ end
186
+ elsif value.respond_to? :to_hash
187
+ value.to_hash
188
+ else
189
+ value
190
+ end
191
+ end
192
+
193
+ end
194
+ end
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`).
15
16
  class EnvelopePurgeConfiguration
16
17
  #
17
18
  attr_accessor :purge_envelopes
@@ -12,12 +12,15 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # This object describes an envelope.
15
16
  class EnvelopeSummary
17
+ # An object that describes the status of the bulk send envelopes.
16
18
  attr_accessor :bulk_envelope_status
17
19
 
18
20
  # The envelope ID of the envelope status that failed to post.
19
21
  attr_accessor :envelope_id
20
22
 
23
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
21
24
  attr_accessor :error_details
22
25
 
23
26
  #
@@ -73,6 +73,7 @@ module DocuSign_eSign
73
73
  # Indicates the date and time the item was created.
74
74
  attr_accessor :created_date_time
75
75
 
76
+ # An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters.
76
77
  attr_accessor :custom_fields
77
78
 
78
79
  # Contains a URI for an endpoint that you can use to retrieve the custom fields.
@@ -108,6 +109,7 @@ module DocuSign_eSign
108
109
  #
109
110
  attr_accessor :email_blurb
110
111
 
112
+ # A complex type that contains email settings.
111
113
  attr_accessor :email_settings
112
114
 
113
115
  # Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
@@ -122,6 +124,9 @@ module DocuSign_eSign
122
124
  #
123
125
  attr_accessor :envelope_attachments
124
126
 
127
+ #
128
+ attr_accessor :envelope_custom_metadata
129
+
125
130
  #
126
131
  attr_accessor :envelope_documents
127
132
 
@@ -134,6 +139,7 @@ module DocuSign_eSign
134
139
  #
135
140
  attr_accessor :envelope_location
136
141
 
142
+ # Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service.
137
143
  attr_accessor :envelope_metadata
138
144
 
139
145
  # Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
@@ -193,6 +199,7 @@ module DocuSign_eSign
193
199
  #
194
200
  attr_accessor :last_modified
195
201
 
202
+ #
196
203
  attr_accessor :last_modified_by
197
204
 
198
205
  # The date and time the item was last modified.
@@ -204,6 +211,7 @@ module DocuSign_eSign
204
211
  #
205
212
  attr_accessor :location
206
213
 
214
+ # Provides lock information about an envelope that a user has locked.
207
215
  attr_accessor :lock_information
208
216
 
209
217
  # When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.
@@ -215,11 +223,13 @@ module DocuSign_eSign
215
223
  #
216
224
  attr_accessor :new_password
217
225
 
226
+ #
218
227
  attr_accessor :notification
219
228
 
220
229
  # Contains a URI for an endpoint that you can use to retrieve the notifications.
221
230
  attr_accessor :notification_uri
222
231
 
232
+ #
223
233
  attr_accessor :owner
224
234
 
225
235
  #
@@ -231,6 +241,7 @@ module DocuSign_eSign
231
241
  #
232
242
  attr_accessor :password_protected
233
243
 
244
+ # Information about any PowerForms that are included in the envelope.
234
245
  attr_accessor :power_form
235
246
 
236
247
  #
@@ -245,6 +256,7 @@ module DocuSign_eSign
245
256
  #
246
257
  attr_accessor :purge_state
247
258
 
259
+ # An array of recipient objects that provides details about the recipients of the envelope.
248
260
  attr_accessor :recipients
249
261
 
250
262
  # When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
@@ -253,6 +265,7 @@ module DocuSign_eSign
253
265
  # Contains a URI for an endpoint that you can use to retrieve the recipients.
254
266
  attr_accessor :recipients_uri
255
267
 
268
+ # Information about the sender of the envelope.
256
269
  attr_accessor :sender
257
270
 
258
271
  # The date and time the envelope was sent.
@@ -297,6 +310,7 @@ module DocuSign_eSign
297
310
  # The reason the envelope or template was voided.
298
311
  attr_accessor :voided_reason
299
312
 
313
+ #
300
314
  attr_accessor :workflow
301
315
 
302
316
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -339,6 +353,7 @@ module DocuSign_eSign
339
353
  :'enable_wet_sign' => :'enableWetSign',
340
354
  :'enforce_signer_visibility' => :'enforceSignerVisibility',
341
355
  :'envelope_attachments' => :'envelopeAttachments',
356
+ :'envelope_custom_metadata' => :'envelopeCustomMetadata',
342
357
  :'envelope_documents' => :'envelopeDocuments',
343
358
  :'envelope_id' => :'envelopeId',
344
359
  :'envelope_id_stamping' => :'envelopeIdStamping',
@@ -444,6 +459,7 @@ module DocuSign_eSign
444
459
  :'enable_wet_sign' => :'String',
445
460
  :'enforce_signer_visibility' => :'String',
446
461
  :'envelope_attachments' => :'Array<Attachment>',
462
+ :'envelope_custom_metadata' => :'EnvelopeCustomMetadata',
447
463
  :'envelope_documents' => :'Array<EnvelopeDocument>',
448
464
  :'envelope_id' => :'String',
449
465
  :'envelope_id_stamping' => :'String',
@@ -669,6 +685,10 @@ module DocuSign_eSign
669
685
  end
670
686
  end
671
687
 
688
+ if attributes.has_key?(:'envelopeCustomMetadata')
689
+ self.envelope_custom_metadata = attributes[:'envelopeCustomMetadata']
690
+ end
691
+
672
692
  if attributes.has_key?(:'envelopeDocuments')
673
693
  if (value = attributes[:'envelopeDocuments']).is_a?(Array)
674
694
  self.envelope_documents = value
@@ -981,6 +1001,7 @@ module DocuSign_eSign
981
1001
  enable_wet_sign == o.enable_wet_sign &&
982
1002
  enforce_signer_visibility == o.enforce_signer_visibility &&
983
1003
  envelope_attachments == o.envelope_attachments &&
1004
+ envelope_custom_metadata == o.envelope_custom_metadata &&
984
1005
  envelope_documents == o.envelope_documents &&
985
1006
  envelope_id == o.envelope_id &&
986
1007
  envelope_id_stamping == o.envelope_id_stamping &&
@@ -1054,7 +1075,7 @@ module DocuSign_eSign
1054
1075
  # Calculates hash code according to all attributes.
1055
1076
  # @return [Fixnum] Hash code
1056
1077
  def hash
1057
- [access_control_list_base64, allow_comments, allow_markup, allow_reassign, allow_view_history, any_signer, asynchronous, attachments_uri, authoritative_copy, authoritative_copy_default, auto_match, auto_match_specified_by_user, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, copy_recipient_data, created, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, description, disable_responsive_document, document_base64, documents, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, expire_after, expire_date_time, expire_enabled, external_envelope_id, favorited_by_me, folder_id, folder_ids, folder_name, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified, last_modified_by, last_modified_date_time, last_used, location, lock_information, message_lock, name, new_password, notification, notification_uri, owner, page_count, password, password_protected, power_form, power_forms, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, shared, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, template_id, templates_uri, transaction_id, uri, use_disclosure, voided_date_time, voided_reason, workflow].hash
1078
+ [access_control_list_base64, allow_comments, allow_markup, allow_reassign, allow_view_history, any_signer, asynchronous, attachments_uri, authoritative_copy, authoritative_copy_default, auto_match, auto_match_specified_by_user, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, copy_recipient_data, created, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, description, disable_responsive_document, document_base64, documents, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_custom_metadata, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, expire_after, expire_date_time, expire_enabled, external_envelope_id, favorited_by_me, folder_id, folder_ids, folder_name, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified, last_modified_by, last_modified_date_time, last_used, location, lock_information, message_lock, name, new_password, notification, notification_uri, owner, page_count, password, password_protected, power_form, power_forms, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, shared, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, template_id, templates_uri, transaction_id, uri, use_disclosure, voided_date_time, voided_reason, workflow].hash
1058
1079
  end
1059
1080
 
1060
1081
  # Builds the object from hash
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # Information about templates.
15
16
  class EnvelopeTemplateResults
16
17
  # The last position in the result set.
17
18
  attr_accessor :end_position
@@ -16,6 +16,7 @@ module DocuSign_eSign
16
16
  # The envelope ID of the envelope status that failed to post.
17
17
  attr_accessor :envelope_id
18
18
 
19
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
19
20
  attr_accessor :error_details
20
21
 
21
22
  # Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # This object contains details about an envelope transfer rule.
15
16
  class EnvelopeTransferRule
16
17
  #
17
18
  attr_accessor :carbon_copy_original_owner
@@ -25,17 +26,22 @@ module DocuSign_eSign
25
26
  #
26
27
  attr_accessor :event_type
27
28
 
29
+ # Information about the group that triggers the transfer.
28
30
  attr_accessor :from_group
29
31
 
32
+ # Information about the user who triggers the transfer.
30
33
  attr_accessor :from_user
31
34
 
32
35
  #
33
36
  attr_accessor :modified_date
34
37
 
38
+ # Information about the user who last modified the envelope transfer rule.
35
39
  attr_accessor :modified_user
36
40
 
41
+ # Information about the destination folder to which the envelope is transferred.
37
42
  attr_accessor :to_folder
38
43
 
44
+ # Information about the user to which the envelope is transferred.
39
45
  attr_accessor :to_user
40
46
 
41
47
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # This object contains details about the envelope transfer rule that you want to create.
15
16
  class EnvelopeTransferRuleRequest
16
17
  #
17
18
  attr_accessor :carbon_copy_original_owner
@@ -34,10 +35,13 @@ module DocuSign_eSign
34
35
  #
35
36
  attr_accessor :modified_date
36
37
 
38
+ # Information about the user who last modified the envelope transfer rule.
37
39
  attr_accessor :modified_user
38
40
 
41
+ # Information about the destination folder to which the envelope is transferred.
39
42
  attr_accessor :to_folder
40
43
 
44
+ # Information about the user to which the envelope is transferred.
41
45
  attr_accessor :to_user
42
46
 
43
47
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -13,16 +13,19 @@ require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
15
  class EnvelopeUpdateSummary
16
+ # An object that describes the status of the bulk send envelopes.
16
17
  attr_accessor :bulk_envelope_status
17
18
 
18
19
  # The envelope ID of the envelope status that failed to post.
19
20
  attr_accessor :envelope_id
20
21
 
22
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
21
23
  attr_accessor :error_details
22
24
 
23
25
  #
24
26
  attr_accessor :list_custom_field_update_results
25
27
 
28
+ # Provides lock information about an envelope that a user has locked.
26
29
  attr_accessor :lock_information
27
30
 
28
31
  #
@@ -31,6 +34,7 @@ module DocuSign_eSign
31
34
  #
32
35
  attr_accessor :recipient_update_results
33
36
 
37
+ #
34
38
  attr_accessor :tab_update_results
35
39
 
36
40
  #
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # Result set for the Envelopes: listStatusChanges method
15
16
  class EnvelopesInformation
16
17
  #
17
18
  attr_accessor :continuation_token
@@ -14,11 +14,18 @@ require 'date'
14
14
  module DocuSign_eSign
15
15
  # This optional complex element allows a message to be sent a specified URL when the envelope or recipient changes status. It is similar to DocuSign Connect. For example, if an envelope changes from \"Sent\" to \"Delivered\", a message containing the updated envelope status and optionally the documents is sent to the URL. When an eventNotification is attached to an envelope using the API, it only applies to the envelope (treating the envelope as the sender). This is different from envelopes created through the console user interface, where the user is treated as the sender.
16
16
  class EventNotification
17
+ #
18
+ attr_accessor :delivery_mode
19
+
17
20
  # A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.
18
21
  attr_accessor :envelope_events
19
22
 
23
+ # Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications)
20
24
  attr_accessor :event_data
21
25
 
26
+ #
27
+ attr_accessor :events
28
+
22
29
  # When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes.
23
30
  attr_accessor :include_certificate_of_completion
24
31
 
@@ -67,8 +74,10 @@ module DocuSign_eSign
67
74
  # Attribute mapping from ruby-style variable name to JSON key.
68
75
  def self.attribute_map
69
76
  {
77
+ :'delivery_mode' => :'deliveryMode',
70
78
  :'envelope_events' => :'envelopeEvents',
71
79
  :'event_data' => :'eventData',
80
+ :'events' => :'events',
72
81
  :'include_certificate_of_completion' => :'includeCertificateOfCompletion',
73
82
  :'include_certificate_with_soap' => :'includeCertificateWithSoap',
74
83
  :'include_document_fields' => :'includeDocumentFields',
@@ -90,8 +99,10 @@ module DocuSign_eSign
90
99
  # Attribute type mapping.
91
100
  def self.swagger_types
92
101
  {
102
+ :'delivery_mode' => :'String',
93
103
  :'envelope_events' => :'Array<EnvelopeEvent>',
94
104
  :'event_data' => :'ConnectEventData',
105
+ :'events' => :'Array<String>',
95
106
  :'include_certificate_of_completion' => :'String',
96
107
  :'include_certificate_with_soap' => :'String',
97
108
  :'include_document_fields' => :'String',
@@ -118,6 +129,10 @@ module DocuSign_eSign
118
129
  # convert string to symbol for hash key
119
130
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
120
131
 
132
+ if attributes.has_key?(:'deliveryMode')
133
+ self.delivery_mode = attributes[:'deliveryMode']
134
+ end
135
+
121
136
  if attributes.has_key?(:'envelopeEvents')
122
137
  if (value = attributes[:'envelopeEvents']).is_a?(Array)
123
138
  self.envelope_events = value
@@ -128,6 +143,12 @@ module DocuSign_eSign
128
143
  self.event_data = attributes[:'eventData']
129
144
  end
130
145
 
146
+ if attributes.has_key?(:'events')
147
+ if (value = attributes[:'events']).is_a?(Array)
148
+ self.events = value
149
+ end
150
+ end
151
+
131
152
  if attributes.has_key?(:'includeCertificateOfCompletion')
132
153
  self.include_certificate_of_completion = attributes[:'includeCertificateOfCompletion']
133
154
  end
@@ -209,8 +230,10 @@ module DocuSign_eSign
209
230
  def ==(o)
210
231
  return true if self.equal?(o)
211
232
  self.class == o.class &&
233
+ delivery_mode == o.delivery_mode &&
212
234
  envelope_events == o.envelope_events &&
213
235
  event_data == o.event_data &&
236
+ events == o.events &&
214
237
  include_certificate_of_completion == o.include_certificate_of_completion &&
215
238
  include_certificate_with_soap == o.include_certificate_with_soap &&
216
239
  include_document_fields == o.include_document_fields &&
@@ -237,7 +260,7 @@ module DocuSign_eSign
237
260
  # Calculates hash code according to all attributes.
238
261
  # @return [Fixnum] Hash code
239
262
  def hash
240
- [envelope_events, event_data, include_certificate_of_completion, include_certificate_with_soap, include_document_fields, include_documents, include_envelope_void_reason, include_hmac, include_sender_account_as_custom_field, include_time_zone, logging_enabled, recipient_events, require_acknowledgment, sign_message_with_x509_cert, soap_name_space, url, use_soap_interface].hash
263
+ [delivery_mode, envelope_events, event_data, events, include_certificate_of_completion, include_certificate_with_soap, include_document_fields, include_documents, include_envelope_void_reason, include_hmac, include_sender_account_as_custom_field, include_time_zone, logging_enabled, recipient_events, require_acknowledgment, sign_message_with_x509_cert, soap_name_space, url, use_soap_interface].hash
241
264
  end
242
265
 
243
266
  # Builds the object from hash
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # Information about the result of an event.
15
16
  class EventResult
16
17
  #
17
18
  attr_accessor :event_timestamp
@@ -12,30 +12,36 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # A complex object specifying the external document sources.
15
16
  class ExternalDocumentSources
16
17
  #
17
18
  attr_accessor :boxnet_enabled
18
19
 
20
+ # Metadata indicating whether the `boxnetEnabled` property is editable.
19
21
  attr_accessor :boxnet_metadata
20
22
 
21
23
  #
22
24
  attr_accessor :dropbox_enabled
23
25
 
26
+ # Metadata indicating whether the `dropboxEnabled` property is editable.
24
27
  attr_accessor :dropbox_metadata
25
28
 
26
29
  #
27
30
  attr_accessor :google_drive_enabled
28
31
 
32
+ # Metadata indicating whether the `googleDriveEnabled` property is editable.
29
33
  attr_accessor :google_drive_metadata
30
34
 
31
35
  #
32
36
  attr_accessor :one_drive_enabled
33
37
 
38
+ # Metadata indicating whether the `oneDriveEnabled` property is editable.
34
39
  attr_accessor :one_drive_metadata
35
40
 
36
41
  #
37
42
  attr_accessor :salesforce_enabled
38
43
 
44
+ # Metadata indicating whether the `salesforceEnabled` property is editable.
39
45
  attr_accessor :salesforce_metadata
40
46
 
41
47
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # This object contains information about a file or folder in cloud storage.
15
16
  class ExternalFile
16
17
  #
17
18
  attr_accessor :date
@@ -16,6 +16,7 @@ module DocuSign_eSign
16
16
  # The last position in the result set.
17
17
  attr_accessor :end_position
18
18
 
19
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
19
20
  attr_accessor :error_details
20
21
 
21
22
  #