docusign_esign 3.12.0 → 3.19.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (355) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +54 -0
  3. data/docusign_esign.gemspec +5 -5
  4. data/lib/docusign_esign/api/accounts_api.rb +83 -433
  5. data/lib/docusign_esign/api/billing_api.rb +12 -4
  6. data/lib/docusign_esign/api/bulk_envelopes_api.rb +93 -26
  7. data/lib/docusign_esign/api/bulk_process_data_api.rb +412 -0
  8. data/lib/docusign_esign/api/bulk_process_data_send_api.rb +252 -0
  9. data/lib/docusign_esign/api/connect_api.rb +239 -5
  10. data/lib/docusign_esign/api/email_archive_api.rb +8 -8
  11. data/lib/docusign_esign/api/envelopes_api.rb +1435 -207
  12. data/lib/docusign_esign/api/notary_api.rb +16 -16
  13. data/lib/docusign_esign/api/organizations_api.rb +8 -60
  14. data/lib/docusign_esign/api/power_forms_api.rb +24 -16
  15. data/lib/docusign_esign/api/templates_api.rb +20 -79
  16. data/lib/docusign_esign/api/users_api.rb +22 -14
  17. data/lib/docusign_esign/api/workspaces_api.rb +4 -4
  18. data/lib/docusign_esign/client/api_client.rb +16 -10
  19. data/lib/docusign_esign/client/api_error.rb +1 -1
  20. data/lib/docusign_esign/client/auth/oauth.rb +1 -1
  21. data/lib/docusign_esign/models/access_code_format.rb +6 -0
  22. data/lib/docusign_esign/models/account_billing_plan.rb +25 -4
  23. data/lib/docusign_esign/models/account_billing_plan_response.rb +37 -10
  24. data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
  25. data/lib/docusign_esign/models/account_identity_verification_workflow.rb +2 -0
  26. data/lib/docusign_esign/models/account_information.rb +11 -1
  27. data/lib/docusign_esign/models/account_notification.rb +3 -0
  28. data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
  29. data/lib/docusign_esign/models/account_password_rules.rb +7 -0
  30. data/lib/docusign_esign/models/account_role_settings.rb +81 -4
  31. data/lib/docusign_esign/models/account_settings_information.rb +1075 -13
  32. data/lib/docusign_esign/models/account_shared_access.rb +1 -0
  33. data/lib/docusign_esign/models/account_signature.rb +2 -0
  34. data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
  35. data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
  36. data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
  37. data/lib/docusign_esign/models/account_ui_settings.rb +28 -13
  38. data/lib/docusign_esign/models/address_information_input.rb +1 -0
  39. data/lib/docusign_esign/models/agent.rb +45 -1
  40. data/lib/docusign_esign/models/app_store_receipt.rb +21 -1
  41. data/lib/docusign_esign/models/approve.rb +65 -1
  42. data/lib/docusign_esign/models/authentication_status.rb +19 -0
  43. data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
  44. data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
  45. data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
  46. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  47. data/lib/docusign_esign/models/billing_entity_information_response.rb +214 -0
  48. data/lib/docusign_esign/models/billing_invoice_item.rb +21 -1
  49. data/lib/docusign_esign/models/billing_invoices_summary.rb +21 -1
  50. data/lib/docusign_esign/models/billing_plan_information.rb +52 -4
  51. data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
  52. data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
  53. data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
  54. data/lib/docusign_esign/models/brand.rb +4 -0
  55. data/lib/docusign_esign/models/brand_email_content.rb +1 -0
  56. data/lib/docusign_esign/models/brand_link.rb +1 -0
  57. data/lib/docusign_esign/models/brand_logos.rb +1 -0
  58. data/lib/docusign_esign/models/brand_request.rb +1 -0
  59. data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
  60. data/lib/docusign_esign/models/brand_resources.rb +3 -0
  61. data/lib/docusign_esign/models/brands_request.rb +1 -0
  62. data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
  63. data/lib/docusign_esign/models/bulk_process_request.rb +194 -0
  64. data/lib/docusign_esign/models/bulk_process_response.rb +248 -0
  65. data/lib/docusign_esign/models/bulk_process_result.rb +206 -0
  66. data/lib/docusign_esign/models/bulk_processing_list_summaries.rb +186 -0
  67. data/lib/docusign_esign/models/bulk_processing_list_summary.rb +214 -0
  68. data/lib/docusign_esign/models/bulk_processing_lists.rb +186 -0
  69. data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
  70. data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +204 -0
  71. data/lib/docusign_esign/models/bulk_send_batch_error.rb +194 -0
  72. data/lib/docusign_esign/models/bulk_send_batch_status.rb +42 -1
  73. data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +22 -1
  74. data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
  75. data/lib/docusign_esign/models/bulk_send_envelopes_info.rb +304 -0
  76. data/lib/docusign_esign/models/bulk_send_error_status.rb +12 -1
  77. data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
  78. data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
  79. data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
  80. data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
  81. data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
  82. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
  83. data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
  84. data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
  85. data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
  86. data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
  87. data/lib/docusign_esign/models/captive_recipient.rb +2 -0
  88. data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
  89. data/lib/docusign_esign/models/carbon_copy.rb +48 -1
  90. data/lib/docusign_esign/models/certified_delivery.rb +47 -1
  91. data/lib/docusign_esign/models/checkbox.rb +109 -1
  92. data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
  93. data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
  94. data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
  95. data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
  96. data/lib/docusign_esign/models/comment_thread.rb +63 -1
  97. data/lib/docusign_esign/models/commission_county.rb +72 -1
  98. data/lib/docusign_esign/models/commission_expiration.rb +72 -1
  99. data/lib/docusign_esign/models/commission_number.rb +72 -1
  100. data/lib/docusign_esign/models/commission_state.rb +72 -1
  101. data/lib/docusign_esign/models/company.rb +72 -1
  102. data/lib/docusign_esign/models/composite_template.rb +2 -0
  103. data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
  104. data/lib/docusign_esign/models/connect_config_results.rb +1 -0
  105. data/lib/docusign_esign/models/connect_custom_configuration.rb +60 -4
  106. data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
  107. data/lib/docusign_esign/models/connect_delete_failure_result.rb +174 -0
  108. data/lib/docusign_esign/models/connect_event_data.rb +1 -0
  109. data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
  110. data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
  111. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +195 -0
  112. data/lib/docusign_esign/models/connect_log.rb +1 -0
  113. data/lib/docusign_esign/models/connect_o_auth_config.rb +214 -0
  114. data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
  115. data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
  116. data/lib/docusign_esign/models/connect_user_info.rb +214 -0
  117. data/lib/docusign_esign/models/consent_details.rb +204 -0
  118. data/lib/docusign_esign/models/console_view_request.rb +1 -0
  119. data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
  120. data/lib/docusign_esign/models/contact.rb +12 -1
  121. data/lib/docusign_esign/models/contact_get_response.rb +1 -0
  122. data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
  123. data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
  124. data/lib/docusign_esign/models/contact_update_response.rb +1 -0
  125. data/lib/docusign_esign/models/correct_view_request.rb +12 -1
  126. data/lib/docusign_esign/models/credit_card_information.rb +2 -0
  127. data/lib/docusign_esign/models/currency.rb +95 -1
  128. data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
  129. data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
  130. data/lib/docusign_esign/models/custom_field.rb +2 -0
  131. data/lib/docusign_esign/models/date.rb +98 -1
  132. data/lib/docusign_esign/models/date_signed.rb +66 -1
  133. data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
  134. data/lib/docusign_esign/models/decline.rb +66 -1
  135. data/lib/docusign_esign/models/delayed_routing.rb +206 -0
  136. data/lib/docusign_esign/models/delayed_routing_api_model.rb +206 -0
  137. data/lib/docusign_esign/models/delegation_info.rb +214 -0
  138. data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
  139. data/lib/docusign_esign/models/document.rb +3 -0
  140. data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
  141. data/lib/docusign_esign/models/document_html_definition.rb +1 -0
  142. data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
  143. data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
  144. data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
  145. data/lib/docusign_esign/models/document_template.rb +1 -0
  146. data/lib/docusign_esign/models/document_visibility.rb +2 -0
  147. data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
  148. data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
  149. data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
  150. data/lib/docusign_esign/models/downgrade_plan_update_response.rb +11 -1
  151. data/lib/docusign_esign/models/downgrade_request_information.rb +204 -0
  152. data/lib/docusign_esign/models/draw.rb +60 -1
  153. data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
  154. data/lib/docusign_esign/models/editor.rb +46 -1
  155. data/lib/docusign_esign/models/email.rb +98 -1
  156. data/lib/docusign_esign/models/email_address.rb +66 -1
  157. data/lib/docusign_esign/models/envelope.rb +20 -1
  158. data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
  159. data/lib/docusign_esign/models/envelope_custom_metadata.rb +186 -0
  160. data/lib/docusign_esign/models/envelope_definition.rb +23 -1
  161. data/lib/docusign_esign/models/envelope_delay_rule.rb +194 -0
  162. data/lib/docusign_esign/models/envelope_delay_rule_api_model.rb +195 -0
  163. data/lib/docusign_esign/models/envelope_document.rb +7 -0
  164. data/lib/docusign_esign/models/envelope_event.rb +1 -0
  165. data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
  166. data/lib/docusign_esign/models/envelope_id.rb +65 -1
  167. data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
  168. data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
  169. data/lib/docusign_esign/models/envelope_publish_transaction.rb +307 -0
  170. data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -0
  171. data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
  172. data/lib/docusign_esign/models/envelope_summary.rb +3 -0
  173. data/lib/docusign_esign/models/envelope_template.rb +22 -1
  174. data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
  175. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
  176. data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
  177. data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
  178. data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
  179. data/lib/docusign_esign/models/envelopes_information.rb +1 -0
  180. data/lib/docusign_esign/models/event_notification.rb +24 -1
  181. data/lib/docusign_esign/models/event_result.rb +1 -0
  182. data/lib/docusign_esign/models/external_document_sources.rb +6 -0
  183. data/lib/docusign_esign/models/external_file.rb +1 -0
  184. data/lib/docusign_esign/models/external_folder.rb +1 -0
  185. data/lib/docusign_esign/models/external_primary_account_recipient_auth_requirements.rb +214 -0
  186. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
  187. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
  188. data/lib/docusign_esign/models/feature_set.rb +1 -0
  189. data/lib/docusign_esign/models/filter.rb +1 -0
  190. data/lib/docusign_esign/models/first_name.rb +66 -1
  191. data/lib/docusign_esign/models/folder.rb +4 -0
  192. data/lib/docusign_esign/models/folder_item_response.rb +1 -0
  193. data/lib/docusign_esign/models/folder_item_v2.rb +13 -1
  194. data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
  195. data/lib/docusign_esign/models/folders_request.rb +1 -0
  196. data/lib/docusign_esign/models/form_data_item.rb +1 -0
  197. data/lib/docusign_esign/models/formula_tab.rb +103 -1
  198. data/lib/docusign_esign/models/full_name.rb +66 -1
  199. data/lib/docusign_esign/models/group.rb +13 -1
  200. data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
  201. data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
  202. data/lib/docusign_esign/models/id_evidence_resource_token.rb +194 -0
  203. data/lib/docusign_esign/models/id_evidence_view_link.rb +184 -0
  204. data/lib/docusign_esign/models/in_person_signer.rb +31 -0
  205. data/lib/docusign_esign/models/initial_here.rb +60 -1
  206. data/lib/docusign_esign/models/inline_template.rb +3 -0
  207. data/lib/docusign_esign/models/integrated_connect_user_info_list.rb +246 -0
  208. data/lib/docusign_esign/models/intermediary.rb +46 -1
  209. data/lib/docusign_esign/models/jurisdiction.rb +1 -0
  210. data/lib/docusign_esign/models/last_name.rb +66 -1
  211. data/lib/docusign_esign/models/linked_external_primary_account.rb +21 -1
  212. data/lib/docusign_esign/models/list.rb +112 -1
  213. data/lib/docusign_esign/models/list_custom_field.rb +2 -0
  214. data/lib/docusign_esign/models/list_item.rb +4 -0
  215. data/lib/docusign_esign/models/locale_policy.rb +13 -0
  216. data/lib/docusign_esign/models/lock_information.rb +2 -0
  217. data/lib/docusign_esign/models/lock_request.rb +1 -0
  218. data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
  219. data/lib/docusign_esign/models/member_shared_items.rb +3 -0
  220. data/lib/docusign_esign/models/merge_field.rb +6 -0
  221. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
  222. data/lib/docusign_esign/models/money.rb +1 -0
  223. data/lib/docusign_esign/models/name_value.rb +2 -0
  224. data/lib/docusign_esign/models/new_account_definition.rb +53 -4
  225. data/lib/docusign_esign/models/new_account_summary.rb +1 -0
  226. data/lib/docusign_esign/models/new_user.rb +2 -0
  227. data/lib/docusign_esign/models/new_users_summary.rb +1 -0
  228. data/lib/docusign_esign/models/notarize.rb +58 -1
  229. data/lib/docusign_esign/models/notary.rb +1 -0
  230. data/lib/docusign_esign/models/notary_host.rb +20 -0
  231. data/lib/docusign_esign/models/notary_journal.rb +2 -0
  232. data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
  233. data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
  234. data/lib/docusign_esign/models/notary_recipient.rb +93 -1
  235. data/lib/docusign_esign/models/notary_result.rb +2 -0
  236. data/lib/docusign_esign/models/notary_seal.rb +59 -1
  237. data/lib/docusign_esign/models/note.rb +67 -1
  238. data/lib/docusign_esign/models/notification.rb +2 -0
  239. data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
  240. data/lib/docusign_esign/models/notification_defaults.rb +2 -0
  241. data/lib/docusign_esign/models/number.rb +100 -1
  242. data/lib/docusign_esign/models/page.rb +1 -0
  243. data/lib/docusign_esign/models/participant.rb +908 -0
  244. data/lib/docusign_esign/models/payment_details.rb +16 -1
  245. data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
  246. data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
  247. data/lib/docusign_esign/models/payment_line_item.rb +1 -0
  248. data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
  249. data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
  250. data/lib/docusign_esign/models/permission_profile.rb +2 -0
  251. data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
  252. data/lib/docusign_esign/models/phone_number.rb +72 -1
  253. data/lib/docusign_esign/models/poly_line_overlay.rb +60 -1
  254. data/lib/docusign_esign/models/power_form.rb +2 -0
  255. data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
  256. data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
  257. data/lib/docusign_esign/models/power_forms_response.rb +1 -0
  258. data/lib/docusign_esign/models/prefill_tabs.rb +65 -4
  259. data/lib/docusign_esign/models/property_metadata.rb +1 -0
  260. data/lib/docusign_esign/models/radio.rb +48 -1
  261. data/lib/docusign_esign/models/radio_group.rb +78 -4
  262. data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
  263. data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
  264. data/lib/docusign_esign/models/recipient_group.rb +1 -0
  265. data/lib/docusign_esign/models/recipient_identity_phone_number.rb +44 -4
  266. data/lib/docusign_esign/models/recipient_identity_verification.rb +15 -4
  267. data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
  268. data/lib/docusign_esign/models/recipient_option.rb +1 -0
  269. data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
  270. data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
  271. data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
  272. data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
  273. data/lib/docusign_esign/models/recipient_routing.rb +2 -0
  274. data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
  275. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
  276. data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
  277. data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +102 -2
  278. data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
  279. data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
  280. data/lib/docusign_esign/models/recipients.rb +14 -1
  281. data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
  282. data/lib/docusign_esign/models/reserved_domain_existence.rb +194 -0
  283. data/lib/docusign_esign/models/return_url_request.rb +1 -0
  284. data/lib/docusign_esign/models/scheduled_sending.rb +216 -0
  285. data/lib/docusign_esign/models/scheduled_sending_api_model.rb +206 -0
  286. data/lib/docusign_esign/models/seal_sign.rb +17 -0
  287. data/lib/docusign_esign/models/seat_discount.rb +1 -0
  288. data/lib/docusign_esign/models/sender_company.rb +65 -1
  289. data/lib/docusign_esign/models/sender_email_notifications.rb +12 -1
  290. data/lib/docusign_esign/models/sender_name.rb +65 -1
  291. data/lib/docusign_esign/models/settings_metadata.rb +1 -0
  292. data/lib/docusign_esign/models/shared_item.rb +3 -0
  293. data/lib/docusign_esign/models/sign_here.rb +62 -1
  294. data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
  295. data/lib/docusign_esign/models/signature_type.rb +1 -0
  296. data/lib/docusign_esign/models/signer.rb +84 -1
  297. data/lib/docusign_esign/models/signer_attachment.rb +60 -1
  298. data/lib/docusign_esign/models/signing_group.rb +2 -0
  299. data/lib/docusign_esign/models/signing_group_user.rb +1 -0
  300. data/lib/docusign_esign/models/smart_section.rb +61 -1
  301. data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
  302. data/lib/docusign_esign/models/social_account_information.rb +1 -0
  303. data/lib/docusign_esign/models/ssn.rb +98 -1
  304. data/lib/docusign_esign/models/stamp.rb +2 -0
  305. data/lib/docusign_esign/models/supported_languages.rb +1 -0
  306. data/lib/docusign_esign/models/tab_account_settings.rb +42 -1
  307. data/lib/docusign_esign/models/tab_group.rb +61 -1
  308. data/lib/docusign_esign/models/tab_metadata.rb +34 -1
  309. data/lib/docusign_esign/models/tabs.rb +2 -0
  310. data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
  311. data/lib/docusign_esign/models/template_notification_request.rb +2 -0
  312. data/lib/docusign_esign/models/template_recipients.rb +14 -1
  313. data/lib/docusign_esign/models/template_role.rb +4 -0
  314. data/lib/docusign_esign/models/template_shared_item.rb +3 -0
  315. data/lib/docusign_esign/models/template_summary.rb +3 -0
  316. data/lib/docusign_esign/models/template_tabs.rb +1 -0
  317. data/lib/docusign_esign/models/template_update_summary.rb +4 -0
  318. data/lib/docusign_esign/models/text.rb +100 -1
  319. data/lib/docusign_esign/models/text_custom_field.rb +2 -0
  320. data/lib/docusign_esign/models/title.rb +72 -1
  321. data/lib/docusign_esign/models/user_account_management_granular_information.rb +70 -1
  322. data/lib/docusign_esign/models/user_info.rb +1 -0
  323. data/lib/docusign_esign/models/user_information.rb +17 -1
  324. data/lib/docusign_esign/models/user_information_list.rb +1 -0
  325. data/lib/docusign_esign/models/user_password_information.rb +1 -0
  326. data/lib/docusign_esign/models/user_password_rules.rb +2 -0
  327. data/lib/docusign_esign/models/user_profile.rb +3 -0
  328. data/lib/docusign_esign/models/user_settings_information.rb +103 -4
  329. data/lib/docusign_esign/models/user_shared_item.rb +3 -0
  330. data/lib/docusign_esign/models/user_signature.rb +2 -0
  331. data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
  332. data/lib/docusign_esign/models/view.rb +66 -1
  333. data/lib/docusign_esign/models/witness.rb +84 -1
  334. data/lib/docusign_esign/models/workflow.rb +32 -1
  335. data/lib/docusign_esign/models/workflow_step.rb +13 -1
  336. data/lib/docusign_esign/models/workspace.rb +4 -0
  337. data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
  338. data/lib/docusign_esign/models/workspace_item.rb +5 -0
  339. data/lib/docusign_esign/models/workspace_settings.rb +1 -0
  340. data/lib/docusign_esign/models/workspace_user.rb +1 -0
  341. data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
  342. data/lib/docusign_esign/models/zip.rb +99 -1
  343. data/lib/docusign_esign/version.rb +1 -1
  344. data/lib/docusign_esign.rb +30 -17
  345. data/tests/spec/unit_tests_using_jwt_spec.rb +605 -449
  346. metadata +70 -44
  347. data/Gemfile.lock +0 -73
  348. data/docusign_esign-2.12.0.rc1.gem +0 -0
  349. data/docusign_esign-3.12.0.rc1.gem +0 -0
  350. data/lib/docusign_esign/.DS_Store +0 -0
  351. data/lib/docusign_esign/api/.DS_Store +0 -0
  352. data/lib/docusign_esign/client/.DS_Store +0 -0
  353. data/tests/.DS_Store +0 -0
  354. data/tests/Gemfile.lock +0 -46
  355. data/tests/docs/private.pem +0 -27
