docspring 4.5.0 → 4.6.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 (437) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +38 -0
  3. data/README.md +1 -1
  4. data/lib/docspring/api/client.rb +10 -4
  5. data/lib/docspring/api_client.rb +1 -1
  6. data/lib/docspring/models/combined_pdf.rb +1 -1
  7. data/lib/docspring/models/create_account_email_action_request.rb +1 -1
  8. data/lib/docspring/models/create_combined_pdf_request.rb +1 -1
  9. data/lib/docspring/models/create_email_action_request.rb +1 -1
  10. data/lib/docspring/models/create_submission_request.rb +5 -5
  11. data/lib/docspring/models/create_template_request.rb +76 -12
  12. data/lib/docspring/models/email_action.rb +1 -1
  13. data/lib/docspring/models/error_info.rb +1 -1
  14. data/lib/docspring/models/field.rb +166 -3
  15. data/lib/docspring/models/field_input.rb +77 -3
  16. data/lib/docspring/models/field_override.rb +55 -2
  17. data/lib/docspring/models/generated_file.rb +2 -2
  18. data/lib/docspring/models/number_part.rb +42 -0
  19. data/lib/docspring/models/predefined_field.rb +14 -1
  20. data/lib/docspring/models/predefined_field_input.rb +14 -1
  21. data/lib/docspring/models/signature_request.rb +3 -3
  22. data/lib/docspring/models/signature_request_input.rb +3 -10
  23. data/lib/docspring/models/submission.rb +3 -3
  24. data/lib/docspring/models/submission_files.rb +11 -1
  25. data/lib/docspring/models/submission_input.rb +2 -2
  26. data/lib/docspring/models/submission_summary.rb +1 -1
  27. data/lib/docspring/models/template.rb +154 -15
  28. data/lib/docspring/models/template_defaults.rb +1 -1
  29. data/lib/docspring/models/template_defaults_input.rb +1 -1
  30. data/lib/docspring/models/template_signer_role.rb +265 -0
  31. data/lib/docspring/models/template_signer_role_input.rb +227 -0
  32. data/lib/docspring/models/update_account_email_action_request.rb +1 -1
  33. data/lib/docspring/models/update_email_action_customization_request.rb +1 -1
  34. data/lib/docspring/models/update_email_action_request.rb +1 -1
  35. data/lib/docspring/models/update_template_document_request.rb +14 -4
  36. data/lib/docspring/models/update_template_request.rb +80 -16
  37. data/lib/docspring/models/validate_submission_request.rb +5 -5
  38. data/lib/docspring/request_schemas.json +278 -12
  39. data/lib/docspring/version.rb +1 -1
  40. data/lib/docspring.rb +3 -0
  41. metadata +5 -591
  42. data/.github/workflows/release.yml +0 -80
  43. data/.gitignore +0 -39
  44. data/.openapi-generator/FILES +0 -593
  45. data/.openapi-generator/VERSION +0 -1
  46. data/.openapi-generator-ignore +0 -23
  47. data/.rspec +0 -2
  48. data/.rubocop.yml +0 -148
  49. data/Gemfile +0 -9
  50. data/Gemfile.lock +0 -146
  51. data/Rakefile +0 -10
  52. data/docs/AddTemplateFieldsRequest.md +0 -18
  53. data/docs/AiFieldNamingLanguage.md +0 -15
  54. data/docs/AuthenticationCheck.md +0 -18
  55. data/docs/BarcodeSymbology.md +0 -15
  56. data/docs/CheckCharacter.md +0 -15
  57. data/docs/Client.md +0 -5890
  58. data/docs/CombinedFieldType.md +0 -15
  59. data/docs/CombinedPdf.md +0 -44
  60. data/docs/CombinedPdfFiles.md +0 -18
  61. data/docs/CombinedPdfList.md +0 -20
  62. data/docs/CombinedPdfSource.md +0 -26
  63. data/docs/CombinedPdfSourceInput.md +0 -88
  64. data/docs/CombinedPdfSourcePdf.md +0 -20
  65. data/docs/CombinedPdfSourceType.md +0 -15
  66. data/docs/CombinedPdfState.md +0 -15
  67. data/docs/CopyTemplateRequest.md +0 -22
  68. data/docs/CreateAccountEmailActionRequest.md +0 -54
  69. data/docs/CreateCombinedPdfRequest.md +0 -26
  70. data/docs/CreateCustomFileFromUploadRequest.md +0 -18
  71. data/docs/CreateEmailActionRequest.md +0 -50
  72. data/docs/CreateEmailDomainRequest.md +0 -18
  73. data/docs/CreateFolderRequest.md +0 -20
  74. data/docs/CreateSignatureRequestEventRequest.md +0 -24
  75. data/docs/CreateSignatureRequestTokenRequest.md +0 -18
  76. data/docs/CreateSubmissionBatchRequest.md +0 -28
  77. data/docs/CreateSubmissionRequest.md +0 -56
  78. data/docs/CreateTemplatePreviewRequest.md +0 -18
  79. data/docs/CreateTemplateRequest.md +0 -130
  80. data/docs/CreateWebhookRequest.md +0 -38
  81. data/docs/CustomFile.md +0 -28
  82. data/docs/CustomFileList.md +0 -20
  83. data/docs/CustomFileSourcePdf.md +0 -20
  84. data/docs/DnsRecordType.md +0 -15
  85. data/docs/EmailAction.md +0 -76
  86. data/docs/EmailActionConditions.md +0 -20
  87. data/docs/EmailActionConditionsInput.md +0 -20
  88. data/docs/EmailActionCustomization.md +0 -36
  89. data/docs/EmailActionDelivery.md +0 -15
  90. data/docs/EmailActionFileFormats.md +0 -15
  91. data/docs/EmailActionList.md +0 -20
  92. data/docs/EmailActionSetting.md +0 -15
  93. data/docs/EmailActionSubmissionType.md +0 -15
  94. data/docs/EmailActionTestEmail.md +0 -18
  95. data/docs/EmailDomain.md +0 -38
  96. data/docs/EmailDomainDnsRecord.md +0 -24
  97. data/docs/EmailDomainDnsRecordPurpose.md +0 -15
  98. data/docs/EmailDomainList.md +0 -20
  99. data/docs/EmailDomainRecordState.md +0 -15
  100. data/docs/EmailDomainState.md +0 -15
  101. data/docs/ErrorCode.md +0 -15
  102. data/docs/ErrorDetail.md +0 -26
  103. data/docs/ErrorInfo.md +0 -42
  104. data/docs/ErrorResponse.md +0 -18
  105. data/docs/ExpirationInterval.md +0 -15
  106. data/docs/Field.md +0 -198
  107. data/docs/FieldComparisonCondition.md +0 -22
  108. data/docs/FieldComparisonOperator.md +0 -15
  109. data/docs/FieldDependency.md +0 -22
  110. data/docs/FieldDependencyInput.md +0 -22
  111. data/docs/FieldDisplayType.md +0 -15
  112. data/docs/FieldEqualsCondition.md +0 -22
  113. data/docs/FieldEqualsOperator.md +0 -15
  114. data/docs/FieldGroup.md +0 -32
  115. data/docs/FieldGroupInput.md +0 -30
  116. data/docs/FieldGroupType.md +0 -15
  117. data/docs/FieldInCondition.md +0 -22
  118. data/docs/FieldInput.md +0 -196
  119. data/docs/FieldOverride.md +0 -142
  120. data/docs/FieldPresenceCondition.md +0 -20
  121. data/docs/FieldPresenceOperator.md +0 -15
  122. data/docs/FieldRangeCondition.md +0 -24
  123. data/docs/FieldReimportState.md +0 -15
  124. data/docs/FieldSetupLogic.md +0 -15
  125. data/docs/FieldSetupNaming.md +0 -15
  126. data/docs/FieldSetupSource.md +0 -15
  127. data/docs/FieldType.md +0 -15
  128. data/docs/Folder.md +0 -28
  129. data/docs/FolderList.md +0 -20
  130. data/docs/GenerateFilesFormat.md +0 -15
  131. data/docs/GenerateSubmissionFilesRequest.md +0 -18
  132. data/docs/GeneratedFile.md +0 -32
  133. data/docs/GeneratedFileState.md +0 -15
  134. data/docs/HtmlEngineOptions.md +0 -36
  135. data/docs/HtmlEngineOptionsInput.md +0 -36
  136. data/docs/ImageGravity.md +0 -15
  137. data/docs/ImageScaleType.md +0 -15
  138. data/docs/ModelCodeLanguage.md +0 -15
  139. data/docs/MoveFolderRequest.md +0 -18
  140. data/docs/MoveTemplateRequest.md +0 -18
  141. data/docs/NumberConditionType.md +0 -15
  142. data/docs/OutputFormat.md +0 -15
  143. data/docs/PageFormat.md +0 -15
  144. data/docs/PageImage.md +0 -34
  145. data/docs/PageImages.md +0 -24
  146. data/docs/PredefinedField.md +0 -30
  147. data/docs/PredefinedFieldInput.md +0 -30
  148. data/docs/PublishTemplateVersionRequest.md +0 -20
  149. data/docs/RemoveTemplateFieldsRequest.md +0 -18
  150. data/docs/RenameFolderRequest.md +0 -18
  151. data/docs/ReorderTemplateFieldsRequest.md +0 -18
  152. data/docs/RestoreTemplateVersionRequest.md +0 -18
  153. data/docs/SendAccountEmailActionTestEmailRequest.md +0 -18
  154. data/docs/ShapeType.md +0 -15
  155. data/docs/SignatureRequest.md +0 -74
  156. data/docs/SignatureRequestAuthSecondFactorType.md +0 -15
  157. data/docs/SignatureRequestAuthType.md +0 -15
  158. data/docs/SignatureRequestEmailAttachments.md +0 -15
  159. data/docs/SignatureRequestEmailStatus.md +0 -15
  160. data/docs/SignatureRequestEvent.md +0 -32
  161. data/docs/SignatureRequestEventType.md +0 -15
  162. data/docs/SignatureRequestInput.md +0 -50
  163. data/docs/SignatureRequestMessageType.md +0 -15
  164. data/docs/SignatureRequestReminders.md +0 -20
  165. data/docs/SignatureRequestState.md +0 -15
  166. data/docs/SignatureRequestToken.md +0 -30
  167. data/docs/SignatureRequestTokenType.md +0 -15
  168. data/docs/SigningOrder.md +0 -15
  169. data/docs/StringConditionType.md +0 -15
  170. data/docs/Submission.md +0 -68
  171. data/docs/SubmissionAction.md +0 -30
  172. data/docs/SubmissionActionState.md +0 -15
  173. data/docs/SubmissionActionType.md +0 -15
  174. data/docs/SubmissionBatch.md +0 -38
  175. data/docs/SubmissionBatchState.md +0 -15
  176. data/docs/SubmissionFiles.md +0 -28
  177. data/docs/SubmissionInput.md +0 -40
  178. data/docs/SubmissionList.md +0 -20
  179. data/docs/SubmissionSource.md +0 -15
  180. data/docs/SubmissionSourcePdf.md +0 -20
  181. data/docs/SubmissionState.md +0 -15
  182. data/docs/SubmissionSummary.md +0 -54
  183. data/docs/SubmissionValidation.md +0 -24
  184. data/docs/Template.md +0 -142
  185. data/docs/TemplateActor.md +0 -26
  186. data/docs/TemplateActorType.md +0 -15
  187. data/docs/TemplateDefaults.md +0 -56
  188. data/docs/TemplateDefaultsInput.md +0 -56
  189. data/docs/TemplateDiff.md +0 -30
  190. data/docs/TemplateDiffSummary.md +0 -28
  191. data/docs/TemplateDocument.md +0 -40
  192. data/docs/TemplateDocumentState.md +0 -15
  193. data/docs/TemplateDocumentSummary.md +0 -24
  194. data/docs/TemplateFieldChange.md +0 -24
  195. data/docs/TemplateFieldChanges.md +0 -24
  196. data/docs/TemplateFieldDependency.md +0 -26
  197. data/docs/TemplateFieldDependencyAction.md +0 -15
  198. data/docs/TemplateFieldDependencyCondition.md +0 -24
  199. data/docs/TemplateFieldDependencyConditionInput.md +0 -93
  200. data/docs/TemplateFieldDependencyInput.md +0 -26
  201. data/docs/TemplateFieldDependencyMatch.md +0 -15
  202. data/docs/TemplateFieldDependencyOperator.md +0 -15
  203. data/docs/TemplateFieldLogicStatus.md +0 -15
  204. data/docs/TemplateFieldMove.md +0 -22
  205. data/docs/TemplateFields.md +0 -22
  206. data/docs/TemplateFormMode.md +0 -15
  207. data/docs/TemplateFormSection.md +0 -24
  208. data/docs/TemplateFormSectionInput.md +0 -24
  209. data/docs/TemplateModelCode.md +0 -22
  210. data/docs/TemplatePageAiError.md +0 -15
  211. data/docs/TemplatePageAiNamingStatus.md +0 -15
  212. data/docs/TemplatePageFieldsStatus.md +0 -15
  213. data/docs/TemplatePageImageStatus.md +0 -15
  214. data/docs/TemplatePageImages.md +0 -24
  215. data/docs/TemplatePageProcessingStatus.md +0 -26
  216. data/docs/TemplatePreview.md +0 -32
  217. data/docs/TemplatePreviewState.md +0 -15
  218. data/docs/TemplateSourcePdf.md +0 -24
  219. data/docs/TemplateSummary.md +0 -46
  220. data/docs/TemplateSummaryList.md +0 -20
  221. data/docs/TemplateType.md +0 -15
  222. data/docs/TemplateVersion.md +0 -24
  223. data/docs/TemplateVersionType.md +0 -15
  224. data/docs/TextAlignment.md +0 -15
  225. data/docs/TextOverflow.md +0 -15
  226. data/docs/TextVerticalAlignment.md +0 -15
  227. data/docs/Typeface.md +0 -15
  228. data/docs/UpdateAccountEmailActionRequest.md +0 -54
  229. data/docs/UpdateEmailActionCustomizationRequest.md +0 -46
  230. data/docs/UpdateEmailActionRequest.md +0 -50
  231. data/docs/UpdateSignatureRequestRequest.md +0 -34
  232. data/docs/UpdateTemplateDocumentRequest.md +0 -26
  233. data/docs/UpdateTemplateFieldsRequest.md +0 -18
  234. data/docs/UpdateTemplateRequest.md +0 -114
  235. data/docs/UpdateWebhookRequest.md +0 -38
  236. data/docs/UploadMethod.md +0 -15
  237. data/docs/UploadPresign.md +0 -24
  238. data/docs/UrlSourcePdf.md +0 -20
  239. data/docs/ValidateSubmissionRequest.md +0 -56
  240. data/docs/Webhook.md +0 -56
  241. data/docs/WebhookEventType.md +0 -15
  242. data/docs/WebhookList.md +0 -20
  243. data/docs/WebhookMode.md +0 -15
  244. data/docspring.gemspec +0 -40
  245. data/spec/api/client_spec.rb +0 -1103
  246. data/spec/models/add_template_fields_request_spec.rb +0 -36
  247. data/spec/models/ai_field_naming_language_spec.rb +0 -30
  248. data/spec/models/authentication_check_spec.rb +0 -36
  249. data/spec/models/barcode_symbology_spec.rb +0 -30
  250. data/spec/models/check_character_spec.rb +0 -30
  251. data/spec/models/combined_field_type_spec.rb +0 -30
  252. data/spec/models/combined_pdf_files_spec.rb +0 -36
  253. data/spec/models/combined_pdf_list_spec.rb +0 -42
  254. data/spec/models/combined_pdf_source_input_spec.rb +0 -44
  255. data/spec/models/combined_pdf_source_pdf_spec.rb +0 -42
  256. data/spec/models/combined_pdf_source_spec.rb +0 -60
  257. data/spec/models/combined_pdf_source_type_spec.rb +0 -30
  258. data/spec/models/combined_pdf_spec.rb +0 -114
  259. data/spec/models/combined_pdf_state_spec.rb +0 -30
  260. data/spec/models/copy_template_request_spec.rb +0 -48
  261. data/spec/models/create_account_email_action_request_spec.rb +0 -144
  262. data/spec/models/create_combined_pdf_request_spec.rb +0 -60
  263. data/spec/models/create_custom_file_from_upload_request_spec.rb +0 -36
  264. data/spec/models/create_email_action_request_spec.rb +0 -132
  265. data/spec/models/create_email_domain_request_spec.rb +0 -36
  266. data/spec/models/create_folder_request_spec.rb +0 -42
  267. data/spec/models/create_signature_request_event_request_spec.rb +0 -54
  268. data/spec/models/create_signature_request_token_request_spec.rb +0 -36
  269. data/spec/models/create_submission_batch_request_spec.rb +0 -66
  270. data/spec/models/create_submission_request_spec.rb +0 -150
  271. data/spec/models/create_template_preview_request_spec.rb +0 -36
  272. data/spec/models/create_template_request_spec.rb +0 -372
  273. data/spec/models/create_webhook_request_spec.rb +0 -96
  274. data/spec/models/custom_file_list_spec.rb +0 -42
  275. data/spec/models/custom_file_source_pdf_spec.rb +0 -42
  276. data/spec/models/custom_file_spec.rb +0 -66
  277. data/spec/models/dns_record_type_spec.rb +0 -30
  278. data/spec/models/email_action_conditions_input_spec.rb +0 -42
  279. data/spec/models/email_action_conditions_spec.rb +0 -42
  280. data/spec/models/email_action_customization_spec.rb +0 -90
  281. data/spec/models/email_action_delivery_spec.rb +0 -30
  282. data/spec/models/email_action_file_formats_spec.rb +0 -30
  283. data/spec/models/email_action_list_spec.rb +0 -42
  284. data/spec/models/email_action_setting_spec.rb +0 -30
  285. data/spec/models/email_action_spec.rb +0 -210
  286. data/spec/models/email_action_submission_type_spec.rb +0 -30
  287. data/spec/models/email_action_test_email_spec.rb +0 -36
  288. data/spec/models/email_domain_dns_record_purpose_spec.rb +0 -30
  289. data/spec/models/email_domain_dns_record_spec.rb +0 -54
  290. data/spec/models/email_domain_list_spec.rb +0 -42
  291. data/spec/models/email_domain_record_state_spec.rb +0 -30
  292. data/spec/models/email_domain_spec.rb +0 -96
  293. data/spec/models/email_domain_state_spec.rb +0 -30
  294. data/spec/models/error_code_spec.rb +0 -30
  295. data/spec/models/error_detail_spec.rb +0 -60
  296. data/spec/models/error_info_spec.rb +0 -108
  297. data/spec/models/error_response_spec.rb +0 -36
  298. data/spec/models/expiration_interval_spec.rb +0 -30
  299. data/spec/models/field_comparison_condition_spec.rb +0 -48
  300. data/spec/models/field_comparison_operator_spec.rb +0 -30
  301. data/spec/models/field_dependency_input_spec.rb +0 -48
  302. data/spec/models/field_dependency_spec.rb +0 -48
  303. data/spec/models/field_display_type_spec.rb +0 -30
  304. data/spec/models/field_equals_condition_spec.rb +0 -48
  305. data/spec/models/field_equals_operator_spec.rb +0 -30
  306. data/spec/models/field_group_input_spec.rb +0 -72
  307. data/spec/models/field_group_spec.rb +0 -78
  308. data/spec/models/field_group_type_spec.rb +0 -30
  309. data/spec/models/field_in_condition_spec.rb +0 -48
  310. data/spec/models/field_input_spec.rb +0 -570
  311. data/spec/models/field_override_spec.rb +0 -408
  312. data/spec/models/field_presence_condition_spec.rb +0 -42
  313. data/spec/models/field_presence_operator_spec.rb +0 -30
  314. data/spec/models/field_range_condition_spec.rb +0 -54
  315. data/spec/models/field_reimport_state_spec.rb +0 -30
  316. data/spec/models/field_setup_logic_spec.rb +0 -30
  317. data/spec/models/field_setup_naming_spec.rb +0 -30
  318. data/spec/models/field_setup_source_spec.rb +0 -30
  319. data/spec/models/field_spec.rb +0 -576
  320. data/spec/models/field_type_spec.rb +0 -30
  321. data/spec/models/folder_list_spec.rb +0 -42
  322. data/spec/models/folder_spec.rb +0 -66
  323. data/spec/models/generate_files_format_spec.rb +0 -30
  324. data/spec/models/generate_submission_files_request_spec.rb +0 -36
  325. data/spec/models/generated_file_spec.rb +0 -78
  326. data/spec/models/generated_file_state_spec.rb +0 -30
  327. data/spec/models/html_engine_options_input_spec.rb +0 -90
  328. data/spec/models/html_engine_options_spec.rb +0 -90
  329. data/spec/models/image_gravity_spec.rb +0 -30
  330. data/spec/models/image_scale_type_spec.rb +0 -30
  331. data/spec/models/model_code_language_spec.rb +0 -30
  332. data/spec/models/move_folder_request_spec.rb +0 -36
  333. data/spec/models/move_template_request_spec.rb +0 -36
  334. data/spec/models/number_condition_type_spec.rb +0 -30
  335. data/spec/models/output_format_spec.rb +0 -30
  336. data/spec/models/page_format_spec.rb +0 -30
  337. data/spec/models/page_image_spec.rb +0 -84
  338. data/spec/models/page_images_spec.rb +0 -54
  339. data/spec/models/predefined_field_input_spec.rb +0 -72
  340. data/spec/models/predefined_field_spec.rb +0 -72
  341. data/spec/models/publish_template_version_request_spec.rb +0 -42
  342. data/spec/models/remove_template_fields_request_spec.rb +0 -36
  343. data/spec/models/rename_folder_request_spec.rb +0 -36
  344. data/spec/models/reorder_template_fields_request_spec.rb +0 -36
  345. data/spec/models/restore_template_version_request_spec.rb +0 -36
  346. data/spec/models/send_account_email_action_test_email_request_spec.rb +0 -36
  347. data/spec/models/shape_type_spec.rb +0 -30
  348. data/spec/models/signature_request_auth_second_factor_type_spec.rb +0 -30
  349. data/spec/models/signature_request_auth_type_spec.rb +0 -30
  350. data/spec/models/signature_request_email_attachments_spec.rb +0 -30
  351. data/spec/models/signature_request_email_status_spec.rb +0 -30
  352. data/spec/models/signature_request_event_spec.rb +0 -78
  353. data/spec/models/signature_request_event_type_spec.rb +0 -30
  354. data/spec/models/signature_request_input_spec.rb +0 -132
  355. data/spec/models/signature_request_message_type_spec.rb +0 -30
  356. data/spec/models/signature_request_reminders_spec.rb +0 -42
  357. data/spec/models/signature_request_spec.rb +0 -204
  358. data/spec/models/signature_request_state_spec.rb +0 -30
  359. data/spec/models/signature_request_token_spec.rb +0 -72
  360. data/spec/models/signature_request_token_type_spec.rb +0 -30
  361. data/spec/models/signing_order_spec.rb +0 -30
  362. data/spec/models/string_condition_type_spec.rb +0 -30
  363. data/spec/models/submission_action_spec.rb +0 -72
  364. data/spec/models/submission_action_state_spec.rb +0 -30
  365. data/spec/models/submission_action_type_spec.rb +0 -30
  366. data/spec/models/submission_batch_spec.rb +0 -96
  367. data/spec/models/submission_batch_state_spec.rb +0 -30
  368. data/spec/models/submission_files_spec.rb +0 -66
  369. data/spec/models/submission_input_spec.rb +0 -102
  370. data/spec/models/submission_list_spec.rb +0 -42
  371. data/spec/models/submission_source_pdf_spec.rb +0 -42
  372. data/spec/models/submission_source_spec.rb +0 -30
  373. data/spec/models/submission_spec.rb +0 -186
  374. data/spec/models/submission_state_spec.rb +0 -30
  375. data/spec/models/submission_summary_spec.rb +0 -144
  376. data/spec/models/submission_validation_spec.rb +0 -54
  377. data/spec/models/template_actor_spec.rb +0 -60
  378. data/spec/models/template_actor_type_spec.rb +0 -30
  379. data/spec/models/template_defaults_input_spec.rb +0 -150
  380. data/spec/models/template_defaults_spec.rb +0 -150
  381. data/spec/models/template_diff_spec.rb +0 -72
  382. data/spec/models/template_diff_summary_spec.rb +0 -66
  383. data/spec/models/template_document_spec.rb +0 -102
  384. data/spec/models/template_document_state_spec.rb +0 -30
  385. data/spec/models/template_document_summary_spec.rb +0 -54
  386. data/spec/models/template_field_change_spec.rb +0 -54
  387. data/spec/models/template_field_changes_spec.rb +0 -54
  388. data/spec/models/template_field_dependency_action_spec.rb +0 -30
  389. data/spec/models/template_field_dependency_condition_input_spec.rb +0 -44
  390. data/spec/models/template_field_dependency_condition_spec.rb +0 -54
  391. data/spec/models/template_field_dependency_input_spec.rb +0 -60
  392. data/spec/models/template_field_dependency_match_spec.rb +0 -30
  393. data/spec/models/template_field_dependency_operator_spec.rb +0 -30
  394. data/spec/models/template_field_dependency_spec.rb +0 -60
  395. data/spec/models/template_field_logic_status_spec.rb +0 -30
  396. data/spec/models/template_field_move_spec.rb +0 -48
  397. data/spec/models/template_fields_spec.rb +0 -48
  398. data/spec/models/template_form_mode_spec.rb +0 -30
  399. data/spec/models/template_form_section_input_spec.rb +0 -54
  400. data/spec/models/template_form_section_spec.rb +0 -54
  401. data/spec/models/template_model_code_spec.rb +0 -48
  402. data/spec/models/template_page_ai_error_spec.rb +0 -30
  403. data/spec/models/template_page_ai_naming_status_spec.rb +0 -30
  404. data/spec/models/template_page_fields_status_spec.rb +0 -30
  405. data/spec/models/template_page_image_status_spec.rb +0 -30
  406. data/spec/models/template_page_images_spec.rb +0 -54
  407. data/spec/models/template_page_processing_status_spec.rb +0 -60
  408. data/spec/models/template_preview_spec.rb +0 -78
  409. data/spec/models/template_preview_state_spec.rb +0 -30
  410. data/spec/models/template_source_pdf_spec.rb +0 -54
  411. data/spec/models/template_spec.rb +0 -408
  412. data/spec/models/template_summary_list_spec.rb +0 -42
  413. data/spec/models/template_summary_spec.rb +0 -120
  414. data/spec/models/template_type_spec.rb +0 -30
  415. data/spec/models/template_version_spec.rb +0 -54
  416. data/spec/models/template_version_type_spec.rb +0 -30
  417. data/spec/models/text_alignment_spec.rb +0 -30
  418. data/spec/models/text_overflow_spec.rb +0 -30
  419. data/spec/models/text_vertical_alignment_spec.rb +0 -30
  420. data/spec/models/typeface_spec.rb +0 -30
  421. data/spec/models/update_account_email_action_request_spec.rb +0 -144
  422. data/spec/models/update_email_action_customization_request_spec.rb +0 -120
  423. data/spec/models/update_email_action_request_spec.rb +0 -132
  424. data/spec/models/update_signature_request_request_spec.rb +0 -84
  425. data/spec/models/update_template_document_request_spec.rb +0 -60
  426. data/spec/models/update_template_fields_request_spec.rb +0 -36
  427. data/spec/models/update_template_request_spec.rb +0 -324
  428. data/spec/models/update_webhook_request_spec.rb +0 -96
  429. data/spec/models/upload_method_spec.rb +0 -30
  430. data/spec/models/upload_presign_spec.rb +0 -54
  431. data/spec/models/url_source_pdf_spec.rb +0 -42
  432. data/spec/models/validate_submission_request_spec.rb +0 -150
  433. data/spec/models/webhook_event_type_spec.rb +0 -30
  434. data/spec/models/webhook_list_spec.rb +0 -42
  435. data/spec/models/webhook_mode_spec.rb +0 -30
  436. data/spec/models/webhook_spec.rb +0 -150
  437. data/spec/spec_helper.rb +0 -111
