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,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
+
15
16
  class SealIdentifier
16
17
  #
17
18
  attr_accessor :seal_display_name
@@ -19,6 +20,7 @@ module DocuSign_eSign
19
20
  #
20
21
  attr_accessor :seal_name
21
22
 
23
+
22
24
  # Attribute mapping from ruby-style variable name to JSON key.
23
25
  def self.attribute_map
24
26
  {
@@ -41,7 +43,7 @@ module DocuSign_eSign
41
43
  return unless attributes.is_a?(Hash)
42
44
 
43
45
  # convert string to symbol for hash key
44
- attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
46
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
45
47
 
46
48
  if attributes.has_key?(:'sealDisplayName')
47
49
  self.seal_display_name = attributes[:'sealDisplayName']
@@ -50,19 +52,20 @@ module DocuSign_eSign
50
52
  if attributes.has_key?(:'sealName')
51
53
  self.seal_name = attributes[:'sealName']
52
54
  end
55
+
53
56
  end
54
57
 
55
58
  # Show invalid properties with the reasons. Usually used together with valid?
56
- # @return Array for valid properties with the reasons
59
+ # @return Array for valid properies with the reasons
57
60
  def list_invalid_properties
58
61
  invalid_properties = Array.new
59
- invalid_properties
62
+ return invalid_properties
60
63
  end
61
64
 
62
65
  # Check to see if the all the properties in the model are valid
63
66
  # @return true if the model is valid
64
67
  def valid?
65
- true
68
+ return true
66
69
  end
67
70
 
68
71
  # Checks equality by comparing each attribute.
@@ -93,10 +96,10 @@ module DocuSign_eSign
93
96
  return nil unless attributes.is_a?(Hash)
94
97
  self.class.swagger_types.each_pair do |key, type|
95
98
  if type =~ /\AArray<(.*)>/i
96
- # check to ensure the input is an array given that the attribute
99
+ # check to ensure the input is an array given that the the attribute
97
100
  # is documented as an array but the input is not
98
101
  if attributes[self.class.attribute_map[key]].is_a?(Array)
99
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
102
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
100
103
  end
101
104
  elsif !attributes[self.class.attribute_map[key]].nil?
102
105
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -178,7 +181,7 @@ module DocuSign_eSign
178
181
  # @return [Hash] Returns the value in the form of hash
179
182
  def _to_hash(value)
180
183
  if value.is_a?(Array)
181
- value.compact.map { |v| _to_hash(v) }
184
+ value.compact.map{ |v| _to_hash(v) }
182
185
  elsif value.is_a?(Hash)
183
186
  {}.tap do |hash|
184
187
  value.each { |k, v| hash[k] = _to_hash(v) }
@@ -191,4 +194,5 @@ module DocuSign_eSign
191
194
  end
192
195
 
193
196
  end
197
+
194
198
  end
@@ -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 SealSign
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,6 +43,8 @@ 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
 
@@ -50,22 +58,32 @@ module DocuSign_eSign
50
58
  # Reserved:
51
59
  attr_accessor :fax_number
52
60
 
61
+ attr_accessor :fax_number_metadata
62
+
53
63
  # 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.
54
64
  attr_accessor :id_check_configuration_name
55
65
 
56
- attr_accessor :id_check_information_input
66
+ attr_accessor :id_check_configuration_name_metadata
57
67
 
58
- attr_accessor :identity_verification
68
+ attr_accessor :id_check_information_input
59
69
 
60
70
  # 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.
61
71
  attr_accessor :inherit_email_notification_configuration
62
72
 
73
+ #
74
+ attr_accessor :locked_recipient_phone_auth_editable
75
+
76
+ #
77
+ attr_accessor :locked_recipient_sms_editable
78
+
63
79
  #
64
80
  attr_accessor :name
65
81
 
66
82
  # 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.
67
83
  attr_accessor :note
68
84
 
85
+ attr_accessor :note_metadata
86
+
69
87
  attr_accessor :phone_authentication
70
88
 
71
89
  # Reserved:
@@ -73,6 +91,9 @@ module DocuSign_eSign
73
91
 
74
92
  attr_accessor :recipient_authentication_status
75
93
 
94
+ #
95
+ attr_accessor :recipient_feature_metadata
96
+
76
97
  # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
77
98
  attr_accessor :recipient_id
78
99
 
@@ -82,16 +103,23 @@ module DocuSign_eSign
82
103
  #
83
104
  attr_accessor :recipient_signature_providers
84
105
 
106
+ #
107
+ attr_accessor :recipient_type
108
+
109
+ attr_accessor :recipient_type_metadata
110
+
85
111
  # When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
86
112
  attr_accessor :require_id_lookup
87
113
 
114
+ attr_accessor :require_id_lookup_metadata
115
+
88
116
  # Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
89
117
  attr_accessor :role_name
90
118
 
91
119
  # Specifies the routing order of the recipient in the envelope.
92
120
  attr_accessor :routing_order
93
121
 
94
- attr_accessor :saml_authentication
122
+ attr_accessor :routing_order_metadata
95
123
 
96
124
  # The date and time the envelope was sent.
97
125
  attr_accessor :sent_date_time
@@ -107,6 +135,12 @@ module DocuSign_eSign
107
135
  # 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.
108
136
  attr_accessor :status
109
137
 
138
+ #
139
+ attr_accessor :status_code
140
+
141
+ #
142
+ attr_accessor :suppress_emails
143
+
110
144
  attr_accessor :tabs
111
145
 
112
146
  # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
@@ -121,43 +155,57 @@ module DocuSign_eSign
121
155
  #
122
156
  attr_accessor :user_id
123
157
 
158
+
124
159
  # Attribute mapping from ruby-style variable name to JSON key.
125
160
  def self.attribute_map
126
161
  {
127
162
  :'access_code' => :'accessCode',
163
+ :'access_code_metadata' => :'accessCodeMetadata',
128
164
  :'add_access_code_to_email' => :'addAccessCodeToEmail',
129
165
  :'client_user_id' => :'clientUserId',
166
+ :'completed_count' => :'completedCount',
130
167
  :'custom_fields' => :'customFields',
131
168
  :'declined_date_time' => :'declinedDateTime',
132
169
  :'declined_reason' => :'declinedReason',
133
170
  :'delivered_date_time' => :'deliveredDateTime',
134
171
  :'delivery_method' => :'deliveryMethod',
172
+ :'delivery_method_metadata' => :'deliveryMethodMetadata',
135
173
  :'document_visibility' => :'documentVisibility',
136
174
  :'email_notification' => :'emailNotification',
137
175
  :'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
138
176
  :'error_details' => :'errorDetails',
139
177
  :'fax_number' => :'faxNumber',
178
+ :'fax_number_metadata' => :'faxNumberMetadata',
140
179
  :'id_check_configuration_name' => :'idCheckConfigurationName',
180
+ :'id_check_configuration_name_metadata' => :'idCheckConfigurationNameMetadata',
141
181
  :'id_check_information_input' => :'idCheckInformationInput',
142
- :'identity_verification' => :'identityVerification',
143
182
  :'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration',
183
+ :'locked_recipient_phone_auth_editable' => :'lockedRecipientPhoneAuthEditable',
184
+ :'locked_recipient_sms_editable' => :'lockedRecipientSmsEditable',
144
185
  :'name' => :'name',
145
186
  :'note' => :'note',
187
+ :'note_metadata' => :'noteMetadata',
146
188
  :'phone_authentication' => :'phoneAuthentication',
147
189
  :'recipient_attachments' => :'recipientAttachments',
148
190
  :'recipient_authentication_status' => :'recipientAuthenticationStatus',
191
+ :'recipient_feature_metadata' => :'recipientFeatureMetadata',
149
192
  :'recipient_id' => :'recipientId',
150
193
  :'recipient_id_guid' => :'recipientIdGuid',
151
194
  :'recipient_signature_providers' => :'recipientSignatureProviders',
195
+ :'recipient_type' => :'recipientType',
196
+ :'recipient_type_metadata' => :'recipientTypeMetadata',
152
197
  :'require_id_lookup' => :'requireIdLookup',
198
+ :'require_id_lookup_metadata' => :'requireIdLookupMetadata',
153
199
  :'role_name' => :'roleName',
154
200
  :'routing_order' => :'routingOrder',
155
- :'saml_authentication' => :'samlAuthentication',
201
+ :'routing_order_metadata' => :'routingOrderMetadata',
156
202
  :'sent_date_time' => :'sentDateTime',
157
203
  :'signed_date_time' => :'signedDateTime',
158
204
  :'sms_authentication' => :'smsAuthentication',
159
205
  :'social_authentications' => :'socialAuthentications',
160
206
  :'status' => :'status',
207
+ :'status_code' => :'statusCode',
208
+ :'suppress_emails' => :'suppressEmails',
161
209
  :'tabs' => :'tabs',
162
210
  :'template_locked' => :'templateLocked',
163
211
  :'template_required' => :'templateRequired',
@@ -170,39 +218,52 @@ module DocuSign_eSign
170
218
  def self.swagger_types
171
219
  {
172
220
  :'access_code' => :'String',
221
+ :'access_code_metadata' => :'PropertyMetadata',
173
222
  :'add_access_code_to_email' => :'String',
174
223
  :'client_user_id' => :'String',
224
+ :'completed_count' => :'String',
175
225
  :'custom_fields' => :'Array<String>',
176
226
  :'declined_date_time' => :'String',
177
227
  :'declined_reason' => :'String',
178
228
  :'delivered_date_time' => :'String',
179
229
  :'delivery_method' => :'String',
230
+ :'delivery_method_metadata' => :'PropertyMetadata',
180
231
  :'document_visibility' => :'Array<DocumentVisibility>',
181
232
  :'email_notification' => :'RecipientEmailNotification',
182
233
  :'embedded_recipient_start_url' => :'String',
183
234
  :'error_details' => :'ErrorDetails',
184
235
  :'fax_number' => :'String',
236
+ :'fax_number_metadata' => :'PropertyMetadata',
185
237
  :'id_check_configuration_name' => :'String',
238
+ :'id_check_configuration_name_metadata' => :'PropertyMetadata',
186
239
  :'id_check_information_input' => :'IdCheckInformationInput',
187
- :'identity_verification' => :'RecipientIdentityVerification',
188
240
  :'inherit_email_notification_configuration' => :'String',
241
+ :'locked_recipient_phone_auth_editable' => :'String',
242
+ :'locked_recipient_sms_editable' => :'String',
189
243
  :'name' => :'String',
190
244
  :'note' => :'String',
245
+ :'note_metadata' => :'PropertyMetadata',
191
246
  :'phone_authentication' => :'RecipientPhoneAuthentication',
192
247
  :'recipient_attachments' => :'Array<RecipientAttachment>',
193
248
  :'recipient_authentication_status' => :'AuthenticationStatus',
249
+ :'recipient_feature_metadata' => :'Array<FeatureAvailableMetadata>',
194
250
  :'recipient_id' => :'String',
195
251
  :'recipient_id_guid' => :'String',
196
252
  :'recipient_signature_providers' => :'Array<RecipientSignatureProvider>',
253
+ :'recipient_type' => :'String',
254
+ :'recipient_type_metadata' => :'PropertyMetadata',
197
255
  :'require_id_lookup' => :'String',
256
+ :'require_id_lookup_metadata' => :'PropertyMetadata',
198
257
  :'role_name' => :'String',
199
258
  :'routing_order' => :'String',
200
- :'saml_authentication' => :'RecipientSAMLAuthentication',
259
+ :'routing_order_metadata' => :'PropertyMetadata',
201
260
  :'sent_date_time' => :'String',
202
261
  :'signed_date_time' => :'String',
203
262
  :'sms_authentication' => :'RecipientSMSAuthentication',
204
263
  :'social_authentications' => :'Array<SocialAuthentication>',
205
264
  :'status' => :'String',
265
+ :'status_code' => :'String',
266
+ :'suppress_emails' => :'String',
206
267
  :'tabs' => :'Tabs',
207
268
  :'template_locked' => :'String',
208
269
  :'template_required' => :'String',
@@ -217,12 +278,16 @@ module DocuSign_eSign
217
278
  return unless attributes.is_a?(Hash)
218
279
 
219
280
  # convert string to symbol for hash key
220
- attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
281
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
221
282
 
222
283
  if attributes.has_key?(:'accessCode')
223
284
  self.access_code = attributes[:'accessCode']
224
285
  end
225
286
 
287
+ if attributes.has_key?(:'accessCodeMetadata')
288
+ self.access_code_metadata = attributes[:'accessCodeMetadata']
289
+ end
290
+
226
291
  if attributes.has_key?(:'addAccessCodeToEmail')
227
292
  self.add_access_code_to_email = attributes[:'addAccessCodeToEmail']
228
293
  end
@@ -231,6 +296,10 @@ module DocuSign_eSign
231
296
  self.client_user_id = attributes[:'clientUserId']
232
297
  end
233
298
 
299
+ if attributes.has_key?(:'completedCount')
300
+ self.completed_count = attributes[:'completedCount']
301
+ end
302
+
234
303
  if attributes.has_key?(:'customFields')
235
304
  if (value = attributes[:'customFields']).is_a?(Array)
236
305
  self.custom_fields = value
@@ -253,6 +322,10 @@ module DocuSign_eSign
253
322
  self.delivery_method = attributes[:'deliveryMethod']
254
323
  end
255
324
 
325
+ if attributes.has_key?(:'deliveryMethodMetadata')
326
+ self.delivery_method_metadata = attributes[:'deliveryMethodMetadata']
327
+ end
328
+
256
329
  if attributes.has_key?(:'documentVisibility')
257
330
  if (value = attributes[:'documentVisibility']).is_a?(Array)
258
331
  self.document_visibility = value
@@ -275,22 +348,34 @@ module DocuSign_eSign
275
348
  self.fax_number = attributes[:'faxNumber']
276
349
  end
277
350
 
351
+ if attributes.has_key?(:'faxNumberMetadata')
352
+ self.fax_number_metadata = attributes[:'faxNumberMetadata']
353
+ end
354
+
278
355
  if attributes.has_key?(:'idCheckConfigurationName')
279
356
  self.id_check_configuration_name = attributes[:'idCheckConfigurationName']
280
357
  end
281
358
 
282
- if attributes.has_key?(:'idCheckInformationInput')
283
- self.id_check_information_input = attributes[:'idCheckInformationInput']
359
+ if attributes.has_key?(:'idCheckConfigurationNameMetadata')
360
+ self.id_check_configuration_name_metadata = attributes[:'idCheckConfigurationNameMetadata']
284
361
  end
285
362
 
286
- if attributes.has_key?(:'identityVerification')
287
- self.identity_verification = attributes[:'identityVerification']
363
+ if attributes.has_key?(:'idCheckInformationInput')
364
+ self.id_check_information_input = attributes[:'idCheckInformationInput']
288
365
  end
289
366
 
290
367
  if attributes.has_key?(:'inheritEmailNotificationConfiguration')
291
368
  self.inherit_email_notification_configuration = attributes[:'inheritEmailNotificationConfiguration']
292
369
  end
293
370
 
371
+ if attributes.has_key?(:'lockedRecipientPhoneAuthEditable')
372
+ self.locked_recipient_phone_auth_editable = attributes[:'lockedRecipientPhoneAuthEditable']
373
+ end
374
+
375
+ if attributes.has_key?(:'lockedRecipientSmsEditable')
376
+ self.locked_recipient_sms_editable = attributes[:'lockedRecipientSmsEditable']
377
+ end
378
+
294
379
  if attributes.has_key?(:'name')
295
380
  self.name = attributes[:'name']
296
381
  end
@@ -299,6 +384,10 @@ module DocuSign_eSign
299
384
  self.note = attributes[:'note']
300
385
  end
301
386
 
387
+ if attributes.has_key?(:'noteMetadata')
388
+ self.note_metadata = attributes[:'noteMetadata']
389
+ end
390
+
302
391
  if attributes.has_key?(:'phoneAuthentication')
303
392
  self.phone_authentication = attributes[:'phoneAuthentication']
304
393
  end
@@ -313,6 +402,12 @@ module DocuSign_eSign
313
402
  self.recipient_authentication_status = attributes[:'recipientAuthenticationStatus']
314
403
  end
315
404
 
405
+ if attributes.has_key?(:'recipientFeatureMetadata')
406
+ if (value = attributes[:'recipientFeatureMetadata']).is_a?(Array)
407
+ self.recipient_feature_metadata = value
408
+ end
409
+ end
410
+
316
411
  if attributes.has_key?(:'recipientId')
317
412
  self.recipient_id = attributes[:'recipientId']
318
413
  end
@@ -327,10 +422,22 @@ module DocuSign_eSign
327
422
  end
328
423
  end
329
424
 
425
+ if attributes.has_key?(:'recipientType')
426
+ self.recipient_type = attributes[:'recipientType']
427
+ end
428
+
429
+ if attributes.has_key?(:'recipientTypeMetadata')
430
+ self.recipient_type_metadata = attributes[:'recipientTypeMetadata']
431
+ end
432
+
330
433
  if attributes.has_key?(:'requireIdLookup')
331
434
  self.require_id_lookup = attributes[:'requireIdLookup']
332
435
  end
333
436
 
437
+ if attributes.has_key?(:'requireIdLookupMetadata')
438
+ self.require_id_lookup_metadata = attributes[:'requireIdLookupMetadata']
439
+ end
440
+
334
441
  if attributes.has_key?(:'roleName')
335
442
  self.role_name = attributes[:'roleName']
336
443
  end
@@ -339,8 +446,8 @@ module DocuSign_eSign
339
446
  self.routing_order = attributes[:'routingOrder']
340
447
  end
341
448
 
342
- if attributes.has_key?(:'samlAuthentication')
343
- self.saml_authentication = attributes[:'samlAuthentication']
449
+ if attributes.has_key?(:'routingOrderMetadata')
450
+ self.routing_order_metadata = attributes[:'routingOrderMetadata']
344
451
  end
345
452
 
346
453
  if attributes.has_key?(:'sentDateTime')
@@ -365,6 +472,14 @@ module DocuSign_eSign
365
472
  self.status = attributes[:'status']
366
473
  end
367
474
 
475
+ if attributes.has_key?(:'statusCode')
476
+ self.status_code = attributes[:'statusCode']
477
+ end
478
+
479
+ if attributes.has_key?(:'suppressEmails')
480
+ self.suppress_emails = attributes[:'suppressEmails']
481
+ end
482
+
368
483
  if attributes.has_key?(:'tabs')
369
484
  self.tabs = attributes[:'tabs']
370
485
  end
@@ -384,19 +499,20 @@ module DocuSign_eSign
384
499
  if attributes.has_key?(:'userId')
385
500
  self.user_id = attributes[:'userId']
386
501
  end
502
+
387
503
  end
388
504
 
389
505
  # Show invalid properties with the reasons. Usually used together with valid?
390
- # @return Array for valid properties with the reasons
506
+ # @return Array for valid properies with the reasons
391
507
  def list_invalid_properties
392
508
  invalid_properties = Array.new
393
- invalid_properties
509
+ return invalid_properties
394
510
  end
395
511
 
396
512
  # Check to see if the all the properties in the model are valid
397
513
  # @return true if the model is valid
398
514
  def valid?
399
- true
515
+ return true
400
516
  end
401
517
 
402
518
  # Checks equality by comparing each attribute.
@@ -405,39 +521,52 @@ module DocuSign_eSign
405
521
  return true if self.equal?(o)
406
522
  self.class == o.class &&
407
523
  access_code == o.access_code &&
524
+ access_code_metadata == o.access_code_metadata &&
408
525
  add_access_code_to_email == o.add_access_code_to_email &&
409
526
  client_user_id == o.client_user_id &&
527
+ completed_count == o.completed_count &&
410
528
  custom_fields == o.custom_fields &&
411
529
  declined_date_time == o.declined_date_time &&
412
530
  declined_reason == o.declined_reason &&
413
531
  delivered_date_time == o.delivered_date_time &&
414
532
  delivery_method == o.delivery_method &&
533
+ delivery_method_metadata == o.delivery_method_metadata &&
415
534
  document_visibility == o.document_visibility &&
416
535
  email_notification == o.email_notification &&
417
536
  embedded_recipient_start_url == o.embedded_recipient_start_url &&
418
537
  error_details == o.error_details &&
419
538
  fax_number == o.fax_number &&
539
+ fax_number_metadata == o.fax_number_metadata &&
420
540
  id_check_configuration_name == o.id_check_configuration_name &&
541
+ id_check_configuration_name_metadata == o.id_check_configuration_name_metadata &&
421
542
  id_check_information_input == o.id_check_information_input &&
422
- identity_verification == o.identity_verification &&
423
543
  inherit_email_notification_configuration == o.inherit_email_notification_configuration &&
544
+ locked_recipient_phone_auth_editable == o.locked_recipient_phone_auth_editable &&
545
+ locked_recipient_sms_editable == o.locked_recipient_sms_editable &&
424
546
  name == o.name &&
425
547
  note == o.note &&
548
+ note_metadata == o.note_metadata &&
426
549
  phone_authentication == o.phone_authentication &&
427
550
  recipient_attachments == o.recipient_attachments &&
428
551
  recipient_authentication_status == o.recipient_authentication_status &&
552
+ recipient_feature_metadata == o.recipient_feature_metadata &&
429
553
  recipient_id == o.recipient_id &&
430
554
  recipient_id_guid == o.recipient_id_guid &&
431
555
  recipient_signature_providers == o.recipient_signature_providers &&
556
+ recipient_type == o.recipient_type &&
557
+ recipient_type_metadata == o.recipient_type_metadata &&
432
558
  require_id_lookup == o.require_id_lookup &&
559
+ require_id_lookup_metadata == o.require_id_lookup_metadata &&
433
560
  role_name == o.role_name &&
434
561
  routing_order == o.routing_order &&
435
- saml_authentication == o.saml_authentication &&
562
+ routing_order_metadata == o.routing_order_metadata &&
436
563
  sent_date_time == o.sent_date_time &&
437
564
  signed_date_time == o.signed_date_time &&
438
565
  sms_authentication == o.sms_authentication &&
439
566
  social_authentications == o.social_authentications &&
440
567
  status == o.status &&
568
+ status_code == o.status_code &&
569
+ suppress_emails == o.suppress_emails &&
441
570
  tabs == o.tabs &&
442
571
  template_locked == o.template_locked &&
443
572
  template_required == o.template_required &&
@@ -454,7 +583,7 @@ module DocuSign_eSign
454
583
  # Calculates hash code according to all attributes.
455
584
  # @return [Fixnum] Hash code
456
585
  def hash
457
- [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_notification, embedded_recipient_start_url, error_details, fax_number, id_check_configuration_name, id_check_information_input, identity_verification, inherit_email_notification_configuration, name, note, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_id, recipient_id_guid, recipient_signature_providers, require_id_lookup, role_name, routing_order, saml_authentication, sent_date_time, signed_date_time, sms_authentication, social_authentications, status, tabs, template_locked, template_required, total_tab_count, user_id].hash
586
+ [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_notification, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, inherit_email_notification_configuration, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, note, note_metadata, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, 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, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
458
587
  end
459
588
 
460
589
  # Builds the object from hash
@@ -464,10 +593,10 @@ module DocuSign_eSign
464
593
  return nil unless attributes.is_a?(Hash)
465
594
  self.class.swagger_types.each_pair do |key, type|
466
595
  if type =~ /\AArray<(.*)>/i
467
- # check to ensure the input is an array given that the attribute
596
+ # check to ensure the input is an array given that the the attribute
468
597
  # is documented as an array but the input is not
469
598
  if attributes[self.class.attribute_map[key]].is_a?(Array)
470
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
599
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
471
600
  end
472
601
  elsif !attributes[self.class.attribute_map[key]].nil?
473
602
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -549,7 +678,7 @@ module DocuSign_eSign
549
678
  # @return [Hash] Returns the value in the form of hash
550
679
  def _to_hash(value)
551
680
  if value.is_a?(Array)
552
- value.compact.map { |v| _to_hash(v) }
681
+ value.compact.map{ |v| _to_hash(v) }
553
682
  elsif value.is_a?(Hash)
554
683
  {}.tap do |hash|
555
684
  value.each { |k, v| hash[k] = _to_hash(v) }
@@ -562,4 +691,5 @@ module DocuSign_eSign
562
691
  end
563
692
 
564
693
  end
694
+
565
695
  end
@@ -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,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
+
15
16
  class SeatDiscount
16
17
  # Reserved: TBD
17
18
  attr_accessor :begin_seat_count
@@ -22,6 +23,7 @@ module DocuSign_eSign
22
23
  # Reserved: TBD
23
24
  attr_accessor :end_seat_count
24
25
 
26
+
25
27
  # Attribute mapping from ruby-style variable name to JSON key.
26
28
  def self.attribute_map
27
29
  {
@@ -46,7 +48,7 @@ module DocuSign_eSign
46
48
  return unless attributes.is_a?(Hash)
47
49
 
48
50
  # convert string to symbol for hash key
49
- attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
51
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
50
52
 
51
53
  if attributes.has_key?(:'beginSeatCount')
52
54
  self.begin_seat_count = attributes[:'beginSeatCount']
@@ -59,19 +61,20 @@ module DocuSign_eSign
59
61
  if attributes.has_key?(:'endSeatCount')
60
62
  self.end_seat_count = attributes[:'endSeatCount']
61
63
  end
64
+
62
65
  end
63
66
 
64
67
  # Show invalid properties with the reasons. Usually used together with valid?
65
- # @return Array for valid properties with the reasons
68
+ # @return Array for valid properies with the reasons
66
69
  def list_invalid_properties
67
70
  invalid_properties = Array.new
68
- invalid_properties
71
+ return invalid_properties
69
72
  end
70
73
 
71
74
  # Check to see if the all the properties in the model are valid
72
75
  # @return true if the model is valid
73
76
  def valid?
74
- true
77
+ return true
75
78
  end
76
79
 
77
80
  # Checks equality by comparing each attribute.
@@ -103,10 +106,10 @@ module DocuSign_eSign
103
106
  return nil unless attributes.is_a?(Hash)
104
107
  self.class.swagger_types.each_pair do |key, type|
105
108
  if type =~ /\AArray<(.*)>/i
106
- # check to ensure the input is an array given that the attribute
109
+ # check to ensure the input is an array given that the the attribute
107
110
  # is documented as an array but the input is not
108
111
  if attributes[self.class.attribute_map[key]].is_a?(Array)
109
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
112
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
110
113
  end
111
114
  elsif !attributes[self.class.attribute_map[key]].nil?
112
115
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -188,7 +191,7 @@ module DocuSign_eSign
188
191
  # @return [Hash] Returns the value in the form of hash
189
192
  def _to_hash(value)
190
193
  if value.is_a?(Array)
191
- value.compact.map { |v| _to_hash(v) }
194
+ value.compact.map{ |v| _to_hash(v) }
192
195
  elsif value.is_a?(Hash)
193
196
  {}.tap do |hash|
194
197
  value.each { |k, v| hash[k] = _to_hash(v) }
@@ -201,4 +204,5 @@ module DocuSign_eSign
201
204
  end
202
205
 
203
206
  end
207
+
204
208
  end