docusign_esign 3.18.0 → 3.20.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (309) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/lib/docusign_esign/api/accounts_api.rb +64 -64
  4. data/lib/docusign_esign/api/billing_api.rb +2 -2
  5. data/lib/docusign_esign/api/bulk_envelopes_api.rb +22 -22
  6. data/lib/docusign_esign/api/connect_api.rb +148 -0
  7. data/lib/docusign_esign/api/email_archive_api.rb +8 -8
  8. data/lib/docusign_esign/api/envelopes_api.rb +1226 -104
  9. data/lib/docusign_esign/api/notary_api.rb +16 -16
  10. data/lib/docusign_esign/api/power_forms_api.rb +16 -16
  11. data/lib/docusign_esign/api/templates_api.rb +20 -20
  12. data/lib/docusign_esign/api/users_api.rb +14 -14
  13. data/lib/docusign_esign/api/workspaces_api.rb +4 -4
  14. data/lib/docusign_esign/client/api_client.rb +1 -1
  15. data/lib/docusign_esign/models/access_code_format.rb +6 -0
  16. data/lib/docusign_esign/models/account_billing_plan.rb +1 -0
  17. data/lib/docusign_esign/models/account_billing_plan_response.rb +9 -0
  18. data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
  19. data/lib/docusign_esign/models/account_identity_verification_workflow.rb +13 -1
  20. data/lib/docusign_esign/models/account_information.rb +1 -0
  21. data/lib/docusign_esign/models/account_notification.rb +3 -0
  22. data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
  23. data/lib/docusign_esign/models/account_password_rules.rb +7 -0
  24. data/lib/docusign_esign/models/account_role_settings.rb +39 -0
  25. data/lib/docusign_esign/models/account_settings_information.rb +748 -5
  26. data/lib/docusign_esign/models/account_shared_access.rb +1 -0
  27. data/lib/docusign_esign/models/account_signature.rb +2 -0
  28. data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
  29. data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
  30. data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
  31. data/lib/docusign_esign/models/account_ui_settings.rb +35 -1
  32. data/lib/docusign_esign/models/address_information_input.rb +1 -0
  33. data/lib/docusign_esign/models/agent.rb +22 -0
  34. data/lib/docusign_esign/models/approve.rb +45 -0
  35. data/lib/docusign_esign/models/authentication_status.rb +19 -0
  36. data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
  37. data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
  38. data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
  39. data/lib/docusign_esign/models/billing_plan_information.rb +19 -1
  40. data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
  41. data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
  42. data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
  43. data/lib/docusign_esign/models/brand.rb +4 -0
  44. data/lib/docusign_esign/models/brand_email_content.rb +1 -0
  45. data/lib/docusign_esign/models/brand_link.rb +1 -0
  46. data/lib/docusign_esign/models/brand_logos.rb +1 -0
  47. data/lib/docusign_esign/models/brand_request.rb +1 -0
  48. data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
  49. data/lib/docusign_esign/models/brand_resources.rb +3 -0
  50. data/lib/docusign_esign/models/brands_request.rb +1 -0
  51. data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
  52. data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
  53. data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +1 -0
  54. data/lib/docusign_esign/models/bulk_send_batch_status.rb +2 -0
  55. data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +1 -0
  56. data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
  57. data/lib/docusign_esign/models/bulk_send_error_status.rb +1 -0
  58. data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
  59. data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
  60. data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
  61. data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
  62. data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
  63. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
  64. data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
  65. data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
  66. data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
  67. data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
  68. data/lib/docusign_esign/models/captive_recipient.rb +2 -0
  69. data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
  70. data/lib/docusign_esign/models/carbon_copy.rb +25 -0
  71. data/lib/docusign_esign/models/certified_delivery.rb +24 -0
  72. data/lib/docusign_esign/models/checkbox.rb +52 -39
  73. data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
  74. data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
  75. data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
  76. data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
  77. data/lib/docusign_esign/models/comment_thread.rb +43 -0
  78. data/lib/docusign_esign/models/commission_county.rb +52 -0
  79. data/lib/docusign_esign/models/commission_expiration.rb +52 -0
  80. data/lib/docusign_esign/models/commission_number.rb +52 -0
  81. data/lib/docusign_esign/models/commission_state.rb +52 -0
  82. data/lib/docusign_esign/models/company.rb +52 -0
  83. data/lib/docusign_esign/models/composite_template.rb +2 -0
  84. data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
  85. data/lib/docusign_esign/models/connect_config_results.rb +1 -0
  86. data/lib/docusign_esign/models/connect_custom_configuration.rb +13 -1
  87. data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
  88. data/lib/docusign_esign/models/connect_event_data.rb +1 -0
  89. data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
  90. data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
  91. data/lib/docusign_esign/models/connect_log.rb +1 -0
  92. data/lib/docusign_esign/models/connect_o_auth_config.rb +224 -0
  93. data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
  94. data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
  95. data/lib/docusign_esign/models/console_view_request.rb +1 -0
  96. data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
  97. data/lib/docusign_esign/models/contact.rb +1 -0
  98. data/lib/docusign_esign/models/contact_get_response.rb +1 -0
  99. data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
  100. data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
  101. data/lib/docusign_esign/models/contact_update_response.rb +1 -0
  102. data/lib/docusign_esign/models/correct_view_request.rb +12 -1
  103. data/lib/docusign_esign/models/credit_card_information.rb +2 -0
  104. data/lib/docusign_esign/models/currency.rb +55 -0
  105. data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
  106. data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
  107. data/lib/docusign_esign/models/custom_field.rb +2 -0
  108. data/lib/docusign_esign/models/date.rb +59 -0
  109. data/lib/docusign_esign/models/date_signed.rb +46 -0
  110. data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
  111. data/lib/docusign_esign/models/decline.rb +46 -0
  112. data/lib/docusign_esign/models/delayed_routing.rb +3 -3
  113. data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
  114. data/lib/docusign_esign/models/doc_gen_form_field.rb +224 -0
  115. data/lib/docusign_esign/models/doc_gen_syntax_error.rb +204 -0
  116. data/lib/docusign_esign/models/document.rb +26 -1
  117. data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
  118. data/lib/docusign_esign/models/document_html_definition.rb +1 -0
  119. data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
  120. data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
  121. data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
  122. data/lib/docusign_esign/models/document_template.rb +1 -0
  123. data/lib/docusign_esign/models/document_visibility.rb +2 -0
  124. data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
  125. data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
  126. data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
  127. data/lib/docusign_esign/models/draw.rb +40 -0
  128. data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
  129. data/lib/docusign_esign/models/editor.rb +23 -0
  130. data/lib/docusign_esign/models/email.rb +59 -0
  131. data/lib/docusign_esign/models/email_address.rb +46 -0
  132. data/lib/docusign_esign/models/envelope.rb +10 -0
  133. data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
  134. data/lib/docusign_esign/models/envelope_definition.rb +13 -0
  135. data/lib/docusign_esign/models/envelope_delay_rule.rb +3 -2
  136. data/lib/docusign_esign/models/envelope_document.rb +52 -1
  137. data/lib/docusign_esign/models/envelope_event.rb +1 -0
  138. data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
  139. data/lib/docusign_esign/models/envelope_id.rb +45 -0
  140. data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
  141. data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
  142. data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
  143. data/lib/docusign_esign/models/envelope_summary.rb +3 -0
  144. data/lib/docusign_esign/models/envelope_template.rb +23 -1
  145. data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
  146. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
  147. data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
  148. data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
  149. data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
  150. data/lib/docusign_esign/models/envelopes_information.rb +1 -0
  151. data/lib/docusign_esign/models/event_notification.rb +12 -1
  152. data/lib/docusign_esign/models/event_result.rb +1 -0
  153. data/lib/docusign_esign/models/external_document_sources.rb +6 -0
  154. data/lib/docusign_esign/models/external_file.rb +1 -0
  155. data/lib/docusign_esign/models/external_folder.rb +1 -0
  156. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
  157. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
  158. data/lib/docusign_esign/models/feature_set.rb +1 -0
  159. data/lib/docusign_esign/models/filter.rb +1 -0
  160. data/lib/docusign_esign/models/first_name.rb +46 -0
  161. data/lib/docusign_esign/models/folder.rb +4 -0
  162. data/lib/docusign_esign/models/folder_item_response.rb +1 -0
  163. data/lib/docusign_esign/models/folder_item_v2.rb +2 -0
  164. data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
  165. data/lib/docusign_esign/models/folders_request.rb +1 -0
  166. data/lib/docusign_esign/models/form_data_item.rb +1 -0
  167. data/lib/docusign_esign/models/formula_tab.rb +64 -0
  168. data/lib/docusign_esign/models/full_name.rb +46 -0
  169. data/lib/docusign_esign/models/group.rb +2 -0
  170. data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
  171. data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
  172. data/lib/docusign_esign/models/in_person_signer.rb +31 -0
  173. data/lib/docusign_esign/models/initial_here.rb +41 -1
  174. data/lib/docusign_esign/models/inline_template.rb +3 -0
  175. data/lib/docusign_esign/models/intermediary.rb +23 -0
  176. data/lib/docusign_esign/models/jurisdiction.rb +1 -0
  177. data/lib/docusign_esign/models/last_name.rb +46 -0
  178. data/lib/docusign_esign/models/linked_external_primary_account.rb +1 -0
  179. data/lib/docusign_esign/models/list.rb +54 -0
  180. data/lib/docusign_esign/models/list_custom_field.rb +2 -0
  181. data/lib/docusign_esign/models/list_item.rb +4 -0
  182. data/lib/docusign_esign/models/locale_policy.rb +13 -0
  183. data/lib/docusign_esign/models/lock_information.rb +2 -0
  184. data/lib/docusign_esign/models/lock_request.rb +1 -0
  185. data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
  186. data/lib/docusign_esign/models/member_shared_items.rb +3 -0
  187. data/lib/docusign_esign/models/merge_field.rb +6 -0
  188. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
  189. data/lib/docusign_esign/models/money.rb +1 -0
  190. data/lib/docusign_esign/models/name_value.rb +2 -0
  191. data/lib/docusign_esign/models/new_account_definition.rb +20 -1
  192. data/lib/docusign_esign/models/new_account_summary.rb +1 -0
  193. data/lib/docusign_esign/models/new_user.rb +2 -0
  194. data/lib/docusign_esign/models/new_users_summary.rb +1 -0
  195. data/lib/docusign_esign/models/notarize.rb +38 -0
  196. data/lib/docusign_esign/models/notary.rb +1 -0
  197. data/lib/docusign_esign/models/notary_host.rb +20 -0
  198. data/lib/docusign_esign/models/notary_journal.rb +2 -0
  199. data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
  200. data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
  201. data/lib/docusign_esign/models/notary_recipient.rb +29 -0
  202. data/lib/docusign_esign/models/notary_result.rb +2 -0
  203. data/lib/docusign_esign/models/notary_seal.rb +39 -0
  204. data/lib/docusign_esign/models/note.rb +47 -0
  205. data/lib/docusign_esign/models/notification.rb +2 -0
  206. data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
  207. data/lib/docusign_esign/models/notification_defaults.rb +2 -0
  208. data/lib/docusign_esign/models/number.rb +61 -0
  209. data/lib/docusign_esign/models/page.rb +1 -0
  210. data/lib/docusign_esign/models/payment_details.rb +5 -0
  211. data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
  212. data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
  213. data/lib/docusign_esign/models/payment_line_item.rb +1 -0
  214. data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
  215. data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
  216. data/lib/docusign_esign/models/permission_profile.rb +2 -0
  217. data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
  218. data/lib/docusign_esign/models/phone_number.rb +52 -0
  219. data/lib/docusign_esign/models/poly_line_overlay.rb +40 -0
  220. data/lib/docusign_esign/models/power_form.rb +2 -0
  221. data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
  222. data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
  223. data/lib/docusign_esign/models/power_forms_response.rb +1 -0
  224. data/lib/docusign_esign/models/prefill_tabs.rb +1 -0
  225. data/lib/docusign_esign/models/property_metadata.rb +1 -0
  226. data/lib/docusign_esign/models/radio.rb +28 -0
  227. data/lib/docusign_esign/models/radio_group.rb +17 -0
  228. data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
  229. data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
  230. data/lib/docusign_esign/models/recipient_group.rb +1 -0
  231. data/lib/docusign_esign/models/recipient_identity_phone_number.rb +3 -0
  232. data/lib/docusign_esign/models/recipient_identity_verification.rb +2 -0
  233. data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
  234. data/lib/docusign_esign/models/recipient_option.rb +1 -0
  235. data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
  236. data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
  237. data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
  238. data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
  239. data/lib/docusign_esign/models/recipient_routing.rb +2 -0
  240. data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
  241. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
  242. data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
  243. data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +30 -30
  244. data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
  245. data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
  246. data/lib/docusign_esign/models/recipients.rb +1 -0
  247. data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
  248. data/lib/docusign_esign/models/return_url_request.rb +1 -0
  249. data/lib/docusign_esign/models/scheduled_sending.rb +3 -3
  250. data/lib/docusign_esign/models/seal_sign.rb +17 -0
  251. data/lib/docusign_esign/models/seat_discount.rb +1 -0
  252. data/lib/docusign_esign/models/sender_company.rb +45 -0
  253. data/lib/docusign_esign/models/sender_email_notifications.rb +1 -0
  254. data/lib/docusign_esign/models/sender_name.rb +45 -0
  255. data/lib/docusign_esign/models/settings_metadata.rb +1 -0
  256. data/lib/docusign_esign/models/shared_item.rb +3 -0
  257. data/lib/docusign_esign/models/sign_here.rb +42 -0
  258. data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
  259. data/lib/docusign_esign/models/signature_type.rb +1 -0
  260. data/lib/docusign_esign/models/signer.rb +30 -0
  261. data/lib/docusign_esign/models/signer_attachment.rb +40 -0
  262. data/lib/docusign_esign/models/signing_group.rb +2 -0
  263. data/lib/docusign_esign/models/signing_group_user.rb +1 -0
  264. data/lib/docusign_esign/models/smart_section.rb +41 -0
  265. data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
  266. data/lib/docusign_esign/models/social_account_information.rb +1 -0
  267. data/lib/docusign_esign/models/ssn.rb +59 -0
  268. data/lib/docusign_esign/models/stamp.rb +2 -0
  269. data/lib/docusign_esign/models/supported_languages.rb +1 -0
  270. data/lib/docusign_esign/models/tab_account_settings.rb +22 -0
  271. data/lib/docusign_esign/models/tab_group.rb +41 -0
  272. data/lib/docusign_esign/models/tab_metadata.rb +14 -1
  273. data/lib/docusign_esign/models/tabs.rb +2 -0
  274. data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
  275. data/lib/docusign_esign/models/template_notification_request.rb +2 -0
  276. data/lib/docusign_esign/models/template_recipients.rb +1 -0
  277. data/lib/docusign_esign/models/template_role.rb +4 -0
  278. data/lib/docusign_esign/models/template_shared_item.rb +3 -0
  279. data/lib/docusign_esign/models/template_summary.rb +3 -0
  280. data/lib/docusign_esign/models/template_tabs.rb +1 -0
  281. data/lib/docusign_esign/models/template_update_summary.rb +4 -0
  282. data/lib/docusign_esign/models/text.rb +61 -0
  283. data/lib/docusign_esign/models/text_custom_field.rb +2 -0
  284. data/lib/docusign_esign/models/title.rb +52 -0
  285. data/lib/docusign_esign/models/user_account_management_granular_information.rb +12 -0
  286. data/lib/docusign_esign/models/user_info.rb +1 -0
  287. data/lib/docusign_esign/models/user_information.rb +6 -0
  288. data/lib/docusign_esign/models/user_information_list.rb +1 -0
  289. data/lib/docusign_esign/models/user_password_information.rb +1 -0
  290. data/lib/docusign_esign/models/user_password_rules.rb +2 -0
  291. data/lib/docusign_esign/models/user_profile.rb +3 -0
  292. data/lib/docusign_esign/models/user_settings_information.rb +61 -0
  293. data/lib/docusign_esign/models/user_shared_item.rb +3 -0
  294. data/lib/docusign_esign/models/user_signature.rb +2 -0
  295. data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
  296. data/lib/docusign_esign/models/view.rb +46 -0
  297. data/lib/docusign_esign/models/witness.rb +30 -0
  298. data/lib/docusign_esign/models/workflow.rb +2 -0
  299. data/lib/docusign_esign/models/workflow_step.rb +3 -0
  300. data/lib/docusign_esign/models/workspace.rb +4 -0
  301. data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
  302. data/lib/docusign_esign/models/workspace_item.rb +5 -0
  303. data/lib/docusign_esign/models/workspace_settings.rb +1 -0
  304. data/lib/docusign_esign/models/workspace_user.rb +1 -0
  305. data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
  306. data/lib/docusign_esign/models/zip.rb +60 -0
  307. data/lib/docusign_esign/version.rb +1 -1
  308. data/lib/docusign_esign.rb +3 -0
  309. metadata +9 -6
