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
@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.
15
16
  class Witness
16
17
  # If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
17
18
  attr_accessor :access_code
18
19
 
20
+ # Metadata that indicates whether the `accessCode` property is editable. This property is read-only.
19
21
  attr_accessor :access_code_metadata
20
22
 
21
23
  # This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
@@ -51,6 +53,9 @@ module DocuSign_eSign
51
53
  #
52
54
  attr_accessor :completed_count
53
55
 
56
+ #
57
+ attr_accessor :consent_details_list
58
+
54
59
  #
55
60
  attr_accessor :creation_reason
56
61
 
@@ -66,12 +71,19 @@ module DocuSign_eSign
66
71
  #
67
72
  attr_accessor :default_recipient
68
73
 
74
+ #
75
+ attr_accessor :delegated_by
76
+
77
+ #
78
+ attr_accessor :delegated_to
79
+
69
80
  # Reserved: For DocuSign use only.
70
81
  attr_accessor :delivered_date_time
71
82
 
72
83
  # Reserved: For DocuSign use only.
73
84
  attr_accessor :delivery_method
74
85
 
86
+ # Reserved for DocuSign.
75
87
  attr_accessor :delivery_method_metadata
76
88
 
77
89
  #
@@ -86,13 +98,19 @@ module DocuSign_eSign
86
98
  #
87
99
  attr_accessor :email
88
100
 
101
+ # Metadata that indicates whether the `email` property is editable. This property is read-only.
89
102
  attr_accessor :email_metadata
90
103
 
104
+ # An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
91
105
  attr_accessor :email_notification
92
106
 
107
+ #
108
+ attr_accessor :email_recipient_post_signing_url
109
+
93
110
  # Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
94
111
  attr_accessor :embedded_recipient_start_url
95
112
 
113
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
96
114
  attr_accessor :error_details
97
115
 
98
116
  # Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
@@ -101,25 +119,31 @@ module DocuSign_eSign
101
119
  # Reserved:
102
120
  attr_accessor :fax_number
103
121
 
122
+ # Reserved for DocuSign.
104
123
  attr_accessor :fax_number_metadata
105
124
 
106
125
  # The user's first name. Maximum Length: 50 characters.
107
126
  attr_accessor :first_name
108
127
 
128
+ # Metadata that indicates whether the `firstName` property is editable. This property is read-only.
109
129
  attr_accessor :first_name_metadata
110
130
 
111
131
  #
112
132
  attr_accessor :full_name
113
133
 
134
+ # Reserved for DocuSign.
114
135
  attr_accessor :full_name_metadata
115
136
 
116
137
  # Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.
117
138
  attr_accessor :id_check_configuration_name
118
139
 
140
+ # Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
119
141
  attr_accessor :id_check_configuration_name_metadata
120
142
 
143
+ # An object that contains input information related to a recipient ID check.
121
144
  attr_accessor :id_check_information_input
122
145
 
146
+ # Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
123
147
  attr_accessor :identity_verification
124
148
 
125
149
  # When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
@@ -128,11 +152,13 @@ module DocuSign_eSign
128
152
  #
129
153
  attr_accessor :is_bulk_recipient
130
154
 
155
+ # Reserved for DocuSign.
131
156
  attr_accessor :is_bulk_recipient_metadata
132
157
 
133
158
  #
134
159
  attr_accessor :last_name
135
160
 
161
+ # Metadata that indicates whether the `lastName` property is editable. This property is read-only.
136
162
  attr_accessor :last_name_metadata
137
163
 
138
164
  #
@@ -144,27 +170,37 @@ module DocuSign_eSign
144
170
  #
145
171
  attr_accessor :name
146
172
 
173
+ # Metadata that indicates whether the `name` property is editable. This property is read-only.
147
174
  attr_accessor :name_metadata
148
175
 
149
176
  #
150
177
  attr_accessor :notary_id
151
178
 
179
+ #
180
+ attr_accessor :notary_signer_email_sent
181
+
152
182
  # Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
153
183
  attr_accessor :note
154
184
 
