docusign_esign 2.13.0.rc1 → 3.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (468) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +0 -66
  3. data/Gemfile +1 -1
  4. data/Gemfile.lock +73 -0
  5. data/README.md +40 -22
  6. data/docusign_esign-3.0.0.gem +0 -0
  7. data/docusign_esign.gemspec +1 -2
  8. data/lib/docusign_esign/api/accounts_api.rb +427 -89
  9. data/lib/docusign_esign/api/authentication_api.rb +1 -1
  10. data/lib/docusign_esign/api/billing_api.rb +16 -20
  11. data/lib/docusign_esign/api/bulk_envelopes_api.rb +195 -155
  12. data/lib/docusign_esign/api/cloud_storage_api.rb +13 -9
  13. data/lib/docusign_esign/api/connect_api.rb +16 -167
  14. data/lib/docusign_esign/api/custom_tabs_api.rb +7 -7
  15. data/lib/docusign_esign/api/data_feed_api.rb +76 -0
  16. data/lib/docusign_esign/api/diagnostics_api.rb +8 -8
  17. data/lib/docusign_esign/api/email_archive_api.rb +261 -0
  18. data/lib/docusign_esign/api/envelopes_api.rb +1694 -377
  19. data/lib/docusign_esign/api/folders_api.rb +20 -11
  20. data/lib/docusign_esign/api/groups_api.rb +25 -21
  21. data/lib/docusign_esign/api/notary_api.rb +3 -3
  22. data/lib/docusign_esign/api/power_forms_api.rb +10 -10
  23. data/lib/docusign_esign/api/signing_groups_api.rb +11 -11
  24. data/lib/docusign_esign/api/templates_api.rb +323 -79
  25. data/lib/docusign_esign/api/trust_service_providers_api.rb +3 -3
  26. data/lib/docusign_esign/api/users_api.rb +66 -38
  27. data/lib/docusign_esign/api/workspaces_api.rb +13 -13
  28. data/lib/docusign_esign/client/api_client.rb +2 -3
  29. data/lib/docusign_esign/configuration.rb +3 -4
  30. data/lib/docusign_esign/models/access_code_format.rb +273 -0
  31. data/lib/docusign_esign/models/account_address.rb +11 -8
  32. data/lib/docusign_esign/models/account_billing_plan.rb +12 -59
  33. data/lib/docusign_esign/models/account_billing_plan_response.rb +31 -9
  34. data/lib/docusign_esign/models/account_identity_verification_response.rb +12 -8
  35. data/lib/docusign_esign/models/account_identity_verification_step.rb +12 -8
  36. data/lib/docusign_esign/models/account_identity_verification_workflow.rb +45 -12
  37. data/lib/docusign_esign/models/account_information.rb +45 -19
  38. data/lib/docusign_esign/models/account_minimum_password_length.rb +12 -8
  39. data/lib/docusign_esign/models/account_notification.rb +206 -0
  40. data/lib/docusign_esign/models/account_password_expire_password_days.rb +12 -8
  41. data/lib/docusign_esign/models/account_password_lockout_duration_minutes.rb +12 -8
  42. data/lib/docusign_esign/models/account_password_lockout_duration_type.rb +12 -8
  43. data/lib/docusign_esign/models/account_password_minimum_password_age_days.rb +12 -8
  44. data/lib/docusign_esign/models/account_password_questions_required.rb +12 -8
  45. data/lib/docusign_esign/models/account_password_rules.rb +12 -8
  46. data/lib/docusign_esign/models/account_password_strength_type.rb +12 -8
  47. data/lib/docusign_esign/models/account_password_strength_type_option.rb +12 -8
  48. data/lib/docusign_esign/models/account_role_settings.rb +41 -9
  49. data/lib/docusign_esign/models/account_seals.rb +12 -8
  50. data/lib/docusign_esign/models/account_settings_information.rb +4700 -27
  51. data/lib/docusign_esign/models/account_shared_access.rb +11 -8
  52. data/lib/docusign_esign/models/account_signature_provider.rb +12 -8
  53. data/lib/docusign_esign/models/account_signature_provider_option.rb +12 -8
  54. data/lib/docusign_esign/models/account_signature_providers.rb +12 -8
  55. data/lib/docusign_esign/models/account_ui_settings.rb +330 -0
  56. data/lib/docusign_esign/models/add_on.rb +11 -8
  57. data/lib/docusign_esign/models/address_information.rb +44 -51
  58. data/lib/docusign_esign/models/address_information_input.rb +11 -8
  59. data/lib/docusign_esign/models/address_information_v2.rb +11 -7
  60. data/lib/docusign_esign/models/agent.rb +207 -34
  61. data/lib/docusign_esign/models/api_request_log.rb +11 -8
  62. data/lib/docusign_esign/models/api_request_logs_result.rb +11 -8
  63. data/lib/docusign_esign/models/app_store_product.rb +11 -8
  64. data/lib/docusign_esign/models/app_store_receipt.rb +11 -8
  65. data/lib/docusign_esign/models/approve.rb +448 -14
  66. data/lib/docusign_esign/models/attachment.rb +11 -8
  67. data/lib/docusign_esign/models/authentication_method.rb +12 -9
  68. data/lib/docusign_esign/models/authentication_status.rb +11 -8
  69. data/lib/docusign_esign/models/bcc_email_address.rb +11 -8
  70. data/lib/docusign_esign/models/bcc_email_archive.rb +276 -0
  71. data/lib/docusign_esign/models/bcc_email_archive_history.rb +237 -0
  72. data/lib/docusign_esign/models/bcc_email_archive_history_list.rb +250 -0
  73. data/lib/docusign_esign/models/bcc_email_archive_list.rb +250 -0
  74. data/lib/docusign_esign/models/billing_charge.rb +12 -9
  75. data/lib/docusign_esign/models/billing_charge_response.rb +11 -8
  76. data/lib/docusign_esign/models/billing_discount.rb +12 -8
  77. data/lib/docusign_esign/models/billing_invoice.rb +11 -8
  78. data/lib/docusign_esign/models/billing_invoice_item.rb +11 -8
  79. data/lib/docusign_esign/models/billing_invoices_response.rb +11 -8
  80. data/lib/docusign_esign/models/billing_invoices_summary.rb +12 -8
  81. data/lib/docusign_esign/models/billing_payment.rb +11 -8
  82. data/lib/docusign_esign/models/billing_payment_item.rb +11 -8
  83. data/lib/docusign_esign/models/billing_payment_request.rb +12 -8
  84. data/lib/docusign_esign/models/billing_payment_response.rb +11 -8
  85. data/lib/docusign_esign/models/billing_payments_response.rb +11 -8
  86. data/lib/docusign_esign/models/billing_plan.rb +11 -8
  87. data/lib/docusign_esign/models/billing_plan_information.rb +32 -9
  88. data/lib/docusign_esign/models/billing_plan_preview.rb +11 -8
  89. data/lib/docusign_esign/models/billing_plan_response.rb +11 -8
  90. data/lib/docusign_esign/models/billing_plan_update_response.rb +11 -8
  91. data/lib/docusign_esign/models/billing_plans_response.rb +11 -8
  92. data/lib/docusign_esign/models/billing_price.rb +12 -8
  93. data/lib/docusign_esign/models/brand.rb +38 -12
  94. data/lib/docusign_esign/models/brand_email_content.rb +12 -8
  95. data/lib/docusign_esign/models/brand_link.rb +12 -8
  96. data/lib/docusign_esign/models/brand_logos.rb +12 -8
  97. data/lib/docusign_esign/models/brand_request.rb +12 -8
  98. data/lib/docusign_esign/models/brand_resource_urls.rb +12 -8
  99. data/lib/docusign_esign/models/brand_resources.rb +25 -9
  100. data/lib/docusign_esign/models/brand_resources_list.rb +12 -8
  101. data/lib/docusign_esign/models/brands_request.rb +12 -8
  102. data/lib/docusign_esign/models/brands_response.rb +12 -8
  103. data/lib/docusign_esign/models/bulk_envelope.rb +12 -8
  104. data/lib/docusign_esign/models/bulk_envelope_status.rb +12 -8
  105. data/lib/docusign_esign/models/bulk_envelopes_response.rb +12 -8
  106. data/lib/docusign_esign/models/bulk_recipient.rb +12 -8
  107. data/lib/docusign_esign/models/bulk_recipient_signature_provider.rb +12 -8
  108. data/lib/docusign_esign/models/bulk_recipient_tab_label.rb +12 -8
  109. data/lib/docusign_esign/models/bulk_recipients_request.rb +12 -8
  110. data/lib/docusign_esign/models/bulk_recipients_response.rb +12 -8
  111. data/lib/docusign_esign/models/bulk_recipients_summary_response.rb +12 -8
  112. data/lib/docusign_esign/models/bulk_recipients_update_response.rb +12 -8
  113. data/lib/docusign_esign/models/bulk_send_request.rb +188 -0
  114. data/lib/docusign_esign/models/{group_brands.rb → bulk_send_response.rb} +48 -33
  115. data/lib/docusign_esign/models/bulk_send_test_response.rb +212 -0
  116. data/lib/docusign_esign/models/bulk_sending_copy.rb +222 -0
  117. data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +198 -0
  118. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +382 -0
  119. data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +198 -0
  120. data/lib/docusign_esign/models/bulk_sending_list.rb +210 -0
  121. data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +190 -0
  122. data/lib/docusign_esign/models/bulk_sending_list_summary.rb +218 -0
  123. data/lib/docusign_esign/models/captive_recipient.rb +12 -8
  124. data/lib/docusign_esign/models/captive_recipient_information.rb +12 -8
  125. data/lib/docusign_esign/models/carbon_copy.rb +217 -43
  126. data/lib/docusign_esign/models/certified_delivery.rb +208 -43
  127. data/lib/docusign_esign/models/checkbox.rb +562 -12
  128. data/lib/docusign_esign/models/chunked_upload_part.rb +12 -8
  129. data/lib/docusign_esign/models/chunked_upload_request.rb +12 -8
  130. data/lib/docusign_esign/models/chunked_upload_response.rb +12 -8
  131. data/lib/docusign_esign/models/cloud_storage_provider.rb +12 -8
  132. data/lib/docusign_esign/models/cloud_storage_providers.rb +12 -8
  133. data/lib/docusign_esign/models/comment.rb +392 -0
  134. data/lib/docusign_esign/models/{prefill_form_data.rb → comment_history_result.rb} +39 -35
  135. data/lib/docusign_esign/models/comment_publish.rb +244 -0
  136. data/lib/docusign_esign/models/comment_thread.rb +961 -0
  137. data/lib/docusign_esign/models/comments_publish.rb +190 -0
  138. data/lib/docusign_esign/models/company.rb +521 -14
  139. data/lib/docusign_esign/models/complete_sign_hash_response.rb +12 -8
  140. data/lib/docusign_esign/models/complete_sign_request.rb +11 -7
  141. data/lib/docusign_esign/models/composite_template.rb +12 -8
  142. data/lib/docusign_esign/models/connect_config_results.rb +12 -8
  143. data/lib/docusign_esign/models/connect_custom_configuration.rb +162 -18
  144. data/lib/docusign_esign/models/connect_debug_log.rb +12 -8
  145. data/lib/docusign_esign/models/connect_failure_filter.rb +12 -8
  146. data/lib/docusign_esign/models/connect_failure_result.rb +12 -8
  147. data/lib/docusign_esign/models/connect_failure_results.rb +12 -8
  148. data/lib/docusign_esign/models/connect_log.rb +12 -8
  149. data/lib/docusign_esign/models/connect_logs.rb +12 -8
  150. data/lib/docusign_esign/models/connect_salesforce_field.rb +258 -0
  151. data/lib/docusign_esign/models/connect_salesforce_object.rb +272 -0
  152. data/lib/docusign_esign/models/connect_user_object.rb +230 -0
  153. data/lib/docusign_esign/models/console_view_request.rb +12 -8
  154. data/lib/docusign_esign/models/consumer_disclosure.rb +12 -8
  155. data/lib/docusign_esign/models/contact.rb +43 -9
  156. data/lib/docusign_esign/models/contact_get_response.rb +12 -8
  157. data/lib/docusign_esign/models/contact_mod_request.rb +20 -16
  158. data/lib/docusign_esign/models/contact_phone_number.rb +12 -8
  159. data/lib/docusign_esign/models/contact_update_response.rb +12 -8
  160. data/lib/docusign_esign/models/correct_view_request.rb +14 -20
  161. data/lib/docusign_esign/models/country.rb +12 -8
  162. data/lib/docusign_esign/models/credential.rb +11 -7
  163. data/lib/docusign_esign/models/credit_card_information.rb +23 -9
  164. data/lib/docusign_esign/models/credit_card_types.rb +12 -8
  165. data/lib/docusign_esign/models/currency_feature_set_price.rb +12 -8
  166. data/lib/docusign_esign/models/currency_plan_price.rb +12 -8
  167. data/lib/docusign_esign/models/custom_field.rb +12 -8
  168. data/lib/docusign_esign/models/custom_field_v2.rb +11 -7
  169. data/lib/docusign_esign/models/custom_fields.rb +11 -8
  170. data/lib/docusign_esign/models/custom_fields_envelope.rb +12 -8
  171. data/lib/docusign_esign/models/custom_settings_information.rb +12 -8
  172. data/lib/docusign_esign/models/date.rb +575 -14
  173. data/lib/docusign_esign/models/date_signed.rb +475 -12
  174. data/lib/docusign_esign/models/date_stamp_properties.rb +12 -8
  175. data/lib/docusign_esign/models/decline.rb +457 -14
  176. data/lib/docusign_esign/models/diagnostics_settings_information.rb +12 -8
  177. data/lib/docusign_esign/models/direct_debit_processor_information.rb +298 -0
  178. data/lib/docusign_esign/models/display_appliance_document.rb +258 -0
  179. data/lib/docusign_esign/models/display_appliance_document_page.rb +278 -0
  180. data/lib/docusign_esign/models/display_appliance_envelope.rb +328 -0
  181. data/lib/docusign_esign/models/display_appliance_info.rb +235 -0
  182. data/lib/docusign_esign/models/display_appliance_page.rb +278 -0
  183. data/lib/docusign_esign/models/display_appliance_pdf.rb +267 -0
  184. data/lib/docusign_esign/models/display_appliance_recipient.rb +388 -0
  185. data/lib/docusign_esign/models/{offline_attributes.rb → display_appliance_signer_attachment.rb} +65 -52
  186. data/lib/docusign_esign/models/dob_information_input.rb +11 -8
  187. data/lib/docusign_esign/models/document.rb +64 -19
  188. data/lib/docusign_esign/models/document_fields_information.rb +12 -8
  189. data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +12 -8
  190. data/lib/docusign_esign/models/document_html_definition.rb +12 -8
  191. data/lib/docusign_esign/models/document_html_definition_original.rb +12 -8
  192. data/lib/docusign_esign/models/document_html_definition_originals.rb +12 -8
  193. data/lib/docusign_esign/models/document_html_definitions.rb +12 -8
  194. data/lib/docusign_esign/models/document_html_display_anchor.rb +12 -8
  195. data/lib/docusign_esign/models/document_html_display_settings.rb +13 -19
  196. data/lib/docusign_esign/models/document_security_store.rb +11 -7
  197. data/lib/docusign_esign/models/document_template.rb +12 -8
  198. data/lib/docusign_esign/models/document_template_list.rb +12 -8
  199. data/lib/docusign_esign/models/document_update_info.rb +11 -7
  200. data/lib/docusign_esign/models/document_visibility.rb +12 -8
  201. data/lib/docusign_esign/models/document_visibility_list.rb +12 -8
  202. data/lib/docusign_esign/models/e_note_configuration.rb +12 -8
  203. data/lib/docusign_esign/models/editor.rb +208 -34
  204. data/lib/docusign_esign/models/email.rb +575 -14
  205. data/lib/docusign_esign/models/email_address.rb +475 -12
  206. data/lib/docusign_esign/models/email_settings.rb +11 -8
  207. data/lib/docusign_esign/models/envelope.rb +246 -19
  208. data/lib/docusign_esign/models/envelope_attachment.rb +12 -8
  209. data/lib/docusign_esign/models/envelope_attachments_request.rb +12 -8
  210. data/lib/docusign_esign/models/envelope_attachments_result.rb +12 -8
  211. data/lib/docusign_esign/models/envelope_audit_event.rb +12 -8
  212. data/lib/docusign_esign/models/envelope_audit_event_response.rb +12 -8
  213. data/lib/docusign_esign/models/envelope_definition.rb +258 -19
  214. data/lib/docusign_esign/models/envelope_document.rb +111 -18
  215. data/lib/docusign_esign/models/envelope_documents_result.rb +12 -8
  216. data/lib/docusign_esign/models/envelope_event.rb +12 -8
  217. data/lib/docusign_esign/models/envelope_form_data.rb +14 -19
  218. data/lib/docusign_esign/models/envelope_id.rb +466 -12
  219. data/lib/docusign_esign/models/envelope_ids_request.rb +12 -8
  220. data/lib/docusign_esign/models/envelope_metadata.rb +208 -0
  221. data/lib/docusign_esign/models/envelope_notification_request.rb +12 -8
  222. data/lib/docusign_esign/models/envelope_purge_configuration.rb +218 -0
  223. data/lib/docusign_esign/models/envelope_summary.rb +31 -9
  224. data/lib/docusign_esign/models/envelope_template.rb +461 -21
  225. data/lib/docusign_esign/models/envelope_template_definition.rb +10 -7
  226. data/lib/docusign_esign/models/envelope_template_result.rb +12 -28
  227. data/lib/docusign_esign/models/envelope_template_results.rb +13 -9
  228. data/lib/docusign_esign/models/envelope_transaction_status.rb +12 -8
  229. data/lib/docusign_esign/models/envelope_transfer_rule.rb +273 -0
  230. data/lib/docusign_esign/models/envelope_transfer_rule_information.rb +250 -0
  231. data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +279 -0
  232. data/lib/docusign_esign/models/envelope_update_summary.rb +23 -9
  233. data/lib/docusign_esign/models/envelopes_information.rb +25 -9
  234. data/lib/docusign_esign/models/error_details.rb +11 -8
  235. data/lib/docusign_esign/models/event_notification.rb +11 -8
  236. data/lib/docusign_esign/models/event_result.rb +12 -8
  237. data/lib/docusign_esign/models/expirations.rb +11 -8
  238. data/lib/docusign_esign/models/{recipient_identity_phone_number.rb → external_claim.rb} +39 -35
  239. data/lib/docusign_esign/models/external_doc_service_error_details.rb +12 -8
  240. data/lib/docusign_esign/models/external_document_sources.rb +273 -0
  241. data/lib/docusign_esign/models/external_file.rb +12 -8
  242. data/lib/docusign_esign/models/external_folder.rb +12 -8
  243. data/lib/docusign_esign/models/favorite_templates_content_item.rb +207 -0
  244. data/lib/docusign_esign/models/favorite_templates_info.rb +209 -0
  245. data/lib/docusign_esign/models/{recipient_proof_file.rb → feature_available_metadata.rb} +26 -22
  246. data/lib/docusign_esign/models/feature_set.rb +12 -8
  247. data/lib/docusign_esign/models/file_type.rb +12 -8
  248. data/lib/docusign_esign/models/file_type_list.rb +12 -8
  249. data/lib/docusign_esign/models/filter.rb +12 -8
  250. data/lib/docusign_esign/models/first_name.rb +475 -12
  251. data/lib/docusign_esign/models/folder.rb +65 -30
  252. data/lib/docusign_esign/models/folder_item.rb +11 -7
  253. data/lib/docusign_esign/models/folder_item_response.rb +12 -8
  254. data/lib/docusign_esign/models/folder_item_v2.rb +36 -32
  255. data/lib/docusign_esign/models/folder_items_response.rb +33 -17
  256. data/lib/docusign_esign/models/folder_shared_item.rb +289 -0
  257. data/lib/docusign_esign/models/folders_request.rb +25 -9
  258. data/lib/docusign_esign/models/folders_response.rb +88 -12
  259. data/lib/docusign_esign/models/forgotten_password_information.rb +11 -8
  260. data/lib/docusign_esign/models/form_data_item.rb +227 -0
  261. data/lib/docusign_esign/models/formula_tab.rb +611 -14
  262. data/lib/docusign_esign/models/full_name.rb +475 -12
  263. data/lib/docusign_esign/models/graphics_context.rb +208 -0
  264. data/lib/docusign_esign/models/group.rb +26 -12
  265. data/lib/docusign_esign/models/group_information.rb +12 -8
  266. data/lib/docusign_esign/models/id_check_configuration.rb +210 -0
  267. data/lib/docusign_esign/models/id_check_information_input.rb +11 -8
  268. data/lib/docusign_esign/models/{payment_signer_values.rb → id_check_security_step.rb} +20 -16
  269. data/lib/docusign_esign/models/in_person_signer.rb +283 -24
  270. data/lib/docusign_esign/models/initial_here.rb +422 -13
  271. data/lib/docusign_esign/models/inline_template.rb +12 -8
  272. data/lib/docusign_esign/models/integrated_user_info_list.rb +12 -8
  273. data/lib/docusign_esign/models/intermediary.rb +208 -34
  274. data/lib/docusign_esign/models/jurisdiction.rb +12 -8
  275. data/lib/docusign_esign/models/last_name.rb +475 -12
  276. data/lib/docusign_esign/models/list.rb +530 -13
  277. data/lib/docusign_esign/models/list_custom_field.rb +12 -8
  278. data/lib/docusign_esign/models/list_item.rb +43 -12
  279. data/lib/docusign_esign/models/locale_policy.rb +595 -0
  280. data/lib/docusign_esign/models/locale_policy_tab.rb +298 -0
  281. data/lib/docusign_esign/models/lock_information.rb +12 -8
  282. data/lib/docusign_esign/models/lock_request.rb +12 -8
  283. data/lib/docusign_esign/models/login_account.rb +12 -8
  284. data/lib/docusign_esign/models/login_information.rb +12 -8
  285. data/lib/docusign_esign/models/match_box.rb +17 -13
  286. data/lib/docusign_esign/models/member_group_shared_item.rb +12 -8
  287. data/lib/docusign_esign/models/member_shared_items.rb +25 -9
  288. data/lib/docusign_esign/models/merge_field.rb +81 -12
  289. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +12 -8
  290. data/lib/docusign_esign/models/mobile_notifier_configuration_information.rb +12 -8
  291. data/lib/docusign_esign/models/money.rb +12 -8
  292. data/lib/docusign_esign/models/name_value.rb +12 -8
  293. data/lib/docusign_esign/models/new_account_definition.rb +37 -17
  294. data/lib/docusign_esign/models/new_account_summary.rb +12 -8
  295. data/lib/docusign_esign/models/new_user.rb +13 -19
  296. data/lib/docusign_esign/models/new_users_definition.rb +12 -8
  297. data/lib/docusign_esign/models/new_users_summary.rb +12 -8
  298. data/lib/docusign_esign/models/notarize.rb +403 -12
  299. data/lib/docusign_esign/models/notary_host.rb +213 -24
  300. data/lib/docusign_esign/models/notary_journal.rb +12 -8
  301. data/lib/docusign_esign/models/notary_journal_credible_witness.rb +12 -8
  302. data/lib/docusign_esign/models/notary_journal_list.rb +12 -8
  303. data/lib/docusign_esign/models/notary_journal_meta_data.rb +12 -8
  304. data/lib/docusign_esign/models/note.rb +466 -14
  305. data/lib/docusign_esign/models/notification.rb +11 -8
  306. data/lib/docusign_esign/models/notification_default_settings.rb +196 -0
  307. data/lib/docusign_esign/models/notification_defaults.rb +196 -0
  308. data/lib/docusign_esign/models/number.rb +593 -14
  309. data/lib/docusign_esign/models/oauth_access.rb +12 -8
  310. data/lib/docusign_esign/models/page.rb +11 -8
  311. data/lib/docusign_esign/models/page_images.rb +12 -8
  312. data/lib/docusign_esign/models/page_request.rb +12 -8
  313. data/lib/docusign_esign/models/page_size.rb +198 -0
  314. data/lib/docusign_esign/models/{recipient_identity_input_option.rb → path_extended_element.rb} +26 -24
  315. data/lib/docusign_esign/models/pay_pal_legacy_settings.rb +228 -0
  316. data/lib/docusign_esign/models/payment_details.rb +31 -18
  317. data/lib/docusign_esign/models/payment_gateway_account.rb +110 -12
  318. data/lib/docusign_esign/models/payment_gateway_account_setting.rb +218 -0
  319. data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +12 -8
  320. data/lib/docusign_esign/models/payment_line_item.rb +12 -8
  321. data/lib/docusign_esign/models/payment_method_with_options.rb +200 -0
  322. data/lib/docusign_esign/models/payment_processor_information.rb +12 -8
  323. data/lib/docusign_esign/models/permission_profile.rb +12 -8
  324. data/lib/docusign_esign/models/permission_profile_information.rb +12 -8
  325. data/lib/docusign_esign/models/plan_information.rb +11 -8
  326. data/lib/docusign_esign/models/poly_line.rb +218 -0
  327. data/lib/docusign_esign/models/poly_line_overlay.rb +885 -0
  328. data/lib/docusign_esign/models/power_form.rb +12 -8
  329. data/lib/docusign_esign/models/power_form_form_data_envelope.rb +12 -8
  330. data/lib/docusign_esign/models/power_form_form_data_recipient.rb +12 -8
  331. data/lib/docusign_esign/models/power_form_recipient.rb +12 -8
  332. data/lib/docusign_esign/models/power_form_senders_response.rb +16 -12
  333. data/lib/docusign_esign/models/power_forms_form_data_response.rb +12 -8
  334. data/lib/docusign_esign/models/power_forms_request.rb +12 -8
  335. data/lib/docusign_esign/models/power_forms_response.rb +16 -12
  336. data/lib/docusign_esign/models/property_metadata.rb +12 -8
  337. data/lib/docusign_esign/models/province.rb +12 -8
  338. data/lib/docusign_esign/models/provisioning_information.rb +12 -8
  339. data/lib/docusign_esign/models/purchased_envelopes_information.rb +12 -8
  340. data/lib/docusign_esign/models/radio.rb +321 -12
  341. data/lib/docusign_esign/models/radio_group.rb +153 -12
  342. data/lib/docusign_esign/models/recipient_attachment.rb +12 -8
  343. data/lib/docusign_esign/models/recipient_domain.rb +12 -8
  344. data/lib/docusign_esign/models/recipient_email_notification.rb +44 -13
  345. data/lib/docusign_esign/models/recipient_event.rb +12 -8
  346. data/lib/docusign_esign/models/recipient_form_data.rb +25 -21
  347. data/lib/docusign_esign/models/recipient_identity_verification.rb +13 -21
  348. data/lib/docusign_esign/models/recipient_names_response.rb +12 -8
  349. data/lib/docusign_esign/models/recipient_phone_authentication.rb +51 -12
  350. data/lib/docusign_esign/models/recipient_preview_request.rb +278 -0
  351. data/lib/docusign_esign/models/recipient_saml_authentication.rb +10 -7
  352. data/lib/docusign_esign/models/recipient_signature_information.rb +11 -8
  353. data/lib/docusign_esign/models/recipient_signature_provider.rb +22 -9
  354. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +52 -12
  355. data/lib/docusign_esign/models/recipient_sms_authentication.rb +24 -12
  356. data/lib/docusign_esign/models/recipient_update_response.rb +33 -9
  357. data/lib/docusign_esign/models/recipient_view_request.rb +13 -33
  358. data/lib/docusign_esign/models/recipients.rb +11 -8
  359. data/lib/docusign_esign/models/recipients_update_summary.rb +12 -8
  360. data/lib/docusign_esign/models/referral_information.rb +11 -8
  361. data/lib/docusign_esign/models/reminders.rb +11 -8
  362. data/lib/docusign_esign/models/resource_information.rb +12 -8
  363. data/lib/docusign_esign/models/return_url_request.rb +12 -8
  364. data/lib/docusign_esign/models/revision.rb +11 -7
  365. data/lib/docusign_esign/models/saml_assertion_attribute.rb +11 -7
  366. data/lib/docusign_esign/models/seal.rb +13 -9
  367. data/lib/docusign_esign/models/seal_identifier.rb +12 -8
  368. data/lib/docusign_esign/models/seal_sign.rb +154 -24
  369. data/lib/docusign_esign/models/seat_discount.rb +12 -8
  370. data/lib/docusign_esign/models/sender.rb +11 -7
  371. data/lib/docusign_esign/models/sender_email_notifications.rb +19 -15
  372. data/lib/docusign_esign/models/server_template.rb +12 -8
  373. data/lib/docusign_esign/models/service_information.rb +12 -8
  374. data/lib/docusign_esign/models/service_version.rb +12 -8
  375. data/lib/docusign_esign/models/settings_metadata.rb +12 -8
  376. data/lib/docusign_esign/models/shared_item.rb +12 -8
  377. data/lib/docusign_esign/models/sign_hash_document.rb +11 -7
  378. data/lib/docusign_esign/models/sign_hash_session_info_response.rb +11 -7
  379. data/lib/docusign_esign/models/sign_here.rb +432 -13
  380. data/lib/docusign_esign/models/sign_session_info_request.rb +11 -7
  381. data/lib/docusign_esign/models/signature_data_info.rb +11 -7
  382. data/lib/docusign_esign/models/signature_properties.rb +198 -0
  383. data/lib/docusign_esign/models/signature_provider_required_option.rb +12 -8
  384. data/lib/docusign_esign/models/signature_type.rb +12 -8
  385. data/lib/docusign_esign/models/signer.rb +236 -34
  386. data/lib/docusign_esign/models/signer_attachment.rb +422 -13
  387. data/lib/docusign_esign/models/signer_email_notifications.rb +11 -8
  388. data/lib/docusign_esign/models/signing_group.rb +12 -8
  389. data/lib/docusign_esign/models/signing_group_information.rb +12 -8
  390. data/lib/docusign_esign/models/signing_group_user.rb +12 -8
  391. data/lib/docusign_esign/models/signing_group_users.rb +12 -8
  392. data/lib/docusign_esign/models/smart_section.rb +452 -12
  393. data/lib/docusign_esign/models/smart_section_anchor_position.rb +12 -8
  394. data/lib/docusign_esign/models/smart_section_collapsible_display_settings.rb +12 -8
  395. data/lib/docusign_esign/models/smart_section_display_settings.rb +13 -19
  396. data/lib/docusign_esign/models/social_account_information.rb +12 -8
  397. data/lib/docusign_esign/models/social_authentication.rb +12 -8
  398. data/lib/docusign_esign/models/ssn.rb +575 -14
  399. data/lib/docusign_esign/models/ssn4_information_input.rb +12 -8
  400. data/lib/docusign_esign/models/ssn9_information_input.rb +12 -8
  401. data/lib/docusign_esign/models/supported_languages.rb +12 -8
  402. data/lib/docusign_esign/models/tab_account_settings.rb +19 -15
  403. data/lib/docusign_esign/models/tab_group.rb +911 -0
  404. data/lib/docusign_esign/models/tab_metadata.rb +13 -39
  405. data/lib/docusign_esign/models/tab_metadata_list.rb +12 -8
  406. data/lib/docusign_esign/models/tabs.rb +50 -10
  407. data/lib/docusign_esign/models/template_custom_fields.rb +12 -8
  408. data/lib/docusign_esign/models/template_document_visibility_list.rb +12 -8
  409. data/lib/docusign_esign/models/template_documents_result.rb +12 -8
  410. data/lib/docusign_esign/models/template_information.rb +12 -8
  411. data/lib/docusign_esign/models/template_match.rb +12 -8
  412. data/lib/docusign_esign/models/template_notification_request.rb +12 -8
  413. data/lib/docusign_esign/models/template_recipients.rb +12 -8
  414. data/lib/docusign_esign/models/template_role.rb +12 -8
  415. data/lib/docusign_esign/models/template_shared_item.rb +23 -9
  416. data/lib/docusign_esign/models/template_summary.rb +22 -9
  417. data/lib/docusign_esign/models/template_tabs.rb +50 -10
  418. data/lib/docusign_esign/models/template_update_summary.rb +23 -9
  419. data/lib/docusign_esign/models/text.rb +584 -15
  420. data/lib/docusign_esign/models/text_custom_field.rb +12 -8
  421. data/lib/docusign_esign/models/time_stamp_field.rb +11 -7
  422. data/lib/docusign_esign/models/title.rb +521 -14
  423. data/lib/docusign_esign/models/tsp_health_check_request.rb +11 -7
  424. data/lib/docusign_esign/models/tsp_health_check_status_description.rb +11 -7
  425. data/lib/docusign_esign/models/update_transaction_request.rb +11 -7
  426. data/lib/docusign_esign/models/update_transaction_response.rb +11 -7
  427. data/lib/docusign_esign/models/usage_history.rb +13 -10
  428. data/lib/docusign_esign/models/user.rb +11 -7
  429. data/lib/docusign_esign/models/user_account_management_granular_information.rb +14 -86
  430. data/lib/docusign_esign/models/user_info.rb +43 -9
  431. data/lib/docusign_esign/models/user_info_list.rb +12 -8
  432. data/lib/docusign_esign/models/user_info_response.rb +11 -7
  433. data/lib/docusign_esign/models/user_information.rb +69 -25
  434. data/lib/docusign_esign/models/user_information_list.rb +12 -8
  435. data/lib/docusign_esign/models/user_password_information.rb +12 -8
  436. data/lib/docusign_esign/models/user_password_rules.rb +12 -8
  437. data/lib/docusign_esign/models/user_profile.rb +13 -9
  438. data/lib/docusign_esign/models/user_settings_information.rb +1115 -17
  439. data/lib/docusign_esign/models/user_shared_item.rb +12 -8
  440. data/lib/docusign_esign/models/user_signature.rb +93 -9
  441. data/lib/docusign_esign/models/user_signature_definition.rb +115 -12
  442. data/lib/docusign_esign/models/user_signatures_information.rb +12 -8
  443. data/lib/docusign_esign/models/user_social_id_result.rb +12 -8
  444. data/lib/docusign_esign/models/users_response.rb +12 -8
  445. data/lib/docusign_esign/models/view.rb +457 -14
  446. data/lib/docusign_esign/models/view_url.rb +12 -8
  447. data/lib/docusign_esign/models/watermark.rb +12 -8
  448. data/lib/docusign_esign/models/witness.rb +236 -34
  449. data/lib/docusign_esign/models/workspace.rb +30 -9
  450. data/lib/docusign_esign/models/workspace_folder_contents.rb +11 -8
  451. data/lib/docusign_esign/models/workspace_item.rb +63 -12
  452. data/lib/docusign_esign/models/workspace_item_list.rb +11 -8
  453. data/lib/docusign_esign/models/workspace_list.rb +11 -8
  454. data/lib/docusign_esign/models/{envelope_form_data_prefill_form_data.rb → workspace_settings.rb} +20 -18
  455. data/lib/docusign_esign/models/workspace_user.rb +45 -12
  456. data/lib/docusign_esign/models/workspace_user_authorization.rb +11 -8
  457. data/lib/docusign_esign/models/zip.rb +584 -14
  458. data/lib/docusign_esign/version.rb +1 -1
  459. data/lib/docusign_esign.rb +138 -59
  460. data/tests/.DS_Store +0 -0
  461. data/tests/Gemfile.lock +42 -0
  462. data/tests/spec/.DS_Store +0 -0
  463. data/tests/spec/unit_tests_using_jwt_spec.rb +2 -61
  464. metadata +130 -119
  465. data/lib/docusign_esign/api/organizations_api.rb +0 -128
  466. data/lib/docusign_esign/api/signature_api.rb +0 -256
  467. data/lib/docusign_esign/api/tsps_api.rb +0 -256
  468. data/runLinter.sh +0 -1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
