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
@@ -34,6 +34,12 @@ module DocSpring
34
34
  # The values the field can take, separated by commas, such as `Yes,No`. Null allows any value.
35
35
  attr_accessor :option_list
36
36
 
37
+ # The label forms show for each option, keyed by its value, such as `{"no": "No, I don't"}`. Each key must be one of the options.
38
+ attr_accessor :option_labels
39
+
40
+ # Print the chosen option's label instead of its value.
41
+ attr_accessor :print_option_labels
42
+
37
43
  # The names of the fields a combined field joins, separated by commas.
38
44
  attr_accessor :combined_field_names
39
45
 
@@ -61,6 +67,12 @@ module DocSpring
61
67
  # The kind of barcode a field with display_type `barcode` prints.
62
68
  attr_accessor :barcode_symbology
63
69
 
70
+ # Fill the last boxes of the field's comb fields, padding the value on the left, as amounts are written on paper forms.
71
+ attr_accessor :comb_fill_from_right
72
+
73
+ # With `comb_fill_from_right`, pad the value with zeros instead of spaces.
74
+ attr_accessor :comb_pad_with_zeros
75
+
64
76
  # Leave the field off the PDF. Its value is still in the data, and combined fields can use it.
65
77
  attr_accessor :hidden
66
78
 
@@ -139,7 +151,7 @@ module DocSpring
139
151
  # The number of boxes in a comb field.
140
152
  attr_accessor :comb_number_of_cells
141
153
 
142
- # The character of the value that the first box starts from, for a value split over several comb fields (such as the parts of a Social Security number).
154
+ # How many boxes of the value's row come before this field, for a value split over several comb fields (such as the parts of a Social Security number).
143
155
  attr_accessor :comb_value_offset
144
156
 
145
157
  # The shape a field with display_type `shape` draws.
@@ -199,6 +211,9 @@ module DocSpring
199
211
  # The number of decimal places a number field prints. Null prints the value as it was sent.
200
212
  attr_accessor :decimal_places
201
213
 
214
+ # Which part of a number field's number this field prints: the whole number, only the part before the decimal point, or only the decimal places.
215
+ attr_accessor :number_part
216
+
202
217
  # How an image is resized to its field.
203
218
  attr_accessor :image_scale_type
204
219
 
@@ -236,6 +251,8 @@ module DocSpring
236
251
  :'title' => :'title',
237
252
  :'required' => :'required',
238
253
  :'option_list' => :'option_list',
254
+ :'option_labels' => :'option_labels',
255
+ :'print_option_labels' => :'print_option_labels',
239
256
  :'combined_field_names' => :'combined_field_names',
240
257
  :'combined_field_type' => :'combined_field_type',
241
258
  :'combined_field_separator' => :'combined_field_separator',
@@ -245,6 +262,8 @@ module DocSpring
245
262
  :'signature_allow_draw' => :'signature_allow_draw',
246
263
  :'signature_allow_type' => :'signature_allow_type',
247
264
  :'barcode_symbology' => :'barcode_symbology',
265
+ :'comb_fill_from_right' => :'comb_fill_from_right',
266
+ :'comb_pad_with_zeros' => :'comb_pad_with_zeros',
248
267
  :'hidden' => :'hidden',
249
268
  :'x' => :'x',
250
269
  :'y' => :'y',
@@ -291,6 +310,7 @@ module DocSpring
291
310
  :'number_condition_range_exclusive_max' => :'number_condition_range_exclusive_max',
292
311
  :'invert_boolean_condition' => :'invert_boolean_condition',
293
312
  :'decimal_places' => :'decimal_places',
313
+ :'number_part' => :'number_part',
294
314
  :'image_scale_type' => :'image_scale_type',
295
315
  :'image_gravity' => :'image_gravity'
296
316
  }
@@ -315,6 +335,8 @@ module DocSpring
315
335
  :'title' => :'String',
316
336
  :'required' => :'Boolean',
317
337
  :'option_list' => :'String',
338
+ :'option_labels' => :'Hash<String, String>',
339
+ :'print_option_labels' => :'Boolean',
318
340
  :'combined_field_names' => :'String',
319
341
  :'combined_field_type' => :'CombinedFieldType',