@@ -14,42 +14,61 @@ require 'date'
14
14
  module DocuSign_eSign
15
15
  # Contains information about the authentication status.
16
16
  class AuthenticationStatus
17
+ # The result of a user's attempt to authenticate by using an access code. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
17
18
  attr_accessor :access_code_result
18
19
 
20
+ # The result of an age verification check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
19
21
  attr_accessor :age_verify_result
20
22
 
23
+ # Deprecated.
21
24
  attr_accessor :any_social_id_result
22
25
 
26
+ # Deprecated.
23
27
  attr_accessor :facebook_result
24
28
 
29
+ # Deprecated.
25
30
  attr_accessor :google_result
26
31
 
32
+ # The result of an [Identity Verification][IDV] workflow. [IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/
27
33
  attr_accessor :identity_verification_result
28
34
 
35
+ # The result of an ID lookup authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
29
36
  attr_accessor :id_lookup_result
30
37
 
38
+ # The result of the user's answers to ID challenge questions. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
31
39
  attr_accessor :id_questions_result
32
40
 
41
+ # Deprecated.
33
42
  attr_accessor :linkedin_result
34
43
 
44
+ # Deprecated.
35
45
  attr_accessor :live_id_result
36
46
 
47
+ # The result of an Office of Foreign Asset Control (OFAC) check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
37
48
  attr_accessor :ofac_result