@@ -58,6 +58,12 @@ module DocSpring
58
58
  # String fields only: a comma-separated list of the values the field accepts. It's added to the template's data schema as an `enum`, forms show it as a select list, and an `editable` field becomes a dropdown. Shared by every field with the same `name`.
59
59
  attr_accessor :option_list
60
60
 
61
+ # With `option_list`: the label forms show for each option, keyed by its value, such as `{"head_of_household": "Head of household"}`. The data, the API and webhooks keep the value, and the PDF prints it unless `print_option_labels` is set. An option without a label shows its value, or its sentence case when the options are lowercase words joined by underscores (`head_of_household` shows as "Head of household"). The template's data schema has them as `x-option-labels`. Each key must be one of the options, and each label must have some text. Shared by every field with the same `name`.
62
+ attr_accessor :option_labels
63
+
64
+ # Text display, with `option_labels`: the PDF prints the chosen option's label instead of its value, and an `editable` field's dropdown lists the labels. Shared by every field with the same `name`.
65
+ attr_accessor :print_option_labels
66
+
61
67
  # Combined fields only: a comma-separated list of the names of the fields whose values are combined, in order. Shared by every field with the same `name`.
62
68
  attr_accessor :combined_field_names
63
69
 
@@ -97,6 +103,15 @@ module DocSpring
97
103
  # Barcode fields only: the barcode format, which the value must match. `code_128` and `pdf417` take any ASCII text; `code_39` and `code_93` take capital letters, digits, spaces and `- . $ / + %`; `code_25` takes digits; `ean_13` takes 12 digits, `ean_8` 7 digits and `upc_a` 11 digits (the check digit is added). Shared by every field with the same `name`.