@@ -12,82 +12,104 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # This tab offers a list of options to choose from. The `listItems` property contains a list of [`listItem`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) objects to specify the selectable options.
15
16
  class List
16
17
  #
17
18
  attr_accessor :anchor_allow_white_space_in_characters
18
19
 
20
+ # Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
19
21
  attr_accessor :anchor_allow_white_space_in_characters_metadata
20
22
 
21
23
  # When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
22
24
  attr_accessor :anchor_case_sensitive
23
25
 
26
+ # Metadata that indicates whether the `anchorCaseSensitive` property is editable.
24
27
  attr_accessor :anchor_case_sensitive_metadata
25
28
 
26
29
  # Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
27
30
  attr_accessor :anchor_horizontal_alignment
28
31
 
32
+ # Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
29
33
  attr_accessor :anchor_horizontal_alignment_metadata
30
34
 
31
35
  # When set to **true**, this tab is ignored if anchorString is not found in the document.
32
36
  attr_accessor :anchor_ignore_if_not_present
33
37
 
38
+ # Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
34
39
  attr_accessor :anchor_ignore_if_not_present_metadata
35
40
 
36
41
  # When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
37
42
  attr_accessor :anchor_match_whole_word
38
43
 
44
+ # Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
39
45
  attr_accessor :anchor_match_whole_word_metadata