185
+ # Metadata that indicates whether the `note` property is editable. This property is read-only.
155
186
  attr_accessor :note_metadata
156
187
 
188
+ # Reserved for DocuSign.
157
189
  attr_accessor :offline_attributes
158
190
 
191
+ # When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign.
159
192
  attr_accessor :phone_authentication
160
193
 
194
+ # Describes the recipient phone number.
161
195
  attr_accessor :phone_number
162
196
 
197
+ # The proof file of the recipient.
163
198
  attr_accessor :proof_file
164
199
 
165
200
  # Reserved:
166
201
  attr_accessor :recipient_attachments
167
202
 
203
+ # Information about the recipient's authentication status. This property is read-only.
168
204
  attr_accessor :recipient_authentication_status
169
205
 
170
206
  #
@@ -185,11 +221,13 @@ module DocuSign_eSign
185
221
  #
186
222
  attr_accessor :recipient_type
187
223
 
224
+ # Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
188
225
  attr_accessor :recipient_type_metadata
189
226
 
190
227
  # When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
191
228
  attr_accessor :require_id_lookup
192
229
 
230
+ # Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
193
231
  attr_accessor :require_id_lookup_metadata
194
232
 
195
233
  #
@@ -207,11 +245,13 @@ module DocuSign_eSign
207
245
  # Specifies the routing order of the recipient in the envelope.
208
246
  attr_accessor :routing_order
209
247
 
248
+ # Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
210
249
  attr_accessor :routing_order_metadata
211
250
 
212
251
  # The date and time the envelope was sent.
213
252
  attr_accessor :sent_date_time
214
253
 
254
+ # Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.
215
255
  attr_accessor :signature_info
216
256
 
217
257
  # Reserved: For DocuSign use only.
@@ -220,11 +260,13 @@ module DocuSign_eSign
220
260
  # When set to **true**, specifies that the signer must sign in all locations.
221
261
  attr_accessor :sign_in_each_location
222
262
 
263
+ # Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only.
223
264
  attr_accessor :sign_in_each_location_metadata
224
265
 
225
266
  # When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
226
267
  attr_accessor :signing_group_id
227
268
 
269
+ # Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
228
270
  attr_accessor :signing_group_id_metadata
229
271
 
230
272
  # The display name for the signing group. Maximum Length: 100 characters.
@@ -233,6 +275,7 @@ module DocuSign_eSign
233
275
  # A complex type that contains information about users in the signing group.
234
276
  attr_accessor :signing_group_users
235
277
 
278
+ # When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication.
236
279
  attr_accessor :sms_authentication
237
280
 
238
281
  # Lists the social ID type that can be used for recipient authentication.
@@ -247,6 +290,7 @@ module DocuSign_eSign
247
290
  #
248
291
  attr_accessor :suppress_emails
249
292
 
293
+ # A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
250
294
  attr_accessor :tabs
251
295
 
252
296
  # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
@@ -283,11 +327,14 @@ module DocuSign_eSign
283
327
  :'can_sign_offline' => :'canSignOffline',
284
328
  :'client_user_id' => :'clientUserId',
285
329
  :'completed_count' => :'completedCount',
330
+ :'consent_details_list' => :'consentDetailsList',
286
331
  :'creation_reason' => :'creationReason',
287
332
  :'custom_fields' => :'customFields',
288
333
  :'declined_date_time' => :'declinedDateTime',
289
334
  :'declined_reason' => :'declinedReason',
290
335
  :'default_recipient' => :'defaultRecipient',
336
+ :'delegated_by' => :'delegatedBy',
337
+ :'delegated_to' => :'delegatedTo',
291
338
  :'delivered_date_time' => :'deliveredDateTime',
292
339
  :'delivery_method' => :'deliveryMethod',
293
340
  :'delivery_method_metadata' => :'deliveryMethodMetadata',
@@ -297,6 +344,7 @@ module DocuSign_eSign
297
344
  :'email' => :'email',
298
345
  :'email_metadata' => :'emailMetadata',
299
346
  :'email_notification' => :'emailNotification',