320
342
  :'combined_field_separator' => :'String',
@@ -324,6 +346,8 @@ module DocSpring
324
346
  :'signature_allow_draw' => :'Boolean',
325
347
  :'signature_allow_type' => :'Boolean',
326
348
  :'barcode_symbology' => :'BarcodeSymbology',
349
+ :'comb_fill_from_right' => :'Boolean',
350
+ :'comb_pad_with_zeros' => :'Boolean',
327
351
  :'hidden' => :'Boolean',
328
352
  :'x' => :'Float',
329
353
  :'y' => :'Float',
@@ -370,6 +394,7 @@ module DocSpring
370
394
  :'number_condition_range_exclusive_max' => :'Boolean',
371
395
  :'invert_boolean_condition' => :'Boolean',
372
396
  :'decimal_places' => :'Integer',
397
+ :'number_part' => :'NumberPart',
373
398
  :'image_scale_type' => :'ImageScaleType',
374
399
  :'image_gravity' => :'ImageGravity'
375
400
  }
@@ -380,6 +405,7 @@ module DocSpring
380
405
  Set.new([
381
406
  :'default',
382
407
  :'option_list',
408
+ :'option_labels',
383
409
  :'include_time',
384
410
  :'date_time_format',
385
411
  :'typeface',
@@ -450,6 +476,16 @@ module DocSpring
450
476
  self.option_list = attributes[:'option_list']
451
477
  end
452
478
 
479
+ if attributes.key?(:'option_labels')
480
+ if (value = attributes[:'option_labels']).is_a?(Hash) || value.nil?
481
+ self.option_labels = value
482
+ end
483
+ end
484
+
485
+ if attributes.key?(:'print_option_labels')
486
+ self.print_option_labels = attributes[:'print_option_labels']
487
+ end
488
+
453
489
  if attributes.key?(:'combined_field_names')
454
490
  self.combined_field_names = attributes[:'combined_field_names']
455
491
  end
@@ -486,6 +522,14 @@ module DocSpring
486
522
  self.barcode_symbology = attributes[:'barcode_symbology']
487
523
  end
488
524
 
525
+ if attributes.key?(:'comb_fill_from_right')
526
+ self.comb_fill_from_right = attributes[:'comb_fill_from_right']
527
+ end
528
+
529
+ if attributes.key?(:'comb_pad_with_zeros')
530
+ self.comb_pad_with_zeros = attributes[:'comb_pad_with_zeros']
531
+ end
532
+
489
533
  if attributes.key?(:'hidden')
490
534
  self.hidden = attributes[:'hidden']
491
535
  end
@@ -670,6 +714,10 @@ module DocSpring
670
714
  self.decimal_places = attributes[:'decimal_places']
671
715
  end
672
716
 
717
+ if attributes.key?(:'number_part')
718
+ self.number_part = attributes[:'number_part']
719
+ end
720
+
673
721
  if attributes.key?(:'image_scale_type')
674
722
  self.image_scale_type = attributes[:'image_scale_type']
675
723
  end
@@ -705,6 +753,8 @@ module DocSpring
705
753
  title == o.title &&
706
754
  required == o.required &&
707
755
  option_list == o.option_list &&
756
+ option_labels == o.option_labels &&
757
+ print_option_labels == o.print_option_labels &&
708
758
  combined_field_names == o.combined_field_names &&
709
759
  combined_field_type == o.combined_field_type &&
710
760
  combined_field_separator == o.combined_field_separator &&
@@ -714,6 +764,8 @@ module DocSpring
714
764
  signature_allow_draw == o.signature_allow_draw &&
715
765
  signature_allow_type == o.signature_allow_type &&
716
766
  barcode_symbology == o.barcode_symbology &&
767
+ comb_fill_from_right == o.comb_fill_from_right &&
768
+ comb_pad_with_zeros == o.comb_pad_with_zeros &&
717
769
  hidden == o.hidden &&
718
770
  x == o.x &&
719
771
  y == o.y &&
@@ -760,6 +812,7 @@ module DocSpring
760
812
  number_condition_range_exclusive_max == o.number_condition_range_exclusive_max &&
761
813
  invert_boolean_condition == o.invert_boolean_condition &&
762
814
  decimal_places == o.decimal_places &&
815
+ number_part == o.number_part &&
763
816
  image_scale_type == o.image_scale_type &&
764
817
  image_gravity == o.image_gravity
765
818
  end
@@ -773,7 +826,7 @@ module DocSpring
773
826
  # Calculates hash code according to all attributes.
774
827
  # @return [Integer] Hash code
775
828
  def hash
776
- [static, editable, default, title, required, option_list, combined_field_names, combined_field_type, combined_field_separator, combined_field_format, integer, 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, max_length, color, background_color, alignment, v_alignment, comb, comb_number_of_cells, comb_value_offset, shape_type, shape_sides, shape_border_width, shape_border_color, shape_fill_color, check_character, check_color, qrcode_color, 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, decimal_places, image_scale_type, image_gravity].hash
829
+ [static, editable, default, title, required, option_list, option_labels, print_option_labels, combined_field_names, combined_field_type, combined_field_separator, combined_field_format, integer, include_time, signature_allow_draw, signature_allow_type, barcode_symbology, comb_fill_from_right, comb_pad_with_zeros, 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, max_length, color, background_color, alignment, v_alignment, comb, comb_number_of_cells, comb_value_offset, shape_type, shape_sides, shape_border_width, shape_border_color, shape_fill_color, check_character, check_color, qrcode_color, 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, decimal_places, number_part, image_scale_type, image_gravity].hash
777
830
  end
778
831
 
779
832
  # Builds the object from hash
@@ -25,13 +25,13 @@ module DocSpring
25
25
  # A temporary link to download the file. Null until the file has been made, and when your account turns off download links for submissions.
26
26
  attr_accessor :download_url
27
27
 
28
- # A link to download the file that doesn't expire: it redirects to a new temporary link. It needs your API token or a signed-in session, except for a submission of a template that makes its submissions public. Null until the file has been made.
28
+ # A link to download the file that doesn't expire: it redirects to a new temporary link. It needs your API token or a signed-in session, except for a submission of a template that makes its submissions public (a signing manifest's link always needs one). Null until the file has been made.
29
29
  attr_accessor :permanent_url
30
30
 
31
31
  # The file's name, such as `sub_123.pdf`, `sub_123.docx` or `sub_123.odt`.
32
32
  attr_accessor :filename
33
33
 
34
- # The file's media type: `application/pdf`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document` for a Word document, or `application/vnd.oasis.opendocument.text` for an OpenDocument file.
34
+ # The file's media type: `application/pdf`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document` for a Word document, or `application/vnd.oasis.opendocument.text` for an OpenDocument file, or `application/json` for a signing manifest.
35
35
  attr_accessor :content_type
36
36
 
37
37
  # The file's size in bytes. Null until the file has been made.
@@ -0,0 +1,42 @@
1
+ =begin
2
+ #DocSpring API
3
+
4
+ #Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
5
+
6
+ The version of the OpenAPI document: v2
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.26.0-DOCSPRING
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module DocSpring
17
+ class NumberPart
18
+ ALL = "all".freeze
19
+ WHOLE = "whole".freeze
20
+ DECIMALS = "decimals".freeze
21
+
22
+ def self.all_vars
23
+ @all_vars ||= [ALL, WHOLE, DECIMALS].freeze
24
+ end
25
+
26
+ # Builds the enum from string
27
+ # @param [String] The enum value in the form of the string
28
+ # @return [String] The enum value
29
+ def self.build_from_hash(value)
30
+ new.build_from_hash(value)
31
+ end
32
+
33
+ # Builds the enum from string
34
+ # @param [String] The enum value in the form of the string
35
+ # @return [String] The enum value
36
+ def build_from_hash(value)
37
+ # Only responses are built from hashes, and a value added to the API after this client was released is kept as it
38
+ # is: the constants are the values this client knows
39
+ value
40
+ end
41
+ end
42
+ end
@@ -31,6 +31,9 @@ module DocSpring
31
31
  # String fields only: the values allowed, separated by commas, such as `Yes,No`. Null allows any value.
32
32
  attr_accessor :option_list
33
33
 
34
+ # The labels forms show for `option_list`'s values, by value, as a field's `option_labels`, such as `{"married_filing_jointly": "Married filing jointly"}`. Each key must be one of `option_list`'s values. A value without a label shows the value, or its sentence case when the values are lowercase words joined by underscores. Null gives no value a label of its own.
35
+ attr_accessor :option_labels
36
+
34
37
  # Whether the template must have a field with this name. The embedded editor shows the names that are missing, and with `disableDoneButtonIfPredefinedFieldsMissing` keeps its Done button disabled until the template has them. Default false.
35
38
  attr_accessor :required_in_template
36
39
 
@@ -67,6 +70,7 @@ module DocSpring
67
70
  :'title' => :'title',
68
71
  :'type' => :'type',
69
72
  :'option_list' => :'option_list',
73
+ :'option_labels' => :'option_labels',
70
74
  :'required_in_template' => :'required_in_template',
71
75
  :'field_required' => :'field_required'
72
76
  }
@@ -90,6 +94,7 @@ module DocSpring
90
94
  :'title' => :'String',
91
95
  :'type' => :'FieldType',
92
96
  :'option_list' => :'String',
97
+ :'option_labels' => :'Hash<String, String>',
93
98
  :'required_in_template' => :'Boolean',
94
99
  :'field_required' => :'Boolean'
95
100
  }
