docspring 3.5.0 → 4.0.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 (505) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/FILES +361 -150
  3. data/.openapi-generator/VERSION +1 -1
  4. data/.rubocop.yml +1 -1
  5. data/.travis.yml +1 -1
  6. data/AGENTS.md +79 -19
  7. data/CHANGELOG.md +123 -0
  8. data/Gemfile.lock +7 -7
  9. data/README.md +60 -53
  10. data/docs/{RenameFolderData.md → AiFieldNamingLanguage.md} +2 -5
  11. data/docs/AuthenticationCheck.md +18 -0
  12. data/docs/{CreateFolderData.md → BarcodeSymbology.md} +2 -5
  13. data/docs/{CreateWebhookData.md → CheckCharacter.md} +2 -5
  14. data/docs/Client.md +890 -777
  15. data/docs/{UpdateWebhookData.md → CombinedFieldType.md} +2 -5
  16. data/docs/CombinedPdf.md +44 -0
  17. data/docs/CombinedPdfFiles.md +18 -0
  18. data/docs/CombinedPdfList.md +20 -0
  19. data/docs/CombinedPdfSource.md +26 -0
  20. data/docs/CombinedPdfSourceInput.md +88 -0
  21. data/docs/CombinedPdfSourcePdf.md +20 -0
  22. data/docs/CombinedPdfSourceType.md +15 -0
  23. data/docs/CombinedPdfState.md +15 -0
  24. data/docs/CopyTemplateRequest.md +22 -0
  25. data/docs/CreateCombinedPdfRequest.md +26 -0
  26. data/docs/CreateCustomFileFromUploadRequest.md +18 -0
  27. data/docs/CreateFolderRequest.md +20 -0
  28. data/docs/CreateSignatureRequestEventRequest.md +24 -0
  29. data/docs/CreateSignatureRequestTokenRequest.md +18 -0
  30. data/docs/CreateSubmissionBatchRequest.md +26 -0
  31. data/docs/CreateSubmissionRequest.md +36 -0
  32. data/docs/CreateTemplateRequest.md +94 -0
  33. data/docs/CreateWebhookRequest.md +38 -0
  34. data/docs/CustomFile.md +11 -3
  35. data/docs/CustomFileList.md +20 -0
  36. data/docs/CustomFileSourcePdf.md +20 -0
  37. data/docs/ErrorCode.md +15 -0
  38. data/docs/ErrorDetail.md +26 -0
  39. data/docs/ErrorInfo.md +32 -0
  40. data/docs/ErrorResponse.md +1 -3
  41. data/docs/ExpirationInterval.md +15 -0
  42. data/docs/FieldComparisonCondition.md +22 -0
  43. data/docs/FieldComparisonOperator.md +15 -0
  44. data/docs/FieldDisplayType.md +15 -0
  45. data/docs/FieldEqualsCondition.md +22 -0
  46. data/docs/FieldEqualsOperator.md +15 -0
  47. data/docs/FieldInCondition.md +22 -0
  48. data/docs/FieldOverride.md +142 -0
  49. data/docs/FieldPresenceCondition.md +20 -0
  50. data/docs/FieldPresenceOperator.md +15 -0
  51. data/docs/FieldRangeCondition.md +24 -0
  52. data/docs/FieldReimportState.md +15 -0
  53. data/docs/FieldSetupLogic.md +15 -0
  54. data/docs/FieldSetupNaming.md +15 -0
  55. data/docs/FieldSetupSource.md +15 -0
  56. data/docs/Folder.md +9 -5
  57. data/docs/FolderList.md +20 -0
  58. data/docs/GeneratedFile.md +32 -0
  59. data/docs/GeneratedFileState.md +15 -0
  60. data/docs/HtmlEngineOptions.md +36 -0
  61. data/docs/HtmlEngineOptionsInput.md +36 -0
  62. data/docs/ImageGravity.md +15 -0
  63. data/docs/ImageScaleType.md +15 -0
  64. data/docs/ModelCodeLanguage.md +15 -0
  65. data/docs/MoveFolderRequest.md +18 -0
  66. data/docs/MoveTemplateRequest.md +18 -0
  67. data/docs/NumberConditionType.md +15 -0
  68. data/docs/PageFormat.md +15 -0
  69. data/docs/PublishTemplateVersionRequest.md +20 -0
  70. data/docs/RenameFolderRequest.md +18 -0
  71. data/docs/RestoreTemplateVersionRequest.md +18 -0
  72. data/docs/ShapeType.md +15 -0
  73. data/docs/SignatureRequest.md +66 -0
  74. data/docs/SignatureRequestAuthSecondFactorType.md +15 -0
  75. data/docs/SignatureRequestAuthType.md +15 -0
  76. data/docs/SignatureRequestEvent.md +32 -0
  77. data/docs/SignatureRequestEventType.md +15 -0
  78. data/docs/SignatureRequestInput.md +46 -0
  79. data/docs/SignatureRequestMessageType.md +15 -0
  80. data/docs/SignatureRequestState.md +15 -0
  81. data/docs/SignatureRequestToken.md +30 -0
  82. data/docs/SignatureRequestTokenType.md +15 -0
  83. data/docs/StringConditionType.md +15 -0
  84. data/docs/Submission.md +41 -47
  85. data/docs/SubmissionAction.md +6 -8
  86. data/docs/SubmissionActionState.md +15 -0
  87. data/docs/SubmissionActionType.md +15 -0
  88. data/docs/SubmissionBatch.md +16 -10
  89. data/docs/SubmissionBatchState.md +15 -0
  90. data/docs/SubmissionFiles.md +22 -0
  91. data/docs/SubmissionInput.md +38 -0
  92. data/docs/SubmissionList.md +20 -0
  93. data/docs/SubmissionSource.md +15 -0
  94. data/docs/SubmissionSourcePdf.md +20 -0
  95. data/docs/SubmissionState.md +15 -0
  96. data/docs/Template.md +73 -107
  97. data/docs/TemplateActor.md +26 -0
  98. data/docs/TemplateActorType.md +15 -0
  99. data/docs/TemplateDefaults.md +56 -0
  100. data/docs/TemplateDefaultsInput.md +56 -0
  101. data/docs/TemplateDocument.md +40 -0
  102. data/docs/TemplateDocumentState.md +15 -0
  103. data/docs/TemplateFieldDependency.md +26 -0
  104. data/docs/TemplateFieldDependencyAction.md +15 -0
  105. data/docs/TemplateFieldDependencyCondition.md +24 -0
  106. data/docs/TemplateFieldDependencyConditionInput.md +93 -0
  107. data/docs/TemplateFieldDependencyInput.md +26 -0
  108. data/docs/TemplateFieldDependencyMatch.md +15 -0
  109. data/docs/TemplateFieldDependencyOperator.md +15 -0
  110. data/docs/TemplateFieldLogicStatus.md +15 -0
  111. data/docs/TemplateFormMode.md +15 -0
  112. data/docs/TemplateModelCode.md +22 -0
  113. data/docs/TemplatePageAiError.md +15 -0
  114. data/docs/TemplatePageAiNamingStatus.md +15 -0
  115. data/docs/TemplatePageFieldsStatus.md +15 -0
  116. data/docs/TemplatePageImageStatus.md +15 -0
  117. data/docs/TemplatePageProcessingStatus.md +26 -0
  118. data/docs/TemplateSourcePdf.md +24 -0
  119. data/docs/TemplateSummary.md +90 -0
  120. data/docs/TemplateSummaryList.md +20 -0
  121. data/docs/TemplateType.md +15 -0
  122. data/docs/TemplateVersion.md +24 -0
  123. data/docs/TemplateVersionType.md +15 -0
  124. data/docs/TextAlignment.md +15 -0
  125. data/docs/TextOverflow.md +15 -0
  126. data/docs/TextVerticalAlignment.md +15 -0
  127. data/docs/Typeface.md +15 -0
  128. data/docs/UpdateSignatureRequestRequest.md +34 -0
  129. data/docs/UpdateTemplateDocumentRequest.md +22 -0
  130. data/docs/UpdateTemplateRequest.md +80 -0
  131. data/docs/UpdateWebhookRequest.md +38 -0
  132. data/docs/UploadMethod.md +15 -0
  133. data/docs/UploadPresign.md +24 -0
  134. data/docs/UrlSourcePdf.md +20 -0
  135. data/docs/Webhook.md +20 -20
  136. data/docs/WebhookEventType.md +15 -0
  137. data/docs/WebhookList.md +20 -0
  138. data/docs/WebhookMode.md +15 -0
  139. data/docspring.gemspec +3 -3
  140. data/lib/docspring/api/client.rb +995 -942
  141. data/lib/docspring/api_client.rb +14 -6
  142. data/lib/docspring/api_error.rb +3 -3
  143. data/lib/docspring/api_model_base.rb +88 -0
  144. data/lib/docspring/configuration.rb +12 -7
  145. data/lib/docspring/models/ai_field_naming_language.rb +42 -0
  146. data/lib/docspring/models/authentication_check.rb +185 -0
  147. data/lib/docspring/models/barcode_symbology.rb +47 -0
  148. data/lib/docspring/models/check_character.rb +44 -0
  149. data/lib/docspring/models/combined_field_type.rb +41 -0
  150. data/lib/docspring/models/{combined_submission.rb → combined_pdf.rb} +228 -206
  151. data/lib/docspring/models/combined_pdf_files.rb +167 -0
  152. data/lib/docspring/models/combined_pdf_list.rb +200 -0
  153. data/lib/docspring/models/{update_webhook_data.rb → combined_pdf_source.rb} +107 -103
  154. data/lib/docspring/models/combined_pdf_source_input.rb +62 -0
  155. data/lib/docspring/models/combined_pdf_source_pdf.rb +212 -0
  156. data/lib/docspring/models/combined_pdf_source_type.rb +44 -0
  157. data/lib/docspring/models/combined_pdf_state.rb +44 -0
  158. data/lib/docspring/models/{copy_template_options.rb → copy_template_request.rb} +32 -87
  159. data/lib/docspring/models/{combine_pdfs_data.rb → create_combined_pdf_request.rb} +60 -123
  160. data/lib/docspring/models/{create_custom_file_data.rb → create_custom_file_from_upload_request.rb} +29 -96
  161. data/lib/docspring/models/{move_template_data.rb → create_folder_request.rb} +60 -102
  162. data/lib/docspring/models/{create_submission_data_request_event_request.rb → create_signature_request_event_request.rb} +50 -122
  163. data/lib/docspring/models/create_signature_request_token_request.rb +190 -0
  164. data/lib/docspring/models/{submission_batch_data.rb → create_submission_batch_request.rb} +53 -108
  165. data/lib/docspring/models/{create_pdf_submission_data.rb → create_submission_request.rb} +97 -149
  166. data/lib/docspring/models/create_template_request.rb +601 -0
  167. data/lib/docspring/models/create_webhook_request.rb +368 -0
  168. data/lib/docspring/models/custom_file.rb +132 -95
  169. data/lib/docspring/models/custom_file_list.rb +200 -0
  170. data/lib/docspring/models/custom_file_source_pdf.rb +212 -0
  171. data/lib/docspring/models/error_code.rb +60 -0
  172. data/lib/docspring/models/error_detail.rb +242 -0
  173. data/lib/docspring/models/error_info.rb +316 -0
  174. data/lib/docspring/models/error_response.rb +28 -138
  175. data/lib/docspring/models/expiration_interval.rb +42 -0
  176. data/lib/docspring/models/field_comparison_condition.rb +247 -0
  177. data/lib/docspring/models/field_comparison_operator.rb +43 -0
  178. data/lib/docspring/models/field_display_type.rb +45 -0
  179. data/lib/docspring/models/field_equals_condition.rb +247 -0
  180. data/lib/docspring/models/field_equals_operator.rb +41 -0
  181. data/lib/docspring/models/{create_folder_data.rb → field_in_condition.rb} +101 -103
  182. data/lib/docspring/models/field_override.rb +829 -0
  183. data/lib/docspring/models/field_presence_condition.rb +234 -0
  184. data/lib/docspring/models/field_presence_operator.rb +41 -0
  185. data/lib/docspring/models/field_range_condition.rb +234 -0
  186. data/lib/docspring/models/field_reimport_state.rb +43 -0
  187. data/lib/docspring/models/field_setup_logic.rb +41 -0
  188. data/lib/docspring/models/field_setup_naming.rb +41 -0
  189. data/lib/docspring/models/field_setup_source.rb +42 -0
  190. data/lib/docspring/models/folder.rb +134 -93
  191. data/lib/docspring/models/folder_list.rb +200 -0
  192. data/lib/docspring/models/generated_file.rb +326 -0
  193. data/lib/docspring/models/generated_file_state.rb +42 -0
  194. data/lib/docspring/models/html_engine_options.rb +416 -0
  195. data/lib/docspring/models/html_engine_options_input.rb +280 -0
  196. data/lib/docspring/models/image_gravity.rb +48 -0
  197. data/lib/docspring/models/image_scale_type.rb +42 -0
  198. data/lib/docspring/models/model_code_language.rb +48 -0
  199. data/lib/docspring/models/{move_folder_data.rb → move_folder_request.rb} +31 -87
  200. data/lib/docspring/models/move_template_request.rb +171 -0
  201. data/lib/docspring/models/number_condition_type.rb +45 -0
  202. data/lib/docspring/models/page_format.rb +52 -0
  203. data/lib/docspring/models/{publish_version_data.rb → publish_template_version_request.rb} +64 -99
  204. data/lib/docspring/models/{rename_folder_data.rb → rename_folder_request.rb} +29 -87
  205. data/lib/docspring/models/{restore_version_data.rb → restore_template_version_request.rb} +29 -87
  206. data/lib/docspring/models/shape_type.rb +45 -0
  207. data/lib/docspring/models/{submission_data_request_show.rb → signature_request.rb} +240 -171
  208. data/lib/docspring/models/signature_request_auth_second_factor_type.rb +45 -0
  209. data/lib/docspring/models/signature_request_auth_type.rb +46 -0
  210. data/lib/docspring/models/{submission_data_request_event.rb → signature_request_event.rb} +137 -122
  211. data/lib/docspring/models/signature_request_event_type.rb +45 -0
  212. data/lib/docspring/models/{update_submission_data_request_data.rb → signature_request_input.rb} +156 -173
  213. data/lib/docspring/models/signature_request_message_type.rb +48 -0
  214. data/lib/docspring/models/signature_request_state.rb +42 -0
  215. data/lib/docspring/models/signature_request_token.rb +369 -0
  216. data/lib/docspring/models/signature_request_token_type.rb +41 -0
  217. data/lib/docspring/models/string_condition_type.rb +44 -0
  218. data/lib/docspring/models/submission.rb +374 -339
  219. data/lib/docspring/models/submission_action.rb +64 -136
  220. data/lib/docspring/models/submission_action_state.rb +43 -0
  221. data/lib/docspring/models/submission_action_type.rb +46 -0
  222. data/lib/docspring/models/submission_batch.rb +157 -112
  223. data/lib/docspring/models/submission_batch_state.rb +42 -0
  224. data/lib/docspring/models/submission_files.rb +188 -0
  225. data/lib/docspring/models/submission_input.rb +274 -0
  226. data/lib/docspring/models/submission_list.rb +200 -0
  227. data/lib/docspring/models/submission_source.rb +43 -0
  228. data/lib/docspring/models/submission_source_pdf.rb +212 -0
  229. data/lib/docspring/models/submission_state.rb +52 -0
  230. data/lib/docspring/models/template.rb +485 -766
  231. data/lib/docspring/models/{add_fields_data.rb → template_actor.rb} +119 -105
  232. data/lib/docspring/models/template_actor_type.rb +42 -0
  233. data/lib/docspring/models/template_defaults.rb +395 -0
  234. data/lib/docspring/models/template_defaults_input.rb +395 -0
  235. data/lib/docspring/models/template_document.rb +396 -0
  236. data/lib/docspring/models/template_document_state.rb +44 -0
  237. data/lib/docspring/models/{success_error_response.rb → template_field_dependency.rb} +122 -114
  238. data/lib/docspring/models/template_field_dependency_action.rb +42 -0
  239. data/lib/docspring/models/{create_pdf_template.rb → template_field_dependency_condition.rb} +116 -103
  240. data/lib/docspring/models/template_field_dependency_condition_input.rb +67 -0
  241. data/lib/docspring/models/template_field_dependency_input.rb +285 -0
  242. data/lib/docspring/models/template_field_dependency_match.rb +41 -0
  243. data/lib/docspring/models/template_field_dependency_operator.rb +49 -0
  244. data/lib/docspring/models/template_field_logic_status.rb +44 -0
  245. data/lib/docspring/models/template_form_mode.rb +42 -0
  246. data/lib/docspring/models/{template_model_code_response.rb → template_model_code.rb} +37 -96
  247. data/lib/docspring/models/template_page_ai_error.rb +43 -0
  248. data/lib/docspring/models/template_page_ai_naming_status.rb +41 -0
  249. data/lib/docspring/models/template_page_fields_status.rb +44 -0
  250. data/lib/docspring/models/template_page_image_status.rb +41 -0
  251. data/lib/docspring/models/template_page_processing_status.rb +275 -0
  252. data/lib/docspring/models/{create_webhook_data.rb → template_source_pdf.rb} +92 -103
  253. data/lib/docspring/models/{template_preview.rb → template_summary.rb} +436 -589
  254. data/lib/docspring/models/template_summary_list.rb +200 -0
  255. data/lib/docspring/models/template_type.rb +41 -0
  256. data/lib/docspring/models/template_version.rb +238 -0
  257. data/lib/docspring/models/template_version_type.rb +42 -0
  258. data/lib/docspring/models/text_alignment.rb +43 -0
  259. data/lib/docspring/models/text_overflow.rb +41 -0
  260. data/lib/docspring/models/text_vertical_alignment.rb +42 -0
  261. data/lib/docspring/models/typeface.rb +56 -0
  262. data/lib/docspring/models/{create_submission_data_request_data.rb → update_signature_request_request.rb} +72 -196
  263. data/lib/docspring/models/update_template_document_request.rb +205 -0
  264. data/lib/docspring/models/update_template_request.rb +514 -0
  265. data/lib/docspring/models/update_webhook_request.rb +344 -0
  266. data/lib/docspring/models/upload_method.rb +40 -0
  267. data/lib/docspring/models/{upload_presign_response.rb → upload_presign.rb} +93 -140
  268. data/lib/docspring/models/url_source_pdf.rb +212 -0
  269. data/lib/docspring/models/webhook.rb +97 -107
  270. data/lib/docspring/models/webhook_event_type.rb +64 -0
  271. data/lib/docspring/models/webhook_list.rb +200 -0
  272. data/lib/docspring/models/webhook_mode.rb +41 -0
  273. data/lib/docspring/request_schemas.json +3187 -0
  274. data/lib/docspring/request_validator.rb +396 -0
  275. data/lib/docspring/version.rb +4 -4
  276. data/lib/docspring.rb +125 -53
  277. data/spec/api/client_spec.rb +304 -277
  278. data/spec/models/ai_field_naming_language_spec.rb +30 -0
  279. data/spec/models/authentication_check_spec.rb +36 -0
  280. data/spec/models/barcode_symbology_spec.rb +30 -0
  281. data/spec/models/check_character_spec.rb +30 -0
  282. data/spec/models/combined_field_type_spec.rb +30 -0
  283. data/spec/models/combined_pdf_files_spec.rb +36 -0
  284. data/spec/models/combined_pdf_list_spec.rb +42 -0
  285. data/spec/models/combined_pdf_source_input_spec.rb +44 -0
  286. data/spec/models/combined_pdf_source_pdf_spec.rb +42 -0
  287. data/spec/models/{submission_data_request_token_spec.rb → combined_pdf_source_spec.rb} +18 -12
  288. data/spec/models/combined_pdf_source_type_spec.rb +30 -0
  289. data/spec/models/{combined_submission_spec.rb → combined_pdf_spec.rb} +20 -24
  290. data/spec/models/combined_pdf_state_spec.rb +30 -0
  291. data/spec/models/{copy_template_options_spec.rb → copy_template_request_spec.rb} +9 -9
  292. data/spec/models/{combine_pdfs_data_spec.rb → create_combined_pdf_request_spec.rb} +12 -18
  293. data/spec/models/{create_custom_file_data_spec.rb → create_custom_file_from_upload_request_spec.rb} +9 -9
  294. data/spec/models/{move_template_data_spec.rb → create_folder_request_spec.rb} +11 -11
  295. data/spec/models/{list_submissions_response_spec.rb → create_signature_request_event_request_spec.rb} +18 -12
  296. data/spec/models/create_signature_request_token_request_spec.rb +36 -0
  297. data/spec/models/{submission_batch_data_spec.rb → create_submission_batch_request_spec.rb} +13 -13
  298. data/spec/models/{create_pdf_submission_data_spec.rb → create_submission_request_spec.rb} +24 -18
  299. data/spec/models/{template_preview_spec.rb → create_template_request_spec.rb} +40 -118
  300. data/spec/models/create_webhook_request_spec.rb +96 -0
  301. data/spec/models/custom_file_list_spec.rb +42 -0
  302. data/spec/models/custom_file_source_pdf_spec.rb +42 -0
  303. data/spec/models/custom_file_spec.rb +29 -5
  304. data/spec/models/error_code_spec.rb +30 -0
  305. data/spec/models/{create_submission_response_spec.rb → error_detail_spec.rb} +14 -18
  306. data/spec/models/{batch_generate_pdfs201_response_spec.rb → error_info_spec.rb} +27 -19
  307. data/spec/models/error_response_spec.rb +4 -14
  308. data/spec/models/expiration_interval_spec.rb +30 -0
  309. data/spec/models/field_comparison_condition_spec.rb +48 -0
  310. data/spec/models/field_comparison_operator_spec.rb +30 -0
  311. data/spec/models/field_display_type_spec.rb +30 -0
  312. data/spec/models/field_equals_condition_spec.rb +48 -0
  313. data/spec/models/field_equals_operator_spec.rb +30 -0
  314. data/spec/models/field_in_condition_spec.rb +48 -0
  315. data/spec/models/field_override_spec.rb +408 -0
  316. data/spec/models/field_presence_condition_spec.rb +42 -0
  317. data/spec/models/field_presence_operator_spec.rb +30 -0
  318. data/spec/models/field_range_condition_spec.rb +54 -0
  319. data/spec/models/field_reimport_state_spec.rb +30 -0
  320. data/spec/models/field_setup_logic_spec.rb +30 -0
  321. data/spec/models/field_setup_naming_spec.rb +30 -0
  322. data/spec/models/field_setup_source_spec.rb +30 -0
  323. data/spec/models/folder_list_spec.rb +42 -0
  324. data/spec/models/folder_spec.rb +16 -4
  325. data/spec/models/generated_file_spec.rb +78 -0
  326. data/spec/models/generated_file_state_spec.rb +30 -0
  327. data/spec/models/html_engine_options_input_spec.rb +90 -0
  328. data/spec/models/html_engine_options_spec.rb +90 -0
  329. data/spec/models/image_gravity_spec.rb +30 -0
  330. data/spec/models/image_scale_type_spec.rb +30 -0
  331. data/spec/models/model_code_language_spec.rb +30 -0
  332. data/spec/models/move_folder_request_spec.rb +36 -0
  333. data/spec/models/move_template_request_spec.rb +36 -0
  334. data/spec/models/number_condition_type_spec.rb +30 -0
  335. data/spec/models/page_format_spec.rb +30 -0
  336. data/spec/models/{publish_version_data_spec.rb → publish_template_version_request_spec.rb} +11 -11
  337. data/spec/models/{rename_folder_data_spec.rb → rename_folder_request_spec.rb} +9 -9
  338. data/spec/models/restore_template_version_request_spec.rb +36 -0
  339. data/spec/models/shape_type_spec.rb +30 -0
  340. data/spec/models/signature_request_auth_second_factor_type_spec.rb +30 -0
  341. data/spec/models/signature_request_auth_type_spec.rb +30 -0
  342. data/spec/models/{submission_data_request_event_spec.rb → signature_request_event_spec.rb} +16 -18
  343. data/spec/models/signature_request_event_type_spec.rb +30 -0
  344. data/spec/models/{create_submission_data_request_data_spec.rb → signature_request_input_spec.rb} +28 -30
  345. data/spec/models/signature_request_message_type_spec.rb +30 -0
  346. data/spec/models/{submission_data_request_show_spec.rb → signature_request_spec.rb} +31 -31
  347. data/spec/models/signature_request_state_spec.rb +30 -0
  348. data/spec/models/signature_request_token_spec.rb +72 -0
  349. data/spec/models/signature_request_token_type_spec.rb +30 -0
  350. data/spec/models/string_condition_type_spec.rb +30 -0
  351. data/spec/models/submission_action_spec.rb +4 -22
  352. data/spec/models/submission_action_state_spec.rb +30 -0
  353. data/spec/models/submission_action_type_spec.rb +30 -0
  354. data/spec/models/submission_batch_spec.rb +27 -13
  355. data/spec/models/submission_batch_state_spec.rb +30 -0
  356. data/spec/models/submission_files_spec.rb +48 -0
  357. data/spec/models/submission_input_spec.rb +96 -0
  358. data/spec/models/submission_list_spec.rb +42 -0
  359. data/spec/models/submission_source_pdf_spec.rb +42 -0
  360. data/spec/models/submission_source_spec.rb +30 -0
  361. data/spec/models/submission_spec.rb +26 -56
  362. data/spec/models/submission_state_spec.rb +30 -0
  363. data/spec/models/template_actor_spec.rb +60 -0
  364. data/spec/models/template_actor_type_spec.rb +30 -0
  365. data/spec/models/{submission_data_request_spec.rb → template_defaults_input_spec.rb} +29 -53
  366. data/spec/models/template_defaults_spec.rb +150 -0
  367. data/spec/models/{json_schema_spec.rb → template_document_spec.rb} +21 -21
  368. data/spec/models/template_document_state_spec.rb +30 -0
  369. data/spec/models/template_field_dependency_action_spec.rb +30 -0
  370. data/spec/models/template_field_dependency_condition_input_spec.rb +44 -0
  371. data/spec/models/template_field_dependency_condition_spec.rb +54 -0
  372. data/spec/models/template_field_dependency_input_spec.rb +60 -0
  373. data/spec/models/template_field_dependency_match_spec.rb +30 -0
  374. data/spec/models/template_field_dependency_operator_spec.rb +30 -0
  375. data/spec/models/template_field_dependency_spec.rb +60 -0
  376. data/spec/models/template_field_logic_status_spec.rb +30 -0
  377. data/spec/models/template_form_mode_spec.rb +30 -0
  378. data/spec/models/{template_model_code_response_spec.rb → template_model_code_spec.rb} +9 -13
  379. data/spec/models/template_page_ai_error_spec.rb +30 -0
  380. data/spec/models/template_page_ai_naming_status_spec.rb +30 -0
  381. data/spec/models/template_page_fields_status_spec.rb +30 -0
  382. data/spec/models/template_page_image_status_spec.rb +30 -0
  383. data/spec/models/template_page_processing_status_spec.rb +60 -0
  384. data/spec/models/template_source_pdf_spec.rb +54 -0
  385. data/spec/models/template_spec.rb +40 -154
  386. data/spec/models/template_summary_list_spec.rb +42 -0
  387. data/spec/models/template_summary_spec.rb +252 -0
  388. data/spec/models/template_type_spec.rb +30 -0
  389. data/spec/models/template_version_spec.rb +54 -0
  390. data/spec/models/template_version_type_spec.rb +30 -0
  391. data/spec/models/text_alignment_spec.rb +30 -0
  392. data/spec/models/text_overflow_spec.rb +30 -0
  393. data/spec/models/text_vertical_alignment_spec.rb +30 -0
  394. data/spec/models/typeface_spec.rb +30 -0
  395. data/spec/models/{submission_batch_with_submissions_spec.rb → update_signature_request_request_spec.rb} +18 -22
  396. data/spec/models/update_template_document_request_spec.rb +48 -0
  397. data/spec/models/{submission_preview_spec.rb → update_template_request_spec.rb} +81 -41
  398. data/spec/models/update_webhook_request_spec.rb +96 -0
  399. data/spec/models/upload_method_spec.rb +30 -0
  400. data/spec/models/{upload_presign_response_spec.rb → upload_presign_spec.rb} +13 -17
  401. data/spec/models/url_source_pdf_spec.rb +42 -0
  402. data/spec/models/webhook_event_type_spec.rb +30 -0
  403. data/spec/models/webhook_list_spec.rb +42 -0
  404. data/spec/models/webhook_mode_spec.rb +30 -0
  405. data/spec/models/webhook_spec.rb +4 -8
  406. data/spec/spec_helper.rb +3 -3
  407. metadata +485 -202
  408. data/docs/AddFieldsData.md +0 -18
  409. data/docs/BatchGeneratePdfs201Response.md +0 -28
  410. data/docs/CombinePdfsData.md +0 -28
  411. data/docs/CombinedSubmission.md +0 -44
  412. data/docs/CombinedSubmissionAction.md +0 -30
  413. data/docs/CopyTemplateOptions.md +0 -22
  414. data/docs/CreateCombinedSubmissionResponse.md +0 -26
  415. data/docs/CreateCustomFileData.md +0 -18
  416. data/docs/CreateCustomFileResponse.md +0 -24
  417. data/docs/CreateHtmlTemplate.md +0 -18
  418. data/docs/CreatePdfSubmissionData.md +0 -34
  419. data/docs/CreatePdfTemplate.md +0 -18
  420. data/docs/CreateSubmissionDataRequestData.md +0 -44
  421. data/docs/CreateSubmissionDataRequestEventRequest.md +0 -24
  422. data/docs/CreateSubmissionDataRequestEventResponse.md +0 -24
  423. data/docs/CreateSubmissionDataRequestResponse.md +0 -24
  424. data/docs/CreateSubmissionDataRequestTokenResponse.md +0 -24
  425. data/docs/CreateSubmissionResponse.md +0 -26
  426. data/docs/ErrorOrMultipleErrorsResponse.md +0 -22
  427. data/docs/ForbiddenErrorResponse.md +0 -22
  428. data/docs/JsonSchema.md +0 -40
  429. data/docs/ListSubmissionsResponse.md +0 -22
  430. data/docs/MoveFolderData.md +0 -18
  431. data/docs/MoveTemplateData.md +0 -20
  432. data/docs/MultipleErrorsResponse.md +0 -20
  433. data/docs/PublishVersionData.md +0 -20
  434. data/docs/RestoreVersionData.md +0 -18
  435. data/docs/Submission422Response.md +0 -24
  436. data/docs/SubmissionBatchData.md +0 -26
  437. data/docs/SubmissionBatchWithSubmissions.md +0 -34
  438. data/docs/SubmissionDataRequest.md +0 -60
  439. data/docs/SubmissionDataRequestEvent.md +0 -30
  440. data/docs/SubmissionDataRequestShow.md +0 -62
  441. data/docs/SubmissionDataRequestToken.md +0 -24
  442. data/docs/SubmissionPreview.md +0 -64
  443. data/docs/SuccessErrorResponse.md +0 -20
  444. data/docs/SuccessMultipleErrorsResponse.md +0 -20
  445. data/docs/TemplateAddFieldsResponse.md +0 -22
  446. data/docs/TemplateDeleteResponse.md +0 -24
  447. data/docs/TemplateModelCodeResponse.md +0 -22
  448. data/docs/TemplatePreview.md +0 -116
  449. data/docs/TemplatePublishVersionResponse.md +0 -22
  450. data/docs/UpdateHtmlTemplate.md +0 -18
  451. data/docs/UpdatePdfTemplate.md +0 -18
  452. data/docs/UpdateSubmissionDataRequestData.md +0 -42
  453. data/docs/UploadPresignResponse.md +0 -24
  454. data/lib/docspring/models/batch_generate_pdfs201_response.rb +0 -352
  455. data/lib/docspring/models/combined_submission_action.rb +0 -384
  456. data/lib/docspring/models/create_combined_submission_response.rb +0 -324
  457. data/lib/docspring/models/create_custom_file_response.rb +0 -314
  458. data/lib/docspring/models/create_html_template.rb +0 -243
  459. data/lib/docspring/models/create_submission_data_request_event_response.rb +0 -314
  460. data/lib/docspring/models/create_submission_data_request_response.rb +0 -314
  461. data/lib/docspring/models/create_submission_data_request_token_response.rb +0 -314
  462. data/lib/docspring/models/create_submission_response.rb +0 -324
  463. data/lib/docspring/models/error_or_multiple_errors_response.rb +0 -290
  464. data/lib/docspring/models/forbidden_error_response.rb +0 -323
  465. data/lib/docspring/models/json_schema.rb +0 -329
  466. data/lib/docspring/models/list_submissions_response.rb +0 -283
  467. data/lib/docspring/models/multiple_errors_response.rb +0 -296
  468. data/lib/docspring/models/submission422_response.rb +0 -299
  469. data/lib/docspring/models/submission_batch_with_submissions.rb +0 -433
  470. data/lib/docspring/models/submission_data_request.rb +0 -570
  471. data/lib/docspring/models/submission_data_request_token.rb +0 -279
  472. data/lib/docspring/models/submission_preview.rb +0 -637
  473. data/lib/docspring/models/success_multiple_errors_response.rb +0 -279
  474. data/lib/docspring/models/template_add_fields_response.rb +0 -290
  475. data/lib/docspring/models/template_delete_response.rb +0 -300
  476. data/lib/docspring/models/template_publish_version_response.rb +0 -305
  477. data/lib/docspring/models/update_html_template.rb +0 -243
  478. data/lib/docspring/models/update_pdf_template.rb +0 -243
  479. data/spec/models/add_fields_data_spec.rb +0 -36
  480. data/spec/models/combined_submission_action_spec.rb +0 -84
  481. data/spec/models/create_combined_submission_response_spec.rb +0 -64
  482. data/spec/models/create_custom_file_response_spec.rb +0 -58
  483. data/spec/models/create_folder_data_spec.rb +0 -36
  484. data/spec/models/create_html_template_spec.rb +0 -36
  485. data/spec/models/create_pdf_template_spec.rb +0 -36
  486. data/spec/models/create_submission_data_request_event_request_spec.rb +0 -62
  487. data/spec/models/create_submission_data_request_event_response_spec.rb +0 -58
  488. data/spec/models/create_submission_data_request_response_spec.rb +0 -58
  489. data/spec/models/create_submission_data_request_token_response_spec.rb +0 -58
  490. data/spec/models/create_webhook_data_spec.rb +0 -36
  491. data/spec/models/error_or_multiple_errors_response_spec.rb +0 -52
  492. data/spec/models/forbidden_error_response_spec.rb +0 -56
  493. data/spec/models/move_folder_data_spec.rb +0 -36
  494. data/spec/models/multiple_errors_response_spec.rb +0 -46
  495. data/spec/models/restore_version_data_spec.rb +0 -36
  496. data/spec/models/submission422_response_spec.rb +0 -58
  497. data/spec/models/success_error_response_spec.rb +0 -46
  498. data/spec/models/success_multiple_errors_response_spec.rb +0 -46
  499. data/spec/models/template_add_fields_response_spec.rb +0 -52
  500. data/spec/models/template_delete_response_spec.rb +0 -58
  501. data/spec/models/template_publish_version_response_spec.rb +0 -52
  502. data/spec/models/update_html_template_spec.rb +0 -36
  503. data/spec/models/update_pdf_template_spec.rb +0 -36
  504. data/spec/models/update_submission_data_request_data_spec.rb +0 -116
  505. data/spec/models/update_webhook_data_spec.rb +0 -36