38
49
 
50
+ # Deprecated.
39
51
  attr_accessor :open_id_result
40
52
 
53
+ # The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
41
54
  attr_accessor :phone_auth_result
42
55
 
56
+ # Success/failure result of authentication using sign-in with a Salesforce account. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
43
57
  attr_accessor :salesforce_result
44
58
 
59
+ # The result of the user's attempt to authenticate by using a signature provider.
45
60
  attr_accessor :signature_provider_result
46
61
 
62
+ # The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone.
47
63
  attr_accessor :sms_auth_result
48
64
 
65
+ # The result of a Student Authentication Network (STAN) authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
49
66
  attr_accessor :s_tan_pin_result
50
67
 
68
+ # Deprecated.
51
69
  attr_accessor :twitter_result
52
70
 
71
+ # Deprecated.
53
72
  attr_accessor :yahoo_result
54
73
 
55
74
  # 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 abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails).
15
16
  class BccEmailArchive
16
17
  # The account ID associated with the envelope.
17
18
  attr_accessor :account_id
@@ -22,6 +23,7 @@ module DocuSign_eSign
22
23
  #
23
24
  attr_accessor :created
24
25
 
26
+ # Details about the user who created the BCC email archive configuration.
25
27
  attr_accessor :created_by
26
28
 
