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
@@ -1,15 +0,0 @@
1
- # DocSpring::CombinedFieldType
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::CombinedFieldType.new()
14
- ```
15
-
data/docs/CombinedPdf.md DELETED
@@ -1,44 +0,0 @@
1
- # DocSpring::CombinedPdf
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | The combined PDF's ID. | |
8
- | **state** | [**CombinedPdfState**](CombinedPdfState.md) | `pending` until the PDF has been generated, then `processed`. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. `error`: the PDFs couldn't be merged (see `error_message`). Waiting ends in `error` if it's discarded or takes over 30 days. | |
9
- | **source_pdfs** | [**Array<CombinedPdfSource>**](CombinedPdfSource.md) | The PDFs to merge, in order. | |
10
- | **metadata** | **Hash<String, Object>** | Your own data about the combined PDF, such as an ID from your app. Its `pdf_filename` key names the PDF's file (`files.pdf.filename`, and its download): 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 combined PDF's ID (`com_1234567890abcdef01.pdf`). | |
11
- | **has_password** | **Boolean** | Whether the PDF needs a password to open (`password`). | |
12
- | **delete_custom_files** | **Boolean** | Delete the custom files in `source_pdfs` once the combined PDF has been generated (they're kept if it fails). Other combined PDFs can't use them after that. A test API token can't delete custom files. | |
13
- | **error_message** | **String** | Why the PDFs couldn't be merged, when `state` is `error`. | |
14
- | **files** | [**CombinedPdfFiles**](CombinedPdfFiles.md) | The generated files, by format. Empty until the PDF has been generated, and once it has expired. | |
15
- | **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | The uploads of the PDF to your storage (account integrations). | |
16
- | **expired** | **Boolean** | An expired combined PDF's PDF, metadata, password and source URLs have been deleted. | |
17
- | **expires_at** | **Time** | When the combined PDF expires (`expires_in` after it's generated). Null if it's kept until you delete it. | |
18
- | **processed_at** | **Time** | When the PDF was generated. Null until then. | |
19
- | **created_at** | **Time** | When the combined PDF was created. | |
20
- | **updated_at** | **Time** | When the combined PDF was last updated. | |
21
-
22
- ## Example
23
-
24
- ```ruby
25
- require 'docspring'
26
-
27
- instance = DocSpring::CombinedPdf.new(
28
- id: null,
29
- state: null,
30
- source_pdfs: null,
31
- metadata: null,
32
- has_password: null,
33
- delete_custom_files: null,
34
- error_message: null,
35
- files: null,
36
- actions: null,
37
- expired: null,
38
- expires_at: null,
39
- processed_at: null,
40
- created_at: null,
41
- updated_at: null
42
- )
43
- ```
44
-
@@ -1,18 +0,0 @@
1
- # DocSpring::CombinedPdfFiles
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **pdf** | [**GeneratedFile**](GeneratedFile.md) | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::CombinedPdfFiles.new(
15
- pdf: null
16
- )
17
- ```
18
-
@@ -1,20 +0,0 @@
1
- # DocSpring::CombinedPdfList
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **data** | [**Array<CombinedPdf>**](CombinedPdf.md) | The items on this page. | |
8
- | **next_cursor** | **String** | Pass it as `cursor` to get the next page. Null on the last page. | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'docspring'
14
-
15
- instance = DocSpring::CombinedPdfList.new(
16
- data: null,
17
- next_cursor: null
18
- )
19
- ```
20
-
@@ -1,26 +0,0 @@
1
- # DocSpring::CombinedPdfSource
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **type** | [**CombinedPdfSourceType**](CombinedPdfSourceType.md) | What the PDF is: a submission's PDF, another combined PDF, a template's PDF, a custom file (POST /custom_files) or a PDF to download from a URL. | |
8
- | **id** | **String** | The ID of the submission, combined PDF, template or custom file. | [optional] |
9
- | **url** | **String** | For a `url` source, the URL to download the PDF from. Removed once the combined PDF has expired. | [optional] |
10
- | **template_version** | **String** | For a `template` source, the version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`. | [optional] |
11
- | **processed** | **Boolean** | For a `template` source: true (the default) merges the template's processed PDF, which is the PDF submissions are filled in on (decrypted, with its form fields removed). false merges the PDF as it was uploaded. | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'docspring'
17
-
18
- instance = DocSpring::CombinedPdfSource.new(
19
- type: null,
20
- id: null,
21
- url: null,
22
- template_version: null,
23
- processed: null
24
- )
25
- ```
26
-
@@ -1,88 +0,0 @@
1
- # DocSpring::CombinedPdfSourceInput
2
-
3
- ## Class instance methods
4
-
5
- ### `openapi_one_of`
6
-
7
- Returns the list of classes defined in oneOf.
8
-
9
- #### Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- DocSpring::CombinedPdfSourceInput.openapi_one_of
15
- # =>
16
- # [
17
- # :'CombinedPdfSourcePdf',
18
- # :'CustomFileSourcePdf',
19
- # :'SubmissionSourcePdf',
20
- # :'TemplateSourcePdf',
21
- # :'UrlSourcePdf'
22
- # ]
23
- ```
24
-
25
- ### `openapi_discriminator_name`
26
-
27
- Returns the discriminator's property name.
28
-
29
- #### Example
30
-
31
- ```ruby
32
- require 'docspring'
33
-
34
- DocSpring::CombinedPdfSourceInput.openapi_discriminator_name
35
- # => :'type'
36
- ```
37
-
38
- ### `openapi_discriminator_name`
39
-
40
- Returns the discriminator's mapping.
41
-
42
- #### Example
43
-
44
- ```ruby
45
- require 'docspring'
46
-
47
- DocSpring::CombinedPdfSourceInput.openapi_discriminator_mapping
48
- # =>
49
- # {
50
- # :'combined_pdf' => :'CombinedPdfSourcePdf',
51
- # :'custom_file' => :'CustomFileSourcePdf',
52
- # :'submission' => :'SubmissionSourcePdf',
53
- # :'template' => :'TemplateSourcePdf',
54
- # :'url' => :'UrlSourcePdf'
55
- # }
56
- ```
57
-
58
- ### build
59
-
60
- Find the appropriate object from the `openapi_one_of` list and casts the data into it.
61
-
62
- #### Example
63
-
64
- ```ruby
65
- require 'docspring'
66
-
67
- DocSpring::CombinedPdfSourceInput.build(data)
68
- # => #<CombinedPdfSourcePdf:0x00007fdd4aab02a0>
69
-
70
- DocSpring::CombinedPdfSourceInput.build(data_that_doesnt_match)
71
- # => nil
72
- ```
73
-
74
- #### Parameters
75
-
76
- | Name | Type | Description |
77
- | ---- | ---- | ----------- |
78
- | **data** | **Mixed** | data to be matched against the list of oneOf items |
79
-
80
- #### Return type
81
-
82
- - `CombinedPdfSourcePdf`
83
- - `CustomFileSourcePdf`
84
- - `SubmissionSourcePdf`
85
- - `TemplateSourcePdf`
86
- - `UrlSourcePdf`
87
- - `nil` (if no type matches)
88
-
@@ -1,20 +0,0 @@
1
- # DocSpring::CombinedPdfSourcePdf
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **type** | **String** | Must be `combined_pdf`. | [default to 'combined_pdf'] |
8
- | **id** | **String** | The ID of the submission, combined PDF, template or custom file. | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'docspring'
14
-
15
- instance = DocSpring::CombinedPdfSourcePdf.new(
16
- type: null,
17
- id: null
18
- )
19
- ```
20
-
@@ -1,15 +0,0 @@
1
- # DocSpring::CombinedPdfSourceType
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::CombinedPdfSourceType.new()
14
- ```
15
-
@@ -1,15 +0,0 @@
1
- # DocSpring::CombinedPdfState
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::CombinedPdfState.new()
14
- ```
15
-
@@ -1,22 +0,0 @@
1
- # DocSpring::CopyTemplateRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | Default: the template's name followed by a number, such as "Contract (2)". For a published version, the name followed by the version, such as "Contract (v1.2.0)". | [optional] |
8
- | **parent_folder_id** | **String** | The folder to put the copy in. Null puts it at the root. Left out, the copy goes in the template's own folder. | [optional] |
9
- | **version** | **String** | Copy this published version (`1.2.0`, or `1` for the latest 1.x.x) instead of the draft. | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'docspring'
15
-
16
- instance = DocSpring::CopyTemplateRequest.new(
17
- name: null,
18
- parent_folder_id: null,
19
- version: null
20
- )
21
- ```
22
-
@@ -1,54 +0,0 @@
1
- # DocSpring::CreateAccountEmailActionRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **template_ids** | **Array&lt;String&gt;** | For an account email action: the IDs of the templates it sends for. With `folder_ids`, it sends for a template that either list includes. Both empty sends for every template. Always empty for a template's own email action. | [optional] |
8
- | **folder_ids** | **Array&lt;String&gt;** | For an account email action: the IDs of folders whose templates it sends for, including the templates in the folders inside them. Always empty for a template's own email action. | [optional] |
9
- | **name** | **String** | A name for the email action, shown in the dashboard. Null shows its recipients instead. | [optional] |
10
- | **enabled** | **Boolean** | Whether it sends emails. DocSpring turns an email action off after 3 days of failed emails, or straight away when one of the addresses in `to`, `cc` or `bcc` (not one from a field or metadata) bounces or marks an email as spam. | [optional] |
11
- | **to** | **Array&lt;String&gt;** | Who gets each email: email addresses, and tags for an address that each submission gives, from one of the template's text or email fields (`{{ data.client_email }}`, or `{{ data["client email"] }}` for a name with spaces) or from its metadata (`{{ metadata.agent_email }}`, or `{{ metadata.agent.email }}` for a value in an object). A tag whose value is blank or isn't a valid address is skipped for that submission, and so is a field an account email action names that the template doesn't have. `{{ signer.email }}` sends each of the submission's signers their own email, to them alone, and everyone else in `to`, `cc` and `bcc` one email together, without the signers. An email needs at least one entry in `to`, `cc` or `bcc`, and at most 10 across them. | [optional] |
12
- | **cc** | **Array&lt;String&gt;** | Who is copied on each email, as in `to` (but not `{{ signer.email }}`). | [optional] |
13
- | **bcc** | **Array&lt;String&gt;** | Who is blind-copied on each email, as in `to` (but not `{{ signer.email }}`). | [optional] |
14
- | **from_name** | **String** | The sender's name. Null uses your account's name. From DocSpring's shared address, the name is followed by "via DocSpring". | [optional] |
15
- | **from_address** | **String** | The sender's address, at one of your verified email domains. Null sends from DocSpring's shared address. | [optional] |
16
- | **reply_to** | **String** | Where replies go: a team member's email address, or an address at one of your verified email domains. Null sends without a reply address. | [optional] |
17
- | **subject** | **String** | The subject line, a Liquid template with the variables `account.name`, `template.name`, `template.id`, `submission.id`, the submission's values as `data.&lt;field name&gt;` (`data["field name"]` for a name with spaces) and its metadata as `metadata.&lt;key&gt;`, such as `Your {{ template.name }}`. Null uses the template's name followed by the file it sends, such as "Lease PDF", or by "files" when it sends several. | [optional] |
18
- | **message** | **String** | The email's text, a Liquid template with the same variables as `subject`. `if`, `unless` and `case` tags work. Line breaks are kept. Null uses a short message that says the files are attached or ready to download. | [optional] |
19
- | **file_name** | **String** | The attached files' name, a Liquid template with the same variables as `subject`, such as `{{ data.last_name }} lease`. Each file's extension (`.pdf`, `.docx` or `.odt`) is added. Null uses the submission's `pdf_filename` metadata when it has one, and otherwise the template's name. A download link's files have the names their other downloads have: the submission's `pdf_filename`, or its ID. | [optional] |
20
- | **file_formats** | [**EmailActionFileFormats**](EmailActionFileFormats.md) | Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`. | [optional] |
21
- | **delivery** | [**EmailActionDelivery**](EmailActionDelivery.md) | `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`. | [optional] |
22
- | **max_attachment_mb** | **Integer** | With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB). | [optional] |
23
- | **submission_type** | [**EmailActionSubmissionType**](EmailActionSubmissionType.md) | Which submissions send emails: `live`, `test` or `all`. Test submissions only email your team's members, and skip every other recipient. | [optional] |
24
- | **send_when** | [**EmailActionConditionsInput**](EmailActionConditionsInput.md) | Sends the email only when the submission's values meet these conditions, which work as a conditional logic rule's do. The values are the ones the PDF has: formulas worked out, and blank for a field that a rule hides. A field the template doesn't have (in an account email action's conditions) counts as blank. A submission that doesn't meet them sends nothing, and its email shows as skipped. Null sends for every submission. | [optional] |
25
- | **failure_notifications_enabled** | **Boolean** | Whether the account's owner gets an email when the email action's emails keep failing. | [optional] |
26
-
27
- ## Example
28
-
29
- ```ruby
30
- require 'docspring'
31
-
32
- instance = DocSpring::CreateAccountEmailActionRequest.new(
33
- template_ids: null,
34
- folder_ids: null,
35
- name: null,
36
- enabled: null,
37
- to: null,
38
- cc: null,
39
- bcc: null,
40
- from_name: null,
41
- from_address: null,
42
- reply_to: null,
43
- subject: null,
44
- message: null,
45
- file_name: null,
46
- file_formats: null,
47
- delivery: null,
48
- max_attachment_mb: null,
49
- submission_type: null,
50
- send_when: null,
51
- failure_notifications_enabled: null
52
- )
53
- ```
54
-
@@ -1,26 +0,0 @@
1
- # DocSpring::CreateCombinedPdfRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **source_pdfs** | [**Array&lt;CombinedPdfSourceInput&gt;**](CombinedPdfSourceInput.md) | The PDFs to merge, in order. | |
8
- | **metadata** | **Hash&lt;String, Object&gt;** | Your own data about the combined PDF, such as an ID from your app. Its `pdf_filename` key names the PDF's file (`files.pdf.filename`, and its download): 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 combined PDF's ID (`com_1234567890abcdef01.pdf`). | [optional] |
9
- | **password** | **String** | A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. | [optional] |
10
- | **delete_custom_files** | **Boolean** | Delete the custom files in `source_pdfs` once the combined PDF has been generated (they're kept if it fails). Other combined PDFs can't use them after that. A test API token can't delete custom files. | [optional] |
11
- | **expires_in** | **Integer** | Seconds after the PDF is generated until the combined PDF expires, up to 10 years (315360000). One that fails is kept for at least 48 hours. Without it, the combined PDF is kept until you delete it. | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'docspring'
17
-
18
- instance = DocSpring::CreateCombinedPdfRequest.new(
19
- source_pdfs: null,
20
- metadata: null,
21
- password: null,
22
- delete_custom_files: null,
23
- expires_in: null
24
- )
25
- ```
26
-
@@ -1,18 +0,0 @@
1
- # DocSpring::CreateCustomFileFromUploadRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **cache_id** | **String** | The `fields.key` from GET /uploads/presign, after you upload the file to its URL. | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::CreateCustomFileFromUploadRequest.new(
15
- cache_id: null
16
- )
17
- ```
18
-
@@ -1,50 +0,0 @@
1
- # DocSpring::CreateEmailActionRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | A name for the email action, shown in the dashboard. Null shows its recipients instead. | [optional] |
8
- | **enabled** | **Boolean** | Whether it sends emails. DocSpring turns an email action off after 3 days of failed emails, or straight away when one of the addresses in `to`, `cc` or `bcc` (not one from a field or metadata) bounces or marks an email as spam. | [optional] |
9
- | **to** | **Array&lt;String&gt;** | Who gets each email: email addresses, and tags for an address that each submission gives, from one of the template's text or email fields (`{{ data.client_email }}`, or `{{ data["client email"] }}` for a name with spaces) or from its metadata (`{{ metadata.agent_email }}`, or `{{ metadata.agent.email }}` for a value in an object). A tag whose value is blank or isn't a valid address is skipped for that submission, and so is a field an account email action names that the template doesn't have. `{{ signer.email }}` sends each of the submission's signers their own email, to them alone, and everyone else in `to`, `cc` and `bcc` one email together, without the signers. An email needs at least one entry in `to`, `cc` or `bcc`, and at most 10 across them. | [optional] |
10
- | **cc** | **Array&lt;String&gt;** | Who is copied on each email, as in `to` (but not `{{ signer.email }}`). | [optional] |
11
- | **bcc** | **Array&lt;String&gt;** | Who is blind-copied on each email, as in `to` (but not `{{ signer.email }}`). | [optional] |
12
- | **from_name** | **String** | The sender's name. Null uses your account's name. From DocSpring's shared address, the name is followed by "via DocSpring". | [optional] |
13
- | **from_address** | **String** | The sender's address, at one of your verified email domains. Null sends from DocSpring's shared address. | [optional] |
14
- | **reply_to** | **String** | Where replies go: a team member's email address, or an address at one of your verified email domains. Null sends without a reply address. | [optional] |
15
- | **subject** | **String** | The subject line, a Liquid template with the variables `account.name`, `template.name`, `template.id`, `submission.id`, the submission's values as `data.&lt;field name&gt;` (`data["field name"]` for a name with spaces) and its metadata as `metadata.&lt;key&gt;`, such as `Your {{ template.name }}`. Null uses the template's name followed by the file it sends, such as "Lease PDF", or by "files" when it sends several. | [optional] |
16
- | **message** | **String** | The email's text, a Liquid template with the same variables as `subject`. `if`, `unless` and `case` tags work. Line breaks are kept. Null uses a short message that says the files are attached or ready to download. | [optional] |
17
- | **file_name** | **String** | The attached files' name, a Liquid template with the same variables as `subject`, such as `{{ data.last_name }} lease`. Each file's extension (`.pdf`, `.docx` or `.odt`) is added. Null uses the submission's `pdf_filename` metadata when it has one, and otherwise the template's name. A download link's files have the names their other downloads have: the submission's `pdf_filename`, or its ID. | [optional] |
18
- | **file_formats** | [**EmailActionFileFormats**](EmailActionFileFormats.md) | Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`. | [optional] |
19
- | **delivery** | [**EmailActionDelivery**](EmailActionDelivery.md) | `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`. | [optional] |
20
- | **max_attachment_mb** | **Integer** | With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB). | [optional] |
21
- | **submission_type** | [**EmailActionSubmissionType**](EmailActionSubmissionType.md) | Which submissions send emails: `live`, `test` or `all`. Test submissions only email your team's members, and skip every other recipient. | [optional] |
22
- | **send_when** | [**EmailActionConditionsInput**](EmailActionConditionsInput.md) | Sends the email only when the submission's values meet these conditions, which work as a conditional logic rule's do. The values are the ones the PDF has: formulas worked out, and blank for a field that a rule hides. A field the template doesn't have (in an account email action's conditions) counts as blank. A submission that doesn't meet them sends nothing, and its email shows as skipped. Null sends for every submission. | [optional] |
23
- | **failure_notifications_enabled** | **Boolean** | Whether the account's owner gets an email when the email action's emails keep failing. | [optional] |
24
-
25
- ## Example
26
-
27
- ```ruby
28
- require 'docspring'
29
-
30
- instance = DocSpring::CreateEmailActionRequest.new(
31
- name: null,
32
- enabled: null,
33
- to: null,
34
- cc: null,
35
- bcc: null,
36
- from_name: null,
37
- from_address: null,
38
- reply_to: null,
39
- subject: null,
40
- message: null,
41
- file_name: null,
42
- file_formats: null,
43
- delivery: null,
44
- max_attachment_mb: null,
45
- submission_type: null,
46
- send_when: null,
47
- failure_notifications_enabled: null
48
- )
49
- ```
50
-
@@ -1,18 +0,0 @@
1
- # DocSpring::CreateEmailDomainRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **domain** | **String** | The domain name, such as `example.com` or `mail.example.com`. Email actions can send from any address at it. | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::CreateEmailDomainRequest.new(
15
- domain: null
16
- )
17
- ```
18
-
@@ -1,20 +0,0 @@
1
- # DocSpring::CreateFolderRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | The folder's name. It can't contain `/`, and is unique within its parent folder. | |
8
- | **parent_folder_id** | **String** | The ID of the folder this folder is in. Null for a folder at the root. | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'docspring'
14
-
15
- instance = DocSpring::CreateFolderRequest.new(
16
- name: null,
17
- parent_folder_id: null
18
- )
19
- ```
20
-
@@ -1,24 +0,0 @@
1
- # DocSpring::CreateSignatureRequestEventRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **event_type** | [**SignatureRequestEventType**](SignatureRequestEventType.md) | `send_request`: you sent the signature request to the person (`message_type` and `message_recipient` are required). It's the only event the API records: DocSpring records everything that happens in the signing form itself, and people decline a signature request in its form. | |
8
- | **message_type** | [**SignatureRequestMessageType**](SignatureRequestMessageType.md) | How you sent the request. Required for `send_request`. | [optional] |
9
- | **message_recipient** | **String** | Where you sent the request, such as an email address or a phone number. Required for `send_request`. | [optional] |
10
- | **occurred_at** | **Time** | When it happened. Default now. | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'docspring'
16
-
17
- instance = DocSpring::CreateSignatureRequestEventRequest.new(
18
- event_type: null,
19
- message_type: null,
20
- message_recipient: null,
21
- occurred_at: null
22
- )
23
- ```
24
-
@@ -1,18 +0,0 @@
1
- # DocSpring::CreateSignatureRequestTokenRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **type** | [**SignatureRequestTokenType**](SignatureRequestTokenType.md) | `api` (the default): the link opens the signature request for 24 hours, for a form your app opens or a link it gives the person right away. `email`: 7 days, for a link you send by email. | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::CreateSignatureRequestTokenRequest.new(
15
- type: null
16
- )
17
- ```
18
-
@@ -1,28 +0,0 @@
1
- # DocSpring::CreateSubmissionBatchRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **metadata** | **Hash&lt;String, Object&gt;** | Your own data about the batch, such as an ID from your app. | [optional] |
8
- | **template_id** | **String** | The template for each submission that doesn't name its own `template_id`. | [optional] |
9
- | **template_version** | **String** | The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`. | [optional] |
10
- | **test** | **Boolean** | The default `test` for each submission that doesn't set its own. | [optional] |
11
- | **output_formats** | [**Array&lt;OutputFormat&gt;**](OutputFormat.md) | The default `output_formats` for each submission that doesn't set its own. | [optional] |
12
- | **submissions** | [**Array&lt;SubmissionInput&gt;**](SubmissionInput.md) | Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests` and the options for DocSpring's emails to signers (`send_email`, `signing_order`, `email_subject`, `email_message`, `cc`, `reply_to`, `notification_emails`, `notify_when_signed` and `reminders`), plus `template_id` and `template_version` when it uses a different template from the batch. | |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'docspring'
18
-
19
- instance = DocSpring::CreateSubmissionBatchRequest.new(
20
- metadata: null,
21
- template_id: null,
22
- template_version: null,
23
- test: null,
24
- output_formats: null,
25
- submissions: null
26
- )
27
- ```
28
-
@@ -1,56 +0,0 @@
1
- # DocSpring::CreateSubmissionRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **test** | **Boolean** | Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions, and the demo API token's are always live. | [optional] |
8
- | **editable** | **Boolean** | `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`. | [optional] |
9
- | **data** | **Hash&lt;String, Object&gt;** | The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs, unless `signature_requests` collects them (PDF templates only). Signatures come only from signature requests: a value for a signature or initials field makes the submission `invalid_data`, in test mode too. To print an image or a name you send, use an Image or Text field. | [optional] |
10
- | **metadata** | **Hash&lt;String, Object&gt;** | 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 `&lt;title&gt;`, 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`). | [optional] |
11
- | **password** | **String** | 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. | [optional] |
12
- | **output_formats** | [**Array&lt;OutputFormat&gt;**](OutputFormat.md) | 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. | [optional] |
13
- | **expires_in** | **Integer** | 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. | [optional] |
14
- | **field_overrides** | [**Hash&lt;String, FieldOverride&gt;**](FieldOverride.md) | 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. | [optional] |
15
- | **html** | **String** | For an HTML template, HTML to use instead of the template's. | [optional] |
16
- | **css** | **String** | For an HTML template, SCSS (plain CSS works too) added after the template's styles, on the page and in its header and footer. It doesn't replace them: its rules come later, so they win over the template's rules of the same specificity. | [optional] |
17
- | **signature_requests** | [**Array&lt;SignatureRequestInput&gt;**](SignatureRequestInput.md) | The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF templates only. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out. | [optional] |
18
- | **send_email** | **Boolean** | Whether DocSpring emails the signers their signing links, and sends the reminders and the completed document. Default true. Each signature request's own `send_email` overrides it. A test submission only emails your DocSpring team: every other address is a 422. `true` needs `signature_requests`. DocSpring doesn't email the signers of a form library template: leave `send_email` out, and send them their links yourself. | [optional] |
19
- | **signing_order** | [**SigningOrder**](SigningOrder.md) | `parallel` (the default): everyone can sign at once. `sequential`: people sign one step at a time (`signing_step`), and DocSpring emails each step when the one before it is done. Needs `signature_requests`. | [optional] |
20
- | **email_subject** | **String** | The subject of the emails that ask people to sign. You can use `{{ signer.name }}`, `{{ signer.email }}`, `{{ document.name }}`, `{{ sender.name }}` and `{{ account.name }}`. Default "&lt;sender&gt; sent you &lt;document&gt; to sign" when you leave it out (a blank subject is a 422). Links and web addresses are shown as plain text (`example[.]com`). | [optional] |
21
- | **email_message** | **String** | A message for the people who sign, shown above the signing button. It takes the same variables as `email_subject`. Links and web addresses are shown as plain text. Leave it out for none: a blank message is a 422. | [optional] |
22
- | **cc** | **Array&lt;String&gt;** | People who get a copy of the completed document. They don't sign. | [optional] |
23
- | **reply_to** | **String** | Where replies to the emails go: a member of your DocSpring team, or an address at one of your verified email domains. Leave it out for the template's reply-to address (the account owner when it has none). | [optional] |
24
- | **notification_emails** | **Array&lt;String&gt;** | Who DocSpring tells when the document is completed or declined, or an email bounces or can't be sent: members of your DocSpring team or addresses at your verified email domains. Leave it out for the template's notification addresses (the account owner when it has none); an empty list means the account owner. | [optional] |
25
- | **notify_when_signed** | **Boolean** | Also email `notification_emails` each time someone signs. Default false. | [optional] |
26
- | **reminders** | [**SignatureRequestReminders**](SignatureRequestReminders.md) | Remind people who haven't signed: every `interval_days` days, up to `max_count` times. Each reminder has a new signing link. Without it, DocSpring sends no reminders. | [optional] |
27
-
28
- ## Example
29
-
30
- ```ruby
31
- require 'docspring'
32
-
33
- instance = DocSpring::CreateSubmissionRequest.new(
34
- test: null,
35
- editable: null,
36
- data: null,
37
- metadata: null,
38
- password: null,
39
- output_formats: null,
40
- expires_in: null,
41
- field_overrides: null,
42
- html: null,
43
- css: null,
44
- signature_requests: null,
45
- send_email: null,
46
- signing_order: null,
47
- email_subject: null,
48
- email_message: null,
49
- cc: null,
50
- reply_to: null,
51
- notification_emails: null,
52
- notify_when_signed: null,
53
- reminders: null
54
- )
55
- ```
56
-
@@ -1,18 +0,0 @@
1
- # DocSpring::CreateTemplatePreviewRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **data** | **Hash&lt;String, Object&gt;** | The values of the template's fields, by field name, as you'd send them to create a submission. They're rendered as they are: they aren't checked against the template's fields. A value that a field can't print, such as an image URL that doesn't download, makes the preview's `state` `error`, with an `error_message`. | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::CreateTemplatePreviewRequest.new(
15
- data: null
16
- )
17
- ```
18
-