5
 
6
- OpenAPI spec version: v2
6
+ OpenAPI spec version: v2.1
7
7
  Contact: devcenter@docusign.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
@@ -12,16 +12,22 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+
15
16
  class Intermediary
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
+ attr_accessor :access_code_metadata
21
+
19
22
  # 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.
20
23
  attr_accessor :add_access_code_to_email
21
24
 
22
25
  # 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.
23
26
  attr_accessor :client_user_id
24
27
 
28
+ #
29
+ attr_accessor :completed_count
30
+
25
31
  # 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.
26
32
  attr_accessor :custom_fields
27
33
 
@@ -37,16 +43,17 @@ module DocuSign_eSign
37
43
  # Reserved: For DocuSign use only.
38
44
  attr_accessor :delivery_method
39
45
 
46
+ attr_accessor :delivery_method_metadata
47
+
40
48
  #
41
49
  attr_accessor :document_visibility
42
50
 
43
51
  # Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
44
52
  attr_accessor :email
45
53
 
46
- attr_accessor :email_notification
54
+ attr_accessor :email_metadata
47
55
 
48
- #
49
- attr_accessor :email_recipient_post_signing_url
56
+ attr_accessor :email_notification
50
57
 
51
58
  # 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]]`
52
59
  attr_accessor :embedded_recipient_start_url