98
104
  attr_accessor :barcode_symbology
99
105
 
106
+ # With `comb`: the value fills the last boxes of the comb fields with this name, padded on the left with spaces, or with zeros with `comb_pad_with_zeros`, as amounts are written on paper forms. A number with `decimal_places` in one row of boxes lines up on its decimal point, which takes no box: the decimal places fill the last boxes. Date fields ignore it: a date prints in its format. Shared by every field with the same `name`.
107
+ attr_accessor :comb_fill_from_right
108
+
109
+ # With `comb_fill_from_right`: pads the value on the left with zeros instead of spaces, such as `000123`. A negative number keeps its minus sign in the first box. Shared by every field with the same `name`.
110
+ attr_accessor :comb_pad_with_zeros
111
+
112
+ # With `comb`, for string fields: only the value's digits print, one in each box, and any punctuation is left out, so `123-45-6789` fills the 9 boxes of an SSN. The template's data schema accepts as many digits as the boxes hold, with anything but letters between them. Number and date fields ignore it. Shared by every field with the same `name`.
113
+ attr_accessor :print_digits_only
114
+
100
115
  # Leaves the field off the PDF. It stays in the template's data schema (marked `x-hidden`) and on forms, so other fields, such as combined fields, can use its value. A hidden static check mark or shape isn't printed.
