signwell_sdk 0.1.2 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (291) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +3 -3
  3. data/.github/workflows/generator-ownership.yml +1 -1
  4. data/.github/workflows/manual-release.yml +1 -1
  5. data/.github/workflows/release.yml +1 -1
  6. data/.release-please-manifest.json +1 -1
  7. data/CHANGELOG.md +20 -0
  8. data/Gemfile.lock +16 -12
  9. data/README.md +11 -0
  10. data/docs/AdditionalFieldsInnerInner.md +4 -0
  11. data/docs/BulkSendCsvRequest.md +1 -1
  12. data/docs/ConditionalLogicDecisionInfo.md +26 -0
  13. data/docs/ConditionalRuleInfo.md +26 -0
  14. data/docs/ConditionalRuleInfoConditionsInner.md +26 -0
  15. data/docs/ConditionalRuleRequest.md +28 -0
  16. data/docs/ConditionalRuleRequestConditionsInner.md +26 -0
  17. data/docs/CopiedPlaceholdersInner.md +1 -1
  18. data/docs/CreateBulkSendRequest.md +2 -2
  19. data/docs/DocumentApi.md +82 -8
  20. data/docs/DocumentFromTemplateRequest.md +11 -3
  21. data/docs/DocumentFromTemplateResponse.md +11 -1
  22. data/docs/DocumentFromTemplateResponseFieldsInnerInner.md +4 -0
  23. data/docs/DocumentFromTemplateResponseRecipientsInner.md +6 -0
  24. data/docs/DocumentRequest.md +10 -4
  25. data/docs/DocumentResponse.md +11 -1
  26. data/docs/DocumentResponseFieldsInnerInner.md +4 -0
  27. data/docs/DocumentResponseRecipientsInner.md +6 -0
  28. data/docs/DocumentResponseRecipientsInnerPasscodeDelivery.md +22 -0
  29. data/docs/DocumentResponseRecipientsInnerSms.md +30 -0
  30. data/docs/DocumentTemplateRequest.md +5 -3
  31. data/docs/DocumentTemplateResponse.md +3 -1
  32. data/docs/DocumentTemplateResponsePlaceholdersInner.md +3 -1
  33. data/docs/DocumentTemplateUpdateRequest.md +5 -3
  34. data/docs/EmbeddedBranding.md +18 -0
  35. data/docs/EmbeddedBrandingBranding.md +26 -0
  36. data/docs/EmbeddedBrandingRequest.md +26 -0
  37. data/docs/EmbeddedBrandingRequestCompanyLogo.md +20 -0
  38. data/docs/EmbeddedRequest.md +18 -0
  39. data/docs/FieldsInnerInner.md +4 -0
  40. data/docs/PlaceholdersInner.md +4 -2
  41. data/docs/PlaceholdersInnerPasscodeDelivery.md +22 -0
  42. data/docs/RecipientsInner.md +14 -4
  43. data/docs/RecipientsInnerPasscodeDelivery.md +22 -0
  44. data/docs/ReminderRecipientsInner.md +1 -1
  45. data/docs/SendReminderRequest.md +1 -1
  46. data/docs/TemplateFieldsInnerInner.md +4 -0
  47. data/docs/TemplateRecipientsInner.md +14 -4
  48. data/docs/UpdateAuthenticationRequest.md +18 -0
  49. data/docs/UpdateAuthenticationRequestRecipientsInner.md +22 -0
  50. data/docs/UpdateDocumentAndSendRequest.md +9 -3
  51. data/docs/UpdateRecipientsMapInner.md +4 -2
  52. data/docs/UpdateRecipientsMapInnerPasscodeDelivery.md +22 -0
  53. data/docs/WebhooksApi.md +1 -1
  54. data/lib/signwell_sdk/api/api_application_api.rb +1 -2
  55. data/lib/signwell_sdk/api/bulk_send_api.rb +1 -2
  56. data/lib/signwell_sdk/api/document_api.rb +87 -14
  57. data/lib/signwell_sdk/api/me_api.rb +1 -2
  58. data/lib/signwell_sdk/api/regional_api.rb +1 -2
  59. data/lib/signwell_sdk/api/template_api.rb +1 -2
  60. data/lib/signwell_sdk/api/webhooks_api.rb +3 -4
  61. data/lib/signwell_sdk/api_client.rb +26 -6
  62. data/lib/signwell_sdk/api_error.rb +1 -2
  63. data/lib/signwell_sdk/api_model_base.rb +88 -0
  64. data/lib/signwell_sdk/configuration.rb +1 -1
  65. data/lib/signwell_sdk/extras/rate_limit.rb +17 -0
  66. data/lib/signwell_sdk/models/account_info_response.rb +1 -2
  67. data/lib/signwell_sdk/models/account_info_response_active_users_inner.rb +1 -2
  68. data/lib/signwell_sdk/models/account_info_response_preferences.rb +1 -2
  69. data/lib/signwell_sdk/models/additional_fields_inner_inner.rb +24 -3
  70. data/lib/signwell_sdk/models/additional_fields_inner_inner_value.rb +3 -4
  71. data/lib/signwell_sdk/models/additional_files_inner.rb +1 -2
  72. data/lib/signwell_sdk/models/api_application_response.rb +1 -2
  73. data/lib/signwell_sdk/models/api_application_response_owner.rb +1 -2
  74. data/lib/signwell_sdk/models/api_application_response_preferences.rb +1 -2
  75. data/lib/signwell_sdk/models/attachment_request_info.rb +1 -2
  76. data/lib/signwell_sdk/models/attachment_requests_inner.rb +1 -2
  77. data/lib/signwell_sdk/models/bulk_send_create_response.rb +1 -2
  78. data/lib/signwell_sdk/models/bulk_send_csv_request.rb +2 -3
  79. data/lib/signwell_sdk/models/bulk_send_csv_template_response.rb +1 -2
  80. data/lib/signwell_sdk/models/bulk_send_documents_response.rb +1 -2
  81. data/lib/signwell_sdk/models/bulk_send_list_item.rb +1 -2
  82. data/lib/signwell_sdk/models/bulk_send_list_response.rb +1 -2
  83. data/lib/signwell_sdk/models/bulk_send_response.rb +1 -2
  84. data/lib/signwell_sdk/models/bulk_send_response_templates_inner.rb +1 -2
  85. data/lib/signwell_sdk/models/bulk_send_validate_csv_response.rb +1 -2
  86. data/lib/signwell_sdk/models/checkbox_group_info.rb +1 -2
  87. data/lib/signwell_sdk/models/checkbox_groups_inner.rb +1 -2
  88. data/lib/signwell_sdk/models/checkbox_validation.rb +4 -3
  89. data/lib/signwell_sdk/models/completed_pdf_response.rb +3 -4
  90. data/lib/signwell_sdk/models/completed_pdf_url_response.rb +1 -2
  91. data/lib/signwell_sdk/models/conditional_logic_decision_info.rb +365 -0
  92. data/lib/signwell_sdk/models/conditional_rule_info.rb +351 -0
  93. data/lib/signwell_sdk/models/conditional_rule_info_conditions_inner.rb +340 -0
  94. data/lib/signwell_sdk/models/conditional_rule_request.rb +322 -0
  95. data/lib/signwell_sdk/models/conditional_rule_request_conditions_inner.rb +371 -0
  96. data/lib/signwell_sdk/models/copied_contact_info.rb +1 -2
  97. data/lib/signwell_sdk/models/copied_contacts_inner.rb +1 -2
  98. data/lib/signwell_sdk/models/copied_placeholders_inner.rb +2 -3
  99. data/lib/signwell_sdk/models/create_bulk_send_request.rb +3 -4
  100. data/lib/signwell_sdk/models/create_webhook_request.rb +1 -2
  101. data/lib/signwell_sdk/models/date_format.rb +4 -3
  102. data/lib/signwell_sdk/models/detailed_option.rb +1 -2
  103. data/lib/signwell_sdk/models/document_from_template_request.rb +90 -6
  104. data/lib/signwell_sdk/models/document_from_template_response.rb +101 -6
  105. data/lib/signwell_sdk/models/document_from_template_response_fields_inner_inner.rb +24 -3
  106. data/lib/signwell_sdk/models/document_from_template_response_fields_inner_inner_recipient.rb +1 -2
  107. data/lib/signwell_sdk/models/document_from_template_response_recipients_inner.rb +71 -3
  108. data/lib/signwell_sdk/models/document_list_response.rb +1 -2
  109. data/lib/signwell_sdk/models/document_request.rb +42 -7
  110. data/lib/signwell_sdk/models/document_response.rb +101 -6
  111. data/lib/signwell_sdk/models/document_response_attachment_requests_inner.rb +1 -2
  112. data/lib/signwell_sdk/models/document_response_fields_inner_inner.rb +24 -3
  113. data/lib/signwell_sdk/models/document_response_fields_inner_inner_options_inner.rb +1 -2
  114. data/lib/signwell_sdk/models/document_response_fields_inner_inner_recipient.rb +1 -2
  115. data/lib/signwell_sdk/models/document_response_fields_inner_inner_value.rb +3 -4
  116. data/lib/signwell_sdk/models/document_response_recipients_inner.rb +71 -3
  117. data/lib/signwell_sdk/models/document_response_recipients_inner_passcode_delivery.rb +246 -0
  118. data/lib/signwell_sdk/models/document_response_recipients_inner_sms.rb +292 -0
  119. data/lib/signwell_sdk/models/document_template_list_response.rb +1 -2
  120. data/lib/signwell_sdk/models/document_template_request.rb +18 -6
  121. data/lib/signwell_sdk/models/document_template_response.rb +17 -6
  122. data/lib/signwell_sdk/models/document_template_response_copied_placeholders_inner.rb +1 -2
  123. data/lib/signwell_sdk/models/document_template_response_placeholders_inner.rb +15 -6
  124. data/lib/signwell_sdk/models/document_template_update_request.rb +18 -6
  125. data/lib/signwell_sdk/models/dropdown_option.rb +3 -4
  126. data/lib/signwell_sdk/models/embedded_branding.rb +241 -0
  127. data/lib/signwell_sdk/models/embedded_branding_branding.rb +307 -0
  128. data/lib/signwell_sdk/models/embedded_branding_request.rb +297 -0
  129. data/lib/signwell_sdk/models/embedded_branding_request_company_logo.rb +236 -0
  130. data/lib/signwell_sdk/models/embedded_request.rb +225 -0
  131. data/lib/signwell_sdk/models/error_response.rb +1 -2
  132. data/lib/signwell_sdk/models/error_response_meta.rb +1 -2
  133. data/lib/signwell_sdk/models/field_type.rb +4 -3
  134. data/lib/signwell_sdk/models/fields_inner_inner.rb +24 -3
  135. data/lib/signwell_sdk/models/file_format.rb +4 -3
  136. data/lib/signwell_sdk/models/file_info.rb +1 -2
  137. data/lib/signwell_sdk/models/files_inner.rb +1 -2
  138. data/lib/signwell_sdk/models/label_info.rb +1 -2
  139. data/lib/signwell_sdk/models/label_request.rb +1 -2
  140. data/lib/signwell_sdk/models/label_response.rb +1 -2
  141. data/lib/signwell_sdk/models/me_response.rb +1 -2
  142. data/lib/signwell_sdk/models/me_response_contact.rb +1 -2
  143. data/lib/signwell_sdk/models/me_response_user.rb +1 -2
  144. data/lib/signwell_sdk/models/me_response_user_preferences.rb +1 -2
  145. data/lib/signwell_sdk/models/nom151_certificate_response.rb +1 -2
  146. data/lib/signwell_sdk/models/nom151_certificate_response_nom151.rb +1 -2
  147. data/lib/signwell_sdk/models/nom151_url_response.rb +1 -2
  148. data/lib/signwell_sdk/models/pagination_meta.rb +1 -2
  149. data/lib/signwell_sdk/models/placeholders_inner.rb +16 -7
  150. data/lib/signwell_sdk/models/placeholders_inner_passcode_delivery.rb +271 -0
  151. data/lib/signwell_sdk/models/rate_limit_error_response.rb +1 -2
  152. data/lib/signwell_sdk/models/recipients_inner.rb +103 -23
  153. data/lib/signwell_sdk/models/recipients_inner_passcode_delivery.rb +271 -0
  154. data/lib/signwell_sdk/models/reminder_recipients_inner.rb +2 -3
  155. data/lib/signwell_sdk/models/send_reminder_request.rb +2 -3
  156. data/lib/signwell_sdk/models/template_attachment_requests_inner.rb +1 -2
  157. data/lib/signwell_sdk/models/template_checkbox_groups_inner.rb +1 -2
  158. data/lib/signwell_sdk/models/template_field_values_inner.rb +1 -2
  159. data/lib/signwell_sdk/models/template_field_values_inner_value.rb +3 -4
  160. data/lib/signwell_sdk/models/template_fields_inner_inner.rb +24 -3
  161. data/lib/signwell_sdk/models/template_recipients_inner.rb +103 -23
  162. data/lib/signwell_sdk/models/text_validation.rb +5 -3
  163. data/lib/signwell_sdk/models/update_authentication_request.rb +243 -0
  164. data/lib/signwell_sdk/models/update_authentication_request_recipients_inner.rb +262 -0
  165. data/lib/signwell_sdk/models/update_document_and_send_request.rb +41 -6
  166. data/lib/signwell_sdk/models/update_recipients_map_inner.rb +16 -7
  167. data/lib/signwell_sdk/models/update_recipients_map_inner_passcode_delivery.rb +271 -0
  168. data/lib/signwell_sdk/models/update_recipients_request.rb +1 -2
  169. data/lib/signwell_sdk/models/validation_error_response.rb +1 -2
  170. data/lib/signwell_sdk/models/webhook_response.rb +1 -2
  171. data/lib/signwell_sdk/version.rb +4 -4
  172. data/lib/signwell_sdk.rb +19 -2
  173. data/openapi.yaml +2231 -972
  174. data/package-lock.json +542 -136
  175. data/package.json +4 -1
  176. data/signwell_sdk.gemspec +1 -2
  177. data/spec/api/api_application_api_spec.rb +1 -2
  178. data/spec/api/bulk_send_api_spec.rb +1 -2
  179. data/spec/api/document_api_spec.rb +11 -4
  180. data/spec/api/me_api_spec.rb +1 -2
  181. data/spec/api/regional_api_spec.rb +1 -2
  182. data/spec/api/template_api_spec.rb +1 -2
  183. data/spec/api/webhooks_api_spec.rb +1 -2
  184. data/spec/models/account_info_response_active_users_inner_spec.rb +1 -2
  185. data/spec/models/account_info_response_preferences_spec.rb +1 -2
  186. data/spec/models/account_info_response_spec.rb +1 -2
  187. data/spec/models/additional_fields_inner_inner_spec.rb +13 -2
  188. data/spec/models/additional_fields_inner_inner_value_spec.rb +1 -2
  189. data/spec/models/additional_files_inner_spec.rb +1 -2
  190. data/spec/models/api_application_response_owner_spec.rb +1 -2
  191. data/spec/models/api_application_response_preferences_spec.rb +1 -2
  192. data/spec/models/api_application_response_spec.rb +1 -2
  193. data/spec/models/attachment_request_info_spec.rb +1 -2
  194. data/spec/models/attachment_requests_inner_spec.rb +1 -2
  195. data/spec/models/bulk_send_create_response_spec.rb +1 -2
  196. data/spec/models/bulk_send_csv_request_spec.rb +1 -2
  197. data/spec/models/bulk_send_csv_template_response_spec.rb +1 -2
  198. data/spec/models/bulk_send_documents_response_spec.rb +1 -2
  199. data/spec/models/bulk_send_list_item_spec.rb +1 -2
  200. data/spec/models/bulk_send_list_response_spec.rb +1 -2
  201. data/spec/models/bulk_send_response_spec.rb +1 -2
  202. data/spec/models/bulk_send_response_templates_inner_spec.rb +1 -2
  203. data/spec/models/bulk_send_validate_csv_response_spec.rb +1 -2
  204. data/spec/models/checkbox_group_info_spec.rb +1 -2
  205. data/spec/models/checkbox_groups_inner_spec.rb +1 -2
  206. data/spec/models/checkbox_validation_spec.rb +1 -2
  207. data/spec/models/completed_pdf_response_spec.rb +1 -2
  208. data/spec/models/completed_pdf_url_response_spec.rb +1 -2
  209. data/spec/models/conditional_logic_decision_info_spec.rb +58 -0
  210. data/spec/models/conditional_rule_info_conditions_inner_spec.rb +58 -0
  211. data/spec/models/conditional_rule_info_spec.rb +58 -0
  212. data/spec/models/conditional_rule_request_conditions_inner_spec.rb +58 -0
  213. data/spec/models/conditional_rule_request_spec.rb +64 -0
  214. data/spec/models/copied_contact_info_spec.rb +1 -2
  215. data/spec/models/copied_contacts_inner_spec.rb +1 -2
  216. data/spec/models/copied_placeholders_inner_spec.rb +1 -2
  217. data/spec/models/create_bulk_send_request_spec.rb +1 -2
  218. data/spec/models/create_webhook_request_spec.rb +1 -2
  219. data/spec/models/date_format_spec.rb +1 -2
  220. data/spec/models/detailed_option_spec.rb +1 -2
  221. data/spec/models/document_from_template_request_spec.rb +25 -2
  222. data/spec/models/document_from_template_response_fields_inner_inner_recipient_spec.rb +1 -2
  223. data/spec/models/document_from_template_response_fields_inner_inner_spec.rb +13 -2
  224. data/spec/models/document_from_template_response_recipients_inner_spec.rb +19 -2
  225. data/spec/models/document_from_template_response_spec.rb +31 -2
  226. data/spec/models/document_list_response_spec.rb +1 -2
  227. data/spec/models/document_request_spec.rb +19 -2
  228. data/spec/models/document_response_attachment_requests_inner_spec.rb +1 -2
  229. data/spec/models/document_response_fields_inner_inner_options_inner_spec.rb +1 -2
  230. data/spec/models/document_response_fields_inner_inner_recipient_spec.rb +1 -2
  231. data/spec/models/document_response_fields_inner_inner_spec.rb +13 -2
  232. data/spec/models/document_response_fields_inner_inner_value_spec.rb +1 -2
  233. data/spec/models/document_response_recipients_inner_passcode_delivery_spec.rb +46 -0
  234. data/spec/models/document_response_recipients_inner_sms_spec.rb +70 -0
  235. data/spec/models/document_response_recipients_inner_spec.rb +19 -2
  236. data/spec/models/document_response_spec.rb +31 -2
  237. data/spec/models/document_template_list_response_spec.rb +1 -2
  238. data/spec/models/document_template_request_spec.rb +7 -2
  239. data/spec/models/document_template_response_copied_placeholders_inner_spec.rb +1 -2
  240. data/spec/models/document_template_response_placeholders_inner_spec.rb +7 -2
  241. data/spec/models/document_template_response_spec.rb +7 -2
  242. data/spec/models/document_template_update_request_spec.rb +7 -2
  243. data/spec/models/dropdown_option_spec.rb +1 -2
  244. data/spec/models/embedded_branding_branding_spec.rb +58 -0
  245. data/spec/models/embedded_branding_request_company_logo_spec.rb +40 -0
  246. data/spec/models/embedded_branding_request_spec.rb +58 -0
  247. data/spec/models/embedded_branding_spec.rb +34 -0
  248. data/spec/models/embedded_request_spec.rb +34 -0
  249. data/spec/models/error_response_meta_spec.rb +1 -2
  250. data/spec/models/error_response_spec.rb +1 -2
  251. data/spec/models/field_type_spec.rb +1 -2
  252. data/spec/models/fields_inner_inner_spec.rb +13 -2
  253. data/spec/models/file_format_spec.rb +1 -2
  254. data/spec/models/file_info_spec.rb +1 -2
  255. data/spec/models/files_inner_spec.rb +1 -2
  256. data/spec/models/label_info_spec.rb +1 -2
  257. data/spec/models/label_request_spec.rb +1 -2
  258. data/spec/models/label_response_spec.rb +1 -2
  259. data/spec/models/me_response_contact_spec.rb +1 -2
  260. data/spec/models/me_response_spec.rb +1 -2
  261. data/spec/models/me_response_user_preferences_spec.rb +1 -2
  262. data/spec/models/me_response_user_spec.rb +1 -2
  263. data/spec/models/nom151_certificate_response_nom151_spec.rb +1 -2
  264. data/spec/models/nom151_certificate_response_spec.rb +1 -2
  265. data/spec/models/nom151_url_response_spec.rb +1 -2
  266. data/spec/models/pagination_meta_spec.rb +1 -2
  267. data/spec/models/placeholders_inner_passcode_delivery_spec.rb +46 -0
  268. data/spec/models/placeholders_inner_spec.rb +7 -2
  269. data/spec/models/rate_limit_error_response_spec.rb +1 -2
  270. data/spec/models/recipients_inner_passcode_delivery_spec.rb +46 -0
  271. data/spec/models/recipients_inner_spec.rb +31 -2
  272. data/spec/models/reminder_recipients_inner_spec.rb +1 -2
  273. data/spec/models/send_reminder_request_spec.rb +1 -2
  274. data/spec/models/template_attachment_requests_inner_spec.rb +1 -2
  275. data/spec/models/template_checkbox_groups_inner_spec.rb +1 -2
  276. data/spec/models/template_field_values_inner_spec.rb +1 -2
  277. data/spec/models/template_field_values_inner_value_spec.rb +1 -2
  278. data/spec/models/template_fields_inner_inner_spec.rb +13 -2
  279. data/spec/models/template_recipients_inner_spec.rb +31 -2
  280. data/spec/models/text_validation_spec.rb +1 -2
  281. data/spec/models/update_authentication_request_recipients_inner_spec.rb +46 -0
  282. data/spec/models/update_authentication_request_spec.rb +34 -0
  283. data/spec/models/update_document_and_send_request_spec.rb +19 -2
  284. data/spec/models/update_recipients_map_inner_passcode_delivery_spec.rb +46 -0
  285. data/spec/models/update_recipients_map_inner_spec.rb +7 -2
  286. data/spec/models/update_recipients_request_spec.rb +1 -2
  287. data/spec/models/validation_error_response_spec.rb +1 -2
  288. data/spec/models/webhook_response_spec.rb +1 -2
  289. data/spec/regressions/api_client_spec.rb +56 -1
  290. data/spec/spec_helper.rb +1 -2
  291. metadata +73 -3