27
29
  #
@@ -33,6 +35,7 @@ module DocuSign_eSign
33
35
  #
34
36
  attr_accessor :modified
35
37
 
38
+ # Details about the user who last modified the BCC email archive configuration.
36
39
  attr_accessor :modified_by
37
40
 
38
41
  # 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
+ # Contains details about the history of the BCC email archive configuration.
15
16
  class BccEmailArchiveHistory
16
17
  # The account ID associated with the envelope.
17
18
  attr_accessor :account_id
@@ -25,6 +26,7 @@ module DocuSign_eSign
25
26
  #
26
27
  attr_accessor :modified
27
28
 
29
+ # Details about the user who last modified the BCC email archive configuration.
28
30
  attr_accessor :modified_by
29
31
 
30
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.
@@ -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 a list of BCC email archive configurations.
15
16
  class BccEmailArchiveList
16
17
  #
17
18
  attr_accessor :bcc_email_archives
@@ -12,13 +12,18 @@ 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 a billing plan.
15
16
  class BillingPlanInformation
17
+ #
16
18
  attr_accessor :app_store_receipt
17
19
 
20
+ # The billing address for the account.
18
21
  attr_accessor :billing_address
19
22
 
23
+ # A complex type that has information about the credit card used to pay for this account.
20
24
  attr_accessor :credit_card_information