@@ -101,6 +106,7 @@ module DocSpring
101
106
  :'display_name',
102
107
  :'title',
103
108
  :'option_list',
109
+ :'option_labels',
104
110
  ])
105
111
  end
106
112
 
@@ -154,6 +160,12 @@ module DocSpring
154
160
  self.option_list = attributes[:'option_list']
155
161
  end
156
162
 
163
+ if attributes.key?(:'option_labels')
164
+ if (value = attributes[:'option_labels']).is_a?(Hash) || value.nil?
165
+ self.option_labels = value
166
+ end
167
+ end
168
+
157
169
  if attributes.key?(:'required_in_template')
158
170
  self.required_in_template = attributes[:'required_in_template']
159
171
  end
@@ -218,6 +230,7 @@ module DocSpring
218
230
  title == o.title &&
219
231
  type == o.type &&
220
232
  option_list == o.option_list &&
233
+ option_labels == o.option_labels &&
221
234
  required_in_template == o.required_in_template &&
222
235
  field_required == o.field_required
223
236
  end
@@ -231,7 +244,7 @@ module DocSpring
231
244
  # Calculates hash code according to all attributes.
232
245
  # @return [Integer] Hash code
233
246
  def hash
234
- [name, display_name, title, type, option_list, required_in_template, field_required].hash
247
+ [name, display_name, title, type, option_list, option_labels, required_in_template, field_required].hash
235
248
  end
