docspring-ts 4.0.0 → 4.1.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 (137) hide show
  1. package/README.md +10 -1
  2. package/dist/RequestSchemas.js +3364 -1584
  3. package/dist/RequestSchemas.js.map +1 -1
  4. package/dist/apis/Client.d.ts +28 -0
  5. package/dist/apis/Client.js +1015 -55
  6. package/dist/apis/Client.js.map +1 -1
  7. package/dist/http/isomorphic-fetch.js +1 -1
  8. package/dist/models/AddTemplateFieldsRequest.d.ts +21 -0
  9. package/dist/models/AddTemplateFieldsRequest.js +23 -0
  10. package/dist/models/AddTemplateFieldsRequest.js.map +1 -0
  11. package/dist/models/CreateSubmissionBatchRequest.d.ts +2 -0
  12. package/dist/models/CreateSubmissionBatchRequest.js +6 -0
  13. package/dist/models/CreateSubmissionBatchRequest.js.map +1 -1
  14. package/dist/models/CreateSubmissionRequest.d.ts +2 -0
  15. package/dist/models/CreateSubmissionRequest.js +6 -0
  16. package/dist/models/CreateSubmissionRequest.js.map +1 -1
  17. package/dist/models/CreateTemplateRequest.d.ts +7 -0
  18. package/dist/models/CreateTemplateRequest.js +24 -0
  19. package/dist/models/CreateTemplateRequest.js.map +1 -1
  20. package/dist/models/Field.d.ts +125 -0
  21. package/dist/models/Field.js +563 -0
  22. package/dist/models/Field.js.map +1 -0
  23. package/dist/models/FieldDependency.d.ts +25 -0
  24. package/dist/models/FieldDependency.js +35 -0
  25. package/dist/models/FieldDependency.js.map +1 -0
  26. package/dist/models/FieldDependencyInput.d.ts +25 -0
  27. package/dist/models/FieldDependencyInput.js +35 -0
  28. package/dist/models/FieldDependencyInput.js.map +1 -0
  29. package/dist/models/FieldGroup.d.ts +28 -0
  30. package/dist/models/FieldGroup.js +65 -0
  31. package/dist/models/FieldGroup.js.map +1 -0
  32. package/dist/models/FieldGroupInput.d.ts +26 -0
  33. package/dist/models/FieldGroupInput.js +59 -0
  34. package/dist/models/FieldGroupInput.js.map +1 -0
  35. package/dist/models/FieldGroupType.d.ts +5 -0
  36. package/dist/models/FieldGroupType.js +8 -0
  37. package/dist/models/FieldGroupType.js.map +1 -0
  38. package/dist/models/FieldInput.d.ts +124 -0
  39. package/dist/models/FieldInput.js +557 -0
  40. package/dist/models/FieldInput.js.map +1 -0
  41. package/dist/models/FieldType.d.ts +18 -0
  42. package/dist/models/FieldType.js +21 -0
  43. package/dist/models/FieldType.js.map +1 -0
  44. package/dist/models/GenerateFilesFormat.d.ts +4 -0
  45. package/dist/models/GenerateFilesFormat.js +7 -0
  46. package/dist/models/GenerateFilesFormat.js.map +1 -0
  47. package/dist/models/GenerateSubmissionFilesRequest.d.ts +21 -0
  48. package/dist/models/GenerateSubmissionFilesRequest.js +23 -0
  49. package/dist/models/GenerateSubmissionFilesRequest.js.map +1 -0
  50. package/dist/models/ObjectSerializer.d.ts +28 -0
  51. package/dist/models/ObjectSerializer.js +80 -0
  52. package/dist/models/ObjectSerializer.js.map +1 -1
  53. package/dist/models/OutputFormat.d.ts +5 -0
  54. package/dist/models/OutputFormat.js +8 -0
  55. package/dist/models/OutputFormat.js.map +1 -0
  56. package/dist/models/PageImage.d.ts +28 -0
  57. package/dist/models/PageImage.js +71 -0
  58. package/dist/models/PageImage.js.map +1 -0
  59. package/dist/models/PageImages.d.ts +25 -0
  60. package/dist/models/PageImages.js +41 -0
  61. package/dist/models/PageImages.js.map +1 -0
  62. package/dist/models/PredefinedField.d.ts +27 -0
  63. package/dist/models/PredefinedField.js +59 -0
  64. package/dist/models/PredefinedField.js.map +1 -0
  65. package/dist/models/PredefinedFieldInput.d.ts +27 -0
  66. package/dist/models/PredefinedFieldInput.js +59 -0
  67. package/dist/models/PredefinedFieldInput.js.map +1 -0
  68. package/dist/models/RemoveTemplateFieldsRequest.d.ts +20 -0
  69. package/dist/models/RemoveTemplateFieldsRequest.js +23 -0
  70. package/dist/models/RemoveTemplateFieldsRequest.js.map +1 -0
  71. package/dist/models/ReorderTemplateFieldsRequest.d.ts +20 -0
  72. package/dist/models/ReorderTemplateFieldsRequest.js +23 -0
  73. package/dist/models/ReorderTemplateFieldsRequest.js.map +1 -0
  74. package/dist/models/Submission.d.ts +2 -0
  75. package/dist/models/Submission.js +6 -0
  76. package/dist/models/Submission.js.map +1 -1
  77. package/dist/models/SubmissionFiles.d.ts +2 -0
  78. package/dist/models/SubmissionFiles.js +6 -0
  79. package/dist/models/SubmissionFiles.js.map +1 -1
  80. package/dist/models/SubmissionInput.d.ts +2 -0
  81. package/dist/models/SubmissionInput.js +6 -0
  82. package/dist/models/SubmissionInput.js.map +1 -1
  83. package/dist/models/SubmissionValidation.d.ts +24 -0
  84. package/dist/models/SubmissionValidation.js +41 -0
  85. package/dist/models/SubmissionValidation.js.map +1 -0
  86. package/dist/models/Template.d.ts +7 -0
  87. package/dist/models/Template.js +18 -0
  88. package/dist/models/Template.js.map +1 -1
  89. package/dist/models/TemplateDiff.d.ts +28 -0
  90. package/dist/models/TemplateDiff.js +59 -0
  91. package/dist/models/TemplateDiff.js.map +1 -0
  92. package/dist/models/TemplateDiffSummary.d.ts +25 -0
  93. package/dist/models/TemplateDiffSummary.js +53 -0
  94. package/dist/models/TemplateDiffSummary.js.map +1 -0
  95. package/dist/models/TemplateDocumentState.d.ts +2 -0
  96. package/dist/models/TemplateDocumentState.js +3 -1
  97. package/dist/models/TemplateDocumentState.js.map +1 -1
  98. package/dist/models/TemplateFieldChange.d.ts +24 -0
  99. package/dist/models/TemplateFieldChange.js +41 -0
  100. package/dist/models/TemplateFieldChange.js.map +1 -0
  101. package/dist/models/TemplateFieldChanges.d.ts +26 -0
  102. package/dist/models/TemplateFieldChanges.js +41 -0
  103. package/dist/models/TemplateFieldChanges.js.map +1 -0
  104. package/dist/models/TemplateFieldMove.d.ts +22 -0
  105. package/dist/models/TemplateFieldMove.js +35 -0
  106. package/dist/models/TemplateFieldMove.js.map +1 -0
  107. package/dist/models/TemplateFields.d.ts +23 -0
  108. package/dist/models/TemplateFields.js +35 -0
  109. package/dist/models/TemplateFields.js.map +1 -0
  110. package/dist/models/TemplatePageImages.d.ts +24 -0
  111. package/dist/models/TemplatePageImages.js +41 -0
  112. package/dist/models/TemplatePageImages.js.map +1 -0
  113. package/dist/models/UpdateTemplateDocumentRequest.d.ts +3 -1
  114. package/dist/models/UpdateTemplateDocumentRequest.js +12 -0
  115. package/dist/models/UpdateTemplateDocumentRequest.js.map +1 -1
  116. package/dist/models/UpdateTemplateFieldsRequest.d.ts +21 -0
  117. package/dist/models/UpdateTemplateFieldsRequest.js +23 -0
  118. package/dist/models/UpdateTemplateFieldsRequest.js.map +1 -0
  119. package/dist/models/UpdateTemplateRequest.d.ts +7 -0
  120. package/dist/models/UpdateTemplateRequest.js +18 -0
  121. package/dist/models/UpdateTemplateRequest.js.map +1 -1
  122. package/dist/models/ValidateSubmissionRequest.d.ts +39 -0
  123. package/dist/models/ValidateSubmissionRequest.js +83 -0
  124. package/dist/models/ValidateSubmissionRequest.js.map +1 -0
  125. package/dist/models/all.d.ts +28 -0
  126. package/dist/models/all.js +28 -0
  127. package/dist/models/all.js.map +1 -1
  128. package/dist/types/ObjectParamAPI.d.ts +66 -0
  129. package/dist/types/ObjectParamAPI.js +54 -0
  130. package/dist/types/ObjectParamAPI.js.map +1 -1
  131. package/dist/types/ObservableAPI.d.ts +28 -0
  132. package/dist/types/ObservableAPI.js +444 -192
  133. package/dist/types/ObservableAPI.js.map +1 -1
  134. package/dist/types/PromiseAPI.d.ts +28 -0
  135. package/dist/types/PromiseAPI.js +90 -0
  136. package/dist/types/PromiseAPI.js.map +1 -1
  137. package/package.json +1 -1