@@ -59,18 +66,24 @@ module DocuSign_eSign
59
66
  # Reserved:
60
67
  attr_accessor :fax_number
61
68
 
69
+ attr_accessor :fax_number_metadata
70
+
62
71
  # The user's first name. Maximum Length: 50 characters.
63
72
  attr_accessor :first_name
64
73
 
74
+ attr_accessor :first_name_metadata
75
+
65
76
  #
66
77
  attr_accessor :full_name
67
78
 
79
+ attr_accessor :full_name_metadata
80
+
68
81
  # 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.
69
82
  attr_accessor :id_check_configuration_name
70
83
 
71
- attr_accessor :id_check_information_input
84
+ attr_accessor :id_check_configuration_name_metadata
72
85
 
73
- attr_accessor :identity_verification
86
+ attr_accessor :id_check_information_input
74
87
 
75
88
  # 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.
76
89
  attr_accessor :inherit_email_notification_configuration
@@ -78,12 +91,24 @@ module DocuSign_eSign
78
91
  #
79
92
  attr_accessor :last_name
80
93
 
94
+ attr_accessor :last_name_metadata
95
+
96
+ #
97
+ attr_accessor :locked_recipient_phone_auth_editable
98
+
99
+ #
100
+ attr_accessor :locked_recipient_sms_editable
101
+
81
102
  #