236
249
 
237
250
  # Builds the object from hash
@@ -31,6 +31,9 @@ module DocSpring
31
31
  # String fields only: the values allowed, separated by commas, such as `Yes,No`. Null allows any value.
32
32
  attr_accessor :option_list
33
33
 
34
+ # The labels forms show for `option_list`'s values, by value, as a field's `option_labels`, such as `{"married_filing_jointly": "Married filing jointly"}`. Each key must be one of `option_list`'s values. A value without a label shows the value, or its sentence case when the values are lowercase words joined by underscores. Null gives no value a label of its own.
35
+ attr_accessor :option_labels
36
+
34
37
  # Whether the template must have a field with this name. The embedded editor shows the names that are missing, and with `disableDoneButtonIfPredefinedFieldsMissing` keeps its Done button disabled until the template has them. Default false.
35
38
  attr_accessor :required_in_template
36
39
 
@@ -67,6 +70,7 @@ module DocSpring
67
70
  :'title' => :'title',
68
71
  :'type' => :'type',
69
72
  :'option_list' => :'option_list',
73
+ :'option_labels' => :'option_labels',
70
74
  :'required_in_template' => :'required_in_template',
71
75
  :'field_required' => :'field_required'
72
76
  }
@@ -90,6 +94,7 @@ module DocSpring
90
94
  :'title' => :'String',
91
95
  :'type' => :'FieldType',
92
96
  :'option_list' => :'String',