@@ -4,6 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **cfr_part11** | **Boolean** | Whether 21 CFR Part 11 controls apply to this document. Read-only: the value is taken from the workspace setting when the document is created and never changes afterwards. | [optional] |
8
+ | **cfr_part11_signing_mode** | **String** | The signing mode of a 21 CFR Part 11 document: streamlined (one final authentication) or per_signature (authentication at every signature and initials field). Null when Part 11 does not apply. | [optional] |
7
9
  | **test_mode** | **Boolean** | | |
8
10
  | **id** | **String** | | |
9
11
  | **template_id** | **String** | | [optional] |
@@ -22,6 +24,7 @@
22
24
  | **status** | **String** | Possible values: Draft, Created, Sending, Sent, Pending, Viewed, Completed, Manually completed, Declined, Canceled, Bounced, Blocked, Error, Expired | [optional] |
23
25
  | **reminders** | **Boolean** | | [optional] |
24
26
  | **archived** | **Boolean** | | [optional] |
27
+ | **embedded** | [**EmbeddedBranding**](EmbeddedBranding.md) | | [optional] |
25
28
  | **embedded_signing** | **Boolean** | | [optional] |
26
29
  | **embedded_edit_url** | **String** | | [optional] |
27
30
  | **embedded_preview_url** | **String** | | [optional] |