347
+ :'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
300
348
  :'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
301
349
  :'error_details' => :'errorDetails',
302
350
  :'excluded_documents' => :'excludedDocuments',
@@ -320,6 +368,7 @@ module DocuSign_eSign
320
368
  :'name' => :'name',
321
369
  :'name_metadata' => :'nameMetadata',
322
370
  :'notary_id' => :'notaryId',
371
+ :'notary_signer_email_sent' => :'notarySignerEmailSent',
323
372
  :'note' => :'note',
324
373
  :'note_metadata' => :'noteMetadata',
325
374
  :'offline_attributes' => :'offlineAttributes',
@@ -383,11 +432,14 @@ module DocuSign_eSign
383
432
  :'can_sign_offline' => :'String',
384
433
  :'client_user_id' => :'String',
385
434
  :'completed_count' => :'String',
435
+ :'consent_details_list' => :'Array<ConsentDetails>',
386
436
  :'creation_reason' => :'String',
387
437
  :'custom_fields' => :'Array<String>',
388
438
  :'declined_date_time' => :'String',
389
439
  :'declined_reason' => :'String',
390
440
  :'default_recipient' => :'String',
441
+ :'delegated_by' => :'DelegationInfo',
442
+ :'delegated_to' => :'Array<DelegationInfo>',
391
443
  :'delivered_date_time' => :'String',
392
444
  :'delivery_method' => :'String',
393
445
  :'delivery_method_metadata' => :'PropertyMetadata',
@@ -397,6 +449,7 @@ module DocuSign_eSign
397
449
  :'email' => :'String',
398
450
  :'email_metadata' => :'PropertyMetadata',
399
451
  :'email_notification' => :'RecipientEmailNotification',
452
+ :'email_recipient_post_signing_url' => :'String',
400
453
  :'embedded_recipient_start_url' => :'String',
401
454
  :'error_details' => :'ErrorDetails',
402
455
  :'excluded_documents' => :'Array<String>',
@@ -420,6 +473,7 @@ module DocuSign_eSign
420
473
  :'name' => :'String',
421
474
  :'name_metadata' => :'PropertyMetadata',
422
475
  :'notary_id' => :'String',
476
+ :'notary_signer_email_sent' => :'String',
423
477
  :'note' => :'String',
424
478
  :'note_metadata' => :'PropertyMetadata',
425
479
  :'offline_attributes' => :'OfflineAttributes',
@@ -529,6 +583,12 @@ module DocuSign_eSign
529
583
  self.completed_count = attributes[:'completedCount']
530
584
  end
531
585
 
586
+ if attributes.has_key?(:'consentDetailsList')
587
+ if (value = attributes[:'consentDetailsList']).is_a?(Array)
588
+ self.consent_details_list = value
589
+ end
590
+ end
591
+
532
592
  if attributes.has_key?(:'creationReason')
533
593
  self.creation_reason = attributes[:'creationReason']
534
594
  end
@@ -551,6 +611,16 @@ module DocuSign_eSign
551
611
  self.default_recipient = attributes[:'defaultRecipient']
552
612
  end
553
613
 
614
+ if attributes.has_key?(:'delegatedBy')
615
+ self.delegated_by = attributes[:'delegatedBy']
616
+ end
617
+
618
+ if attributes.has_key?(:'delegatedTo')
619
+ if (value = attributes[:'delegatedTo']).is_a?(Array)
620
+ self.delegated_to = value
621
+ end
622
+ end
623
+
554
624
  if attributes.has_key?(:'deliveredDateTime')
555
625
  self.delivered_date_time = attributes[:'deliveredDateTime']
556
626
  end
@@ -589,6 +659,10 @@ module DocuSign_eSign
589
659
  self.email_notification = attributes[:'emailNotification']
590
660
  end
591
661
 
662
+ if attributes.has_key?(:'emailRecipientPostSigningURL')
663
+ self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
664
+ end
665
+
592
666
  if attributes.has_key?(:'embeddedRecipientStartURL')
593
667
  self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
594
668
  end