101
116
  attr_accessor :hidden
102
117
 
@@ -190,10 +205,10 @@ module DocSpring
190
205
  # Text display only: splits the field into `comb_number_of_cells` boxes of equal width and prints one character, centered, in each.
191
206
  attr_accessor :comb
192
207
 
193
- # With `comb`: how many boxes the field has. The value's maximum length in the template's data schema is this plus `comb_value_offset`.
208
+ # With `comb`: how many boxes the field has, up to 10,000. The value's maximum length in the template's data schema is the furthest that a comb field of its name reaches: its `comb_value_offset` plus its boxes. With `print_digits_only`, that many digits. A number field is split from its printed form (with `decimal_places`), and a number with a digit that no box prints (more digits than the boxes, or a digit where the offsets leave a gap) is a data error.
194
209
  attr_accessor :comb_number_of_cells
195
210
 
196
- # With `comb`: the position, from 0, of the first character of the value that this field prints. For an SSN printed in boxes of 3, 2 and 4 digits, three fields named `ssn` use offsets 0, 3 and 5.
211
+ # With `comb`: how many boxes of the value's row come before this field, from 0 to 10,000. The comb fields that share a name make one row of boxes, and each prints the row's characters from its offset. For an SSN printed in boxes of 3, 2 and 4 digits, three fields named `ssn` use offsets 0, 3 and 5. The fields that print a number's whole part (`number_part`) make a row of their own, and so do the ones that print its decimal places.
197
212
  attr_accessor :comb_value_offset
198
213
 
199
214
  # Shape display only: `square`, `rectangle`, `circle`, `ellipse`, `triangle` or `polygon`. A square or circle uses the smaller of `width` and `height`.
@@ -280,12 +295,18 @@ module DocSpring
280
295
  # Number fields with text display: prints the number with this many decimal places, from 0 (rounds to a whole number) to 99. Empty prints the number as it was sent.
281
296
  attr_accessor :decimal_places
282
297
 
298
+ # Number fields with text display: which part of the number this field prints. `all` prints the whole number, `whole` only the part before the decimal point (with a minus sign) and `decimals` only the decimal places. For an amount printed as `$ ____ . __`, two fields with the same name: one `whole`, and one `decimals` with `decimal_places` 2. The number is rounded once, to the `decimals` field's decimal places (2 when it sets none).
299
+ attr_accessor :number_part
300
+
283
301
  # Image fields only: how the image is resized to the field. `fit` keeps its proportions and fits it inside the field, which can leave empty space; `fill` keeps its proportions and crops it to fill the field; `stretch` stretches it to the field's size. Signatures and initials always fit.
284
302
  attr_accessor :image_scale_type
285
303
 
286
304
  # Image, signature and initials fields: where the image sits in the field with `fit`, or which part is kept with `fill`: `NorthWest` (top left), `North`, `NorthEast`, `West`, `Center`, `East`, `SouthWest`, `South` or `SouthEast` (bottom right). It also aligns typed signatures, and isn't used with `stretch`.
287
305
  attr_accessor :image_gravity
288
306
 
307
+ # Who fills in or signs the field when a submission has signature requests: one of the template's `signer_roles`, by its key, or `sender` for a field that submission data fills in, which no signer is asked for. Null when it has no role: a submission's only signer fills it in when data doesn't, and with two or more signature requests one of them has to list it in its `fields`. In an HTML or Word template, a field whose tag gives it a role (`{% form_field tenant_name, role: tenant %}`) has that one, which only the code can change. Shared by every field with the same `name`.
308
+ attr_accessor :signer_role
309
+
289
310
  # The field's own conditional logic rule: when other fields' values meet its conditions, the field is shown, made required, or both. Null when it has none. The template's rules (`field_dependencies`) can apply to the field too. Shared by every field with the same `name`.