40
46
 
41
47
  # Anchor text information for a radio button.
42
48
  attr_accessor :anchor_string
43
49
 
50
+ # Metadata that indicates whether the `anchorString` property is editable.
44
51
  attr_accessor :anchor_string_metadata
45
52
 
46
53
  #
47
54
  attr_accessor :anchor_tab_processor_version
48
55
 
56
+ # Reserved for DocuSign.
49
57
  attr_accessor :anchor_tab_processor_version_metadata
50
58
 
51
59
  # Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
52
60
  attr_accessor :anchor_units
53
61
 
62
+ # Metadata that indicates whether the `anchorUnits` property is editable.
54
63
  attr_accessor :anchor_units_metadata
55
64
 
56
65
  # Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
57
66
  attr_accessor :anchor_x_offset
58
67
 
68
+ # Metadata that indicates whether the `anchorXOffset` property is editable.
59
69
  attr_accessor :anchor_x_offset_metadata
60
70
 
61
71
  # Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
62
72
  attr_accessor :anchor_y_offset
63
73
 
74
+ # Metadata that indicates whether the `anchorYOffset` property is editable.
64
75
  attr_accessor :anchor_y_offset_metadata
65
76
 
66
77
  # When set to **true**, the information in the tab is bold.
67
78
  attr_accessor :bold