21
25
 
26
+ # Information about the bank that processes direct debits for the payment plan.
22
27
  attr_accessor :direct_debit_processor_information
23
28
 
24
29
  #
@@ -39,13 +44,19 @@ module DocuSign_eSign
39
44
  #
40
45
  attr_accessor :payment_method
41
46
 
47
+ #
48
+ attr_accessor :payment_processor
49
+
50
+ # Information about the entity that processes payments for the billing plan.
42
51
  attr_accessor :payment_processor_information
43
52
 
53
+ # An object used to identify the features and attributes of the account being created.
44
54
  attr_accessor :plan_information
45
55
 
46
56
  #
47
57
  attr_accessor :process_payment
48
58
 
59
+ # A complex type that contains properties for entering referral and discount information.
49
60
  attr_accessor :referral_information
50
61
 
51
62
  #
@@ -82,6 +93,7 @@ module DocuSign_eSign
82
93
  :'included_seats' => :'includedSeats',
83
94
  :'incremental_seats' => :'incrementalSeats',
84
95
  :'payment_method' => :'paymentMethod',
96
+ :'payment_processor' => :'paymentProcessor',
85
97
  :'payment_processor_information' => :'paymentProcessorInformation',
86
98
  :'plan_information' => :'planInformation',
87
99
  :'process_payment' => :'processPayment',