97
+ :'option_labels' => :'Hash<String, String>',
93
98
  :'required_in_template' => :'Boolean',
94
99
  :'field_required' => :'Boolean'
95
100
  }
@@ -101,6 +106,7 @@ module DocSpring
101
106
  :'display_name',
102
107
  :'title',
103
108
  :'option_list',
109
+ :'option_labels',
104
110
  ])
105
111
  end
106
112
 
@@ -154,6 +160,12 @@ module DocSpring
154
160
  self.option_list = attributes[:'option_list']
155
161
  end
156
162
 
163
+ if attributes.key?(:'option_labels')
164
+ if (value = attributes[:'option_labels']).is_a?(Hash) || value.nil?
165
+ self.option_labels = value
166
+ end
167
+ end
168
+
157
169
  if attributes.key?(:'required_in_template')
158
170
  self.required_in_template = attributes[:'required_in_template']
159
171
  end
@@ -218,6 +230,7 @@ module DocSpring
218
230
  title == o.title &&
219
231
  type == o.type &&
220
232
  option_list == o.option_list &&
233
+ option_labels == o.option_labels &&
221
234
  required_in_template == o.required_in_template &&
222
235
  field_required == o.field_required
223
236
  end
@@ -231,7 +244,7 @@ module DocSpring
231
244
  # Calculates hash code according to all attributes.
232
245
  # @return [Integer] Hash code
233
246
  def hash
234
- [name, display_name, title, type, option_list, required_in_template, field_required].hash
247
+ [name, display_name, title, type, option_list, option_labels, required_in_template, field_required].hash
235
248
  end
236
249
 
237
250
  # Builds the object from hash
@@ -28,16 +28,16 @@ module DocSpring
28
28
  # Their email address. Null when they have none.
29
29
  attr_accessor :email
30
30
 
31
- # The fields this person fills in. Null for a signature request created with API v1 without a field list: it asks for every field the submission's data doesn't have.
31
+ # The fields this person fills in or signs: the ones the template gives their role that data didn't fill in, and the ones their signature request listed. A submission's only signature request without a list also has every field without a role that data didn't fill in. Null for a signature request created with API v1 without a field list, on a PDF template without roles: it asks for every field the submission's data doesn't have.
32
32
  attr_accessor :fields
33
33
 
34
34
  # Your own data about the signature request, such as an ID from your app.
35
35
  attr_accessor :metadata
36
36
 
37
- # Which of the template's signers the person is. Until templates have roles of their own, a template's signers are `Signer 1`, `Signer 2` and so on, up to `Signer 100`: `Signer 1` is the one whose details the template's `@@signature_requests/0` fields print.
37
+ # Which of the template's signers the person is: their role's key (`tenant`) when the template has roles, otherwise `Signer 1`, `Signer 2` and so on, up to `Signer 100`. `Signer 1`, or the template's first role, is the one whose details the template's `@@signature_requests/0` fields print, and a role's details are in its `@@signature_requests/<key>` fields too (`@@signature_requests/tenant/completed_at`).
38
38
  attr_accessor :role
39
39
 
40
- # The signer's position, from 0: `Signer 1` is 0. The template's `@@signature_requests/<sort_order>` fields print this signature request's details.
40
+ # The signer's position, from 0: `Signer 1` is 0, as is the template's first role. The template's `@@signature_requests/<sort_order>` fields, and its role's `@@signature_requests/<key>` fields, print this signature request's details.
41
41
  attr_accessor :sort_order
42
42
 
43
43
  # Whether DocSpring emails this person their signing link.
@@ -22,13 +22,13 @@ module DocSpring
22
22
  # Their email address. Null when they have none.
23
23
  attr_accessor :email
24
24
 
25
- # The fields this person fills in. Each field can only be in one signature request, and a field that `data` fills in needs `prefilled_values_editable`.
25
+ # The fields this person fills in or signs, besides the ones the template gives their role. A submission's only signature request can leave it out: the person gets every field without a role that `data` doesn't fill in. With two or more signature requests, every required field that `data` doesn't fill in needs a signer, from its role in the template or from a signature request's `fields` (an optional one that nobody is given stays empty). Each field can only be in one signature request, can't be another role's or the sender's, and needs `prefilled_values_editable` when `data` fills it in. A field that the Liquid of an HTML template, a Word template or a page design uses outside its form fields (`{{ name }}`) can only be filled in by the signer who signs first (the only signer, or the only one in the first `signing_step`): their signing page asks them for it before the document is made.
26
26
  attr_accessor :fields