package/README.md CHANGED
@@ -9,7 +9,7 @@ templates with your data, generates PDFs from HTML templates, combines PDFs and
9
9
  The code in this repository is generated from DocSpring's OpenAPI spec ([About this SDK](#about-this-sdk)). Issues and
10
10
  pull requests are welcome.
11
11
 
12
- Version 4.0.0.
12
+ Version 4.1.0.
13
13
 
14
14
  ## Install and configure
15
15
 
@@ -92,6 +92,7 @@ TypeScript code for every method.
92
92
 
93
93
  | Method | Description |
94
94
  | ------ | ----------- |
95
+ | [`addTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#addtemplatefields) | Add fields to a template |
95
96
  | [`copyTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#copytemplate) | Copy a template |
96
97
  | [`createCombinedPdf`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createcombinedpdf) | Combine PDFs |
97
98
  | [`createCustomFileFromUpload`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createcustomfilefromupload) | Create a custom file from an upload |
@@ -108,6 +109,7 @@ TypeScript code for every method.
108
109
  | [`deleteWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletewebhook) | Delete a webhook |
109
110
  | [`expireCombinedPdf`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#expirecombinedpdf) | Expire a combined PDF |
110
111
  | [`expireSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#expiresubmission) | Expire a submission |
112
+ | [`generateSubmissionFiles`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#generatesubmissionfiles) | Generate more files |
111
113
  | [`generateSubmissionPreview`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#generatesubmissionpreview) | Generate a preview PDF |
112
114
  | [`getCombinedPdf`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getcombinedpdf) | Get a combined PDF |
113
115
  | [`getCustomFile`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getcustomfile) | Get a custom file |
@@ -117,28 +119,35 @@ TypeScript code for every method.
117
119
  | [`getSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getsubmission) | Get a submission |
118
120
  | [`getSubmissionBatch`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getsubmissionbatch) | Get a batch |
119
121
  | [`getTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplate) | Get a template |
122
+ | [`getTemplateDiff`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplatediff) | Compare a version of a template with the one before it |
120
123
  | [`getTemplateModelCode`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplatemodelcode) | Generate typed code for a template's submission data |
124
+ | [`getTemplatePageImages`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplatepageimages) | Get images of a template's pages |
121
125
  | [`getTemplateSchema`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplateschema) | Get the JSON Schema of a template's submission data |
122
126
  | [`getWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getwebhook) | Get a webhook |
123
127
  | [`listCombinedPdfs`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listcombinedpdfs) | List combined PDFs |
124
128
  | [`listCustomFiles`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listcustomfiles) | List custom files |
125
129
  | [`listFolders`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listfolders) | List folders |
126
130
  | [`listSubmissions`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listsubmissions) | List submissions |
131
+ | [`listTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listtemplatefields) | List a template's fields |
127
132
  | [`listTemplates`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listtemplates) | List templates |
128
133
  | [`listTemplateSubmissions`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listtemplatesubmissions) | List a template's submissions |
129
134
  | [`listWebhooks`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listwebhooks) | List webhooks |
130
135
  | [`moveFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#movefolder) | Move a folder |
131
136
  | [`moveTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#movetemplate) | Move a template to a folder |
132
137
  | [`publishTemplateVersion`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#publishtemplateversion) | Publish a template version |
138
+ | [`removeTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#removetemplatefields) | Remove fields from a template |
133
139
  | [`renameFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#renamefolder) | Rename a folder |
140
+ | [`reorderTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#reordertemplatefields) | Reorder a template's fields |
134
141
  | [`restoreTemplateVersion`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#restoretemplateversion) | Restore a template version |
135
142
  | [`testAuthentication`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#testauthentication) | Test authentication |
136
143
  | [`updateSignatureRequest`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatesignaturerequest) | Update a signature request |
137
144
  | [`updateTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatetemplate) | Update a template |
138
145
  | [`updateTemplateDocument`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatetemplatedocument) | Replace a template's PDF |
146
+ | [`updateTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatetemplatefields) | Update a template's fields |
139
147
  | [`updateWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatewebhook) | Update a webhook |
140
148
  | [`uploadTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#uploadtemplate) | Create a PDF template from an uploaded PDF |
141
149
  | [`uploadTemplateDocument`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#uploadtemplatedocument) | Replace a template's PDF with an uploaded PDF |
150
+ | [`validateSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#validatesubmission) | Check a submission without creating it |
142
151
 
143
152
  ## Errors
144
153