@@ -109,6 +121,7 @@ module DocuSign_eSign
109
121
  :'included_seats' => :'String',
110
122
  :'incremental_seats' => :'String',
111
123
  :'payment_method' => :'String',
124
+ :'payment_processor' => :'String',
112
125
  :'payment_processor_information' => :'PaymentProcessorInformation',
113
126
  :'plan_information' => :'PlanInformation',
114
127
  :'process_payment' => :'String',
@@ -171,6 +184,10 @@ module DocuSign_eSign
171
184
  self.payment_method = attributes[:'paymentMethod']
172
185
  end
173
186
 
187
+ if attributes.has_key?(:'paymentProcessor')
188
+ self.payment_processor = attributes[:'paymentProcessor']
189
+ end
190
+
174
191
  if attributes.has_key?(:'paymentProcessorInformation')
175
192
  self.payment_processor_information = attributes[:'paymentProcessorInformation']
176
193
  end
@@ -244,6 +261,7 @@ module DocuSign_eSign
244
261
  included_seats == o.included_seats &&
245
262
  incremental_seats == o.incremental_seats &&
246
263
  payment_method == o.payment_method &&
264
+ payment_processor == o.payment_processor &&
247
265
  payment_processor_information == o.payment_processor_information &&
248
266
  plan_information == o.plan_information &&
249
267
  process_payment == o.process_payment &&
@@ -266,7 +284,7 @@ module DocuSign_eSign
266
284
  # Calculates hash code according to all attributes.
267
285
  # @return [Fixnum] Hash code
268
286
  def hash
269
- [app_store_receipt, billing_address, credit_card_information, direct_debit_processor_information, downgrade_reason, enable_pre_auth, enable_support, included_seats, incremental_seats, payment_method, payment_processor_information, plan_information, process_payment, referral_information, renewal_status, sale_discount_amount, sale_discount_fixed_amount, sale_discount_percent, sale_discount_periods, sale_discount_seat_price_override, tax_exempt_id].hash
287
+ [app_store_receipt, billing_address, credit_card_information, direct_debit_processor_information, downgrade_reason, enable_pre_auth, enable_support, included_seats, incremental_seats, payment_method, payment_processor, payment_processor_information, plan_information, process_payment, referral_information, renewal_status, sale_discount_amount, sale_discount_fixed_amount, sale_discount_percent, sale_discount_periods, sale_discount_seat_price_override, tax_exempt_id].hash
270
288
  end