82
103
  attr_accessor :name
83
104
 
105
+ attr_accessor :name_metadata
106
+
84
107
  # 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.
85
108
  attr_accessor :note
86
109
 
110
+ attr_accessor :note_metadata
111
+
87
112
  attr_accessor :phone_authentication
88
113
 
89
114
  # Reserved:
@@ -91,22 +116,32 @@ module DocuSign_eSign
91
116
 
92
117
  attr_accessor :recipient_authentication_status
93
118
 
119
+ #
120
+ attr_accessor :recipient_feature_metadata
121
+
94
122
  # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
95
123
  attr_accessor :recipient_id
96
124
 
97
125
  #
98
126
  attr_accessor :recipient_id_guid
99
127
 
128
+ #
129
+ attr_accessor :recipient_type
130
+
131
+ attr_accessor :recipient_type_metadata
132
+
100
133
  # When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
101
134
  attr_accessor :require_id_lookup
102
135
 
136
+ attr_accessor :require_id_lookup_metadata
137
+
103
138
  # Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
104
139
  attr_accessor :role_name
105
140
 
106
141
  # Specifies the routing order of the recipient in the envelope.
107
142
  attr_accessor :routing_order
108
143
 
109
- attr_accessor :saml_authentication
144
+ attr_accessor :routing_order_metadata
110
145
 