@@ -683,6 +757,10 @@ module DocuSign_eSign
683
757
  self.notary_id = attributes[:'notaryId']
684
758
  end
685
759
 
760
+ if attributes.has_key?(:'notarySignerEmailSent')
761
+ self.notary_signer_email_sent = attributes[:'notarySignerEmailSent']
762
+ end
763
+
686
764
  if attributes.has_key?(:'note')
687
765
  self.note = attributes[:'note']
688
766
  end
@@ -901,11 +979,14 @@ module DocuSign_eSign
901
979
  can_sign_offline == o.can_sign_offline &&
902
980
  client_user_id == o.client_user_id &&
903
981
  completed_count == o.completed_count &&
982
+ consent_details_list == o.consent_details_list &&
904
983
  creation_reason == o.creation_reason &&
905
984
  custom_fields == o.custom_fields &&
906
985
  declined_date_time == o.declined_date_time &&
907
986
  declined_reason == o.declined_reason &&
908
987
  default_recipient == o.default_recipient &&
988
+ delegated_by == o.delegated_by &&
989
+ delegated_to == o.delegated_to &&
909
990
  delivered_date_time == o.delivered_date_time &&
910
991
  delivery_method == o.delivery_method &&
911
992
  delivery_method_metadata == o.delivery_method_metadata &&
@@ -915,6 +996,7 @@ module DocuSign_eSign
915
996
  email == o.email &&
916
997
  email_metadata == o.email_metadata &&
917
998
  email_notification == o.email_notification &&
999
+ email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
918
1000
  embedded_recipient_start_url == o.embedded_recipient_start_url &&
919
1001
  error_details == o.error_details &&
920
1002
  excluded_documents == o.excluded_documents &&
@@ -938,6 +1020,7 @@ module DocuSign_eSign
938
1020
  name == o.name &&
939
1021
  name_metadata == o.name_metadata &&
940
1022
  notary_id == o.notary_id &&
1023
+ notary_signer_email_sent == o.notary_signer_email_sent &&
941
1024
  note == o.note &&
942
1025
  note_metadata == o.note_metadata &&
943
1026
  offline_attributes == o.offline_attributes &&
@@ -993,7 +1076,7 @@ module DocuSign_eSign
993
1076
  # Calculates hash code according to all attributes.
994
1077
  # @return [Fixnum] Hash code
995
1078
  def hash
996
- [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id, witness_for, witness_for_guid].hash
1079
+ [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, consent_details_list, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id, witness_for, witness_for_guid].hash
997
1080
  end
998
1081
 
999
1082
  # Builds the object from hash
@@ -12,10 +12,20 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # Describes the workflow for an envelope.
15
16
  class Workflow
16
17
  #
17
18
  attr_accessor :current_workflow_step_id
18
19
 
20
+ #
21
+ attr_accessor :overwrite_update_mode
22
+
23
+ #
24
+ attr_accessor :resume_date
25
+
26
+ # An object that describes the settings for scheduled sending.
27
+ attr_accessor :scheduled_sending
28
+
19
29
  #
20
30
  attr_accessor :workflow_status
21
31
 
@@ -26,6 +36,9 @@ module DocuSign_eSign
26
36
  def self.attribute_map
27
37
  {
28
38
  :'current_workflow_step_id' => :'currentWorkflowStepId',
39
+ :'overwrite_update_mode' => :'overwriteUpdateMode',
40
+ :'resume_date' => :'resumeDate',
41
+ :'scheduled_sending' => :'scheduledSending',
29
42
  :'workflow_status' => :'workflowStatus',
30
43
  :'workflow_steps' => :'workflowSteps'
31
44
  }
@@ -35,6 +48,9 @@ module DocuSign_eSign
35
48
  def self.swagger_types
36
49
  {
37
50
  :'current_workflow_step_id' => :'String',
51
+ :'overwrite_update_mode' => :'String',
52
+ :'resume_date' => :'String',
53
+ :'scheduled_sending' => :'ScheduledSending',
38
54
  :'workflow_status' => :'String',
39
55
  :'workflow_steps' => :'Array<WorkflowStep>'
40
56
  }