271
289
 
272
290
  # Builds the object from hash
@@ -17,6 +17,7 @@ module DocuSign_eSign
17
17
  # Specifies the ISO currency code for the account.
18
18
  attr_accessor :currency_code
19
19
 
20
+ #
20
21
  attr_accessor :invoice
21
22
 
22
23
  #
@@ -14,6 +14,7 @@ require 'date'
14
14
  module DocuSign_eSign
15
15
  # Defines a billing plan response object.
16
16
  class BillingPlanResponse
17
+ # An object that contains details about the billing plan.
17
18
  attr_accessor :billing_plan
18
19
 
19
20
  #
@@ -17,6 +17,7 @@ module DocuSign_eSign
17
17
  #
18
18
  attr_accessor :account_payment_method
19
19
 
20
+ #
20
21
  attr_accessor :billing_plan_preview
21
22
 
22
23
  # Specifies the ISO currency code for the account.
@@ -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 a brand that is associated with an account. A brand applies custom styles and text to an envelope.
15
16
  class Brand
16
17
  # The name of the company associated with this brand.
17
18
  attr_accessor :brand_company
@@ -34,6 +35,7 @@ module DocuSign_eSign
34
35
  #
35
36
  attr_accessor :email_content
36
37
 
38
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
37
39
  attr_accessor :error_details
38
40
 
39
41
  #
@@ -51,8 +53,10 @@ module DocuSign_eSign
51
53
  #
52
54
  attr_accessor :links
53
55
 
56
+ # The URIs for retrieving the logos that are associated with the brand.
54
57
  attr_accessor :logos
55
58
 
59
+ # An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience. **Note:** This object is returned only when the `resourceContentType` is `sending`, `signing`, `email`, or `signing_captive`.
56
60
  attr_accessor :resources
57
61
 
58
62
  # 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
+ # Deprecated.
15
16
  class BrandEmailContent
16
17
  #
17
18
  attr_accessor :content
@@ -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 a link that a brand uses.
15
16
  class BrandLink
16
17
  #
17
18
  attr_accessor :link_text
@@ -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
+ # The URIs for retrieving the logos that are associated with the brand. These are read-only properties that provide a URI to logos in use. To update a logo use [AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/).
15
16
  class BrandLogos
16
17
  #
17
18
  attr_accessor :email
@@ -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 request object contains information about a specific brand.
15
16
  class BrandRequest
16
17
  # The ID of the brand used in API calls
17
18
  attr_accessor :brand_id
@@ -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
+ # Brands use resource files to style the following experiences: - Email - Sending - Signing - Captive (embedded) signing You can modify these resource files to customize these experiences.
15
16
  class BrandResourceUrls
16
17
  #
17
18
  attr_accessor :email
@@ -12,7 +12,9 @@ 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 resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.
15
16
  class BrandResources
17
+ # The user ID of the user who created the brand resource.
16
18
  attr_accessor :created_by_user_info
17
19
 
18
20
  #
@@ -21,6 +23,7 @@ module DocuSign_eSign
21
23
  #
22
24
  attr_accessor :data_not_saved_not_in_master
23
25
 
26
+ # Information about the user who last modified the brand resource.
24
27
  attr_accessor :modified_by_user_info
25
28
 
26
29
  #
@@ -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
+ # Details about one or more brands.
15
16
  class BrandsRequest
16
17
  # The list of brands.
17
18
  attr_accessor :brands
@@ -28,6 +28,7 @@ module DocuSign_eSign
28
28
  # Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
29
29
  attr_accessor :envelope_uri
30
30
 
31
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
31
32
  attr_accessor :error_details
32
33
 
33
34
  #
@@ -13,6 +13,7 @@ require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
15
  class BulkRecipientsUpdateResponse
16
+ #
16
17
  attr_accessor :signer
17
18
 
18
19
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -16,6 +16,7 @@ module DocuSign_eSign
16
16
  #
17
17
  attr_accessor :action
18
18
 
19
+ #
19
20
  attr_accessor :notification