290
311
  attr_accessor :dependencies
291
312
 
@@ -328,6 +349,8 @@ module DocSpring
328
349
  :'metadata' => :'metadata',
329
350
  :'required' => :'required',
330
351
  :'option_list' => :'option_list',
352
+ :'option_labels' => :'option_labels',
353
+ :'print_option_labels' => :'print_option_labels',
331
354
  :'combined_field_names' => :'combined_field_names',
332
355
  :'combined_field_type' => :'combined_field_type',
333
356
  :'combined_field_separator' => :'combined_field_separator',
@@ -341,6 +364,9 @@ module DocSpring
341
364
  :'signature_allow_draw' => :'signature_allow_draw',
342
365
  :'signature_allow_type' => :'signature_allow_type',
343
366
  :'barcode_symbology' => :'barcode_symbology',
367
+ :'comb_fill_from_right' => :'comb_fill_from_right',
368
+ :'comb_pad_with_zeros' => :'comb_pad_with_zeros',
369
+ :'print_digits_only' => :'print_digits_only',
344
370
  :'hidden' => :'hidden',
345
371
  :'x' => :'x',
346
372
  :'y' => :'y',
@@ -402,8 +428,10 @@ module DocSpring
402
428
  :'invert_boolean_condition' => :'invert_boolean_condition',
403
429
  :'currency' => :'currency',
404
430
  :'decimal_places' => :'decimal_places',
431
+ :'number_part' => :'number_part',
405
432
  :'image_scale_type' => :'image_scale_type',
406
433
  :'image_gravity' => :'image_gravity',
434
+ :'signer_role' => :'signer_role',
407
435
  :'dependencies' => :'dependencies'
408
436
  }
409
437
  end
@@ -435,6 +463,8 @@ module DocSpring
435
463
  :'metadata' => :'String',
436
464
  :'required' => :'Boolean',
437
465
  :'option_list' => :'String',
466
+ :'option_labels' => :'Hash<String, String>',
467
+ :'print_option_labels' => :'Boolean',
438
468
  :'combined_field_names' => :'String',
439
469
  :'combined_field_type' => :'CombinedFieldType',
440
470
  :'combined_field_separator' => :'String',
@@ -448,6 +478,9 @@ module DocSpring
448
478
  :'signature_allow_draw' => :'Boolean',
449
479
  :'signature_allow_type' => :'Boolean',
450
480
  :'barcode_symbology' => :'BarcodeSymbology',
481
+ :'comb_fill_from_right' => :'Boolean',
482
+ :'comb_pad_with_zeros' => :'Boolean',
483
+ :'print_digits_only' => :'Boolean',
451
484
  :'hidden' => :'Boolean',
452
485
  :'x' => :'Float',
453
486
  :'y' => :'Float',
@@ -509,8 +542,10 @@ module DocSpring
509
542
  :'invert_boolean_condition' => :'Boolean',
510
543
  :'currency' => :'Boolean',
511
544
  :'decimal_places' => :'Integer',
545
+ :'number_part' => :'NumberPart',
512
546
  :'image_scale_type' => :'ImageScaleType',
513
547
  :'image_gravity' => :'ImageGravity',
548
+ :'signer_role' => :'String',
514
549
  :'dependencies' => :'FieldDependency'
515
550
  }
516
551
  end
@@ -522,6 +557,7 @@ module DocSpring
522
557
  :'acroform_name',
523
558
  :'default',
524
559
  :'option_list',
560
+ :'option_labels',
525
561
  :'minimum',
526
562
  :'maximum',
527
563
  :'include_time',
@@ -547,6 +583,7 @@ module DocSpring
547
583
  :'number_condition_range_min',
548
584
  :'number_condition_range_max',
549
585
  :'decimal_places',
586
+ :'signer_role',
550
587
  :'dependencies'
551
588
  ])
552
589
  end
@@ -661,6 +698,20 @@ module DocSpring
661
698
  self.option_list = nil
662
699
  end
663
700
 
701
+ if attributes.key?(:'option_labels')
702
+ if (value = attributes[:'option_labels']).is_a?(Hash) || value.nil?
703
+ self.option_labels = value
704
+ end
705
+ else
706
+ self.option_labels = nil
707
+ end
708
+
709
+ if attributes.key?(:'print_option_labels')
710
+ self.print_option_labels = attributes[:'print_option_labels']
711
+ else
712
+ self.print_option_labels = nil
713
+ end
714
+
664
715
  if attributes.key?(:'combined_field_names')
665
716
  self.combined_field_names = attributes[:'combined_field_names']
666
717
  else
@@ -739,6 +790,24 @@ module DocSpring
739
790
  self.barcode_symbology = nil
740
791
  end
741
792
 
793
+ if attributes.key?(:'comb_fill_from_right')
794
+ self.comb_fill_from_right = attributes[:'comb_fill_from_right']
795
+ else
796
+ self.comb_fill_from_right = nil
797
+ end
798
+
799
+ if attributes.key?(:'comb_pad_with_zeros')
800
+ self.comb_pad_with_zeros = attributes[:'comb_pad_with_zeros']
801
+ else
802
+ self.comb_pad_with_zeros = nil
803
+ end
804
+
805
+ if attributes.key?(:'print_digits_only')
806
+ self.print_digits_only = attributes[:'print_digits_only']
807
+ else
808
+ self.print_digits_only = nil
809
+ end
810
+
742
811
  if attributes.key?(:'hidden')
743
812
  self.hidden = attributes[:'hidden']
744
813
  else
@@ -1105,6 +1174,12 @@ module DocSpring
1105
1174
  self.decimal_places = nil
1106
1175
  end
1107
1176
 
1177
+ if attributes.key?(:'number_part')
1178
+ self.number_part = attributes[:'number_part']
1179
+ else
1180
+ self.number_part = nil
1181
+ end
1182
+
1108
1183
  if attributes.key?(:'image_scale_type')
1109
1184
  self.image_scale_type = attributes[:'image_scale_type']
1110
1185
  else
@@ -1117,6 +1192,12 @@ module DocSpring
1117
1192
  self.image_gravity = nil
1118
1193
  end
1119
1194
 
1195
+ if attributes.key?(:'signer_role')
1196
+ self.signer_role = attributes[:'signer_role']
1197
+ else
1198
+ self.signer_role = nil
1199
+ end
1200
+
1120
1201
  if attributes.key?(:'dependencies')
1121
1202
  self.dependencies = attributes[:'dependencies']
1122
1203
  else
@@ -1169,6 +1250,10 @@ module DocSpring
1169
1250
  invalid_properties.push('invalid value for "required", required cannot be nil.')
1170
1251
  end
1171
1252
 
1253
+ if @print_option_labels.nil?
1254
+ invalid_properties.push('invalid value for "print_option_labels", print_option_labels cannot be nil.')
1255
+ end
1256
+
1172
1257
  if @combined_field_names.nil?
1173
1258
  invalid_properties.push('invalid value for "combined_field_names", combined_field_names cannot be nil.')
1174
1259
  end
@@ -1209,6 +1294,18 @@ module DocSpring
1209
1294
  invalid_properties.push('invalid value for "barcode_symbology", barcode_symbology cannot be nil.')
1210
1295
  end
1211
1296
 
1297
+ if @comb_fill_from_right.nil?
1298
+ invalid_properties.push('invalid value for "comb_fill_from_right", comb_fill_from_right cannot be nil.')
1299
+ end
1300
+
1301
+ if @comb_pad_with_zeros.nil?
1302
+ invalid_properties.push('invalid value for "comb_pad_with_zeros", comb_pad_with_zeros cannot be nil.')
1303
+ end
1304
+
1305
+ if @print_digits_only.nil?
1306
+ invalid_properties.push('invalid value for "print_digits_only", print_digits_only cannot be nil.')
1307
+ end
1308
+
1212
1309
  if @hidden.nil?
1213
1310
  invalid_properties.push('invalid value for "hidden", hidden cannot be nil.')
1214
1311
  end
@@ -1365,6 +1462,10 @@ module DocSpring
1365
1462
  invalid_properties.push('invalid value for "currency", currency cannot be nil.')
1366
1463
  end
1367
1464
 
1465
+ if @number_part.nil?
1466
+ invalid_properties.push('invalid value for "number_part", number_part cannot be nil.')
1467
+ end
1468
+
1368
1469
  if @image_scale_type.nil?
1369
1470
  invalid_properties.push('invalid value for "image_scale_type", image_scale_type cannot be nil.')
1370
1471
  end
@@ -1390,6 +1491,7 @@ module DocSpring
1390
1491
  return false if @placeholder.nil?