data/docs/AddFieldsData.md DELETED
@@ -1,18 +0,0 @@
1
- # DocSpring::AddFieldsData
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **fields** | **Array<Object>** | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::AddFieldsData.new(
15
- fields: null
16
- )
17
- ```
18
-
data/docs/BatchGeneratePdfs201Response.md DELETED
@@ -1,28 +0,0 @@
1
- # DocSpring::BatchGeneratePdfs201Response
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **status** | **String** | | |
8
- | **error** | **String** | | [optional] |
9
- | **errors** | **Array<String>** | | [optional] |
10
- | **submission_batch** | [**SubmissionBatch**](SubmissionBatch.md) | | |
11
- | **submissions** | **Array<Object>** | | |
12
- | **code** | **String** | `insufficient_credits` when the response is a 402. | [optional] |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'docspring'
18
-
19
- instance = DocSpring::BatchGeneratePdfs201Response.new(
20
- status: null,
21
- error: null,
22
- errors: null,
23
- submission_batch: null,
24
- submissions: null,
25
- code: null
26
- )
27
- ```
28
-
data/docs/CombinePdfsData.md DELETED
@@ -1,28 +0,0 @@
1
- # DocSpring::CombinePdfsData
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **delete_custom_files** | **Boolean** | Delete the custom files in source_pdfs once the combined PDF has been processed (they're kept if it fails). Other combined submissions can't use them after that. A test API token can't delete custom files. | [optional] |
8
- | **expires_in** | **Integer** | | [optional] |
9
- | **metadata** | **Object** | | [optional] |
10
- | **password** | **String** | | [optional] |
11
- | **source_pdfs** | **Array<Object>** | | |
12
- | **test** | **Boolean** | Deprecated, and has no effect. Combining always uses credits, even with a test API token or watermarked source PDFs. | [optional] |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'docspring'
18
-
19
- instance = DocSpring::CombinePdfsData.new(
20
- delete_custom_files: null,
21
- expires_in: null,
22
- metadata: null,
23
- password: null,
24
- source_pdfs: null,
25
- test: null
26
- )
27
- ```
28
-
data/docs/CombinedSubmission.md DELETED
@@ -1,44 +0,0 @@
1
- # DocSpring::CombinedSubmission
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | |
8
- | **state** | **String** | | |
9
- | **expired** | **Boolean** | | |
10
- | **expires_in** | **Integer** | | |
11
- | **expires_at** | **String** | | |
12
- | **processed_at** | **String** | | |
13
- | **error_message** | **String** | | |
14
- | **submission_ids** | **Array<String>** | | |
15
- | **source_pdfs** | **Array<Object>** | | |
16
- | **metadata** | **Object** | | |
17
- | **password** | **String** | | |
18
- | **pdf_hash** | **String** | | |
19
- | **download_url** | **String** | | |
20
- | **actions** | [**Array<CombinedSubmissionAction>**](CombinedSubmissionAction.md) | | |
21
-
22
- ## Example
23
-
24
- ```ruby
25
- require 'docspring'
26
-
27
- instance = DocSpring::CombinedSubmission.new(
28
- id: null,
29
- state: null,
30
- expired: null,
31
- expires_in: null,
32
- expires_at: null,
33
- processed_at: null,
34
- error_message: null,
35
- submission_ids: null,
36
- source_pdfs: null,
37
- metadata: null,
38
- password: null,
39
- pdf_hash: null,
40
- download_url: null,
41
- actions: null
42
- )
43
- ```
44
-
data/docs/CombinedSubmissionAction.md DELETED
@@ -1,30 +0,0 @@
1
- # DocSpring::CombinedSubmissionAction
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | |
8
- | **integration_id** | **String** | | |
9
- | **state** | **String** | | |
10
- | **action_type** | **String** | | |
11
- | **action_category** | **String** | | |
12
- | **result_data** | **Object** | | |
13
- | **error_message** | **String** | | |
14
-
15
- ## Example
16
-
17
- ```ruby
18
- require 'docspring'
19
-
20
- instance = DocSpring::CombinedSubmissionAction.new(
21
- id: null,
22
- integration_id: null,
23
- state: null,
24
- action_type: null,
25
- action_category: null,
26
- result_data: null,
27
- error_message: null
28
- )
29
- ```
30
-
data/docs/CopyTemplateOptions.md DELETED
@@ -1,22 +0,0 @@
1
- # DocSpring::CopyTemplateOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **parent_folder_id** | **String** | | [optional] |
9
- | **version** | **String** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'docspring'
15
-
16
- instance = DocSpring::CopyTemplateOptions.new(
17
- name: null,
18
- parent_folder_id: null,
19
- version: null
20
- )
21
- ```
22
-
data/docs/CreateCombinedSubmissionResponse.md DELETED
@@ -1,26 +0,0 @@
1
- # DocSpring::CreateCombinedSubmissionResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **status** | **String** | | |
8
- | **combined_submission** | [**CombinedSubmission**](CombinedSubmission.md) | | |
9
- | **error** | **String** | | [optional] |
10
- | **errors** | **Array<String>** | | [optional] |
11
- | **code** | **String** | `insufficient_credits` when the response is a 402. | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'docspring'
17
-
18
- instance = DocSpring::CreateCombinedSubmissionResponse.new(
19
- status: null,
20
- combined_submission: null,
21
- error: null,
22
- errors: null,
23
- code: null
24
- )
25
- ```
26
-
data/docs/CreateCustomFileData.md DELETED
@@ -1,18 +0,0 @@
1
- # DocSpring::CreateCustomFileData
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **cache_id** | **String** | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::CreateCustomFileData.new(
15
- cache_id: null
16
- )
17
- ```
18
-
data/docs/CreateCustomFileResponse.md DELETED
@@ -1,24 +0,0 @@
1
- # DocSpring::CreateCustomFileResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **status** | **String** | | |
8
- | **custom_file** | [**CustomFile**](CustomFile.md) | | |
9
- | **error** | **String** | | [optional] |
10
- | **errors** | **Array<String>** | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'docspring'
16
-
17
- instance = DocSpring::CreateCustomFileResponse.new(
18
- status: null,
19
- custom_file: null,
20
- error: null,
21
- errors: null
22
- )
23
- ```
24
-
data/docs/CreateHtmlTemplate.md DELETED
@@ -1,18 +0,0 @@
1
- # DocSpring::CreateHtmlTemplate
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **template** | **Object** | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::CreateHtmlTemplate.new(
15
- template: null
16
- )
17
- ```
18
-
data/docs/CreatePdfSubmissionData.md DELETED
@@ -1,34 +0,0 @@
1
- # DocSpring::CreatePdfSubmissionData
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **data** | **Object** | | |
8
- | **data_requests** | [**Array<CreateSubmissionDataRequestData>**](CreateSubmissionDataRequestData.md) | | [optional] |
9
- | **editable** | **Boolean** | | [optional] |
10
- | **expires_in** | **Integer** | | [optional] |
11
- | **field_overrides** | **Object** | | [optional] |
12
- | **metadata** | **Object** | | [optional] |
13
- | **password** | **String** | | [optional] |
14
- | **test** | **Boolean** | Generate a watermarked test PDF. Test PDFs are free; live PDFs (the default) use credits. | [optional] |
15
- | **version** | **String** | | [optional] |
16
-
17
- ## Example
18
-
19
- ```ruby
20
- require 'docspring'
21
-
22
- instance = DocSpring::CreatePdfSubmissionData.new(
23
- data: null,
24
- data_requests: null,
25
- editable: null,
26
- expires_in: null,
27
- field_overrides: null,
28
- metadata: null,
29
- password: null,
30
- test: null,
31
- version: null
32
- )
33
- ```
34
-
data/docs/CreatePdfTemplate.md DELETED
@@ -1,18 +0,0 @@
1
- # DocSpring::CreatePdfTemplate
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **template** | **Object** | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::CreatePdfTemplate.new(
15
- template: null
16
- )
17
- ```
18
-
data/docs/CreateSubmissionDataRequestData.md DELETED
@@ -1,44 +0,0 @@
1
- # DocSpring::CreateSubmissionDataRequestData
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **auth_phone_number_hash** | **String** | | [optional] |
8
- | **auth_provider** | **String** | | [optional] |
9
- | **auth_second_factor_type** | **String** | | [optional] |
10
- | **auth_session_id_hash** | **String** | | [optional] |
11
- | **auth_session_started_at** | **String** | | [optional] |
12
- | **auth_type** | **String** | | [optional] |
13
- | **auth_user_id_hash** | **String** | | [optional] |
14
- | **auth_username_hash** | **String** | | [optional] |
15
- | **email** | **String** | | [optional] |
16
- | **fields** | **Array<String>** | | [optional] |
17
- | **metadata** | **Object** | | [optional] |
18
- | **name** | **String** | | [optional] |
19
- | **order** | **Integer** | | [optional] |
20
- | **skipped** | **Boolean** | | [optional] |
21
-
22
- ## Example
23
-
24
- ```ruby
25
- require 'docspring'
26
-
27
- instance = DocSpring::CreateSubmissionDataRequestData.new(
28
- auth_phone_number_hash: null,
29
- auth_provider: null,
30
- auth_second_factor_type: null,
31
- auth_session_id_hash: null,
32
- auth_session_started_at: null,
33
- auth_type: null,
34
- auth_user_id_hash: null,
35
- auth_username_hash: null,
36
- email: null,
37
- fields: null,
38
- metadata: null,
39
- name: null,
40
- order: null,
41
- skipped: null
42
- )
43
- ```
44
-
data/docs/CreateSubmissionDataRequestEventRequest.md DELETED
@@ -1,24 +0,0 @@
1
- # DocSpring::CreateSubmissionDataRequestEventRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **event_type** | **String** | | |
8
- | **message_recipient** | **String** | | [optional] |
9
- | **message_type** | **String** | | [optional] |
10
- | **occurred_at** | **String** | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'docspring'
16
-
17
- instance = DocSpring::CreateSubmissionDataRequestEventRequest.new(
18
- event_type: null,
19
- message_recipient: null,
20
- message_type: null,
21
- occurred_at: null
22
- )
23
- ```
24
-
data/docs/CreateSubmissionDataRequestEventResponse.md DELETED
@@ -1,24 +0,0 @@
1
- # DocSpring::CreateSubmissionDataRequestEventResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **status** | **String** | | |
8
- | **event** | [**SubmissionDataRequestEvent**](SubmissionDataRequestEvent.md) | | |
9
- | **error** | **String** | | [optional] |
10
- | **errors** | **Array<String>** | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'docspring'
16
-
17
- instance = DocSpring::CreateSubmissionDataRequestEventResponse.new(
18
- status: null,
19
- event: null,
20
- error: null,
21
- errors: null
22
- )
23
- ```
24
-
data/docs/CreateSubmissionDataRequestResponse.md DELETED
@@ -1,24 +0,0 @@
1
- # DocSpring::CreateSubmissionDataRequestResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **status** | **String** | | |
8
- | **data_request** | [**SubmissionDataRequestShow**](SubmissionDataRequestShow.md) | | |
9
- | **error** | **String** | | [optional] |
10
- | **errors** | **Array<String>** | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'docspring'
16
-
17
- instance = DocSpring::CreateSubmissionDataRequestResponse.new(
18
- status: null,
19
- data_request: null,
20
- error: null,
21
- errors: null
22
- )
23
- ```
24
-
data/docs/CreateSubmissionDataRequestTokenResponse.md DELETED
@@ -1,24 +0,0 @@
1
- # DocSpring::CreateSubmissionDataRequestTokenResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **status** | **String** | | |
8
- | **token** | [**SubmissionDataRequestToken**](SubmissionDataRequestToken.md) | | |
9
- | **error** | **String** | | [optional] |
10
- | **errors** | **Array<String>** | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'docspring'
16
-
17
- instance = DocSpring::CreateSubmissionDataRequestTokenResponse.new(
18
- status: null,
19
- token: null,
20
- error: null,
21
- errors: null
22
- )
23
- ```
24
-
data/docs/CreateSubmissionResponse.md DELETED
@@ -1,26 +0,0 @@
1
- # DocSpring::CreateSubmissionResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **status** | **String** | | |
8
- | **submission** | [**SubmissionPreview**](SubmissionPreview.md) | | |
9
- | **error** | **String** | | [optional] |
10
- | **errors** | **Array<String>** | | [optional] |
11
- | **code** | **String** | `insufficient_credits` when the response is a 402. | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'docspring'
17
-
18
- instance = DocSpring::CreateSubmissionResponse.new(
19
- status: null,
20
- submission: null,
21
- error: null,
22
- errors: null,
23
- code: null
24
- )
25
- ```
26
-
data/docs/ErrorOrMultipleErrorsResponse.md DELETED
@@ -1,22 +0,0 @@
1
- # DocSpring::ErrorOrMultipleErrorsResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **status** | **String** | | |
8
- | **error** | **String** | Single error message (when only one error occurred) | [optional] |
9
- | **errors** | **Array<String>** | Array of error messages (when multiple validation errors occurred) | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'docspring'
15
-
16
- instance = DocSpring::ErrorOrMultipleErrorsResponse.new(
17
- status: null,
18
- error: null,
19
- errors: null
20
- )
21
- ```
22
-
data/docs/ForbiddenErrorResponse.md DELETED
@@ -1,22 +0,0 @@
1
- # DocSpring::ForbiddenErrorResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **status** | **String** | | |
8
- | **error** | **String** | | |
9
- | **code** | **String** | | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'docspring'
15
-
16
- instance = DocSpring::ForbiddenErrorResponse.new(
17
- status: null,
18
- error: null,
19
- code: null
20
- )
21
- ```
22
-
data/docs/JsonSchema.md DELETED
@@ -1,40 +0,0 @@
1
- # DocSpring::JsonSchema
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **schema** | **String** | | [optional] |
8
- | **id** | **String** | | [optional] |
9
- | **schema_id** | **String** | | [optional] |
10
- | **title** | **String** | | [optional] |
11
- | **description** | **String** | | [optional] |
12
- | **definitions** | **Object** | | [optional] |
13
- | **type** | **String** | | [optional] |
14
- | **properties** | **Object** | | [optional] |
15
- | **additional_properties** | **Boolean** | | [optional] |
16
- | **required** | **Array<String>** | | [optional] |
17
- | **dependencies** | **Object** | | [optional] |
18
- | **all_of** | **Array<Object>** | | [optional] |
19
-
20
- ## Example
21
-
22
- ```ruby
23
- require 'docspring'
24
-
25
- instance = DocSpring::JsonSchema.new(
26
- schema: null,
27
- id: null,
28
- schema_id: null,
29
- title: null,
30
- description: null,
31
- definitions: null,
32
- type: null,
33
- properties: null,
34
- additional_properties: null,
35
- required: null,
36
- dependencies: null,
37
- all_of: null
38
- )
39
- ```
40
-
data/docs/ListSubmissionsResponse.md DELETED
@@ -1,22 +0,0 @@
1
- # DocSpring::ListSubmissionsResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **submissions** | [**Array<Submission>**](Submission.md) | | |
8
- | **limit** | **Integer** | | |
9
- | **next_cursor** | **String** | | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'docspring'
15
-
16
- instance = DocSpring::ListSubmissionsResponse.new(
17
- submissions: null,
18
- limit: null,
19
- next_cursor: null
20
- )
21
- ```
22
-
data/docs/MoveFolderData.md DELETED
@@ -1,18 +0,0 @@
1
- # DocSpring::MoveFolderData
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **parent_folder_id** | **String** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'docspring'
13
-
14
- instance = DocSpring::MoveFolderData.new(
15
- parent_folder_id: null
16
- )
17
- ```
18
-
data/docs/MoveTemplateData.md DELETED
@@ -1,20 +0,0 @@
1
- # DocSpring::MoveTemplateData
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **parent_folder_id** | **String** | | |
8
- | **version** | **String** | | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'docspring'
14
-
15
- instance = DocSpring::MoveTemplateData.new(
16
- parent_folder_id: null,
17
- version: null
18
- )
19
- ```
20
-
data/docs/MultipleErrorsResponse.md DELETED
@@ -1,20 +0,0 @@
1
- # DocSpring::MultipleErrorsResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **status** | **String** | | |
8
- | **errors** | **Array<String>** | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'docspring'
14
-
15
- instance = DocSpring::MultipleErrorsResponse.new(
16
- status: null,
17
- errors: null
18
- )
19
- ```
20
-
data/docs/PublishVersionData.md DELETED
@@ -1,20 +0,0 @@
1
- # DocSpring::PublishVersionData
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **description** | **String** | | [optional] |
8
- | **version_type** | **String** | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'docspring'
14
-
15
- instance = DocSpring::PublishVersionData.new(
16
- description: null,
17
- version_type: null
18
- )
19
- ```
20
-