20
21
 
21
22
  #
@@ -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 of `getBulkSendBatchStatus`
15
16
  class BulkSendBatchStatus
16
17
  #
17
18
  attr_accessor :action
@@ -34,6 +35,7 @@ module DocuSign_eSign
34
35
  #
35
36
  attr_accessor :envelope_id_or_template_id
36
37
 
38
+ #
37
39
  attr_accessor :envelopes_info
38
40
 
39
41
  #
@@ -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
+ # A list of bulk send batch summaries.
15
16
  class BulkSendBatchSummaries
16
17
  #
17
18
  attr_accessor :batch_size_limit
@@ -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
+ # Summary status of a single batch.
15
16
  class BulkSendBatchSummary
16
17
  #
17
18
  attr_accessor :batch_id
@@ -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
+ # A single bulk send error report.
15
16
  class BulkSendErrorStatus
16
17
  #
17
18
  attr_accessor :created
@@ -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 the envelope or template that you want to send in bulk.
15
16
  class BulkSendRequest
16
17
  #
17
18
  attr_accessor :batch_name
@@ -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
+ # The object contains the response to a bulk send request.
15
16
  class BulkSendResponse
16
17
  #
17
18
  attr_accessor :batch_id
@@ -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 the results of a bulk send test.
15
16
  class BulkSendTestResponse
16
17
  #
17
18
  attr_accessor :can_be_sent
@@ -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 the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.
15
16
  class BulkSendingCopy
16
17
  # An optional array of strings that allows 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.
17
18
  attr_accessor :custom_fields
@@ -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 a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send.
15
16
  class BulkSendingCopyCustomField
16
17
  #
17
18
  attr_accessor :name
@@ -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 a bulk send recipient.
15
16
  class BulkSendingCopyRecipient
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
@@ -28,6 +29,7 @@ module DocuSign_eSign
28
29
  #
29
30
  attr_accessor :email
30
31
 
32
+ # 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`.
31
33
  attr_accessor :email_notification
32
34
 
33
35
  # 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]]`
@@ -45,6 +47,7 @@ module DocuSign_eSign
45
47
  # 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.
46
48
  attr_accessor :id_check_configuration_name
47
49
 
50
+ # An object that contains input information related to a recipient ID check.
48
51
  attr_accessor :id_check_information_input
49
52
 
50
53
  #
@@ -56,6 +59,7 @@ module DocuSign_eSign
56
59
  # 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.
57
60
  attr_accessor :note
58
61
 
62
+ # 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.
59
63
  attr_accessor :phone_authentication
60
64
 
61
65
  # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
@@ -73,6 +77,7 @@ module DocuSign_eSign
73
77
  # 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).
74
78
  attr_accessor :signing_group_id
75
79
 
80
+ # 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.
76
81
  attr_accessor :sms_authentication
77
82
 
78
83
  # Lists the social ID type that can be used for recipient authentication.
@@ -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
+ # A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same. For example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.
15
16
  class BulkSendingCopyTab
16
17
  # The original value of the tab.
17
18
  attr_accessor :initial_value
@@ -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 the details for the bulk send list.
15
16
  class BulkSendingList
16
17
  #
17
18
  attr_accessor :bulk_copies
@@ -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 complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.
15
16
  class BulkSendingListSummaries
16
17
  #
17
18
  attr_accessor :bulk_list_summaries
@@ -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 basic information about a bulk send list.
15
16
  class BulkSendingListSummary
16
17
  #
17
18
  attr_accessor :bulk_send_list_id
@@ -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 a captive (embedded) recipient.
15
16
  class CaptiveRecipient
16
17
  # Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters.
17
18
  attr_accessor :client_user_id
@@ -19,6 +20,7 @@ module DocuSign_eSign
19
20
  # Specifies the email address associated with the captive recipient.
20
21
  attr_accessor :email
21
22
 
23
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
22
24
  attr_accessor :error_details
23
25
 
24
26
  # Specifies the user name associated with the captive recipient.
@@ -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 captive (embedded) recipients.
15
16
  class CaptiveRecipientInformation
16
17
  # A complex type containing information about one or more captive recipients.
17
18
  attr_accessor :captive_recipients