@@ -41,6 +44,8 @@
41
44
  | **allow_reassign** | **Boolean** | | [optional] |
42
45
  | **labels** | [**Array<LabelInfo>**](LabelInfo.md) | | [optional] |
43
46
  | **checkbox_groups** | [**Array<CheckboxGroupInfo>**](CheckboxGroupInfo.md) | | [optional] |
47
+ | **conditional_rules** | [**Array<ConditionalRuleInfo>**](ConditionalRuleInfo.md) | | [optional] |
48
+ | **conditional_logic_decisions** | [**Array<ConditionalLogicDecisionInfo>**](ConditionalLogicDecisionInfo.md) | | [optional] |
44
49
 
45
50
  ## Example
46
51
 
@@ -48,6 +53,8 @@
48
53
  require 'signwell_sdk'
49
54
 
50
55
  instance = SignWell::Models::DocumentFromTemplateResponse.new(
56
+ cfr_part11: null,
57
+ cfr_part11_signing_mode: null,
51
58
  test_mode: null,
52
59
  id: null,
53
60
  template_id: null,
@@ -66,6 +73,7 @@ instance = SignWell::Models::DocumentFromTemplateResponse.new(
66
73
  status: null,
67
74
  reminders: null,
68
75
  archived: null,
76
+ embedded: null,
69
77
  embedded_signing: null,
70
78
  embedded_edit_url: null,
71
79
  embedded_preview_url: null,
@@ -84,7 +92,9 @@ instance = SignWell::Models::DocumentFromTemplateResponse.new(
84
92
  allow_decline: null,
85
93
  allow_reassign: null,
86
94
  labels: null,
87
- checkbox_groups: null
95
+ checkbox_groups: null,
96
+ conditional_rules: null,
97
+ conditional_logic_decisions: null
88
98
  )
89
99
  ```
90
100
 
@@ -18,6 +18,8 @@
18
18
  | **required** | **Boolean** | | [optional] |
19
19
  | **type** | [**FieldType**](FieldType.md) | | [optional] |
20
20
  | **validation** | [**TextValidation**](TextValidation.md) | | [optional] |
21
+ | **validation_regex** | **String** | Text fields with custom validation only: the regex pattern used to validate field values. Required when validation is set to custom. | [optional] |
22
+ | **validation_regex_error_message** | **String** | Text fields with custom validation only: the error message shown to the recipient when their input doesn't match the regex pattern. Required when validation is set to custom. | [optional] |
21
23
  | **value** | [**DocumentResponseFieldsInnerInnerValue**](DocumentResponseFieldsInnerInnerValue.md) | | [optional] |
22
24
  | **height** | **String** | | [optional] |
23
25
  | **width** | **String** | | [optional] |
@@ -48,6 +50,8 @@ instance = SignWell::Models::DocumentFromTemplateResponseFieldsInnerInner.new(
48
50
  required: null,
49
51
  type: null,
50
52
  validation: null,
53
+ validation_regex: null,
54
+ validation_regex_error_message: null,
51
55
  value: null,
52
56
  height: null,
53
57
  width: null,
@@ -12,6 +12,8 @@
12
12
  | **subject** | **String** | | [optional] |
13
13
  | **send_email** | **Boolean** | | [optional] |
14
14
  | **send_email_delay** | **Integer** | | [optional] |
15
+ | **delivery_method** | **String** | How the recipient is notified: email (default), sms, or email_and_sms. | [optional] |
16
+ | **sms** | [**DocumentResponseRecipientsInnerSms**](DocumentResponseRecipientsInnerSms.md) | | [optional] |
15
17
  | **signing_order** | **Integer** | | [optional] |
16
18
  | **signing_url** | **String** | | [optional] |
17
19
  | **embedded_signing_url** | **String** | | [optional] |
@@ -19,6 +21,7 @@
19
21
  | **bounced_details** | **String** | | [optional] |
20
22
  | **attachment_requests** | [**Array<AttachmentRequestInfo>**](AttachmentRequestInfo.md) | | [optional] |
21
23
  | **passcode** | **String** | | [optional] |
24
+ | **passcode_delivery** | [**DocumentResponseRecipientsInnerPasscodeDelivery**](DocumentResponseRecipientsInnerPasscodeDelivery.md) | | [optional] |
22
25
  | **status** | **String** | | [optional] |
23
26
  | **placeholder_name** | **String** | | [optional] |
24
27
 
@@ -36,6 +39,8 @@ instance = SignWell::Models::DocumentFromTemplateResponseRecipientsInner.new(
36
39
  subject: null,
37
40
  send_email: null,
38
41
  send_email_delay: null,
42
+ delivery_method: null,
43
+ sms: null,
39
44
  signing_order: null,
40
45
  signing_url: null,
41
46
  embedded_signing_url: null,
@@ -43,6 +48,7 @@ instance = SignWell::Models::DocumentFromTemplateResponseRecipientsInner.new(
43
48
  bounced_details: null,
44
49
  attachment_requests: null,
45
50
  passcode: null,
51
+ passcode_delivery: null,
46
52
  status: null,
47
53
  placeholder_name: null
48
54
  )
@@ -5,13 +5,14 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **test_mode** | **Boolean** | Set to `true` to enable Test Mode. Documents created with Test Mode do not count towards API billing and are not legally binding. Defaults to `false` | [optional][default to false] |
8
+ | **send_sms_test_preview_email** | **Boolean** | Only applies when `test_mode` is `true`. When `true`, and the document has an SMS-only recipient, sends the document owner a test-mode preview email (with a masked phone number) instead of the regular SMS sender-copy email. No SMS is sent and no credits are used, in test mode or otherwise. Defaults to `false`. | [optional][default to false] |
8
9
  | **files** | [**Array<FilesInner>**](FilesInner.md) | Document files can be uploaded by specifying a file URL or base64 string. Either `file_url` or `file_base64` must be present (not both). Valid file types are: .pdf, .doc, .docx, .pages, .ppt, .pptx, .key, .xls, .xlsx, .numbers, .jpg, .jpeg, .png, .tiff, .tif, .webp, .html, and .htm | |
9
10
  | **name** | **String** | The name of the document. | [optional] |
10
- | **subject** | **String** | Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template). | [optional] |
11
- | **message** | **String** | Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template). | [optional] |
11
+ | **subject** | **String** | Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates. | [optional] |
12
+ | **message** | **String** | Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates. | [optional] |
12
13
  | **recipients** | [**Array<RecipientsInner>**](RecipientsInner.md) | Document recipients are people that must complete and/or sign a document. | |
13
14
  | **draft** | **Boolean** | Whether the document can still be updated before sending a signature request. If set to `false` the document is sent for signing as part of this request. Defaults to `false`. | [optional][default to false] |
14
- | **self_sign** | **Boolean** | When set to true the document will enter self-sign mode, which allows the document creator to sign and complete a document without any field setup. Must use the embedded_edit_url in the response and (if embedding) the embedded requesting workflow. | [optional][default to false] |
15
+ | **self_sign** | **Boolean** | When set to true the document will enter self-sign mode, which allows the document creator to sign and complete a document without any field setup. Must use the embedded_edit_url in the response and (if embedding) the embedded requesting workflow. Unavailable on 21 CFR Part 11 documents, which require every signature to come from an authenticated signer: sending `true` returns a 422. | [optional][default to false] |
15
16
  | **with_signature_page** | **Boolean** | When set to `true` the document will have a signature page added to the end, and all signers will be required to add their signature on that page. | [optional][default to false] |
16
17
  | **expires_in** | **Integer** | Number of days before the signature request expires. Defaults to the account expiration setting or template expiration (if the document is created from a template). | [optional] |
17
18
  | **reminders** | **Boolean** | Whether to send signing reminders to recipients. Reminders are sent on day 3, day 6, and day 10 if set to `true`. Defaults to `true`. | [optional][default to true] |
@@ -19,14 +20,16 @@
19
20
  | **api_application_id** | **String** | Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings | [optional] |
20
21
  | **embedded_signing** | **Boolean** | When set to `true` it enables embedded signing in your website/web application. Embedded functionality works with an iFrame and email authentication is disabled. :embedded_signinig defaults to `false`. | [optional][default to false] |
21
22
  | **embedded_signing_notifications** | **Boolean** | On embedding signing, document owners (and CC'd contacts) do not get a notification email when documents have been completed. Setting this param to `true` will send out those final completed notifications. Default is `false` | [optional][default to false] |
23
+ | **embedded** | [**EmbeddedRequest**](EmbeddedRequest.md) | | [optional] |
22
24
  | **text_tags** | **Boolean** | An alternative way (if you can’t use the recommended way) of placing fields in specific locations of your document by using special text tags. Useful when changing the content of your files changes the location of fields. See API documentation for “Text Tags” for details. Defaults to false. | [optional][default to false] |
23
25
  | **custom_requester_name** | **String** | Sets the custom requester name for the document. When set, this is the name used for all email communications, signing notifications, and in the audit file. | [optional] |
24
26
  | **custom_requester_email** | **String** | Sets the custom requester email for the document. When set, this is the email used for all email communications, signing notifications, and in the audit file. | [optional] |
25
27
  | **redirect_url** | **String** | A URL that recipients are redirected to after successfully signing a document. | [optional] |
26
28
  | **allow_decline** | **Boolean** | Whether to allow recipients the option to decline signing a document. If multiple signers are involved in a document, any single recipient can cancel the entire document signing process by declining to sign. | [optional][default to true] |
27
- | **allow_reassign** | **Boolean** | In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else. | [optional][default to true] |
29
+ | **allow_reassign** | **Boolean** | In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else. Unavailable on 21 CFR Part 11 documents: omit it and reassignment stays off, while sending `true` returns a 422. | [optional][default to true] |
28
30
  | **decline_redirect_url** | **String** | A URL that recipients are redirected to if the document is declined. | [optional] |
29
31
  | **language** | **String** | Sets the language for all recipients on the document and updates all recipient side interactions including the document email and the document itself. Accepted languages: English, Français, Español, Deutsch, Polski, Português, Dansk, Nederlands, Italiano, Русский, Svenska, العربية, Ελληνικά, Türkçe, Slovenčina. Defaults to English. Language should be sent in ISO 639-1 format: en, fr, es, de, pl, pt, da, nl, it, ru, sv, ar, el, tr, sk. | [optional] |
32
+ | **conditional_rules** | [**Array<ConditionalRuleRequest>**](ConditionalRuleRequest.md) | Conditional logic rules that show, hide, or require fields based on what a signer does to other fields. Every identifier is a field api_id. At most 10 rules per document or template. | [optional] |
30
33
  | **metadata** | **Hash<String, String>** | Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned. | [optional] |
31
34
  | **fields** | **Array<Array<FieldsInnerInner>>** | Document fields placed on a document for collecting data or signatures from recipients. At least one field must be present in the Create Document request if `draft` is `false` (unless adding a signature page by using `with_signature_page`). Field data should be sent as a 2-dimensional JSON array. One array of fields is needed for each file in the files array. An array of fields can be empty if you have a file that does not contain any fields. | [optional] |
32
35
  | **attachment_requests** | [**Array<AttachmentRequestsInner>**](AttachmentRequestsInner.md) | Attachments that a recipient must upload to complete the signing process. Attachment requests are shown after all document fields have been completed. | [optional] |
@@ -41,6 +44,7 @@ require 'signwell_sdk'
41
44
 
42
45
  instance = SignWell::Models::DocumentRequest.new(
43
46
  test_mode: null,
47
+ send_sms_test_preview_email: null,
44
48
  files: null,
45
49
  name: null,
46
50
  subject: null,
@@ -55,6 +59,7 @@ instance = SignWell::Models::DocumentRequest.new(
55
59
  api_application_id: null,
56
60
  embedded_signing: null,
57
61
  embedded_signing_notifications: null,
62
+ embedded: null,
58
63
  text_tags: null,
59
64
  custom_requester_name: null,
60
65
  custom_requester_email: null,
@@ -63,6 +68,7 @@ instance = SignWell::Models::DocumentRequest.new(
63
68
  allow_reassign: null,
64
69
  decline_redirect_url: null,
65
70
  language: null,
71
+ conditional_rules: null,
66
72
  metadata: null,
67
73
  fields: null,
68
74
  attachment_requests: null,
@@ -4,6 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **cfr_part11** | **Boolean** | Whether 21 CFR Part 11 controls apply to this document. Read-only: the value is taken from the workspace setting when the document is created and never changes afterwards. | [optional] |
8
+ | **cfr_part11_signing_mode** | **String** | The signing mode of a 21 CFR Part 11 document: streamlined (one final authentication) or per_signature (authentication at every signature and initials field). Null when Part 11 does not apply. | [optional] |
7
9
  | **test_mode** | **Boolean** | | |
8
10
  | **id** | **String** | | |
9
11
  | **api_application_id** | **String** | | [optional] |
@@ -20,6 +22,7 @@
20
22
  | **status** | **String** | Possible values: Draft, Created, Sending, Sent, Pending, Viewed, Completed, Manually completed, Declined, Canceled, Bounced, Blocked, Error, Expired | [optional] |
21
23
  | **reminders** | **Boolean** | | [optional] |
22
24
  | **archived** | **Boolean** | | [optional] |
25
+ | **embedded** | [**EmbeddedBranding**](EmbeddedBranding.md) | | [optional] |
23
26
  | **embedded_signing** | **Boolean** | | [optional] |
24
27
  | **embedded_edit_url** | **String** | | [optional] |
25
28
  | **embedded_preview_url** | **String** | | [optional] |
@@ -41,6 +44,8 @@
41
44
  | **allow_reassign** | **Boolean** | | [optional] |
42
45
  | **labels** | [**Array<LabelInfo>**](LabelInfo.md) | | [optional] |
43
46
  | **checkbox_groups** | [**Array<CheckboxGroupInfo>**](CheckboxGroupInfo.md) | | [optional] |
47
+ | **conditional_rules** | [**Array<ConditionalRuleInfo>**](ConditionalRuleInfo.md) | | [optional] |
48
+ | **conditional_logic_decisions** | [**Array<ConditionalLogicDecisionInfo>**](ConditionalLogicDecisionInfo.md) | | [optional] |
44
49
 
45
50
  ## Example
46
51
 
@@ -48,6 +53,8 @@
48
53
  require 'signwell_sdk'
49
54
 
50
55
  instance = SignWell::Models::DocumentResponse.new(
56
+ cfr_part11: null,
57
+ cfr_part11_signing_mode: null,
51
58
  test_mode: null,
52
59
  id: null,
53
60
  api_application_id: null,
@@ -64,6 +71,7 @@ instance = SignWell::Models::DocumentResponse.new(
64
71
  status: null,
65
72
  reminders: null,
66
73
  archived: null,
74
+ embedded: null,
67
75
  embedded_signing: null,
68
76
  embedded_edit_url: null,
69
77
  embedded_preview_url: null,
@@ -84,7 +92,9 @@ instance = SignWell::Models::DocumentResponse.new(
84
92
  allow_decline: null,
85
93
  allow_reassign: null,
86
94
  labels: null,
87
- checkbox_groups: null
95
+ checkbox_groups: null,
96
+ conditional_rules: null,
97
+ conditional_logic_decisions: null
88
98
  )
89
99
  ```
90
100
 
@@ -18,6 +18,8 @@
18
18
  | **required** | **Boolean** | | [optional] |
19
19
  | **type** | [**FieldType**](FieldType.md) | | [optional] |
20
20
  | **validation** | [**TextValidation**](TextValidation.md) | | [optional] |
21
+ | **validation_regex** | **String** | Text fields with custom validation only: the regex pattern used to validate field values. Required when validation is set to custom. | [optional] |
22
+ | **validation_regex_error_message** | **String** | Text fields with custom validation only: the error message shown to the recipient when their input doesn't match the regex pattern. Required when validation is set to custom. | [optional] |
21
23
  | **value** | [**DocumentResponseFieldsInnerInnerValue**](DocumentResponseFieldsInnerInnerValue.md) | | [optional] |
22
24
  | **height** | **String** | | [optional] |
23
25
  | **width** | **String** | | [optional] |
@@ -48,6 +50,8 @@ instance = SignWell::Models::DocumentResponseFieldsInnerInner.new(
48
50
  required: null,
49
51
  type: null,
50
52
  validation: null,
53
+ validation_regex: null,
54
+ validation_regex_error_message: null,
51
55
  value: null,
52
56
  height: null,
53
57
  width: null,
@@ -12,6 +12,8 @@
12
12
  | **subject** | **String** | | [optional] |
13
13
  | **send_email** | **Boolean** | | [optional] |
14
14
  | **send_email_delay** | **Integer** | | [optional] |
15
+ | **delivery_method** | **String** | How the recipient is notified: email (default), sms, or email_and_sms. | [optional] |
16
+ | **sms** | [**DocumentResponseRecipientsInnerSms**](DocumentResponseRecipientsInnerSms.md) | | [optional] |
15
17
  | **signing_order** | **Integer** | | [optional] |
16
18
  | **signing_url** | **String** | | [optional] |
17
19
  | **embedded_signing_url** | **String** | | [optional] |
@@ -19,6 +21,7 @@
19
21
  | **bounced_details** | **String** | | [optional] |
20
22
  | **attachment_requests** | [**Array<AttachmentRequestInfo>**](AttachmentRequestInfo.md) | | [optional] |
21
23
  | **passcode** | **String** | | [optional] |
24
+ | **passcode_delivery** | [**DocumentResponseRecipientsInnerPasscodeDelivery**](DocumentResponseRecipientsInnerPasscodeDelivery.md) | | [optional] |
22
25
  | **status** | **String** | | [optional] |
23
26
 
24
27
  ## Example
@@ -35,6 +38,8 @@ instance = SignWell::Models::DocumentResponseRecipientsInner.new(
35
38
  subject: null,
36
39
  send_email: null,
37
40
  send_email_delay: null,
41
+ delivery_method: null,
42
+ sms: null,
38
43
  signing_order: null,
39
44
  signing_url: null,
40
45
  embedded_signing_url: null,
@@ -42,6 +47,7 @@ instance = SignWell::Models::DocumentResponseRecipientsInner.new(
42
47
  bounced_details: null,
43
48
  attachment_requests: null,
44
49
  passcode: null,
50
+ passcode_delivery: null,
45
51
  status: null
46
52
  )
47
53
  ```
@@ -0,0 +1,22 @@
1
+ # SignWell::Models::DocumentResponseRecipientsInnerPasscodeDelivery
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enabled** | **Boolean** | | [optional] |
8
+ | **methods** | **Array<String>** | | [optional] |
9
+ | **expire_after_access** | **Boolean** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'signwell_sdk'
15
+
16
+ instance = SignWell::Models::DocumentResponseRecipientsInnerPasscodeDelivery.new(
17
+ enabled: null,
18
+ methods: null,
19
+ expire_after_access: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,30 @@
1
+ # SignWell::Models::DocumentResponseRecipientsInnerSms
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **phone_number_masked** | **String** | Masked phone number; the full number never leaves the API. | [optional] |
8
+ | **send_sms** | **Boolean** | | [optional] |
9
+ | **send_sms_delay** | **Integer** | | [optional] |
10
+ | **delivery_status** | **String** | | [optional] |
11
+ | **message_type** | **String** | | [optional] |
12
+ | **failed** | **Boolean** | | [optional] |
13
+ | **failed_details** | **String** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'signwell_sdk'
19
+
20
+ instance = SignWell::Models::DocumentResponseRecipientsInnerSms.new(
21
+ phone_number_masked: null,
22
+ send_sms: null,
23
+ send_sms_delay: null,
24
+ delivery_status: null,
25
+ message_type: null,
26
+ failed: null,
27
+ failed_details: null
28
+ )
29
+ ```
30
+
@@ -6,8 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **files** | [**Array<FilesInner>**](FilesInner.md) | Document files can be uploaded by specifying a file URL or base64 string. Either `file_url` or `file_base64` must be present (not both). Valid file types are: .pdf, .doc, .docx, .pages, .ppt, .pptx, .key, .xls, .xlsx, .numbers, .jpg, .jpeg, .png, .tiff, .tif, .webp, .html, and .htm | |
8
8
  | **name** | **String** | The name of the template. | [optional] |
9
- | **subject** | **String** | Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template). | [optional] |
10
- | **message** | **String** | Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template). | [optional] |
9
+ | **subject** | **String** | Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates. | [optional] |
10
+ | **message** | **String** | Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates. | [optional] |
11
11
  | **placeholders** | [**Array<PlaceholdersInner>**](PlaceholdersInner.md) | Placeholders are generally job roles that must complete and/or sign the document. For example, a placeholder might be “Client” or “Legal Department”. When a document is created from the template, you assign a person to each placeholder. | |
12
12
  | **copied_placeholders** | [**Array<CopiedPlaceholdersInner>**](CopiedPlaceholdersInner.md) | Copied placeholders are emailed the final document once it has been completed by all recipients. | [optional] |
13
13
  | **draft** | **Boolean** | Whether the template can still be updated before it is ready for usage. If set to `false` the template is marked as `Available` and it will be ready for use. Defaults to `false`. | [optional][default to false] |
@@ -18,9 +18,10 @@
18
18
  | **text_tags** | **Boolean** | An alternative way (if you can’t use the recommended way) of placing fields in specific locations of your document by using special text tags. Useful when changing the content of your files changes the location of fields. See API documentation for “Text Tags” for details. Defaults to false. | [optional][default to false] |
19
19
  | **redirect_url** | **String** | A URL that recipients are redirected to after successfully signing a document. | [optional] |
20
20
  | **allow_decline** | **Boolean** | Whether to allow recipients the option to decline signing a document. If multiple signers are involved in a document, any single recipient can cancel the entire document signing process by declining to sign. | [optional][default to true] |
21
- | **allow_reassign** | **Boolean** | In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else. | [optional][default to true] |
21
+ | **allow_reassign** | **Boolean** | In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else. Unavailable on 21 CFR Part 11 documents: omit it and reassignment stays off, while sending `true` returns a 422. | [optional][default to true] |
22
22
  | **decline_redirect_url** | **String** | A URL that recipients are redirected to if the document is declined. | [optional] |
23
23
  | **language** | **String** | Sets the language for the template and documents created from the template for all recipient side interactions including the document email and the document itself. Accepted languages: English, Français, Español, Deutsch, Polski, Português, Dansk, Nederlands, Italiano, Русский, Svenska, العربية, Ελληνικά, Türkçe, Slovenčina. Language should be sent in ISO 639-1 format: en, fr, es, de, pl, pt, da, nl, it, ru, sv, ar, el, tr, sk. | [optional] |
24
+ | **conditional_rules** | [**Array<ConditionalRuleRequest>**](ConditionalRuleRequest.md) | Conditional logic rules that show, hide, or require fields based on what a signer does to other fields. Every identifier is a field api_id. At most 10 rules per document or template. | [optional] |
24
25
  | **metadata** | **Hash<String, String>** | Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned. | [optional] |
25
26
  | **fields** | **Array<Array<TemplateFieldsInnerInner>>** | Document fields placed on a document for collecting data or signatures from recipients. At least one field must be present in the Create Document request if `draft` is `false` (unless adding a signature page by using `with_signature_page`). Field data should be sent as a 2-dimensional JSON array. One array of fields is needed for each file in the files array. An array of fields can be empty if you have a file that does not contain any fields. | [optional] |
26
27
  | **attachment_requests** | [**Array<TemplateAttachmentRequestsInner>**](TemplateAttachmentRequestsInner.md) | Attachments that a recipient must upload to complete the signing process. Attachment requests are shown after all document fields have been completed. | [optional] |
@@ -50,6 +51,7 @@ instance = SignWell::Models::DocumentTemplateRequest.new(
50
51
  allow_reassign: null,
51
52
  decline_redirect_url: null,
52
53
  language: null,
54
+ conditional_rules: null,
53
55
  metadata: null,
54
56
  fields: null,
55
57
  attachment_requests: null,
@@ -34,6 +34,7 @@
34
34
  | **allow_reassign** | **Boolean** | | [optional] |
35
35
  | **labels** | [**Array<LabelInfo>**](LabelInfo.md) | | [optional] |
36
36
  | **checkbox_groups** | [**Array<CheckboxGroupInfo>**](CheckboxGroupInfo.md) | | [optional] |
37
+ | **conditional_rules** | [**Array<ConditionalRuleInfo>**](ConditionalRuleInfo.md) | | [optional] |
37
38
 
38
39
  ## Example
39
40
 
@@ -70,7 +71,8 @@ instance = SignWell::Models::DocumentTemplateResponse.new(
70
71
  allow_decline: null,
71
72
  allow_reassign: null,
72
73
  labels: null,
73
- checkbox_groups: null
74
+ checkbox_groups: null,
75
+ conditional_rules: null
74
76
  )
75
77
  ```
76
78
 
@@ -12,6 +12,7 @@
12
12
  | **preassigned_recipient_email** | **String** | | [optional] |
13
13
  | **signing_order** | **Integer** | | [optional] |
14
14
  | **attachment_requests** | [**Array<AttachmentRequestInfo>**](AttachmentRequestInfo.md) | | [optional] |
15
+ | **passcode_delivery** | [**DocumentResponseRecipientsInnerPasscodeDelivery**](DocumentResponseRecipientsInnerPasscodeDelivery.md) | | [optional] |
15
16
 
16
17
  ## Example
17
18
 
@@ -26,7 +27,8 @@ instance = SignWell::Models::DocumentTemplateResponsePlaceholdersInner.new(
26
27
  preassigned_recipient_name: null,
27
28
  preassigned_recipient_email: null,
28
29
  signing_order: null,
29
- attachment_requests: null
30
+ attachment_requests: null,
31
+ passcode_delivery: null
30
32
  )
31
33
  ```
32
34
 
@@ -5,8 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | The name of the template. | [optional] |
8
- | **subject** | **String** | Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template). | [optional] |
9
- | **message** | **String** | Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template). | [optional] |
8
+ | **subject** | **String** | Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates. | [optional] |
9
+ | **message** | **String** | Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template). Applies to email notifications only; SMS notifications always use fixed system templates. | [optional] |
10
10
  | **draft** | **Boolean** | Whether the template can still be updated before it is ready for usage. If set to `false` the template is marked as `Available` and it will be ready for use. Defaults to `false`. | [optional][default to false] |
