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,36 +0,0 @@
1
- # DocSpring::HtmlEngineOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **format** | [**PageFormat**](PageFormat.md) | The paper size. `Custom` uses `width` and `height`. | |
8
- | **width** | **String** | The page width for the `Custom` format, with a unit (`8.5in`, `210mm`), from 0.05in to 200in. | [optional] |
9
- | **height** | **String** | The page height for the `Custom` format, with a unit, from 0.05in to 200in. | [optional] |
10
- | **scale** | **Float** | How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size. | |
11
- | **landscape** | **Boolean** | Print pages in landscape orientation. | |
12
- | **print_background** | **Boolean** | Print background colors and images. | |
13
- | **margin_top** | **String** | The top margin, with a unit, such as `1in` or `20mm`. The top and bottom margins together must be less than the page's height. | |
14
- | **margin_bottom** | **String** | The bottom margin, with a unit. | |
15
- | **margin_left** | **String** | The left margin, with a unit. The left and right margins together must be less than the page's width. | |
16
- | **margin_right** | **String** | The right margin, with a unit. | |
17
-
18
- ## Example
19
-
20
- ```ruby
21
- require 'docspring'
22
-
23
- instance = DocSpring::HtmlEngineOptions.new(
24
- format: null,
25
- width: null,
26
- height: null,
27
- scale: null,
28
- landscape: null,
29
- print_background: null,
30
- margin_top: null,
31
- margin_bottom: null,
32
- margin_left: null,
33
- margin_right: null
34
- )
35
- ```
36
-
@@ -1,36 +0,0 @@
1
- # DocSpring::HtmlEngineOptionsInput
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **format** | [**PageFormat**](PageFormat.md) | The paper size. `Custom` uses `width` and `height`. | [optional] |
8
- | **width** | **String** | The page width for the `Custom` format, with a unit (`8.5in`, `210mm`), from 0.05in to 200in. | [optional] |
9
- | **height** | **String** | The page height for the `Custom` format, with a unit, from 0.05in to 200in. | [optional] |
10
- | **scale** | **Float** | How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size. | [optional] |
11
- | **landscape** | **Boolean** | Print pages in landscape orientation. | [optional] |
12
- | **print_background** | **Boolean** | Print background colors and images. | [optional] |
13
- | **margin_top** | **String** | The top margin, with a unit, such as `1in` or `20mm`. The top and bottom margins together must be less than the page's height. | [optional] |
14
- | **margin_bottom** | **String** | The bottom margin, with a unit. | [optional] |
15
- | **margin_left** | **String** | The left margin, with a unit. The left and right margins together must be less than the page's width. | [optional] |
16
- | **margin_right** | **String** | The right margin, with a unit. | [optional] |
17
-
18
- ## Example
19
-
20
- ```ruby
21
- require 'docspring'
22
-
23
- instance = DocSpring::HtmlEngineOptionsInput.new(
24
- format: null,
25
- width: null,
26
- height: null,
27
- scale: null,
28
- landscape: null,
29
- print_background: null,
30
- margin_top: null,
31
- margin_bottom: null,
32
- margin_left: null,
33
- margin_right: null
34
- )
35
- ```
36
-
data/docs/ImageGravity.md DELETED
@@ -1,15 +0,0 @@
1
- # DocSpring::ImageGravity
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::ImageGravity.new()
14
- ```
15
-
@@ -1,15 +0,0 @@
1
- # DocSpring::ImageScaleType
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::ImageScaleType.new()
14
- ```
15
-
@@ -1,15 +0,0 @@
1
- # DocSpring::ModelCodeLanguage
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::ModelCodeLanguage.new()
14
- ```
15
-
@@ -1,18 +0,0 @@
1
- # DocSpring::MoveFolderRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **parent_folder_id** | **String** | The ID of the folder this folder is in. Null for a folder at the root. | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::MoveFolderRequest.new(
15
- parent_folder_id: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # DocSpring::MoveTemplateRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **parent_folder_id** | **String** | The folder to move the template and all of its published versions to. Null moves them to the root. | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::MoveTemplateRequest.new(
15
- parent_folder_id: null
16
- )
17
- ```
18
-
@@ -1,15 +0,0 @@
1
- # DocSpring::NumberConditionType
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::NumberConditionType.new()
14
- ```
15
-
data/docs/OutputFormat.md DELETED
@@ -1,15 +0,0 @@
1
- # DocSpring::OutputFormat
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::OutputFormat.new()
14
- ```
15
-
data/docs/PageFormat.md DELETED
@@ -1,15 +0,0 @@
1
- # DocSpring::PageFormat
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::PageFormat.new()
14
- ```
15
-
data/docs/PageImage.md DELETED
@@ -1,34 +0,0 @@
1
- # DocSpring::PageImage
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **page** | **Integer** | The page number, from 1. | |
8
- | **width** | **Integer** | The image's width in pixels. | |
9
- | **height** | **Integer** | The image's height in pixels. | |
10
- | **download_url** | **String** | A temporary link to download the image. A submission's is null when your account turns off download links for submissions. | |
11
- | **permanent_url** | **String** | A link to download a submission's image 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 for a template's page images. | |
12
- | **filename** | **String** | The image's file name, such as `sub_123_page_1.png`. | |
13
- | **content_type** | **String** | The image's media type, `image/png` for a submission's pages or `image/jpeg` for a template's. | |
14
- | **size** | **Integer** | The image's size in bytes. | |
15
- | **sha256** | **String** | The SHA-256 hash of the image. Null for a template's page images. | |
16
-
17
- ## Example
18
-
19
- ```ruby
20
- require 'docspring'
21
-
22
- instance = DocSpring::PageImage.new(
23
- page: null,
24
- width: null,
25
- height: null,
26
- download_url: null,
27
- permanent_url: null,
28
- filename: null,
29
- content_type: null,
30
- size: null,
31
- sha256: null
32
- )
33
- ```
34
-
data/docs/PageImages.md DELETED
@@ -1,24 +0,0 @@
1
- # DocSpring::PageImages
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **state** | [**GeneratedFileState**](GeneratedFileState.md) | `processed` once the images have been made, with the PDF or by POST /submissions/{submission_id}/generate_files. `pending` until then, and `error` if they couldn't be made (see `error_message`). | |
8
- | **error_message** | **String** | Why the images couldn't be made, when `state` is `error`. | |
9
- | **page_count** | **Integer** | How many pages have an image. Null until the images have been made. | |
10
- | **pages** | [**Array<PageImage>**](PageImage.md) | An image of each page, in order: `pages[0]` is page 1. Lists of submissions leave it out (null): get the submission to see them. Empty until the images have been made. | |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'docspring'
16
-
17
- instance = DocSpring::PageImages.new(
18
- state: null,
19
- error_message: null,
20
- page_count: null,
21
- pages: null
22
- )
23
- ```
24
-
@@ -1,30 +0,0 @@
1
- # DocSpring::PredefinedField
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | The field's name, the key of its value in submission data. A `/` nests the key in objects and arrays (`customer/email`, `signers/0/name`). | |
8
- | **display_name** | **String** | The name the template editor shows instead of `name`, where a `/` puts it in a folder, such as `Defendant/Name`. Null shows `name`. Two names can't share a display name. | [optional] |
9
- | **title** | **String** | The Title setting a field gets when it's given this name. Null leaves the field's title as it is. | [optional] |
10
- | **type** | [**FieldType**](FieldType.md) | The data type a field gets when it's given this name, as a field's `type`. | |
11
- | **option_list** | **String** | String fields only: the values allowed, separated by commas, such as `Yes,No`. Null allows any value. | [optional] |
12
- | **required_in_template** | **Boolean** | 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. | [optional] |
13
- | **field_required** | **Boolean** | The Required setting a field gets when it's given this name. Default true. | [optional] |
14
-
15
- ## Example
16
-
17
- ```ruby
18
- require 'docspring'
19
-
20
- instance = DocSpring::PredefinedField.new(
21
- name: null,
22
- display_name: null,
23
- title: null,
24
- type: null,
25
- option_list: null,
26
- required_in_template: null,
27
- field_required: null
28
- )
29
- ```
30
-
@@ -1,30 +0,0 @@
1
- # DocSpring::PredefinedFieldInput
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | The field's name, the key of its value in submission data. A `/` nests the key in objects and arrays (`customer/email`, `signers/0/name`). | |
8
- | **display_name** | **String** | The name the template editor shows instead of `name`, where a `/` puts it in a folder, such as `Defendant/Name`. Null shows `name`. Two names can't share a display name. | [optional] |
9
- | **title** | **String** | The Title setting a field gets when it's given this name. Null leaves the field's title as it is. | [optional] |
10
- | **type** | [**FieldType**](FieldType.md) | The data type a field gets when it's given this name, as a field's `type`. | |
11
- | **option_list** | **String** | String fields only: the values allowed, separated by commas, such as `Yes,No`. Null allows any value. | [optional] |
12
- | **required_in_template** | **Boolean** | 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. | [optional] |
13
- | **field_required** | **Boolean** | The Required setting a field gets when it's given this name. Default true. | [optional] |
14
-
15
- ## Example
16
-
17
- ```ruby
18
- require 'docspring'
19
-
20
- instance = DocSpring::PredefinedFieldInput.new(
21
- name: null,
22
- display_name: null,
23
- title: null,
24
- type: null,
25
- option_list: null,
26
- required_in_template: null,
27
- field_required: null
28
- )
29
- ```
30
-
@@ -1,20 +0,0 @@
1
- # DocSpring::PublishTemplateVersionRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **version_type** | [**TemplateVersionType**](TemplateVersionType.md) | Which part of the latest version number to increase. | |
8
- | **description** | **String** | What changed in the version, shown with it in DocSpring. | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'docspring'
14
-
15
- instance = DocSpring::PublishTemplateVersionRequest.new(
16
- version_type: null,
17
- description: null
18
- )
19
- ```
20
-
@@ -1,18 +0,0 @@
1
- # DocSpring::RemoveTemplateFieldsRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **field_ids** | **Array<Integer>** | The IDs of the fields to remove. | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::RemoveTemplateFieldsRequest.new(
15
- field_ids: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # DocSpring::RenameFolderRequest
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
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::RenameFolderRequest.new(
15
- name: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # DocSpring::ReorderTemplateFieldsRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **field_ids** | **Array<Integer>** | The ID of every field, in the new order. Each field stays on its page, and a page's fields take the order their IDs have here: the order they're printed in (a later field prints over an earlier one where they overlap), and the order of their values in the template's data schema and forms. | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::ReorderTemplateFieldsRequest.new(
15
- field_ids: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # DocSpring::RestoreTemplateVersionRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **version** | **String** | The published version to restore to the draft (`1.2.0`, or `1` for the latest 1.x.x). | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::RestoreTemplateVersionRequest.new(
15
- version: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # DocSpring::SendAccountEmailActionTestEmailRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **template_id** | **String** | A template the email action sends for: the test uses its PDF and name. Left out, it uses the one that changed most recently. | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::SendAccountEmailActionTestEmailRequest.new(
15
- template_id: null
16
- )
17
- ```
18
-
data/docs/ShapeType.md DELETED
@@ -1,15 +0,0 @@
1
- # DocSpring::ShapeType
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::ShapeType.new()
14
- ```
15
-
@@ -1,74 +0,0 @@
1
- # DocSpring::SignatureRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | The signature request's ID. | |
8
- | **submission_id** | **String** | The ID of the submission the signature request belongs to. | |
9
- | **name** | **String** | The name of the person the request is for. | |
10
- | **email** | **String** | Their email address. Null when they have none. | |
11
- | **fields** | **Array<String>** | 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. | |
12
- | **metadata** | **Hash<String, Object>** | Your own data about the signature request, such as an ID from your app. | |
13
- | **role** | **String** | 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. | |
14
- | **sort_order** | **Integer** | The signer's position, from 0: `Signer 1` is 0. The template's `@@signature_requests/<sort_order>` fields print this signature request's details. | |
15
- | **send_email** | **Boolean** | Whether DocSpring emails this person their signing link. | |
16
- | **signing_step** | **Integer** | When this person signs, when the submission's `signing_order` is `sequential`: everyone in step 1 first, then step 2, and so on. Null when everyone can sign at once. | |
17
- | **sent_at** | **Time** | When DocSpring first emailed this person their signing link. Null until it has, and when it doesn't email them (`send_email` is false). | |
18
- | **email_status** | [**SignatureRequestEmailStatus**](SignatureRequestEmailStatus.md) | What happened to the latest email DocSpring sent this person with their signing link: `sent` until the email service reports on it, then `delayed` (still trying), `delivered`, `undelivered` (it stopped trying, as with a full mailbox), `bounced` (the address doesn't exist) or `complained` (marked as spam). `failed` means DocSpring couldn't send the first email with their link, and `unknown` that it couldn't tell whether that email went: neither is sent again. Null until DocSpring has emailed them or tried to. | |
19
- | **state** | [**SignatureRequestState**](SignatureRequestState.md) | `pending` until the person completes the signature request (`completed`) or declines it (`declined`). | |
20
- | **data** | **Hash<String, Object>** | The values this person entered for their own fields (`fields`). Null when their submission's data is left out: in lists without `include_data=true`, in the events of a webhook that leaves out submission data, and once the submission has expired. | |
21
- | **viewed_at** | **Time** | When the person first opened the signature request. | |
22
- | **completed_at** | **Time** | When they completed it. | |
23
- | **declined_at** | **Time** | When they declined it. | |
24
- | **auth_type** | [**SignatureRequestAuthType**](SignatureRequestAuthType.md) | How your app authenticated the person before it showed them the signature request. | |
25
- | **auth_second_factor_type** | [**SignatureRequestAuthSecondFactorType**](SignatureRequestAuthSecondFactorType.md) | The second factor your app authenticated them with, if any. | |
26
- | **auth_provider** | **String** | The service that authenticated them, such as `google`. Required when `auth_type` is `oauth`. | |
27
- | **auth_session_started_at** | **Time** | When your app authenticated them. Set for you with `email_link`. | |
28
- | **auth_session_id_hash** | **String** | A hash of your app's session ID, for the audit trail. | |
29
- | **auth_user_id_hash** | **String** | Their user ID in your app, or a SHA-256 hash of a salt and the user ID. | |
30
- | **auth_username_hash** | **String** | Their username in your app, or a SHA-256 hash of a salt and the username. | |
31
- | **auth_phone_number_hash** | **String** | The phone number they authenticated with, or a SHA-256 hash of a salt and the phone number. | |
32
- | **ip_address** | **String** | The IP address they completed the signature request from. Null in the events of a webhook that leaves out submission data. | |
33
- | **user_agent** | **String** | The User-Agent header of the browser they completed the signature request with. Null in the events of a webhook that leaves out submission data. | |
34
- | **created_at** | **Time** | When the signature request was created. | |
35
- | **updated_at** | **Time** | When the signature request was last updated. | |
36
-
37
- ## Example
38
-
39
- ```ruby
40
- require 'docspring'
41
-
42
- instance = DocSpring::SignatureRequest.new(
43
- id: null,
44
- submission_id: null,
45
- name: null,
46
- email: null,
47
- fields: null,
48
- metadata: null,
49
- role: null,
50
- sort_order: null,
51
- send_email: null,
52
- signing_step: null,
53
- sent_at: null,
54
- email_status: null,
55
- state: null,
56
- data: null,
57
- viewed_at: null,
58
- completed_at: null,
59
- declined_at: null,
60
- auth_type: null,
61
- auth_second_factor_type: null,
62
- auth_provider: null,
63
- auth_session_started_at: null,
64
- auth_session_id_hash: null,
65
- auth_user_id_hash: null,
66
- auth_username_hash: null,
67
- auth_phone_number_hash: null,
68
- ip_address: null,
69
- user_agent: null,
70
- created_at: null,
71
- updated_at: null
72
- )
73
- ```
74
-
@@ -1,15 +0,0 @@
1
- # DocSpring::SignatureRequestAuthSecondFactorType
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::SignatureRequestAuthSecondFactorType.new()
14
- ```
15
-
@@ -1,15 +0,0 @@
1
- # DocSpring::SignatureRequestAuthType
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::SignatureRequestAuthType.new()
14
- ```
15
-
@@ -1,15 +0,0 @@
1
- # DocSpring::SignatureRequestEmailAttachments
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::SignatureRequestEmailAttachments.new()
14
- ```
15
-
@@ -1,15 +0,0 @@
1
- # DocSpring::SignatureRequestEmailStatus
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::SignatureRequestEmailStatus.new()
14
- ```
15
-
@@ -1,32 +0,0 @@
1
- # DocSpring::SignatureRequestEvent
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | The event's ID. | |
8
- | **submission_id** | **String** | The ID of the signature request's submission. | |
9
- | **signature_request_id** | **String** | The ID of the signature request. | |
10
- | **event_type** | [**SignatureRequestEventType**](SignatureRequestEventType.md) | What happened. | |
11
- | **message_type** | [**SignatureRequestMessageType**](SignatureRequestMessageType.md) | How you sent the request. Required for `send_request`. | |
12
- | **message_recipient** | **String** | Where you sent the request, such as an email address or a phone number. Required for `send_request`. | |
13
- | **occurred_at** | **Time** | When it happened. Default now. | |
14
- | **created_at** | **Time** | When the event was recorded. | |
15
-
16
- ## Example
17
-
18
- ```ruby
19
- require 'docspring'
20
-
21
- instance = DocSpring::SignatureRequestEvent.new(
22
- id: null,
23
- submission_id: null,
24
- signature_request_id: null,
25
- event_type: null,
26
- message_type: null,
27
- message_recipient: null,
28
- occurred_at: null,
29
- created_at: null
30
- )
31
- ```
32
-
@@ -1,15 +0,0 @@
1
- # DocSpring::SignatureRequestEventType
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'docspring'
12
-
13
- instance = DocSpring::SignatureRequestEventType.new()
14
- ```
15
-