1391
1492
  return false if @metadata.nil?
1392
1493
  return false if @required.nil?
1494
+ return false if @print_option_labels.nil?
1393
1495
  return false if @combined_field_names.nil?
1394
1496
  return false if @combined_field_type.nil?
1395
1497
  return false if @combined_field_separator.nil?
@@ -1400,6 +1502,9 @@ module DocSpring
1400
1502
  return false if @signature_allow_draw.nil?
1401
1503
  return false if @signature_allow_type.nil?
1402
1504
  return false if @barcode_symbology.nil?
1505
+ return false if @comb_fill_from_right.nil?
1506
+ return false if @comb_pad_with_zeros.nil?
1507
+ return false if @print_digits_only.nil?
1403
1508
  return false if @hidden.nil?
1404
1509
  return false if @x.nil?
1405
1510
  return false if @y.nil?
@@ -1439,6 +1544,7 @@ module DocSpring
1439
1544
  return false if @number_condition_range_exclusive_max.nil?
1440
1545
  return false if @invert_boolean_condition.nil?
1441
1546
  return false if @currency.nil?
1547
+ return false if @number_part.nil?
1442
1548
  return false if @image_scale_type.nil?
1443
1549
  return false if @image_gravity.nil?
1444
1550
  true
@@ -1544,6 +1650,16 @@ module DocSpring
1544
1650
  @required = required
1545
1651
  end
1546
1652
 
1653
+ # Custom attribute writer method with validation
1654
+ # @param [Object] print_option_labels Value to be assigned
1655
+ def print_option_labels=(print_option_labels)
1656
+ if print_option_labels.nil?
1657
+ fail ArgumentError, 'print_option_labels cannot be nil'
1658
+ end
1659
+
1660
+ @print_option_labels = print_option_labels
1661
+ end
1662
+
1547
1663
  # Custom attribute writer method with validation
1548
1664
  # @param [Object] combined_field_names Value to be assigned
1549
1665
  def combined_field_names=(combined_field_names)
@@ -1644,6 +1760,36 @@ module DocSpring
1644
1760
  @barcode_symbology = barcode_symbology
1645
1761
  end
1646
1762
 
1763
+ # Custom attribute writer method with validation
1764
+ # @param [Object] comb_fill_from_right Value to be assigned
1765
+ def comb_fill_from_right=(comb_fill_from_right)
1766
+ if comb_fill_from_right.nil?
1767
+ fail ArgumentError, 'comb_fill_from_right cannot be nil'
1768
+ end
1769
+
1770
+ @comb_fill_from_right = comb_fill_from_right
1771
+ end
1772
+
1773
+ # Custom attribute writer method with validation
1774
+ # @param [Object] comb_pad_with_zeros Value to be assigned
1775
+ def comb_pad_with_zeros=(comb_pad_with_zeros)
1776
+ if comb_pad_with_zeros.nil?
1777
+ fail ArgumentError, 'comb_pad_with_zeros cannot be nil'
1778
+ end
1779
+
1780
+ @comb_pad_with_zeros = comb_pad_with_zeros
1781
+ end
1782
+
1783
+ # Custom attribute writer method with validation
1784
+ # @param [Object] print_digits_only Value to be assigned
1785
+ def print_digits_only=(print_digits_only)
1786
+ if print_digits_only.nil?
1787
+ fail ArgumentError, 'print_digits_only cannot be nil'
1788
+ end
1789
+
1790
+ @print_digits_only = print_digits_only
1791
+ end
1792
+
1647
1793
  # Custom attribute writer method with validation
1648
1794
  # @param [Object] hidden Value to be assigned
1649
1795
  def hidden=(hidden)
@@ -2034,6 +2180,16 @@ module DocSpring
2034
2180
  @currency = currency
2035
2181
  end
2036
2182
 
2183
+ # Custom attribute writer method with validation
2184
+ # @param [Object] number_part Value to be assigned
2185
+ def number_part=(number_part)
2186
+ if number_part.nil?
2187
+ fail ArgumentError, 'number_part cannot be nil'
2188
+ end
2189
+
2190
+ @number_part = number_part
2191
+ end
2192
+
2037
2193
  # Custom attribute writer method with validation
2038
2194
  # @param [Object] image_scale_type Value to be assigned
2039
2195
  def image_scale_type=(image_scale_type)
@@ -2073,6 +2229,8 @@ module DocSpring
2073
2229
  metadata == o.metadata &&
2074
2230
  required == o.required &&
2075
2231
  option_list == o.option_list &&
2232
+ option_labels == o.option_labels &&
2233
+ print_option_labels == o.print_option_labels &&
2076
2234
  combined_field_names == o.combined_field_names &&
2077
2235
  combined_field_type == o.combined_field_type &&
2078
2236
  combined_field_separator == o.combined_field_separator &&
@@ -2086,6 +2244,9 @@ module DocSpring
2086
2244
  signature_allow_draw == o.signature_allow_draw &&
2087
2245
  signature_allow_type == o.signature_allow_type &&
2088
2246
  barcode_symbology == o.barcode_symbology &&
2247
+ comb_fill_from_right == o.comb_fill_from_right &&
2248
+ comb_pad_with_zeros == o.comb_pad_with_zeros &&
2249
+ print_digits_only == o.print_digits_only &&
2089
2250
  hidden == o.hidden &&
2090
2251
  x == o.x &&
2091
2252
  y == o.y &&
@@ -2147,8 +2308,10 @@ module DocSpring
2147
2308
  invert_boolean_condition == o.invert_boolean_condition &&
2148
2309
  currency == o.currency &&
2149
2310
  decimal_places == o.decimal_places &&
2311
+ number_part == o.number_part &&
2150
2312
  image_scale_type == o.image_scale_type &&
2151
2313
  image_gravity == o.image_gravity &&
2314
+ signer_role == o.signer_role &&
2152
2315
  dependencies == o.dependencies
2153
2316
  end
2154
2317
 
@@ -2161,7 +2324,7 @@ module DocSpring
2161
2324
  # Calculates hash code according to all attributes.
2162
2325
  # @return [Integer] Hash code
2163
2326
  def hash
2164
- [id, name, page, acroform_name, type, static, editable, default, title, description, placeholder, metadata, required, option_list, combined_field_names, combined_field_type, combined_field_separator, combined_field_format, integer, minimum, maximum, exclusive_minimum, exclusive_maximum, include_time, signature_allow_draw, signature_allow_type, barcode_symbology, hidden, x, y, width, height, rotation, display_type, opacity, date_time_format, typeface, font_size, character_spacing, bold, uppercase, strikethrough, keep_leading_spaces, overflow, multiline, multiline_lines, min_length, max_length, auto_calculate_max_length, color, color_field_name, color_field_required, background_color, background_color_field_name, background_color_field_required, alignment, v_alignment, comb, comb_number_of_cells, comb_value_offset, shape_type, shape_sides, shape_border_width, shape_border_color, shape_border_color_field_name, shape_border_color_field_required, shape_fill_color, shape_fill_color_field_name, shape_fill_color_field_required, check_character, check_color, check_color_field_name, check_color_field_required, qrcode_color, qrcode_color_field_name, qrcode_color_field_required, true_text, false_text, condition, string_condition_type, number_condition_type, number_condition_range_min, number_condition_range_max, number_condition_range_exclusive_min, number_condition_range_exclusive_max, invert_boolean_condition, currency, decimal_places, image_scale_type, image_gravity, dependencies].hash
2327
+ [id, name, page, acroform_name, type, static, editable, default, title, description, placeholder, metadata, required, option_list, option_labels, print_option_labels, combined_field_names, combined_field_type, combined_field_separator, combined_field_format, integer, minimum, maximum, exclusive_minimum, exclusive_maximum, include_time, signature_allow_draw, signature_allow_type, barcode_symbology, comb_fill_from_right, comb_pad_with_zeros, print_digits_only, hidden, x, y, width, height, rotation, display_type, opacity, date_time_format, typeface, font_size, character_spacing, bold, uppercase, strikethrough, keep_leading_spaces, overflow, multiline, multiline_lines, min_length, max_length, auto_calculate_max_length, color, color_field_name, color_field_required, background_color, background_color_field_name, background_color_field_required, alignment, v_alignment, comb, comb_number_of_cells, comb_value_offset, shape_type, shape_sides, shape_border_width, shape_border_color, shape_border_color_field_name, shape_border_color_field_required, shape_fill_color, shape_fill_color_field_name, shape_fill_color_field_required, check_character, check_color, check_color_field_name, check_color_field_required, qrcode_color, qrcode_color_field_name, qrcode_color_field_required, true_text, false_text, condition, string_condition_type, number_condition_type, number_condition_range_min, number_condition_range_max, number_condition_range_exclusive_min, number_condition_range_exclusive_max, invert_boolean_condition, currency, decimal_places, number_part, image_scale_type, image_gravity, signer_role, dependencies].hash
2165
2328
  end