27
27
 
28
28
  # Your own data about the signature request, such as an ID from your app.
29
29
  attr_accessor :metadata
30
30
 
31
- # Which of the template's signers the person is: `Signer 1`, `Signer 2` and so on, up to `Signer 100`, until templates have roles of their own. Either every signature request has a `role` or none does, and each role can only have one.
31
+ # Which of the template's signers the person is: one of its roles, by key (`tenant`), or by place (`Signer 1` is the first role). A template without roles has `Signer 1`, `Signer 2` and so on, up to `Signer 100`. Either every signature request has a `role` or none does, and each role can only have one. Without any `role`, the first signature request is the template's first signer, the second its second, and so on. When the template gives its roles names of their own (`Tenant`, not `Signer 1`), two or more signature requests each need a `role`.
32
32
  attr_accessor :role
33
33
 
34
34
  # How your app authenticated the person before it showed them the signature request.
@@ -58,7 +58,7 @@ module DocSpring
58
58
  # Leave out names in `fields` that the template doesn't have, for one field list that you send with several templates. Without it, an unknown name makes the submission `invalid_data`.
59
59
  attr_accessor :ignore_unknown_fields
60
60
 
61
- # Let the person change the values that `data` already has for fields in `fields`. Without it, those fields are a 422.
61
+ # Let the person change the values that `data` already has for their fields. Without it, a field in `fields` that `data` fills in is a 422, and a field of their role that `data` fills in is the sender's.
62
62
  attr_accessor :prefilled_values_editable
63
63
 
64
64
  # Whether DocSpring emails this person their signing link. Default: the submission's `send_email`. Set it to false for someone who signs in your app (embedded signing) or whose link you send yourself. When DocSpring emails them, `email` is required and `auth_type` is `email_link` (the default). Otherwise `auth_type` is required.
@@ -197,8 +197,6 @@ module DocSpring
197
197
  if (value = attributes[:'fields']).is_a?(Array)
198
198
  self.fields = value
199
199
  end
200
- else
201
- self.fields = nil
202
200
  end
203
201
 
204
202
  if attributes.key?(:'metadata')
@@ -265,10 +263,6 @@ module DocSpring
265
263
  def list_invalid_properties
266
264
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
267
265
  invalid_properties = Array.new
268
- if @fields.nil?
269
- invalid_properties.push('invalid value for "fields", fields cannot be nil.')
270
- end
271
-
272
266
  invalid_properties
273
267
  end
274
268
 
@@ -276,7 +270,6 @@ module DocSpring
276
270
  # @return true if the model is valid
277
271
  def valid?
278
272
  warn '[DEPRECATED] the `valid?` method is obsolete'
279
- return false if @fields.nil?
280
273
  true
281
274
  end
282
275
 
@@ -55,10 +55,10 @@ module DocSpring
55
55
  # Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
56
56
  attr_accessor :metadata
57
57
 
58
- # The generated files: `pdf`, `docx` and `odt` (by `output_formats`) once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
58
+ # The generated files: `pdf`, `docx` and `odt` (by `output_formats`) once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` and `signing_manifest` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
59
59
  attr_accessor :files
60
60
 
61
- # An expired submission's data, metadata, password and PDF have been deleted.
61
+ # An expired submission's data, metadata, password and files have been deleted, along with its signature requests and audit trail.
62
62
  attr_accessor :expired
63
63
 
64
64
  # When the submission expires. Null if it's kept until you delete it.
@@ -88,7 +88,7 @@ module DocSpring
88
88
  # The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
89
89
  attr_accessor :truncated_text
90
90
 
91
- # What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
91
+ # What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. A Word template's submission with signature requests makes only `pdf`, which its signers sign. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
92
92
  attr_accessor :output_formats
93
93
 
94
94
  # When the preview PDF was generated. Null if there is no preview.