@@ -52,6 +68,18 @@ module DocuSign_eSign
52
68
  self.current_workflow_step_id = attributes[:'currentWorkflowStepId']
53
69
  end
54
70
 
71
+ if attributes.has_key?(:'overwriteUpdateMode')
72
+ self.overwrite_update_mode = attributes[:'overwriteUpdateMode']
73
+ end
74
+
75
+ if attributes.has_key?(:'resumeDate')
76
+ self.resume_date = attributes[:'resumeDate']
77
+ end
78
+
79
+ if attributes.has_key?(:'scheduledSending')
80
+ self.scheduled_sending = attributes[:'scheduledSending']
81
+ end
82
+
55
83
  if attributes.has_key?(:'workflowStatus')
56
84
  self.workflow_status = attributes[:'workflowStatus']
57
85
  end
@@ -82,6 +110,9 @@ module DocuSign_eSign
82
110
  return true if self.equal?(o)
83
111
  self.class == o.class &&
84
112
  current_workflow_step_id == o.current_workflow_step_id &&
113
+ overwrite_update_mode == o.overwrite_update_mode &&
114
+ resume_date == o.resume_date &&
115
+ scheduled_sending == o.scheduled_sending &&
85
116
  workflow_status == o.workflow_status &&
86
117
  workflow_steps == o.workflow_steps
87
118
  end
@@ -95,7 +126,7 @@ module DocuSign_eSign
95
126
  # Calculates hash code according to all attributes.
96
127
  # @return [Fixnum] Hash code
97
128
  def hash
98
- [current_workflow_step_id, workflow_status, workflow_steps].hash
129
+ [current_workflow_step_id, overwrite_update_mode, resume_date, scheduled_sending, workflow_status, workflow_steps].hash
99
130
  end
100
131
 
101
132
  # 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
+ # Describes a single step in a workflow.
15
16
  class WorkflowStep
16
17
  #
17
18
  attr_accessor :action
@@ -19,9 +20,13 @@ module DocuSign_eSign
19
20
  #
20
21
  attr_accessor :completed_date
21
22
 
23
+ # A complex element that specifies the delayed routing settings for the workflow step.
24
+ attr_accessor :delayed_routing
25
+
22
26
  #
23
27
  attr_accessor :item_id
24
28
 
29
+ # The rules for recipient routing.
25
30
  attr_accessor :recipient_routing
26
31
 
27
32
  # 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.