11
11
  | **expires_in** | **Integer** | Number of days before the signature request expires. Defaults to the account expiration setting or template expiration (if the document is created from a template). | [optional] |
12
12
  | **reminders** | **Boolean** | Whether to send signing reminders to recipients. Reminders are sent on day 3, day 6, and day 10 if set to `true`. Defaults to `true`. | [optional][default to true] |
@@ -14,8 +14,9 @@
14
14
  | **api_application_id** | **String** | Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings | [optional] |
15
15
  | **redirect_url** | **String** | A URL that recipients are redirected to after successfully signing a document. | [optional] |
16
16
  | **allow_decline** | **Boolean** | Whether to allow recipients the option to decline signing a document. If multiple signers are involved in a document, any single recipient can cancel the entire document signing process by declining to sign. | [optional][default to true] |
17
- | **allow_reassign** | **Boolean** | In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else. | [optional][default to true] |
17
+ | **allow_reassign** | **Boolean** | In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else. Unavailable on 21 CFR Part 11 documents: omit it and reassignment stays off, while sending `true` returns a 422. | [optional][default to true] |
18
18
  | **decline_redirect_url** | **String** | A URL that recipients are redirected to if the document is declined. | [optional] |
19
+ | **conditional_rules** | [**Array<ConditionalRuleRequest>**](ConditionalRuleRequest.md) | Conditional logic rules that show, hide, or require fields based on what a signer does to other fields. Every identifier is a field api_id. At most 10 rules per document or template. | [optional] |
19
20
  | **metadata** | **Hash<String, String>** | Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned. | [optional] |