@@ -22,6 +22,9 @@ module DocSpring
22
22
  # The audit trail of a submission with signature requests: who signed, when and how. It's also added to the end of the PDF when the template's `merge_audit_trail_pdf` is on.
23
23
  attr_accessor :audit_trail
24
24
 
25
+ # The audit data behind the audit trail of a submission with signature requests, as JSON: the hashes of the document and the audit trail, and each signing event with the salt and hash that DocSpring's signing record holds for it. It has who signed, like the audit trail, and goes when the submission expires, so keep it with the PDF and the audit trail.
26
+ attr_accessor :signing_manifest
27
+
25
28
  # The preview PDF from POST /submissions/{submission_id}/generate_preview, such as for a submission still waiting for its signature requests.
26
29
  attr_accessor :preview
27
30
 
@@ -38,6 +41,7 @@ module DocSpring
38
41
  {
39
42
  :'pdf' => :'pdf',
40
43
  :'audit_trail' => :'audit_trail',
44
+ :'signing_manifest' => :'signing_manifest',
41
45
  :'preview' => :'preview',
42
46
  :'docx' => :'docx',
43
47
  :'odt' => :'odt',
@@ -60,6 +64,7 @@ module DocSpring
60
64
  {
61
65
  :'pdf' => :'GeneratedFile',
62
66
  :'audit_trail' => :'GeneratedFile',
67
+ :'signing_manifest' => :'GeneratedFile',
63
68
  :'preview' => :'GeneratedFile',
64
69
  :'docx' => :'GeneratedFile',
65
70
  :'odt' => :'GeneratedFile',
@@ -107,6 +112,10 @@ module DocSpring
107
112
  self.audit_trail = attributes[:'audit_trail']
108
113
  end
109
114
 
115
+ if attributes.key?(:'signing_manifest')
116
+ self.signing_manifest = attributes[:'signing_manifest']
117
+ end
118
+
110
119
  if attributes.key?(:'preview')
111
120
  self.preview = attributes[:'preview']
112
121
  end
@@ -146,6 +155,7 @@ module DocSpring
146
155
  self.class == o.class &&
147
156
  pdf == o.pdf &&
148
157
  audit_trail == o.audit_trail &&
158
+ signing_manifest == o.signing_manifest &&
149
159
  preview == o.preview &&
150
160
  docx == o.docx &&
151
161
  odt == o.odt &&
@@ -161,7 +171,7 @@ module DocSpring
161
171
  # Calculates hash code according to all attributes.
162
172
  # @return [Integer] Hash code
163
173
  def hash
164
- [pdf, audit_trail, preview, docx, odt, png].hash
174
+ [pdf, audit_trail, signing_manifest, preview, docx, odt, png].hash
165
175
  end
166
176
 
167
177
  # Builds the object from hash
@@ -31,10 +31,10 @@ module DocSpring
31
31
  # A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them.
32
32
  attr_accessor :password
33
33
 
34
- # What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
34
+ # What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. A Word template's submission with signature requests makes only `pdf`, which its signers sign. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
35
35
  attr_accessor :output_formats
36
36
 
37
- # Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. The demo API token's submissions expire within an hour: up to 3600, and that's their default.
37
+ # Seconds after the submission is processed until it expires, up to 10 years (315360000), sooner or later than the template's or the account's expiry setting. Defaults to the template's expiry when it overrides the account's (`override_account_expiry`), and otherwise to the account's expiry setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. The demo API token's submissions expire within an hour: up to 3600, and that's their default.
38
38
  attr_accessor :expires_in
39
39
 
40
40
  # Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. A `default` for a signature or initials field makes the submission `invalid_data`. With `signature_requests`, `editable: true` is a 422.
@@ -58,7 +58,7 @@ module DocSpring
58
58
  # Empty unless you pass `include_files=true`: then the generated files, as when you get the submission, without the `png` pages' links (`files.png.pages` is null). Get the submission for its page images.
59
59
  attr_accessor :files
60
60
 
61
- # An expired submission's data, metadata, password and PDF have been deleted.
61
+ # An expired submission's data, metadata, password and files have been deleted, along with its signature requests and audit trail.
62
62
  attr_accessor :expired
63
63
 
64
64
  # When the submission expires. Null if it's kept until you delete it.