2166
2329
 
2167
2330
  # Builds the object from hash
@@ -52,6 +52,12 @@ module DocSpring
52
52
  # String fields only: a comma-separated list of the values the field accepts. It's added to the template's data schema as an `enum`, forms show it as a select list, and an `editable` field becomes a dropdown. Shared by every field with the same `name`.
53
53
  attr_accessor :option_list
54
54
 
55
+ # With `option_list`: the label forms show for each option, keyed by its value, such as `{"head_of_household": "Head of household"}`. The data, the API and webhooks keep the value, and the PDF prints it unless `print_option_labels` is set. An option without a label shows its value, or its sentence case when the options are lowercase words joined by underscores (`head_of_household` shows as "Head of household"). The template's data schema has them as `x-option-labels`. Each key must be one of the options, and each label must have some text. Shared by every field with the same `name`.
56
+ attr_accessor :option_labels
57
+
58
+ # Text display, with `option_labels`: the PDF prints the chosen option's label instead of its value, and an `editable` field's dropdown lists the labels. Shared by every field with the same `name`.
59
+ attr_accessor :print_option_labels
60
+
55
61
  # Combined fields only: a comma-separated list of the names of the fields whose values are combined, in order. Shared by every field with the same `name`.
56
62
  attr_accessor :combined_field_names
57
63
 
@@ -91,6 +97,15 @@ module DocSpring
91
97
  # Barcode fields only: the barcode format, which the value must match. `code_128` and `pdf417` take any ASCII text; `code_39` and `code_93` take capital letters, digits, spaces and `- . $ / + %`; `code_25` takes digits; `ean_13` takes 12 digits, `ean_8` 7 digits and `upc_a` 11 digits (the check digit is added). Shared by every field with the same `name`.
92
98
  attr_accessor :barcode_symbology
93
99
 
100
+ # With `comb`: the value fills the last boxes of the comb fields with this name, padded on the left with spaces, or with zeros with `comb_pad_with_zeros`, as amounts are written on paper forms. A number with `decimal_places` in one row of boxes lines up on its decimal point, which takes no box: the decimal places fill the last boxes. Date fields ignore it: a date prints in its format. Shared by every field with the same `name`.
101
+ attr_accessor :comb_fill_from_right
102
+
103
+ # With `comb_fill_from_right`: pads the value on the left with zeros instead of spaces, such as `000123`. A negative number keeps its minus sign in the first box. Shared by every field with the same `name`.
104
+ attr_accessor :comb_pad_with_zeros
105
+
106
+ # With `comb`, for string fields: only the value's digits print, one in each box, and any punctuation is left out, so `123-45-6789` fills the 9 boxes of an SSN. The template's data schema accepts as many digits as the boxes hold, with anything but letters between them. Number and date fields ignore it. Shared by every field with the same `name`.
107
+ attr_accessor :print_digits_only
108
+
94
109
  # Leaves the field off the PDF. It stays in the template's data schema (marked `x-hidden`) and on forms, so other fields, such as combined fields, can use its value. A hidden static check mark or shape isn't printed.
95
110
  attr_accessor :hidden
96
111
 
@@ -184,10 +199,10 @@ module DocSpring
184
199
  # Text display only: splits the field into `comb_number_of_cells` boxes of equal width and prints one character, centered, in each.
185
200
  attr_accessor :comb
186
201
 
187
- # With `comb`: how many boxes the field has. The value's maximum length in the template's data schema is this plus `comb_value_offset`.
202
+ # With `comb`: how many boxes the field has, up to 10,000. The value's maximum length in the template's data schema is the furthest that a comb field of its name reaches: its `comb_value_offset` plus its boxes. With `print_digits_only`, that many digits. A number field is split from its printed form (with `decimal_places`), and a number with a digit that no box prints (more digits than the boxes, or a digit where the offsets leave a gap) is a data error.
188
203
  attr_accessor :comb_number_of_cells
189
204
 
190
- # With `comb`: the position, from 0, of the first character of the value that this field prints. For an SSN printed in boxes of 3, 2 and 4 digits, three fields named `ssn` use offsets 0, 3 and 5.
205
+ # With `comb`: how many boxes of the value's row come before this field, from 0 to 10,000. The comb fields that share a name make one row of boxes, and each prints the row's characters from its offset. For an SSN printed in boxes of 3, 2 and 4 digits, three fields named `ssn` use offsets 0, 3 and 5. The fields that print a number's whole part (`number_part`) make a row of their own, and so do the ones that print its decimal places.
191
206
  attr_accessor :comb_value_offset
192
207
 
193
208
  # Shape display only: `square`, `rectangle`, `circle`, `ellipse`, `triangle` or `polygon`. A square or circle uses the smaller of `width` and `height`.
@@ -274,12 +289,18 @@ module DocSpring
274
289
  # Number fields with text display: prints the number with this many decimal places, from 0 (rounds to a whole number) to 99. Empty prints the number as it was sent.
275
290
  attr_accessor :decimal_places
276
291
 
292
+ # Number fields with text display: which part of the number this field prints. `all` prints the whole number, `whole` only the part before the decimal point (with a minus sign) and `decimals` only the decimal places. For an amount printed as `$ ____ . __`, two fields with the same name: one `whole`, and one `decimals` with `decimal_places` 2. The number is rounded once, to the `decimals` field's decimal places (2 when it sets none).
293
+ attr_accessor :number_part
294
+
277
295
  # Image fields only: how the image is resized to the field. `fit` keeps its proportions and fits it inside the field, which can leave empty space; `fill` keeps its proportions and crops it to fill the field; `stretch` stretches it to the field's size. Signatures and initials always fit.
278
296
  attr_accessor :image_scale_type
279
297
 
280
298
  # Image, signature and initials fields: where the image sits in the field with `fit`, or which part is kept with `fill`: `NorthWest` (top left), `North`, `NorthEast`, `West`, `Center`, `East`, `SouthWest`, `South` or `SouthEast` (bottom right). It also aligns typed signatures, and isn't used with `stretch`.
281
299
  attr_accessor :image_gravity
282
300
 
301
+ # Who fills in or signs the field when a submission has signature requests: one of the template's `signer_roles`, by its key, or `sender` for a field that submission data fills in, which no signer is asked for. Null when it has no role: a submission's only signer fills it in when data doesn't, and with two or more signature requests one of them has to list it in its `fields`. In an HTML or Word template, a field whose tag gives it a role (`{% form_field tenant_name, role: tenant %}`) has that one, which only the code can change. Shared by every field with the same `name`.
302
+ attr_accessor :signer_role
303
+
283
304
  # The field's own conditional logic rule: when other fields' values meet its conditions, the field is shown, made required, or both. Null when it has none. The template's rules (`field_dependencies`) can apply to the field too. Shared by every field with the same `name`.
284
305
  attr_accessor :dependencies
285
306
 
@@ -323,6 +344,8 @@ module DocSpring
323
344
  :'metadata' => :'metadata',
324
345
  :'required' => :'required',
325
346
  :'option_list' => :'option_list',
347
+ :'option_labels' => :'option_labels',
348
+ :'print_option_labels' => :'print_option_labels',
326
349
  :'combined_field_names' => :'combined_field_names',
327
350
  :'combined_field_type' => :'combined_field_type',
328
351
  :'combined_field_separator' => :'combined_field_separator',
@@ -336,6 +359,9 @@ module DocSpring
336
359
  :'signature_allow_draw' => :'signature_allow_draw',
337
360
  :'signature_allow_type' => :'signature_allow_type',
338
361
  :'barcode_symbology' => :'barcode_symbology',
362
+ :'comb_fill_from_right' => :'comb_fill_from_right',
363
+ :'comb_pad_with_zeros' => :'comb_pad_with_zeros',
364
+ :'print_digits_only' => :'print_digits_only',
339
365
  :'hidden' => :'hidden',
340
366
  :'x' => :'x',
341
367
  :'y' => :'y',
@@ -397,8 +423,10 @@ module DocSpring
397
423
  :'invert_boolean_condition' => :'invert_boolean_condition',
398
424
  :'currency' => :'currency',
399
425
  :'decimal_places' => :'decimal_places',
426
+ :'number_part' => :'number_part',
400
427
  :'image_scale_type' => :'image_scale_type',
401
428
  :'image_gravity' => :'image_gravity',
429
+ :'signer_role' => :'signer_role',
402
430
  :'dependencies' => :'dependencies',
403
431
  :'id' => :'id'
404
432
  }
@@ -429,6 +457,8 @@ module DocSpring
429
457
  :'metadata' => :'String',
430
458
  :'required' => :'Boolean',
431
459
  :'option_list' => :'String',