20
21
  | **labels** | [**Array<LabelRequest>**](LabelRequest.md) | Labels can be used to organize documents in a way that can make it easy to find using the document search in SignWell. A document can have multiple labels. Updating labels on a document will replace any existing labels for that document. | [optional] |
21
22
  | **checkbox_groups** | [**Array<TemplateCheckboxGroupsInner>**](TemplateCheckboxGroupsInner.md) | Checkbox fields that are placed on a document can be grouped with selection requirements. At least 2 checkbox fields in an array of fields must be assigned to the same recipient. | [optional] |
@@ -38,6 +39,7 @@ instance = SignWell::Models::DocumentTemplateUpdateRequest.new(
38
39
  allow_decline: null,
39
40
  allow_reassign: null,
40
41
  decline_redirect_url: null,
42
+ conditional_rules: null,
41
43
  metadata: null,
42
44
  labels: null,
43
45
  checkbox_groups: null
@@ -0,0 +1,18 @@
1
+ # SignWell::Models::EmbeddedBranding
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **branding** | [**EmbeddedBrandingBranding**](EmbeddedBrandingBranding.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'signwell_sdk'
13
+
14
+ instance = SignWell::Models::EmbeddedBranding.new(
15
+ branding: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,26 @@
1
+ # SignWell::Models::EmbeddedBrandingBranding
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **company_logo** | **String** | Write-only. Reports only that a logo was set, never its URL or Base64 payload. | [optional] |
8
+ | **accent_color** | **String** | Hex, as #RRGGBB. | [optional] |
9
+ | **button_label_color** | **String** | Hex, as #RRGGBB. | [optional] |
10
+ | **link_color** | **String** | Hex, as #RRGGBB. | [optional] |
11
+ | **button_border_radius** | **Integer** | Pixels, 0 to 25. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'signwell_sdk'
17
+
18
+ instance = SignWell::Models::EmbeddedBrandingBranding.new(
19
+ company_logo: null,
20
+ accent_color: null,
21
+ button_label_color: null,
22
+ link_color: null,
23
+ button_border_radius: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # SignWell::Models::EmbeddedBrandingRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **company_logo** | [**EmbeddedBrandingRequestCompanyLogo**](EmbeddedBrandingRequestCompanyLogo.md) | | [optional] |
8
+ | **accent_color** | **String** | Accent color for this document's embedded pages, as a 6-digit HEX value. Returned normalized to `#RRGGBB`. | [optional] |
9
+ | **button_label_color** | **String** | Button label color for this document's embedded pages, as a 6-digit HEX value. Returned normalized to `#RRGGBB`. | [optional] |
10
+ | **link_color** | **String** | Link color for this document's embedded pages, as a 6-digit HEX value. Returned normalized to `#RRGGBB`. | [optional] |
11
+ | **button_border_radius** | **Integer** | Corner radius of buttons on this document's embedded pages, in pixels. Must be between 0 and 25. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'signwell_sdk'
17
+
18
+ instance = SignWell::Models::EmbeddedBrandingRequest.new(
19
+ company_logo: null,
20
+ accent_color: #51B6C4,
21
+ button_label_color: #FFFFFF,
22
+ link_color: #1A0DAB,
23
+ button_border_radius: 25
24
+ )
25
+ ```
26
+
@@ -0,0 +1,20 @@
1
+ # SignWell::Models::EmbeddedBrandingRequestCompanyLogo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **file_url** | **String** | Public `http` or `https` URL of the logo image. The value has to parse as one — anything else returns a `422`. SignWell never requests the URL when the document is created, so it is not checked for reachability or for what it points at. If the URL turns out to be unreachable, slow, or not a usable image when the page loads, the page falls back to the no-logo experience rather than erroring. | [optional] |
8
+ | **file_base64** | **String** | RFC 4648 Base64 string of the logo image. The 300 KB limit applies to the decoded image, not to the string you send, so a valid string runs about a third larger. The decoded image must be one of image/jpeg, image/png, image/gif, image/tiff, image/webp, image/svg+xml, image/heic, image/heif, image/avif. A payload that cannot be decoded, is not one of those formats, or is over the size limit returns a `422`. A payload that is accepted here but still fails to render when the page loads falls back to the no-logo experience. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'signwell_sdk'
14
+
15
+ instance = SignWell::Models::EmbeddedBrandingRequestCompanyLogo.new(
16
+ file_url: https://example.com/customer-logo.png,
17
+ file_base64: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # SignWell::Models::EmbeddedRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **branding** | [**EmbeddedBrandingRequest**](EmbeddedBrandingRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'signwell_sdk'
13
+
14
+ instance = SignWell::Models::EmbeddedRequest.new(
15
+ branding: null
16
+ )
17
+ ```
18
+
@@ -15,6 +15,8 @@
15
15
  | **api_id** | **String** | Unique identifier of the field. Useful when needing to reference specific field values or update a document and its fields. | [optional] |
16
16
  | **name** | **String** | Checkbox fields only. At least 2 checkbox fields in an array of fields must be assigned to the same recipient and grouped with selection requirements. | [optional] |
17
17
  | **validation** | [**TextValidation**](TextValidation.md) | | [optional] |
18
+ | **validation_regex** | **String** | Text fields with custom validation only: the regex pattern used to validate field values. Required when validation is set to custom. | [optional] |
19
+ | **validation_regex_error_message** | **String** | Text fields with custom validation only: the error message shown to the recipient when their input doesn't match the regex pattern. Required when validation is set to custom. | [optional] |
18
20
  | **fixed_width** | **Boolean** | Text fields only: whether the field width will stay fixed and text will display in multiple lines, rather than one long line. If set to `false` the field width will automatically grow horizontally to fit text on one line. Defaults to `false`. | [optional][default to false] |
19
21
  | **lock_sign_date** | **Boolean** | Date fields only: makes fields readonly and automatically populates with the date the recipient signed. Defaults to `false`. | [optional][default to false] |
20
22
  | **date_format** | [**DateFormat**](DateFormat.md) | | [optional] |
@@ -41,6 +43,8 @@ instance = SignWell::Models::FieldsInnerInner.new(
41
43
  api_id: null,
42
44
  name: null,
43
45
  validation: null,
46
+ validation_regex: null,
47
+ validation_regex_error_message: null,
44
48
  fixed_width: null,
45
49
  lock_sign_date: null,
46
50
  date_format: null,
@@ -6,8 +6,9 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | A unique identifier that you will give to each placeholder. We recommend numbering sequentially from 1 to X. IDs are required for associating recipients to fields and more. | |
8
8
  | **name** | **String** | Name of the placeholder. | |
9
- | **preassigned_recipient_name** | **String** | In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the name. | [optional] |
9
+ | **preassigned_recipient_name** | **String** | In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the name. Every recipient on a 21 CFR Part 11 document needs a name, so leaving it unset means the name has to be supplied when the document is created. | [optional] |
10
10
  | **preassigned_recipient_email** | **String** | In some cases, it may be necessary to pre-fill the name and email for a placeholder because it will always be the same person for all documents created from this template. This sets the email. | [optional] |
11
+ | **passcode_delivery** | [**PlaceholdersInnerPasscodeDelivery**](PlaceholdersInnerPasscodeDelivery.md) | | [optional] |
11
12
 
12
13
  ## Example
13
14
 
@@ -18,7 +19,8 @@ instance = SignWell::Models::PlaceholdersInner.new(
18
19
  id: null,
19
20
  name: null,
20
21
  preassigned_recipient_name: null,
21
- preassigned_recipient_email: null
22
+ preassigned_recipient_email: null,
23
+ passcode_delivery: null
22
24
  )
23
25
  ```
24
26
 
@@ -0,0 +1,22 @@
1
+ # SignWell::Models::PlaceholdersInnerPasscodeDelivery
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enabled** | **Boolean** | Enable passcode delivery for this recipient. Cannot be set to `false` on a 21 CFR Part 11 document: it returns a 422. | [optional] |
8
+ | **methods** | **Array<String>** | Delivery methods for the passcode. Currently supports: email. Defaults to [\"email\"] when omitted. | [optional] |
9
+ | **expire_after_access** | **Boolean** | Whether the passcode expires after the recipient accesses the document. Inherited by documents created from this template. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'signwell_sdk'
15
+
16
+ instance = SignWell::Models::PlaceholdersInnerPasscodeDelivery.new(
17
+ enabled: null,
18
+ methods: null,
19
+ expire_after_access: null
20
+ )
21
+ ```
22
+