68
79
 
80
+ # Metadata that indicates whether the `bold` property is editable.
69
81
  attr_accessor :bold_metadata
70
82
 
83
+ #
84
+ attr_accessor :caption
85
+
86
+ attr_accessor :caption_metadata
87
+
71
88
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
72
89
  attr_accessor :conditional_parent_label
73
90
 
91
+ # Metadata that indicates whether the `conditionalParentLabel` property is editable.
74
92
  attr_accessor :conditional_parent_label_metadata
75
93
 
76
94
  # For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.
77
95
  attr_accessor :conditional_parent_value
78
96
 
97
+ # Metadata that indicates whether the `conditionalParentValue` property is editable.
79
98
  attr_accessor :conditional_parent_value_metadata
80
99
 
81
100
  # The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
82
101
  attr_accessor :custom_tab_id
83
102
 
103
+ # Metadata that indicates whether the `customTabId` property is editable.
84
104
  attr_accessor :custom_tab_id_metadata
85
105
 
86
106
  # Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
87
107
  attr_accessor :document_id
88
108
 
109
+ # Metadata that indicates whether the `documentId` property is editable.
89
110
  attr_accessor :document_id_metadata
90
111
 
112
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
91
113
  attr_accessor :error_details
92
114
 
93
115
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -96,38 +118,46 @@ module DocuSign_eSign
96
118
  # The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