@@ -41,6 +46,7 @@ module DocuSign_eSign
41
46
  {
42
47
  :'action' => :'action',
43
48
  :'completed_date' => :'completedDate',
49
+ :'delayed_routing' => :'delayedRouting',
44
50
  :'item_id' => :'itemId',
45
51
  :'recipient_routing' => :'recipientRouting',
46
52
  :'status' => :'status',
@@ -55,6 +61,7 @@ module DocuSign_eSign
55
61
  {
56
62
  :'action' => :'String',
57
63
  :'completed_date' => :'String',
64
+ :'delayed_routing' => :'DelayedRouting',
58
65
  :'item_id' => :'String',
59
66
  :'recipient_routing' => :'RecipientRouting',
60
67
  :'status' => :'String',
@@ -80,6 +87,10 @@ module DocuSign_eSign
80
87
  self.completed_date = attributes[:'completedDate']
81
88
  end
82
89
 
90
+ if attributes.has_key?(:'delayedRouting')
91
+ self.delayed_routing = attributes[:'delayedRouting']
92
+ end
93
+
83
94
  if attributes.has_key?(:'itemId')
84
95
  self.item_id = attributes[:'itemId']
85
96
  end
@@ -125,6 +136,7 @@ module DocuSign_eSign
125
136
  self.class == o.class &&
126
137
  action == o.action &&
127
138
  completed_date == o.completed_date &&
139
+ delayed_routing == o.delayed_routing &&
128
140
  item_id == o.item_id &&
129
141
  recipient_routing == o.recipient_routing &&
130
142
  status == o.status &&
@@ -142,7 +154,7 @@ module DocuSign_eSign
142
154
  # Calculates hash code according to all attributes.
143
155
  # @return [Fixnum] Hash code
144
156
  def hash
145
- [action, completed_date, item_id, recipient_routing, status, triggered_date, trigger_on_item, workflow_step_id].hash
157
+ [action, completed_date, delayed_routing, item_id, recipient_routing, status, triggered_date, trigger_on_item, workflow_step_id].hash
146
158
  end
147
159
 
148
160
  # Builds the object from hash
@@ -17,18 +17,22 @@ module DocuSign_eSign
17
17
  #
18
18
  attr_accessor :billable_account_id
19
19
 
20
+ #
20
21
  attr_accessor :caller_information
21
22
 
22
23
  #
23
24
  attr_accessor :created
24
25
 
26
+ # Details about the user who created the workspace.
25
27
  attr_accessor :created_by_information
26
28
 
27
29
  # Utc date and time the comment was last updated (can only be done by creator.)
28
30
  attr_accessor :last_modified
29
31
 
32
+ # Details about the user who last modified the workspace.
30
33
  attr_accessor :last_modified_by_information
31
34
 
35
+ # Information about the settings for the workspace.
32
36
  attr_accessor :settings
33
37
 
34
38
  # 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.
@@ -17,6 +17,7 @@ module DocuSign_eSign
17
17
  # The last position in the result set.
18
18
  attr_accessor :end_position
19
19
 
20
+ # The folder from which to return items. You can enter either the folder name or folder ID.
20
21
  attr_accessor :folder
21
22
 
22
23
  #
@@ -14,6 +14,7 @@ require 'date'
14
14
  module DocuSign_eSign
15
15
  # A workspaceItem (file type only) representing the file. This property is only returned in response to file specific GET call.
16
16
  class WorkspaceItem
17
+ #
17
18
  attr_accessor :caller_authorization
18
19
 
19
20
  #
@@ -25,6 +26,7 @@ module DocuSign_eSign
25
26
  #
26
27
  attr_accessor :created_by_id
27
28
 
29
+ # Details about the user who created the workspace item.
28
30
  attr_accessor :created_by_information
29
31
 
30
32
  #
@@ -48,6 +50,7 @@ module DocuSign_eSign
48
50
  # Utc date and time the comment was last updated (can only be done by creator)
49
51
  attr_accessor :last_modified_by_id
50
52
 
53
+ # Details about the user who last modified the workspace item.
51
54
  attr_accessor :last_modified_by_information
52
55
 
53
56
  # A simple string description of the item, such as a file name or a folder name.
@@ -68,6 +71,7 @@ module DocuSign_eSign
68
71
  #
69
72
  attr_accessor :thumb_height
70
73
 
74
+ #
71
75
  attr_accessor :thumbnail
72
76
 
73
77
  #
@@ -79,6 +83,7 @@ module DocuSign_eSign
79
83
  #
80
84
  attr_accessor :uri
81
85
 
86
+ #
82
87
  attr_accessor :user_authorization
83
88
 
84
89
  # 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 provides information about the settings for the workspace.
15
16
  class WorkspaceSettings
16
17
  #
17
18
  attr_accessor :comments_allowed
@@ -32,6 +32,7 @@ module DocuSign_eSign
32
32
  #
33
33
  attr_accessor :email
34
34
 
35
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
35
36
  attr_accessor :error_details
36
37
 
37
38
  #
@@ -32,6 +32,7 @@ module DocuSign_eSign
32
32
  #
33
33
  attr_accessor :created_by_id
34
34
 
35
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
35
36
  attr_accessor :error_details
36
37
 
37
38
  #
@@ -43,6 +44,7 @@ module DocuSign_eSign
43
44
  #
44
45
  attr_accessor :workspace_user_id
45
46
 
47
+ # An object that provides details about the workspace user.
46
48
  attr_accessor :workspace_user_information
47
49
 
48
50
  # Attribute mapping from ruby-style variable name to JSON key.