111
146
  # The date and time the envelope was sent.
112
147
  attr_accessor :sent_date_time
@@ -117,6 +152,8 @@ module DocuSign_eSign
117
152
  # 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).
118
153
  attr_accessor :signing_group_id
119
154
 
155
+ attr_accessor :signing_group_id_metadata
156
+
120
157
  # The display name for the signing group. Maximum Length: 100 characters.
121
158
  attr_accessor :signing_group_name
122
159
 
@@ -131,6 +168,12 @@ module DocuSign_eSign
131
168
  # 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.
132
169
  attr_accessor :status
133
170
 
171
+ #
172
+ attr_accessor :status_code
173
+
174
+ #
175
+ attr_accessor :suppress_emails
176
+
134
177
  # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
135
178
  attr_accessor :template_locked
136
179
 
@@ -143,51 +186,70 @@ module DocuSign_eSign
143
186
  #
144
187
  attr_accessor :user_id
145
188
 
189
+
146
190
  # Attribute mapping from ruby-style variable name to JSON key.
147
191
  def self.attribute_map
148
192
  {
149
193
  :'access_code' => :'accessCode',
194
+ :'access_code_metadata' => :'accessCodeMetadata',
150
195
  :'add_access_code_to_email' => :'addAccessCodeToEmail',
151
196
  :'client_user_id' => :'clientUserId',
197
+ :'completed_count' => :'completedCount',
152
198
  :'custom_fields' => :'customFields',
153
199
  :'declined_date_time' => :'declinedDateTime',
154
200
  :'declined_reason' => :'declinedReason',
155
201
  :'delivered_date_time' => :'deliveredDateTime',
156
202
  :'delivery_method' => :'deliveryMethod',
203
+ :'delivery_method_metadata' => :'deliveryMethodMetadata',
157
204
  :'document_visibility' => :'documentVisibility',
158
205
  :'email' => :'email',
206
+ :'email_metadata' => :'emailMetadata',
159
207
  :'email_notification' => :'emailNotification',
160
- :'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
161
208
  :'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
162
209
  :'error_details' => :'errorDetails',
163
210
  :'excluded_documents' => :'excludedDocuments',
164
211
  :'fax_number' => :'faxNumber',
212
+ :'fax_number_metadata' => :'faxNumberMetadata',
165
213
  :'first_name' => :'firstName',
214
+ :'first_name_metadata' => :'firstNameMetadata',
166
215
  :'full_name' => :'fullName',
216
+ :'full_name_metadata' => :'fullNameMetadata',
167
217
  :'id_check_configuration_name' => :'idCheckConfigurationName',
218
+ :'id_check_configuration_name_metadata' => :'idCheckConfigurationNameMetadata',
168
219
  :'id_check_information_input' => :'idCheckInformationInput',
169
- :'identity_verification' => :'identityVerification',
170
220
  :'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration',
171
221
  :'last_name' => :'lastName',
222
+ :'last_name_metadata' => :'lastNameMetadata',
223
+ :'locked_recipient_phone_auth_editable' => :'lockedRecipientPhoneAuthEditable',
224
+ :'locked_recipient_sms_editable' => :'lockedRecipientSmsEditable',
172
225
  :'name' => :'name',
226
+ :'name_metadata' => :'nameMetadata',
173
227
  :'note' => :'note',
228
+ :'note_metadata' => :'noteMetadata',
174
229
  :'phone_authentication' => :'phoneAuthentication',
175
230
  :'recipient_attachments' => :'recipientAttachments',
176
231
  :'recipient_authentication_status' => :'recipientAuthenticationStatus',
232
+ :'recipient_feature_metadata' => :'recipientFeatureMetadata',
177
233
  :'recipient_id' => :'recipientId',
178
234
  :'recipient_id_guid' => :'recipientIdGuid',
235
+ :'recipient_type' => :'recipientType',
236
+ :'recipient_type_metadata' => :'recipientTypeMetadata',
179
237
  :'require_id_lookup' => :'requireIdLookup',
238
+ :'require_id_lookup_metadata' => :'requireIdLookupMetadata',
180
239
  :'role_name' => :'roleName',
181
240
  :'routing_order' => :'routingOrder',
182
- :'saml_authentication' => :'samlAuthentication',
241
+ :'routing_order_metadata' => :'routingOrderMetadata',
183
242
  :'sent_date_time' => :'sentDateTime',
184
243
  :'signed_date_time' => :'signedDateTime',
185
244
  :'signing_group_id' => :'signingGroupId',
245
+ :'signing_group_id_metadata' => :'signingGroupIdMetadata',
186
246
  :'signing_group_name' => :'signingGroupName',
187
247
  :'signing_group_users' => :'signingGroupUsers',
188
248
  :'sms_authentication' => :'smsAuthentication',
189
249
  :'social_authentications' => :'socialAuthentications',
190
250
  :'status' => :'status',
251
+ :'status_code' => :'statusCode',
252
+ :'suppress_emails' => :'suppressEmails',
191
253
  :'template_locked' => :'templateLocked',
192
254
  :'template_required' => :'templateRequired',
193
255
  :'total_tab_count' => :'totalTabCount',
@@ -199,47 +261,65 @@ module DocuSign_eSign
199
261
  def self.swagger_types
200
262
  {
201
263
  :'access_code' => :'String',
264
+ :'access_code_metadata' => :'PropertyMetadata',
202
265
  :'add_access_code_to_email' => :'String',
203
266
  :'client_user_id' => :'String',
267
+ :'completed_count' => :'String',
204
268
  :'custom_fields' => :'Array<String>',
205
269
  :'declined_date_time' => :'String',
206
270
  :'declined_reason' => :'String',
207
271
  :'delivered_date_time' => :'String',
208
272
  :'delivery_method' => :'String',
273
+ :'delivery_method_metadata' => :'PropertyMetadata',
209
274
  :'document_visibility' => :'Array<DocumentVisibility>',
210
275
  :'email' => :'String',
276
+ :'email_metadata' => :'PropertyMetadata',
211
277
  :'email_notification' => :'RecipientEmailNotification',
212
- :'email_recipient_post_signing_url' => :'String',
213
278
  :'embedded_recipient_start_url' => :'String',
214
279
  :'error_details' => :'ErrorDetails',
215
280
  :'excluded_documents' => :'Array<String>',
216
281
  :'fax_number' => :'String',
282
+ :'fax_number_metadata' => :'PropertyMetadata',
217
283
  :'first_name' => :'String',
284
+ :'first_name_metadata' => :'PropertyMetadata',
218
285
  :'full_name' => :'String',
286
+ :'full_name_metadata' => :'PropertyMetadata',
219
287
  :'id_check_configuration_name' => :'String',
288
+ :'id_check_configuration_name_metadata' => :'PropertyMetadata',
220
289
  :'id_check_information_input' => :'IdCheckInformationInput',
221
- :'identity_verification' => :'RecipientIdentityVerification',
222
290
  :'inherit_email_notification_configuration' => :'String',
223
291
  :'last_name' => :'String',
292
+ :'last_name_metadata' => :'PropertyMetadata',
293
+ :'locked_recipient_phone_auth_editable' => :'String',
294
+ :'locked_recipient_sms_editable' => :'String',
224
295
  :'name' => :'String',
296
+ :'name_metadata' => :'PropertyMetadata',
225
297
  :'note' => :'String',
298
+ :'note_metadata' => :'PropertyMetadata',
226
299
  :'phone_authentication' => :'RecipientPhoneAuthentication',
227
300
  :'recipient_attachments' => :'Array<RecipientAttachment>',
228
301
  :'recipient_authentication_status' => :'AuthenticationStatus',
302
+ :'recipient_feature_metadata' => :'Array<FeatureAvailableMetadata>',
229
303
  :'recipient_id' => :'String',
230
304
  :'recipient_id_guid' => :'String',
305
+ :'recipient_type' => :'String',
306
+ :'recipient_type_metadata' => :'PropertyMetadata',
231
307
  :'require_id_lookup' => :'String',
308
+ :'require_id_lookup_metadata' => :'PropertyMetadata',
232
309
  :'role_name' => :'String',
233
310
  :'routing_order' => :'String',
234
- :'saml_authentication' => :'RecipientSAMLAuthentication',
311
+ :'routing_order_metadata' => :'PropertyMetadata',
235
312
  :'sent_date_time' => :'String',
236
313
  :'signed_date_time' => :'String',
237
314
  :'signing_group_id' => :'String',
315
+ :'signing_group_id_metadata' => :'PropertyMetadata',
238
316
  :'signing_group_name' => :'String',
239
317
  :'signing_group_users' => :'Array<UserInfo>',
240
318
  :'sms_authentication' => :'RecipientSMSAuthentication',
241
319
  :'social_authentications' => :'Array<SocialAuthentication>',
242
320
  :'status' => :'String',
321
+ :'status_code' => :'String',
322
+ :'suppress_emails' => :'String',
243
323
  :'template_locked' => :'String',
244
324
  :'template_required' => :'String',
245
325
  :'total_tab_count' => :'String',
@@ -253,12 +333,16 @@ module DocuSign_eSign
253
333
  return unless attributes.is_a?(Hash)
254
334
 
255
335
  # convert string to symbol for hash key
256
- attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
336
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
257
337
 
258
338
  if attributes.has_key?(:'accessCode')
259
339
  self.access_code = attributes[:'accessCode']
260
340
  end
261
341
 
342
+ if attributes.has_key?(:'accessCodeMetadata')
343
+ self.access_code_metadata = attributes[:'accessCodeMetadata']
344
+ end
345
+
262
346
  if attributes.has_key?(:'addAccessCodeToEmail')
263
347
  self.add_access_code_to_email = attributes[:'addAccessCodeToEmail']
264
348
  end
@@ -267,6 +351,10 @@ module DocuSign_eSign
267
351
  self.client_user_id = attributes[:'clientUserId']
268
352
  end
269
353
 
354
+ if attributes.has_key?(:'completedCount')
355
+ self.completed_count = attributes[:'completedCount']
356
+ end
357
+
270
358
  if attributes.has_key?(:'customFields')
271
359
  if (value = attributes[:'customFields']).is_a?(Array)
272
360
  self.custom_fields = value
@@ -289,6 +377,10 @@ module DocuSign_eSign
289
377
  self.delivery_method = attributes[:'deliveryMethod']
290
378
  end
291
379
 
380
+ if attributes.has_key?(:'deliveryMethodMetadata')
381
+ self.delivery_method_metadata = attributes[:'deliveryMethodMetadata']
382
+ end
383
+
292
384
  if attributes.has_key?(:'documentVisibility')
293
385
  if (value = attributes[:'documentVisibility']).is_a?(Array)
294
386
  self.document_visibility = value
@@ -299,12 +391,12 @@ module DocuSign_eSign
299
391
  self.email = attributes[:'email']
300
392
  end
301
393
 
302
- if attributes.has_key?(:'emailNotification')
303
- self.email_notification = attributes[:'emailNotification']
394
+ if attributes.has_key?(:'emailMetadata')
395
+ self.email_metadata = attributes[:'emailMetadata']
304
396
  end
305
397
 
306
- if attributes.has_key?(:'emailRecipientPostSigningURL')
307
- self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
398
+ if attributes.has_key?(:'emailNotification')
399
+ self.email_notification = attributes[:'emailNotification']
308
400
  end
309
401
 
310
402
  if attributes.has_key?(:'embeddedRecipientStartURL')
@@ -325,24 +417,36 @@ module DocuSign_eSign
325
417
  self.fax_number = attributes[:'faxNumber']
326
418
  end
327
419
 
420
+ if attributes.has_key?(:'faxNumberMetadata')
421
+ self.fax_number_metadata = attributes[:'faxNumberMetadata']
422
+ end
423
+
328
424
  if attributes.has_key?(:'firstName')
329
425
  self.first_name = attributes[:'firstName']
330
426
  end
331
427
 
428
+ if attributes.has_key?(:'firstNameMetadata')
429
+ self.first_name_metadata = attributes[:'firstNameMetadata']
430
+ end
431
+
332
432
  if attributes.has_key?(:'fullName')
333
433
  self.full_name = attributes[:'fullName']
334
434
  end
335
435
 
436
+ if attributes.has_key?(:'fullNameMetadata')
437
+ self.full_name_metadata = attributes[:'fullNameMetadata']
438
+ end
439
+
336
440
  if attributes.has_key?(:'idCheckConfigurationName')
337
441
  self.id_check_configuration_name = attributes[:'idCheckConfigurationName']
338
442
  end
339
443
 
340
- if attributes.has_key?(:'idCheckInformationInput')
341
- self.id_check_information_input = attributes[:'idCheckInformationInput']
444
+ if attributes.has_key?(:'idCheckConfigurationNameMetadata')
445
+ self.id_check_configuration_name_metadata = attributes[:'idCheckConfigurationNameMetadata']
342
446
  end
343
447
 
344
- if attributes.has_key?(:'identityVerification')
345
- self.identity_verification = attributes[:'identityVerification']
448
+ if attributes.has_key?(:'idCheckInformationInput')
449
+ self.id_check_information_input = attributes[:'idCheckInformationInput']
346
450
  end
347
451
 
348
452
  if attributes.has_key?(:'inheritEmailNotificationConfiguration')
@@ -353,14 +457,34 @@ module DocuSign_eSign
353
457
  self.last_name = attributes[:'lastName']
354
458
  end
355
459
 
460
+ if attributes.has_key?(:'lastNameMetadata')
461
+ self.last_name_metadata = attributes[:'lastNameMetadata']
462
+ end
463
+
464
+ if attributes.has_key?(:'lockedRecipientPhoneAuthEditable')
465
+ self.locked_recipient_phone_auth_editable = attributes[:'lockedRecipientPhoneAuthEditable']
466
+ end
467
+
468
+ if attributes.has_key?(:'lockedRecipientSmsEditable')
469
+ self.locked_recipient_sms_editable = attributes[:'lockedRecipientSmsEditable']
470
+ end
471
+
356
472
  if attributes.has_key?(:'name')
357
473
  self.name = attributes[:'name']
358
474
  end
359
475
 
476
+ if attributes.has_key?(:'nameMetadata')
477
+ self.name_metadata = attributes[:'nameMetadata']
478
+ end
479
+
360
480
  if attributes.has_key?(:'note')
361
481
  self.note = attributes[:'note']
362
482
  end
363
483
 
484
+ if attributes.has_key?(:'noteMetadata')
485
+ self.note_metadata = attributes[:'noteMetadata']
486
+ end
487
+
364
488
  if attributes.has_key?(:'phoneAuthentication')
365
489
  self.phone_authentication = attributes[:'phoneAuthentication']
366
490
  end
@@ -375,6 +499,12 @@ module DocuSign_eSign
375
499
  self.recipient_authentication_status = attributes[:'recipientAuthenticationStatus']
376
500
  end
377
501
 
502
+ if attributes.has_key?(:'recipientFeatureMetadata')
503
+ if (value = attributes[:'recipientFeatureMetadata']).is_a?(Array)
504
+ self.recipient_feature_metadata = value
505
+ end
506
+ end
507
+
378
508
  if attributes.has_key?(:'recipientId')
379
509
  self.recipient_id = attributes[:'recipientId']
380
510
  end
@@ -383,10 +513,22 @@ module DocuSign_eSign
383
513
  self.recipient_id_guid = attributes[:'recipientIdGuid']
384
514
  end
385
515
 
516
+ if attributes.has_key?(:'recipientType')
517
+ self.recipient_type = attributes[:'recipientType']
518
+ end
519
+
520
+ if attributes.has_key?(:'recipientTypeMetadata')
521
+ self.recipient_type_metadata = attributes[:'recipientTypeMetadata']
522
+ end
523
+
386
524
  if attributes.has_key?(:'requireIdLookup')
387
525
  self.require_id_lookup = attributes[:'requireIdLookup']
388
526
  end
389
527
 
528
+ if attributes.has_key?(:'requireIdLookupMetadata')
529
+ self.require_id_lookup_metadata = attributes[:'requireIdLookupMetadata']
530
+ end
531
+
390
532
  if attributes.has_key?(:'roleName')
391
533
  self.role_name = attributes[:'roleName']
392
534
  end
@@ -395,8 +537,8 @@ module DocuSign_eSign
395
537
  self.routing_order = attributes[:'routingOrder']
396
538
  end
397
539
 
398
- if attributes.has_key?(:'samlAuthentication')
399
- self.saml_authentication = attributes[:'samlAuthentication']
540
+ if attributes.has_key?(:'routingOrderMetadata')
541
+ self.routing_order_metadata = attributes[:'routingOrderMetadata']
400
542
  end
401
543
 
402
544
  if attributes.has_key?(:'sentDateTime')
@@ -411,6 +553,10 @@ module DocuSign_eSign
411
553
  self.signing_group_id = attributes[:'signingGroupId']
412
554
  end
413
555
 
556
+ if attributes.has_key?(:'signingGroupIdMetadata')
557
+ self.signing_group_id_metadata = attributes[:'signingGroupIdMetadata']
558
+ end
559
+
414
560
  if attributes.has_key?(:'signingGroupName')
415
561
  self.signing_group_name = attributes[:'signingGroupName']
416
562
  end
@@ -435,6 +581,14 @@ module DocuSign_eSign
435
581
  self.status = attributes[:'status']
436
582
  end
437
583
 
584
+ if attributes.has_key?(:'statusCode')
585
+ self.status_code = attributes[:'statusCode']
586
+ end
587
+
588
+ if attributes.has_key?(:'suppressEmails')
589
+ self.suppress_emails = attributes[:'suppressEmails']
590
+ end
591
+
438
592
  if attributes.has_key?(:'templateLocked')
439
593
  self.template_locked = attributes[:'templateLocked']
440
594
  end
@@ -450,19 +604,20 @@ module DocuSign_eSign
450
604
  if attributes.has_key?(:'userId')
451
605
  self.user_id = attributes[:'userId']
452
606
  end
607
+
453
608
  end
454
609
 
455
610
  # Show invalid properties with the reasons. Usually used together with valid?
456
- # @return Array for valid properties with the reasons
611
+ # @return Array for valid properies with the reasons
457
612
  def list_invalid_properties
458
613
  invalid_properties = Array.new
459
- invalid_properties
614
+ return invalid_properties
460
615
  end
461
616
 
462
617
  # Check to see if the all the properties in the model are valid
463
618
  # @return true if the model is valid
464
619
  def valid?
465
- true
620
+ return true
466
621
  end
467
622
 
468
623
  # Checks equality by comparing each attribute.
@@ -471,47 +626,65 @@ module DocuSign_eSign
471
626
  return true if self.equal?(o)
472
627
  self.class == o.class &&
473
628
  access_code == o.access_code &&
629
+ access_code_metadata == o.access_code_metadata &&
474
630
  add_access_code_to_email == o.add_access_code_to_email &&
475
631
  client_user_id == o.client_user_id &&
632
+ completed_count == o.completed_count &&
476
633
  custom_fields == o.custom_fields &&
477
634
  declined_date_time == o.declined_date_time &&
478
635
  declined_reason == o.declined_reason &&
479
636
  delivered_date_time == o.delivered_date_time &&
480
637
  delivery_method == o.delivery_method &&
638
+ delivery_method_metadata == o.delivery_method_metadata &&
481
639
  document_visibility == o.document_visibility &&
482
640
  email == o.email &&
641
+ email_metadata == o.email_metadata &&
483
642
  email_notification == o.email_notification &&
484
- email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
485
643
  embedded_recipient_start_url == o.embedded_recipient_start_url &&
486
644
  error_details == o.error_details &&
487
645
  excluded_documents == o.excluded_documents &&
488
646
  fax_number == o.fax_number &&
647
+ fax_number_metadata == o.fax_number_metadata &&
489
648
  first_name == o.first_name &&
649
+ first_name_metadata == o.first_name_metadata &&
490
650
  full_name == o.full_name &&
651
+ full_name_metadata == o.full_name_metadata &&
491
652
  id_check_configuration_name == o.id_check_configuration_name &&
653
+ id_check_configuration_name_metadata == o.id_check_configuration_name_metadata &&
492
654
  id_check_information_input == o.id_check_information_input &&
493
- identity_verification == o.identity_verification &&
494
655
  inherit_email_notification_configuration == o.inherit_email_notification_configuration &&
495
656
  last_name == o.last_name &&
657
+ last_name_metadata == o.last_name_metadata &&
658
+ locked_recipient_phone_auth_editable == o.locked_recipient_phone_auth_editable &&
659
+ locked_recipient_sms_editable == o.locked_recipient_sms_editable &&
496
660
  name == o.name &&
661
+ name_metadata == o.name_metadata &&
497
662
  note == o.note &&
663
+ note_metadata == o.note_metadata &&
498
664
  phone_authentication == o.phone_authentication &&
499
665
  recipient_attachments == o.recipient_attachments &&
500
666
  recipient_authentication_status == o.recipient_authentication_status &&
667
+ recipient_feature_metadata == o.recipient_feature_metadata &&
501
668
  recipient_id == o.recipient_id &&
502
669
  recipient_id_guid == o.recipient_id_guid &&
670
+ recipient_type == o.recipient_type &&
671
+ recipient_type_metadata == o.recipient_type_metadata &&
503
672
  require_id_lookup == o.require_id_lookup &&
673
+ require_id_lookup_metadata == o.require_id_lookup_metadata &&
504
674
  role_name == o.role_name &&
505
675
  routing_order == o.routing_order &&
506
- saml_authentication == o.saml_authentication &&
676
+ routing_order_metadata == o.routing_order_metadata &&
507
677
  sent_date_time == o.sent_date_time &&
508
678
  signed_date_time == o.signed_date_time &&
509
679
  signing_group_id == o.signing_group_id &&
680
+ signing_group_id_metadata == o.signing_group_id_metadata &&
510
681
  signing_group_name == o.signing_group_name &&
511
682
  signing_group_users == o.signing_group_users &&
512
683
  sms_authentication == o.sms_authentication &&
513
684
  social_authentications == o.social_authentications &&
514
685
  status == o.status &&
686
+ status_code == o.status_code &&
687
+ suppress_emails == o.suppress_emails &&
515
688
  template_locked == o.template_locked &&
516
689
  template_required == o.template_required &&
517
690
  total_tab_count == o.total_tab_count &&
@@ -527,7 +700,7 @@ module DocuSign_eSign
527
700
  # Calculates hash code according to all attributes.
528
701
  # @return [Fixnum] Hash code
529
702
  def hash
530
- [access_code, add_access_code_to_email, client_user_id, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, document_visibility, email, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, first_name, full_name, id_check_configuration_name, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, name, note, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_id, recipient_id_guid, require_id_lookup, role_name, routing_order, saml_authentication, sent_date_time, signed_date_time, signing_group_id, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, template_locked, template_required, total_tab_count, user_id].hash
703
+ [access_code, access_code_metadata, add_access_code_to_email, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, 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, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
531
704
  end
532
705
 
533
706
  # Builds the object from hash
@@ -537,10 +710,10 @@ module DocuSign_eSign
537
710
  return nil unless attributes.is_a?(Hash)
538
711
  self.class.swagger_types.each_pair do |key, type|
539
712
  if type =~ /\AArray<(.*)>/i
540
- # check to ensure the input is an array given that the attribute
713
+ # check to ensure the input is an array given that the the attribute
541
714
  # is documented as an array but the input is not
542
715
  if attributes[self.class.attribute_map[key]].is_a?(Array)
543
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
716
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
544
717
  end
545
718
  elsif !attributes[self.class.attribute_map[key]].nil?
546
719
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -622,7 +795,7 @@ module DocuSign_eSign
622
795
  # @return [Hash] Returns the value in the form of hash
623
796
  def _to_hash(value)
624
797
  if value.is_a?(Array)
625
- value.compact.map { |v| _to_hash(v) }
798
+ value.compact.map{ |v| _to_hash(v) }
626
799
  elsif value.is_a?(Hash)
627
800
  {}.tap do |hash|
628
801
  value.each { |k, v| hash[k] = _to_hash(v) }
@@ -635,4 +808,5 @@ module DocuSign_eSign
635
808
  end
636
809
 
637
810
  end
811
+
638
812
  end