97
119
  attr_accessor :font_color
98
120
 
121
+ # Metadata that indicates whether the `fontColor` property is editable.
99
122
  attr_accessor :font_color_metadata
100
123
 
124
+ # Metadata that indicates whether the `font` property is editable.
101
125
  attr_accessor :font_metadata
102
126
 
103
127
  # The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
104
128
  attr_accessor :font_size
105
129
 
130
+ # Metadata that indicates whether the `fontSize` property is editable.
106
131
  attr_accessor :font_size_metadata
107
132
 
108
133
  #
109
134
  attr_accessor :form_order
110
135
 
136
+ # Metadata that indicates whether the `formOrder` property is editable.
111
137
  attr_accessor :form_order_metadata
112
138
 
113
139
  #
114
140
  attr_accessor :form_page_label
115
141
 
142
+ # Metadata that indicates whether the `formPageLabel` property is editable.
116
143
  attr_accessor :form_page_label_metadata
117
144
 
118
145
  #
119
146
  attr_accessor :form_page_number
120
147
 
148
+ # Metadata that indicates whether the `fromPageNumber` property is editable.
121
149
  attr_accessor :form_page_number_metadata
122
150
 
123
151
  # Height of the tab in pixels.
124
152
  attr_accessor :height
125
153
 
154
+ # Metadata that indicates whether the `height` property is editable.
126
155
  attr_accessor :height_metadata
127
156
 
128
157
  # When set to **true**, the information in the tab is italic.
129
158
  attr_accessor :italic
130
159
 
160
+ # Metadata that indicates whether the `italic` property is editable.
131
161
  attr_accessor :italic_metadata
132
162
 
133
163
  # The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four] Maximum Length of listItems: 2048 characters. Maximum Length of items in the list: 100 characters.
@@ -136,23 +166,34 @@ module DocuSign_eSign
136
166
  #
137
167
  attr_accessor :list_selected_value
138
168
 
169
+ # Metadata that indicates whether the `listSelectedValue` property is editable.
139
170
  attr_accessor :list_selected_value_metadata
140
171
 
172
+ # Reserved for DocuSign.
141
173
  attr_accessor :locale_policy
142
174
 
143
175
  # When set to **true**, the signer cannot change the data of the custom tab.
144
176
  attr_accessor :locked
145
177
 
178
+ # Metadata that indicates whether the `locked` property is editable.
146
179
  attr_accessor :locked_metadata
147
180
 
181
+ # Contains the information necessary to map the tab to a field in SalesForce.
148
182
  attr_accessor :merge_field
149
183
 
150
184
  #
151
185
  attr_accessor :merge_field_xml
152
186
 
187
+ # The initial value of the tab when it was sent to the recipient.
188
+ attr_accessor :original_value
189
+
190
+ # Metadata that indicates whether the `originalValue` property is editable.
191
+ attr_accessor :original_value_metadata
192
+
153
193
  # Specifies the page number on which the tab is located.
154
194
  attr_accessor :page_number
155
195
 
196
+ # Metadata that indicates whether the `pageNumber` property is editable.
156
197
  attr_accessor :page_number_metadata
157
198
 
158
199
  # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
@@ -161,35 +202,49 @@ module DocuSign_eSign
161
202
  #
162
203
  attr_accessor :recipient_id_guid
163
204
 
205
+ # Metadata that indicates whether the `recipientIdGuid` property is editable.
164
206
  attr_accessor :recipient_id_guid_metadata
165
207
 
208
+ # Metadata that indicates whether the `recipientId` property is editable.
166
209
  attr_accessor :recipient_id_metadata
167
210
 
168
211
  # When set to **true** and shared is true, information must be entered in this field to complete the envelope.
169
212
  attr_accessor :require_all
170
213
 
214
+ # Metadata that indicates whether the `requireAll` property is editable.
171
215
  attr_accessor :require_all_metadata
172
216
 
173
217
  # When set to **true**, the signer is required to fill out this tab
174
218
  attr_accessor :required
175
219
 
220
+ # Metadata that indicates whether the `required` property is editable.
176
221
  attr_accessor :required_metadata
177
222
 
178
223
  # Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
179
224
  attr_accessor :require_initial_on_shared_change
180
225
 
226
+ # Metadata that indicates whether the `requireInitialOnSharedChange` property is editable.
181
227
  attr_accessor :require_initial_on_shared_change_metadata
182
228
 
183
229
  # When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
184
230
  attr_accessor :sender_required
185
231
 
232
+ # Metadata that indicates whether the `senderRequired` property is editable.
186
233
  attr_accessor :sender_required_metadata
187
234
 
188
235
  # When set to **true**, this custom tab is shared.
189
236
  attr_accessor :shared
190
237
 
238
+ # Metadata that indicates whether the `shared` property is editable.
191
239
  attr_accessor :shared_metadata
192
240
 