460
+ :'option_labels' => :'Hash<String, String>',
461
+ :'print_option_labels' => :'Boolean',
432
462
  :'combined_field_names' => :'String',
433
463
  :'combined_field_type' => :'CombinedFieldType',
434
464
  :'combined_field_separator' => :'String',
@@ -442,6 +472,9 @@ module DocSpring
442
472
  :'signature_allow_draw' => :'Boolean',
443
473
  :'signature_allow_type' => :'Boolean',
444
474
  :'barcode_symbology' => :'BarcodeSymbology',
475
+ :'comb_fill_from_right' => :'Boolean',
476
+ :'comb_pad_with_zeros' => :'Boolean',
477
+ :'print_digits_only' => :'Boolean',
445
478
  :'hidden' => :'Boolean',
446
479
  :'x' => :'Float',
447
480
  :'y' => :'Float',
@@ -503,8 +536,10 @@ module DocSpring
503
536
  :'invert_boolean_condition' => :'Boolean',
504
537
  :'currency' => :'Boolean',
505
538
  :'decimal_places' => :'Integer',
539
+ :'number_part' => :'NumberPart',
506
540
  :'image_scale_type' => :'ImageScaleType',
507
541
  :'image_gravity' => :'ImageGravity',
542
+ :'signer_role' => :'String',
508
543
  :'dependencies' => :'FieldDependencyInput',
509
544
  :'id' => :'Integer'
510
545
  }
@@ -516,6 +551,7 @@ module DocSpring
516
551
  :'name',
517
552
  :'default',
518
553
  :'option_list',
554
+ :'option_labels',
519
555
  :'minimum',
520
556
  :'maximum',
521
557
  :'include_time',
@@ -541,6 +577,7 @@ module DocSpring
541
577
  :'number_condition_range_min',
542
578
  :'number_condition_range_max',
543
579
  :'decimal_places',
580
+ :'signer_role',
544
581
  :'dependencies',
545
582
  ])
546
583
  end
@@ -619,6 +656,16 @@ module DocSpring
619
656
  self.option_list = attributes[:'option_list']
620
657
  end
621
658
 
659
+ if attributes.key?(:'option_labels')
660
+ if (value = attributes[:'option_labels']).is_a?(Hash) || value.nil?
661
+ self.option_labels = value
662
+ end
663
+ end
664
+
665
+ if attributes.key?(:'print_option_labels')
666
+ self.print_option_labels = attributes[:'print_option_labels']
667
+ end
668
+
622
669
  if attributes.key?(:'combined_field_names')
623
670
  self.combined_field_names = attributes[:'combined_field_names']
624
671
  end
@@ -671,6 +718,18 @@ module DocSpring
671
718
  self.barcode_symbology = attributes[:'barcode_symbology']
672
719
  end
673
720
 
721
+ if attributes.key?(:'comb_fill_from_right')
722
+ self.comb_fill_from_right = attributes[:'comb_fill_from_right']
723
+ end
724
+
725
+ if attributes.key?(:'comb_pad_with_zeros')
726
+ self.comb_pad_with_zeros = attributes[:'comb_pad_with_zeros']
727
+ end
728
+
729
+ if attributes.key?(:'print_digits_only')
730
+ self.print_digits_only = attributes[:'print_digits_only']
731
+ end
732
+
674
733
  if attributes.key?(:'hidden')
675
734
  self.hidden = attributes[:'hidden']
676
735
  end
@@ -915,6 +974,10 @@ module DocSpring
915
974
  self.decimal_places = attributes[:'decimal_places']
916
975
  end
917
976
 
977
+ if attributes.key?(:'number_part')
978
+ self.number_part = attributes[:'number_part']
979
+ end
980
+
918
981
  if attributes.key?(:'image_scale_type')
919
982
  self.image_scale_type = attributes[:'image_scale_type']
920
983
  end
@@ -923,6 +986,10 @@ module DocSpring
923
986
  self.image_gravity = attributes[:'image_gravity']
924
987
  end
925
988
 
989
+ if attributes.key?(:'signer_role')
990
+ self.signer_role = attributes[:'signer_role']
991
+ end
992
+
926
993
  if attributes.key?(:'dependencies')
927
994
  self.dependencies = attributes[:'dependencies']
928
995
  end
@@ -964,6 +1031,8 @@ module DocSpring
964
1031
  metadata == o.metadata &&
965
1032
  required == o.required &&
966
1033
  option_list == o.option_list &&
1034
+ option_labels == o.option_labels &&
1035
+ print_option_labels == o.print_option_labels &&
967
1036
  combined_field_names == o.combined_field_names &&
968
1037
  combined_field_type == o.combined_field_type &&
969
1038
  combined_field_separator == o.combined_field_separator &&
@@ -977,6 +1046,9 @@ module DocSpring
977
1046
  signature_allow_draw == o.signature_allow_draw &&
978
1047
  signature_allow_type == o.signature_allow_type &&
979
1048
  barcode_symbology == o.barcode_symbology &&
1049
+ comb_fill_from_right == o.comb_fill_from_right &&
1050
+ comb_pad_with_zeros == o.comb_pad_with_zeros &&
1051
+ print_digits_only == o.print_digits_only &&
980
1052
  hidden == o.hidden &&
981
1053
  x == o.x &&
982
1054
  y == o.y &&
@@ -1038,8 +1110,10 @@ module DocSpring
1038
1110
  invert_boolean_condition == o.invert_boolean_condition &&
1039
1111
  currency == o.currency &&
1040
1112
  decimal_places == o.decimal_places &&
1113
+ number_part == o.number_part &&
1041
1114
  image_scale_type == o.image_scale_type &&
1042
1115
  image_gravity == o.image_gravity &&
1116
+ signer_role == o.signer_role &&
1043
1117
  dependencies == o.dependencies &&
1044
1118
  id == o.id
1045
1119
  end
@@ -1053,7 +1127,7 @@ module DocSpring
1053
1127
  # Calculates hash code according to all attributes.
1054
1128
  # @return [Integer] Hash code
1055
1129
  def hash
1056
- [name, page, type, static, editable, default, title, description, placeholder, metadata, required, option_list, combined_field_names, combined_field_type, combined_field_separator, combined_field_format, integer, minimum, maximum, exclusive_minimum, exclusive_maximum, include_time, signature_allow_draw, signature_allow_type, barcode_symbology, hidden, x, y, width, height, rotation, display_type, opacity, date_time_format, typeface, font_size, character_spacing, bold, uppercase, strikethrough, keep_leading_spaces, overflow, multiline, multiline_lines, min_length, max_length, auto_calculate_max_length, color, color_field_name, color_field_required, background_color, background_color_field_name, background_color_field_required, alignment, v_alignment, comb, comb_number_of_cells, comb_value_offset, shape_type, shape_sides, shape_border_width, shape_border_color, shape_border_color_field_name, shape_border_color_field_required, shape_fill_color, shape_fill_color_field_name, shape_fill_color_field_required, check_character, check_color, check_color_field_name, check_color_field_required, qrcode_color, qrcode_color_field_name, qrcode_color_field_required, true_text, false_text, condition, string_condition_type, number_condition_type, number_condition_range_min, number_condition_range_max, number_condition_range_exclusive_min, number_condition_range_exclusive_max, invert_boolean_condition, currency, decimal_places, image_scale_type, image_gravity, dependencies, id].hash
1130
+ [name, page, type, static, editable, default, title, description, placeholder, metadata, required, option_list, option_labels, print_option_labels, combined_field_names, combined_field_type, combined_field_separator, combined_field_format, integer, minimum, maximum, exclusive_minimum, exclusive_maximum, include_time, signature_allow_draw, signature_allow_type, barcode_symbology, comb_fill_from_right, comb_pad_with_zeros, print_digits_only, hidden, x, y, width, height, rotation, display_type, opacity, date_time_format, typeface, font_size, character_spacing, bold, uppercase, strikethrough, keep_leading_spaces, overflow, multiline, multiline_lines, min_length, max_length, auto_calculate_max_length, color, color_field_name, color_field_required, background_color, background_color_field_name, background_color_field_required, alignment, v_alignment, comb, comb_number_of_cells, comb_value_offset, shape_type, shape_sides, shape_border_width, shape_border_color, shape_border_color_field_name, shape_border_color_field_required, shape_fill_color, shape_fill_color_field_name, shape_fill_color_field_required, check_character, check_color, check_color_field_name, check_color_field_required, qrcode_color, qrcode_color_field_name, qrcode_color_field_required, true_text, false_text, condition, string_condition_type, number_condition_type, number_condition_range_min, number_condition_range_max, number_condition_range_exclusive_min, number_condition_range_exclusive_max, invert_boolean_condition, currency, decimal_places, number_part, image_scale_type, image_gravity, signer_role, dependencies, id].hash
1057
1131
  end
1058
1132
 
1059
1133
  # Builds the object from hash