241
+ #
242
+ attr_accessor :share_to_recipients
243
+
244
+ # Reserved for DocuSign.
245
+ attr_accessor :share_to_recipients_metadata
246
+
247
+ # Reserved for DocuSign.
193
248
  attr_accessor :smart_contract_information
194
249
 
195
250
  #
@@ -198,71 +253,85 @@ module DocuSign_eSign
198
253
  # 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.
199
254
  attr_accessor :status
200
255
 
256
+ # Metadata that indicates whether the `status` property is editable.
201
257
  attr_accessor :status_metadata
202
258
 
203
259
  #
204
260
  attr_accessor :tab_group_labels
205
261
 
262
+ # Metadata that indicates whether the `tabGroupLabels` property is editable.
206
263
  attr_accessor :tab_group_labels_metadata
207
264
 
208
265
  # The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
209
266
  attr_accessor :tab_id
210
267
 
268
+ # Metadata that indicates whether the `tabId` property is editable.
211
269
  attr_accessor :tab_id_metadata
212
270
 
213
271
  # The label string associated with the tab.
214
272
  attr_accessor :tab_label
215
273
 
274
+ # Metadata that indicates whether the `tabLabel` property is editable.
216
275
  attr_accessor :tab_label_metadata
217
276
 
218
277
  #
219
278
  attr_accessor :tab_order
220
279
 
280
+ # Metadata that indicates whether the `tabOrder` property is editable.
221
281
  attr_accessor :tab_order_metadata
222
282
 
223
283
  #
224
284
  attr_accessor :tab_type
225
285
 
286
+ # Metadata that indicates whether the `tabType` property is editable.
226
287
  attr_accessor :tab_type_metadata
227
288
 
228
289
  # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
229
290
  attr_accessor :template_locked
230
291
 
292
+ # Metadata that indicates whether the `templateLocked` property is editable.
231
293
  attr_accessor :template_locked_metadata
232
294
 
233
295
  # When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
234
296
  attr_accessor :template_required
235
297
 
298
+ # Metadata that indicates whether the `templateRequired` property is editable.
236
299
  attr_accessor :template_required_metadata
237
300
 
238
301
  #
239
302
  attr_accessor :tooltip
240
303
 
304
+ # Metadata that indicates whether the `toolTip` property is editable.
241
305
  attr_accessor :tool_tip_metadata
242
306
 
243
307
  # When set to **true**, the information in the tab is underlined.
244
308
  attr_accessor :underline
245
309
 
310
+ # Metadata that indicates whether the `underline` property is editable.
246
311
  attr_accessor :underline_metadata
247
312
 
248
313
  # The value to use when the item is selected.
249
314
  attr_accessor :value
250
315
 
316
+ # Metadata that indicates whether the `value` property is editable.
251
317
  attr_accessor :value_metadata
252
318
 
253
319
  # Width of the tab in pixels.
254
320
  attr_accessor :width
255
321
 
322
+ # Metadata that indicates whether the `width` property is editable.
256
323
  attr_accessor :width_metadata
257
324
 
258
325
  # This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
259
326
  attr_accessor :x_position
260
327
 
328
+ # Metadata that indicates whether the `xPosition` property is editable.
261
329
  attr_accessor :x_position_metadata
262
330
 
263
331
  # This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
264
332
  attr_accessor :y_position
265
333
 
334
+ # Metadata that indicates whether the `yPosition` property is editable.
266
335
  attr_accessor :y_position_metadata
267
336
 
268
337
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -290,6 +359,8 @@ module DocuSign_eSign
290
359
  :'anchor_y_offset_metadata' => :'anchorYOffsetMetadata',
291
360
  :'bold' => :'bold',
292
361
  :'bold_metadata' => :'boldMetadata',
362
+ :'caption' => :'caption',
363
+ :'caption_metadata' => :'captionMetadata',
293
364
  :'conditional_parent_label' => :'conditionalParentLabel',
294
365
  :'conditional_parent_label_metadata' => :'conditionalParentLabelMetadata',
295
366
  :'conditional_parent_value' => :'conditionalParentValue',
@@ -323,6 +394,8 @@ module DocuSign_eSign
323
394
  :'locked_metadata' => :'lockedMetadata',
324
395
  :'merge_field' => :'mergeField',
325
396
  :'merge_field_xml' => :'mergeFieldXml',
397
+ :'original_value' => :'originalValue',
398
+ :'original_value_metadata' => :'originalValueMetadata',
326
399
  :'page_number' => :'pageNumber',
327
400
  :'page_number_metadata' => :'pageNumberMetadata',
328
401
  :'recipient_id' => :'recipientId',
@@ -339,6 +412,8 @@ module DocuSign_eSign
339
412
  :'sender_required_metadata' => :'senderRequiredMetadata',
340
413
  :'shared' => :'shared',
341
414
  :'shared_metadata' => :'sharedMetadata',
415
+ :'share_to_recipients' => :'shareToRecipients',
416
+ :'share_to_recipients_metadata' => :'shareToRecipientsMetadata',
342
417
  :'smart_contract_information' => :'smartContractInformation',
343
418
  :'source' => :'source',
344
419
  :'status' => :'status',
@@ -397,6 +472,8 @@ module DocuSign_eSign
397
472
  :'anchor_y_offset_metadata' => :'PropertyMetadata',
398
473
  :'bold' => :'String',
399
474
  :'bold_metadata' => :'PropertyMetadata',
475
+ :'caption' => :'String',
476
+ :'caption_metadata' => :'PropertyMetadata',
400
477
  :'conditional_parent_label' => :'String',
401
478
  :'conditional_parent_label_metadata' => :'PropertyMetadata',
402
479
  :'conditional_parent_value' => :'String',
@@ -430,6 +507,8 @@ module DocuSign_eSign
430
507
  :'locked_metadata' => :'PropertyMetadata',
431
508
  :'merge_field' => :'MergeField',
432
509
  :'merge_field_xml' => :'String',
510
+ :'original_value' => :'String',
511
+ :'original_value_metadata' => :'PropertyMetadata',
433
512
  :'page_number' => :'String',
434
513
  :'page_number_metadata' => :'PropertyMetadata',
435
514
  :'recipient_id' => :'String',
@@ -446,6 +525,8 @@ module DocuSign_eSign
446
525
  :'sender_required_metadata' => :'PropertyMetadata',
447
526
  :'shared' => :'String',
448
527
  :'shared_metadata' => :'PropertyMetadata',
528
+ :'share_to_recipients' => :'String',
529
+ :'share_to_recipients_metadata' => :'PropertyMetadata',
449
530
  :'smart_contract_information' => :'SmartContractInformation',
450
531
  :'source' => :'String',
451
532
  :'status' => :'String',
@@ -575,6 +656,14 @@ module DocuSign_eSign
575
656
  self.bold_metadata = attributes[:'boldMetadata']
576
657
  end
577
658
 
659
+ if attributes.has_key?(:'caption')
660
+ self.caption = attributes[:'caption']
661
+ end
662
+
663
+ if attributes.has_key?(:'captionMetadata')
664
+ self.caption_metadata = attributes[:'captionMetadata']
665
+ end
666
+
578
667
  if attributes.has_key?(:'conditionalParentLabel')
579
668
  self.conditional_parent_label = attributes[:'conditionalParentLabel']
580
669
  end
@@ -709,6 +798,14 @@ module DocuSign_eSign
709
798
  self.merge_field_xml = attributes[:'mergeFieldXml']
710
799
  end
711
800
 
801
+ if attributes.has_key?(:'originalValue')
802
+ self.original_value = attributes[:'originalValue']
803
+ end
804
+
805
+ if attributes.has_key?(:'originalValueMetadata')
806
+ self.original_value_metadata = attributes[:'originalValueMetadata']
807
+ end
808
+
712
809
  if attributes.has_key?(:'pageNumber')
713
810
  self.page_number = attributes[:'pageNumber']
714
811
  end
@@ -773,6 +870,14 @@ module DocuSign_eSign
773
870
  self.shared_metadata = attributes[:'sharedMetadata']
774
871
  end
775
872
 
873
+ if attributes.has_key?(:'shareToRecipients')
874
+ self.share_to_recipients = attributes[:'shareToRecipients']
875
+ end
876
+
877
+ if attributes.has_key?(:'shareToRecipientsMetadata')
878
+ self.share_to_recipients_metadata = attributes[:'shareToRecipientsMetadata']
879
+ end
880
+
776
881
  if attributes.has_key?(:'smartContractInformation')
777
882
  self.smart_contract_information = attributes[:'smartContractInformation']
778
883
  end
@@ -936,6 +1041,8 @@ module DocuSign_eSign
936
1041
  anchor_y_offset_metadata == o.anchor_y_offset_metadata &&
937
1042
  bold == o.bold &&
938
1043
  bold_metadata == o.bold_metadata &&
1044
+ caption == o.caption &&
1045
+ caption_metadata == o.caption_metadata &&
939
1046
  conditional_parent_label == o.conditional_parent_label &&
940
1047
  conditional_parent_label_metadata == o.conditional_parent_label_metadata &&
941
1048
  conditional_parent_value == o.conditional_parent_value &&
@@ -969,6 +1076,8 @@ module DocuSign_eSign
969
1076
  locked_metadata == o.locked_metadata &&
970
1077
  merge_field == o.merge_field &&
971
1078
  merge_field_xml == o.merge_field_xml &&
1079
+ original_value == o.original_value &&
1080
+ original_value_metadata == o.original_value_metadata &&
972
1081
  page_number == o.page_number &&
973
1082
  page_number_metadata == o.page_number_metadata &&
974
1083
  recipient_id == o.recipient_id &&
@@ -985,6 +1094,8 @@ module DocuSign_eSign
985
1094
  sender_required_metadata == o.sender_required_metadata &&
986
1095
  shared == o.shared &&
987
1096
  shared_metadata == o.shared_metadata &&
1097
+ share_to_recipients == o.share_to_recipients &&
1098
+ share_to_recipients_metadata == o.share_to_recipients_metadata &&
988
1099
  smart_contract_information == o.smart_contract_information &&
989
1100
  source == o.source &&
990
1101
  status == o.status &&
@@ -1026,7 +1137,7 @@ module DocuSign_eSign
1026
1137
  # Calculates hash code according to all attributes.
1027
1138
  # @return [Fixnum] Hash code
1028
1139
  def hash
1029
- [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, list_items, list_selected_value, list_selected_value_metadata, locale_policy, locked, locked_metadata, merge_field, merge_field_xml, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
1140
+ [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, caption, caption_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, list_items, list_selected_value, list_selected_value_metadata, locale_policy, locked, locked_metadata, merge_field, merge_field_xml, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, share_to_recipients, share_to_recipients_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
1030
1141
  end
1031
1142
 
1032
1143
  # Builds the object from hash
@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # This object represents a list custom field from which envelope creators and senders can select custom data.
15
16
  class ListCustomField
16
17
  # If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.
17
18
  attr_accessor :configuration_type
18
19
 
20
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
19
21
  attr_accessor :error_details
20
22
 
21
23
  # An ID used to specify a custom field.
@@ -12,20 +12,24 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # One of the selectable items in the `listItems` property of a [`list`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) tab.
15
16
  class ListItem
16
17
  # When set to **true**, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default.
17
18
  attr_accessor :selected
18
19
 
20
+ # Metadata that indicates whether the `selected` property is editable.
19
21
  attr_accessor :selected_metadata
20
22
 
21
23
  # Specifies the text that is shown in the dropdown list.
22
24
  attr_accessor :text
23
25
 
26
+ #
24
27
  attr_accessor :text_metadata
25
28
 
26
29
  # Specifies the value that is used when the list item is selected.
27
30
  attr_accessor :value
28
31
 
32
+ # Metadata that indicates whether the `value` property is editable.
29
33
  attr_accessor :value_metadata
30
34
 
31
35
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -16,6 +16,7 @@ module DocuSign_eSign
16
16
  #
17
17
  attr_accessor :address_format
18
18
 
19
+ #
19
20
  attr_accessor :address_format_metadata
20
21
 
21
22
  #
@@ -24,26 +25,31 @@ module DocuSign_eSign
24
25
  #
25
26
  attr_accessor :calendar_type
26
27
 
28
+ #
27
29
  attr_accessor :calendar_type_metadata
28
30
 
29
31
  #
30
32
  attr_accessor :culture_name
31
33
 
34
+ #
32
35
  attr_accessor :culture_name_metadata
33
36
 
34
37
  #
35
38
  attr_accessor :currency_code
36
39
 
40
+ # Metadata that indicates whether the `currencyCode` property is editable.
37
41
  attr_accessor :currency_code_metadata
38
42
 
39
43
  #
40
44
  attr_accessor :currency_negative_format
41
45
 
46
+ #
42
47
  attr_accessor :currency_negative_format_metadata
43
48
 
44
49
  #
45
50
  attr_accessor :currency_positive_format
46
51
 
52
+ #
47
53
  attr_accessor :currency_positive_format_metadata
48
54
 
49
55
  #
@@ -61,6 +67,7 @@ module DocuSign_eSign
61
67
  #
62
68
  attr_accessor :date_format
63
69
 
70
+ #
64
71
  attr_accessor :date_format_metadata
65
72
 
66
73
  #
@@ -102,31 +109,37 @@ module DocuSign_eSign
102
109
  #
103
110
  attr_accessor :initial_format
104
111
 
112
+ #
105
113
  attr_accessor :initial_format_metadata
106
114
 
107
115
  #
108
116
  attr_accessor :name_format
109
117
 
118
+ #
110
119
  attr_accessor :name_format_metadata
111
120
 
112
121
  #
113
122
  attr_accessor :sign_date_format
114
123
 
124
+ # Metadata that indicates whether the `signDateFormat` property is editable.
115
125
  attr_accessor :sign_date_format_metadata
116
126
 
117
127
  #
118
128
  attr_accessor :sign_time_format
119
129
 
130
+ # Metadata that indicates whether the `signTimeFormat` property is editable.
120
131
  attr_accessor :sign_time_format_metadata
121
132
 
122
133
  #
123
134
  attr_accessor :time_format
124
135
 
136
+ #
125
137
  attr_accessor :time_format_metadata
126
138
 
127
139
  #
128
140
  attr_accessor :time_zone
129
141
 
142
+ #
130
143
  attr_accessor :time_zone_metadata
131
144
 
132
145
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -13,6 +13,7 @@ require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
15
  class LockInformation
16
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
16
17
  attr_accessor :error_details
17
18
 
18
19
  # Sets the time, in seconds, until the lock expires when there is no activity on the envelope. If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds. The lock duration can be extended.
@@ -21,6 +22,7 @@ module DocuSign_eSign
21
22
  # Specifies the friendly name of the application that is locking the envelope.
22
23
  attr_accessor :locked_by_app
23
24
 
25
+ # A complex type containing information about the user that has the envelope or template locked.
24
26
  attr_accessor :locked_by_user
25
27
 
26
28
  # The datetime until the envelope lock expires.
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # This request object contains information about the lock that you want to create or update.
15
16
  class LockRequest
16
17
  # The number of seconds to lock the envelope for editing. Must be greater than 0 seconds.
17
18
  attr_accessor :lock_duration_in_seconds
@@ -12,9 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # Information about items shared among groups.
15
16
  class MemberGroupSharedItem
17
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
16
18
  attr_accessor :error_details
17
19
 
20
+ # The group sharing the item.
18
21
  attr_accessor :group
19
22
 
20
23
  # When set to **true**, this custom tab is shared.
@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
12
12
  require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
+ # Information about shared items.
15
16
  class MemberSharedItems
16
17
  #
17
18
  attr_accessor :envelopes
18
19
 
20
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
19
21
  attr_accessor :error_details
20
22
 
21
23
  #
@@ -24,6 +26,7 @@ module DocuSign_eSign
24
26
  #
25
27
  attr_accessor :templates
26
28
 
29
+ # Information about the user requesting sharing information.
27
30
  attr_accessor :user
28
31
 
29
32
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,11 +17,13 @@ module DocuSign_eSign
17
17
  # When set to **true**, the sender can modify the value of the custom tab during the sending process.
18
18
  attr_accessor :allow_sender_to_edit
19
19
 
20
+ # Metadata that indicates if the sender can edit the `allowSenderToEdit` property.
20
21
  attr_accessor :allow_sender_to_edit_metadata
21
22
 
22
23
  # If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.
23
24
  attr_accessor :configuration_type
24
25
 
26
+ # Metadata that indicates if the sender can edit the `configurationType` property.
25
27
  attr_accessor :configuration_type_metadata
26
28
 
27
29
  # Sets the object associated with the custom tab. Currently this is the Salesforce Object.
@@ -30,18 +32,22 @@ module DocuSign_eSign
30
32
  #
31
33
  attr_accessor :path_extended
32
34
 
35
+ # Reserved for DocuSign.
33
36
  attr_accessor :path_extended_metadata
34
37
 
38
+ # Metadata that indicates whether the `path` property is editable.
35
39
  attr_accessor :path_metadata
36
40
 
37
41
  # Specifies the row number in a Salesforce table that the merge field value corresponds to.
38
42
  attr_accessor :row
39
43
 
44
+ # Metadata that indicates whether the `row` property is editable.
40
45
  attr_accessor :row_metadata
41
46
 
42
47
  # When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed.
43
48
  attr_accessor :write_back
44
49
 
50
+ # Metadata that indicates if the sender can edit the `writeBack` property.
45
51
  attr_accessor :write_back_metadata
46
52
 
47
53
  # Attribute mapping from ruby-style variable name to JSON key.