docspring-ts 1.0.2 → 2.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 (328) hide show
  1. package/README.md +54 -19
  2. package/dist/apis/PDFApi.d.ts +128 -435
  3. package/dist/apis/PDFApi.js +3441 -1712
  4. package/dist/apis/PDFApi.js.map +1 -0
  5. package/dist/apis/baseapi.d.ts +18 -0
  6. package/dist/apis/baseapi.js +46 -0
  7. package/dist/apis/baseapi.js.map +1 -0
  8. package/dist/apis/exception.d.ts +10 -0
  9. package/dist/apis/exception.js +32 -0
  10. package/dist/apis/exception.js.map +1 -0
  11. package/dist/auth/auth.d.ts +36 -0
  12. package/dist/auth/auth.js +31 -0
  13. package/dist/auth/auth.js.map +1 -0
  14. package/dist/configuration.d.ts +18 -0
  15. package/dist/configuration.js +22 -0
  16. package/dist/configuration.js.map +1 -0
  17. package/dist/http/http.d.ts +68 -0
  18. package/dist/http/http.js +261 -0
  19. package/dist/http/http.js.map +1 -0
  20. package/dist/http/isomorphic-fetch.d.ts +6 -0
  21. package/dist/http/isomorphic-fetch.js +45 -0
  22. package/dist/http/isomorphic-fetch.js.map +1 -0
  23. package/dist/index.d.ts +10 -3
  24. package/dist/index.js +13 -5
  25. package/dist/index.js.map +1 -0
  26. package/dist/middleware.d.ts +16 -0
  27. package/dist/middleware.js +18 -0
  28. package/dist/middleware.js.map +1 -0
  29. package/dist/models/AddFieldsData.d.ts +19 -30
  30. package/dist/models/AddFieldsData.js +19 -46
  31. package/dist/models/AddFieldsData.js.map +1 -0
  32. package/dist/models/BatchGeneratePdfs201Response.d.ts +29 -0
  33. package/dist/models/BatchGeneratePdfs201Response.js +52 -0
  34. package/dist/models/BatchGeneratePdfs201Response.js.map +1 -0
  35. package/dist/models/CombinePdfsData.d.ts +24 -60
  36. package/dist/models/CombinePdfsData.js +49 -57
  37. package/dist/models/CombinePdfsData.js.map +1 -0
  38. package/dist/models/CombinedSubmission.d.ts +38 -112
  39. package/dist/models/CombinedSubmission.js +103 -84
  40. package/dist/models/CombinedSubmission.js.map +1 -0
  41. package/dist/models/CombinedSubmissionAction.d.ts +40 -88
  42. package/dist/models/CombinedSubmissionAction.js +68 -86
  43. package/dist/models/CombinedSubmissionAction.js.map +1 -0
  44. package/dist/models/CombinedSubmissionData.d.ts +23 -54
  45. package/dist/models/CombinedSubmissionData.js +43 -55
  46. package/dist/models/CombinedSubmissionData.js.map +1 -0
  47. package/dist/models/CopyTemplateOptions.d.ts +21 -0
  48. package/dist/models/CopyTemplateOptions.js +29 -0
  49. package/dist/models/CopyTemplateOptions.js.map +1 -0
  50. package/dist/models/CreateCombinedSubmissionResponse.d.ts +26 -51
  51. package/dist/models/CreateCombinedSubmissionResponse.js +36 -60
  52. package/dist/models/CreateCombinedSubmissionResponse.js.map +1 -0
  53. package/dist/models/CreateCustomFileData.d.ts +19 -30
  54. package/dist/models/CreateCustomFileData.js +19 -46
  55. package/dist/models/CreateCustomFileData.js.map +1 -0
  56. package/dist/models/CreateCustomFileResponse.d.ts +26 -50
  57. package/dist/models/CreateCustomFileResponse.js +36 -59
  58. package/dist/models/CreateCustomFileResponse.js.map +1 -0
  59. package/dist/models/CreateFolderData.d.ts +19 -31
  60. package/dist/models/CreateFolderData.js +19 -47
  61. package/dist/models/CreateFolderData.js.map +1 -0
  62. package/dist/models/CreateHtmlSubmissionData.d.ts +29 -0
  63. package/dist/models/CreateHtmlSubmissionData.js +77 -0
  64. package/dist/models/CreateHtmlSubmissionData.js.map +1 -0
  65. package/dist/models/CreateHtmlTemplate.d.ts +20 -0
  66. package/dist/models/CreateHtmlTemplate.js +23 -0
  67. package/dist/models/CreateHtmlTemplate.js.map +1 -0
  68. package/dist/models/CreatePdfSubmissionData.d.ts +29 -0
  69. package/dist/models/CreatePdfSubmissionData.js +71 -0
  70. package/dist/models/CreatePdfSubmissionData.js.map +1 -0
  71. package/dist/models/CreatePdfTemplate.d.ts +20 -0
  72. package/dist/models/CreatePdfTemplate.js +23 -0
  73. package/dist/models/CreatePdfTemplate.js.map +1 -0
  74. package/dist/models/CreateSubmissionDataRequestData.d.ts +40 -127
  75. package/dist/models/CreateSubmissionDataRequestData.js +62 -95
  76. package/dist/models/CreateSubmissionDataRequestData.js.map +1 -0
  77. package/dist/models/CreateSubmissionDataRequestEventRequest.d.ts +40 -0
  78. package/dist/models/CreateSubmissionDataRequestEventRequest.js +50 -0
  79. package/dist/models/CreateSubmissionDataRequestEventRequest.js.map +1 -0
  80. package/dist/models/CreateSubmissionDataRequestEventResponse.d.ts +27 -0
  81. package/dist/models/CreateSubmissionDataRequestEventResponse.js +40 -0
  82. package/dist/models/CreateSubmissionDataRequestEventResponse.js.map +1 -0
  83. package/dist/models/CreateSubmissionDataRequestResponse.d.ts +27 -0
  84. package/dist/models/CreateSubmissionDataRequestResponse.js +40 -0
  85. package/dist/models/CreateSubmissionDataRequestResponse.js.map +1 -0
  86. package/dist/models/CreateSubmissionDataRequestTokenResponse.d.ts +26 -51
  87. package/dist/models/CreateSubmissionDataRequestTokenResponse.js +36 -60
  88. package/dist/models/CreateSubmissionDataRequestTokenResponse.js.map +1 -0
  89. package/dist/models/CreateSubmissionResponse.d.ts +26 -51
  90. package/dist/models/CreateSubmissionResponse.js +36 -60
  91. package/dist/models/CreateSubmissionResponse.js.map +1 -0
  92. package/dist/models/CustomFile.d.ts +21 -0
  93. package/dist/models/CustomFile.js +29 -0
  94. package/dist/models/CustomFile.js.map +1 -0
  95. package/dist/models/ErrorResponse.d.ts +23 -43
  96. package/dist/models/ErrorResponse.js +29 -55
  97. package/dist/models/ErrorResponse.js.map +1 -0
  98. package/dist/models/Folder.d.ts +22 -48
  99. package/dist/models/Folder.js +37 -52
  100. package/dist/models/Folder.js.map +1 -0
  101. package/dist/models/JsonSchema.d.ts +28 -0
  102. package/dist/models/JsonSchema.js +71 -0
  103. package/dist/models/JsonSchema.js.map +1 -0
  104. package/dist/models/ListSubmissionsResponse.d.ts +22 -43
  105. package/dist/models/ListSubmissionsResponse.js +31 -53
  106. package/dist/models/ListSubmissionsResponse.js.map +1 -0
  107. package/dist/models/MoveFolderData.d.ts +19 -30
  108. package/dist/models/MoveFolderData.js +19 -46
  109. package/dist/models/MoveFolderData.js.map +1 -0
  110. package/dist/models/MoveTemplateData.d.ts +19 -30
  111. package/dist/models/MoveTemplateData.js +19 -46
  112. package/dist/models/MoveTemplateData.js.map +1 -0
  113. package/dist/models/MultipleErrorsResponse.d.ts +24 -0
  114. package/dist/models/MultipleErrorsResponse.js +33 -0
  115. package/dist/models/MultipleErrorsResponse.js.map +1 -0
  116. package/dist/models/ObjectSerializer.d.ts +61 -0
  117. package/dist/models/ObjectSerializer.js +477 -0
  118. package/dist/models/ObjectSerializer.js.map +1 -0
  119. package/dist/models/PublishVersionData.d.ts +21 -0
  120. package/dist/models/PublishVersionData.js +29 -0
  121. package/dist/models/PublishVersionData.js.map +1 -0
  122. package/dist/models/RenameFolderData.d.ts +19 -30
  123. package/dist/models/RenameFolderData.js +19 -46
  124. package/dist/models/RenameFolderData.js.map +1 -0
  125. package/dist/models/RestoreVersionData.d.ts +20 -0
  126. package/dist/models/RestoreVersionData.js +23 -0
  127. package/dist/models/RestoreVersionData.js.map +1 -0
  128. package/dist/models/Submission.d.ts +69 -157
  129. package/dist/models/Submission.js +195 -104
  130. package/dist/models/Submission.js.map +1 -0
  131. package/dist/models/SubmissionAction.d.ts +40 -88
  132. package/dist/models/SubmissionAction.js +68 -86
  133. package/dist/models/SubmissionAction.js.map +1 -0
  134. package/dist/models/SubmissionBatch.d.ts +31 -88
  135. package/dist/models/SubmissionBatch.js +67 -79
  136. package/dist/models/SubmissionBatch.js.map +1 -0
  137. package/dist/models/SubmissionBatchData.d.ts +21 -49
  138. package/dist/models/SubmissionBatchData.js +31 -54
  139. package/dist/models/SubmissionBatchData.js.map +1 -0
  140. package/dist/models/SubmissionBatchWithSubmissions.d.ts +34 -0
  141. package/dist/models/SubmissionBatchWithSubmissions.js +77 -0
  142. package/dist/models/SubmissionBatchWithSubmissions.js.map +1 -0
  143. package/dist/models/SubmissionDataRequest.d.ts +60 -183
  144. package/dist/models/SubmissionDataRequest.js +163 -124
  145. package/dist/models/SubmissionDataRequest.js.map +1 -0
  146. package/dist/models/SubmissionDataRequestEvent.d.ts +45 -0
  147. package/dist/models/SubmissionDataRequestEvent.js +80 -0
  148. package/dist/models/SubmissionDataRequestEvent.js.map +1 -0
  149. package/dist/models/SubmissionDataRequestShow.d.ts +62 -0
  150. package/dist/models/SubmissionDataRequestShow.js +173 -0
  151. package/dist/models/SubmissionDataRequestShow.js.map +1 -0
  152. package/dist/models/SubmissionDataRequestToken.d.ts +23 -0
  153. package/dist/models/SubmissionDataRequestToken.js +41 -0
  154. package/dist/models/SubmissionDataRequestToken.js.map +1 -0
  155. package/dist/models/SubmissionPreview.d.ts +61 -0
  156. package/dist/models/SubmissionPreview.js +174 -0
  157. package/dist/models/SubmissionPreview.js.map +1 -0
  158. package/dist/models/SuccessErrorResponse.d.ts +25 -0
  159. package/dist/models/SuccessErrorResponse.js +34 -0
  160. package/dist/models/SuccessErrorResponse.js.map +1 -0
  161. package/dist/models/SuccessMultipleErrorsResponse.d.ts +25 -0
  162. package/dist/models/SuccessMultipleErrorsResponse.js +34 -0
  163. package/dist/models/SuccessMultipleErrorsResponse.js.map +1 -0
  164. package/dist/models/Template.d.ts +86 -153
  165. package/dist/models/Template.js +349 -111
  166. package/dist/models/Template.js.map +1 -0
  167. package/dist/models/TemplateAddFieldsResponse.d.ts +26 -0
  168. package/dist/models/TemplateAddFieldsResponse.js +40 -0
  169. package/dist/models/TemplateAddFieldsResponse.js.map +1 -0
  170. package/dist/models/TemplateDeleteResponse.d.ts +27 -0
  171. package/dist/models/TemplateDeleteResponse.js +46 -0
  172. package/dist/models/TemplateDeleteResponse.js.map +1 -0
  173. package/dist/models/TemplatePreview.d.ts +76 -0
  174. package/dist/models/TemplatePreview.js +287 -0
  175. package/dist/models/TemplatePreview.js.map +1 -0
  176. package/dist/models/TemplatePublishVersionResponse.d.ts +26 -0
  177. package/dist/models/TemplatePublishVersionResponse.js +40 -0
  178. package/dist/models/TemplatePublishVersionResponse.js.map +1 -0
  179. package/dist/models/UpdateHtmlTemplate.d.ts +20 -0
  180. package/dist/models/UpdateHtmlTemplate.js +23 -0
  181. package/dist/models/UpdateHtmlTemplate.js.map +1 -0
  182. package/dist/models/UpdateSubmissionDataRequestData.d.ts +31 -127
  183. package/dist/models/UpdateSubmissionDataRequestData.js +47 -93
  184. package/dist/models/UpdateSubmissionDataRequestData.js.map +1 -0
  185. package/dist/models/UploadPresignResponse.d.ts +26 -0
  186. package/dist/models/UploadPresignResponse.js +45 -0
  187. package/dist/models/UploadPresignResponse.js.map +1 -0
  188. package/dist/models/all.d.ts +52 -0
  189. package/dist/models/all.js +69 -0
  190. package/dist/models/all.js.map +1 -0
  191. package/dist/rxjsStub.d.ts +10 -0
  192. package/dist/rxjsStub.js +33 -0
  193. package/dist/rxjsStub.js.map +1 -0
  194. package/dist/servers.d.ts +17 -0
  195. package/dist/servers.js +32 -0
  196. package/dist/servers.js.map +1 -0
  197. package/dist/types/ObjectParamAPI.d.ts +286 -0
  198. package/dist/types/ObjectParamAPI.js +264 -0
  199. package/dist/types/ObjectParamAPI.js.map +1 -0
  200. package/dist/types/ObservableAPI.d.ts +132 -0
  201. package/dist/types/ObservableAPI.js +1096 -0
  202. package/dist/types/ObservableAPI.js.map +1 -0
  203. package/dist/types/PromiseAPI.d.ts +129 -0
  204. package/dist/types/PromiseAPI.js +332 -0
  205. package/dist/types/PromiseAPI.js.map +1 -0
  206. package/dist/util.d.ts +2 -0
  207. package/dist/util.js +29 -0
  208. package/dist/util.js.map +1 -0
  209. package/package.json +24 -2
  210. package/.openapi-generator/FILES +0 -61
  211. package/.openapi-generator/VERSION +0 -1
  212. package/.openapi-generator-ignore +0 -23
  213. package/CHANGELOG.md +0 -7
  214. package/dist/apis/index.d.ts +0 -1
  215. package/dist/apis/index.js +0 -19
  216. package/dist/models/AddFieldsTemplateResponse.d.ts +0 -51
  217. package/dist/models/AddFieldsTemplateResponse.js +0 -62
  218. package/dist/models/AuthenticationError.d.ts +0 -44
  219. package/dist/models/AuthenticationError.js +0 -59
  220. package/dist/models/AuthenticationSuccessResponse.d.ts +0 -38
  221. package/dist/models/AuthenticationSuccessResponse.js +0 -56
  222. package/dist/models/CopyTemplateData.d.ts +0 -37
  223. package/dist/models/CopyTemplateData.js +0 -53
  224. package/dist/models/CreateFolderAttributes.d.ts +0 -37
  225. package/dist/models/CreateFolderAttributes.js +0 -53
  226. package/dist/models/CreateHtmlTemplateData.d.ts +0 -32
  227. package/dist/models/CreateHtmlTemplateData.js +0 -51
  228. package/dist/models/CreateSubmissionBatchResponse.d.ts +0 -65
  229. package/dist/models/CreateSubmissionBatchResponse.js +0 -70
  230. package/dist/models/CreateSubmissionBatchSubmissionsResponse.d.ts +0 -53
  231. package/dist/models/CreateSubmissionBatchSubmissionsResponse.js +0 -64
  232. package/dist/models/CreateSubmissionData.d.ts +0 -80
  233. package/dist/models/CreateSubmissionData.js +0 -68
  234. package/dist/models/CreateTemplateFromUploadData.d.ts +0 -32
  235. package/dist/models/CreateTemplateFromUploadData.js +0 -51
  236. package/dist/models/DataRequestToken.d.ts +0 -49
  237. package/dist/models/DataRequestToken.js +0 -59
  238. package/dist/models/DeleteTemplateResponse.d.ts +0 -45
  239. package/dist/models/DeleteTemplateResponse.js +0 -60
  240. package/dist/models/FullTemplate.d.ts +0 -269
  241. package/dist/models/FullTemplate.js +0 -173
  242. package/dist/models/HtmlTemplateData.d.ts +0 -144
  243. package/dist/models/HtmlTemplateData.js +0 -98
  244. package/dist/models/InvalidRequest.d.ts +0 -44
  245. package/dist/models/InvalidRequest.js +0 -59
  246. package/dist/models/PendingTemplate.d.ts +0 -136
  247. package/dist/models/PendingTemplate.js +0 -103
  248. package/dist/models/SubmissionData.d.ts +0 -62
  249. package/dist/models/SubmissionData.js +0 -62
  250. package/dist/models/SubmissionDataBatchRequest.d.ts +0 -61
  251. package/dist/models/SubmissionDataBatchRequest.js +0 -62
  252. package/dist/models/TemplateData.d.ts +0 -130
  253. package/dist/models/TemplateData.js +0 -88
  254. package/dist/models/TemplateDefaults.d.ts +0 -43
  255. package/dist/models/TemplateDefaults.js +0 -56
  256. package/dist/models/TemplateDocument.d.ts +0 -51
  257. package/dist/models/TemplateDocument.js +0 -63
  258. package/dist/models/TemplateDocumentMetadata.d.ts +0 -50
  259. package/dist/models/TemplateDocumentMetadata.js +0 -62
  260. package/dist/models/UpdateDataRequestResponse.d.ts +0 -52
  261. package/dist/models/UpdateDataRequestResponse.js +0 -64
  262. package/dist/models/UpdateTemplateData.d.ts +0 -32
  263. package/dist/models/UpdateTemplateData.js +0 -51
  264. package/dist/models/UpdateTemplateResponse.d.ts +0 -45
  265. package/dist/models/UpdateTemplateResponse.js +0 -60
  266. package/dist/models/UploadTemplateData.d.ts +0 -151
  267. package/dist/models/UploadTemplateData.js +0 -101
  268. package/dist/models/index.d.ts +0 -51
  269. package/dist/models/index.js +0 -69
  270. package/dist/runtime.d.ts +0 -182
  271. package/dist/runtime.js +0 -562
  272. package/src/apis/PDFApi.ts +0 -1665
  273. package/src/apis/index.ts +0 -3
  274. package/src/index.ts +0 -5
  275. package/src/models/AddFieldsData.ts +0 -66
  276. package/src/models/AddFieldsTemplateResponse.ts +0 -93
  277. package/src/models/AuthenticationError.ts +0 -84
  278. package/src/models/AuthenticationSuccessResponse.ts +0 -76
  279. package/src/models/CombinePdfsData.ts +0 -106
  280. package/src/models/CombinedSubmission.ts +0 -185
  281. package/src/models/CombinedSubmissionAction.ts +0 -144
  282. package/src/models/CombinedSubmissionData.ts +0 -98
  283. package/src/models/CopyTemplateData.ts +0 -74
  284. package/src/models/CreateCombinedSubmissionResponse.ts +0 -101
  285. package/src/models/CreateCustomFileData.ts +0 -66
  286. package/src/models/CreateCustomFileResponse.ts +0 -94
  287. package/src/models/CreateFolderAttributes.ts +0 -74
  288. package/src/models/CreateFolderData.ts +0 -73
  289. package/src/models/CreateHtmlTemplateData.ts +0 -73
  290. package/src/models/CreateSubmissionBatchResponse.ts +0 -124
  291. package/src/models/CreateSubmissionBatchSubmissionsResponse.ts +0 -101
  292. package/src/models/CreateSubmissionData.ts +0 -137
  293. package/src/models/CreateSubmissionDataRequestData.ts +0 -192
  294. package/src/models/CreateSubmissionDataRequestTokenResponse.ts +0 -101
  295. package/src/models/CreateSubmissionResponse.ts +0 -101
  296. package/src/models/CreateTemplateFromUploadData.ts +0 -73
  297. package/src/models/DataRequestToken.ts +0 -93
  298. package/src/models/DeleteTemplateResponse.ts +0 -85
  299. package/src/models/ErrorResponse.ts +0 -85
  300. package/src/models/Folder.ts +0 -89
  301. package/src/models/FullTemplate.ts +0 -427
  302. package/src/models/HtmlTemplateData.ts +0 -215
  303. package/src/models/InvalidRequest.ts +0 -85
  304. package/src/models/ListSubmissionsResponse.ts +0 -91
  305. package/src/models/MoveFolderData.ts +0 -65
  306. package/src/models/MoveTemplateData.ts +0 -66
  307. package/src/models/PendingTemplate.ts +0 -218
  308. package/src/models/RenameFolderData.ts +0 -66
  309. package/src/models/Submission.ts +0 -246
  310. package/src/models/SubmissionAction.ts +0 -144
  311. package/src/models/SubmissionBatch.ts +0 -156
  312. package/src/models/SubmissionBatchData.ts +0 -97
  313. package/src/models/SubmissionData.ts +0 -113
  314. package/src/models/SubmissionDataBatchRequest.ts +0 -107
  315. package/src/models/SubmissionDataRequest.ts +0 -271
  316. package/src/models/Template.ts +0 -249
  317. package/src/models/TemplateData.ts +0 -197
  318. package/src/models/TemplateDefaults.ts +0 -84
  319. package/src/models/TemplateDocument.ts +0 -101
  320. package/src/models/TemplateDocumentMetadata.ts +0 -94
  321. package/src/models/UpdateDataRequestResponse.ts +0 -101
  322. package/src/models/UpdateSubmissionDataRequestData.ts +0 -190
  323. package/src/models/UpdateTemplateData.ts +0 -73
  324. package/src/models/UpdateTemplateResponse.ts +0 -85
  325. package/src/models/UploadTemplateData.ts +0 -230
  326. package/src/models/index.ts +0 -53
  327. package/src/runtime.ts +0 -431
  328. package/tsconfig.json +0 -20
@@ -1,1665 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * API v1
5
- * DocSpring is a service that helps you fill out and sign PDF templates.
6
- *
7
- * The version of the OpenAPI document: v1
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
-
16
- import * as runtime from '../runtime';
17
- import type {
18
- AddFieldsData,
19
- AddFieldsTemplateResponse,
20
- AuthenticationError,
21
- AuthenticationSuccessResponse,
22
- CombinePdfsData,
23
- CombinedSubmission,
24
- CombinedSubmissionData,
25
- CopyTemplateData,
26
- CreateCombinedSubmissionResponse,
27
- CreateCustomFileData,
28
- CreateCustomFileResponse,
29
- CreateFolderData,
30
- CreateHtmlTemplateData,
31
- CreateSubmissionBatchResponse,
32
- CreateSubmissionData,
33
- CreateSubmissionDataRequestTokenResponse,
34
- CreateSubmissionResponse,
35
- CreateTemplateFromUploadData,
36
- DeleteTemplateResponse,
37
- ErrorResponse,
38
- Folder,
39
- FullTemplate,
40
- InvalidRequest,
41
- ListSubmissionsResponse,
42
- MoveFolderData,
43
- MoveTemplateData,
44
- PendingTemplate,
45
- RenameFolderData,
46
- Submission,
47
- SubmissionBatch,
48
- SubmissionBatchData,
49
- SubmissionData,
50
- SubmissionDataRequest,
51
- Template,
52
- UpdateDataRequestResponse,
53
- UpdateSubmissionDataRequestData,
54
- UpdateTemplateData,
55
- UpdateTemplateResponse,
56
- } from '../models/index';
57
- import {
58
- AddFieldsDataFromJSON,
59
- AddFieldsDataToJSON,
60
- AddFieldsTemplateResponseFromJSON,
61
- AddFieldsTemplateResponseToJSON,
62
- AuthenticationErrorFromJSON,
63
- AuthenticationErrorToJSON,
64
- AuthenticationSuccessResponseFromJSON,
65
- AuthenticationSuccessResponseToJSON,
66
- CombinePdfsDataFromJSON,
67
- CombinePdfsDataToJSON,
68
- CombinedSubmissionFromJSON,
69
- CombinedSubmissionToJSON,
70
- CombinedSubmissionDataFromJSON,
71
- CombinedSubmissionDataToJSON,
72
- CopyTemplateDataFromJSON,
73
- CopyTemplateDataToJSON,
74
- CreateCombinedSubmissionResponseFromJSON,
75
- CreateCombinedSubmissionResponseToJSON,
76
- CreateCustomFileDataFromJSON,
77
- CreateCustomFileDataToJSON,
78
- CreateCustomFileResponseFromJSON,
79
- CreateCustomFileResponseToJSON,
80
- CreateFolderDataFromJSON,
81
- CreateFolderDataToJSON,
82
- CreateHtmlTemplateDataFromJSON,
83
- CreateHtmlTemplateDataToJSON,
84
- CreateSubmissionBatchResponseFromJSON,
85
- CreateSubmissionBatchResponseToJSON,
86
- CreateSubmissionDataFromJSON,
87
- CreateSubmissionDataToJSON,
88
- CreateSubmissionDataRequestTokenResponseFromJSON,
89
- CreateSubmissionDataRequestTokenResponseToJSON,
90
- CreateSubmissionResponseFromJSON,
91
- CreateSubmissionResponseToJSON,
92
- CreateTemplateFromUploadDataFromJSON,
93
- CreateTemplateFromUploadDataToJSON,
94
- DeleteTemplateResponseFromJSON,
95
- DeleteTemplateResponseToJSON,
96
- ErrorResponseFromJSON,
97
- ErrorResponseToJSON,
98
- FolderFromJSON,
99
- FolderToJSON,
100
- FullTemplateFromJSON,
101
- FullTemplateToJSON,
102
- InvalidRequestFromJSON,
103
- InvalidRequestToJSON,
104
- ListSubmissionsResponseFromJSON,
105
- ListSubmissionsResponseToJSON,
106
- MoveFolderDataFromJSON,
107
- MoveFolderDataToJSON,
108
- MoveTemplateDataFromJSON,
109
- MoveTemplateDataToJSON,
110
- PendingTemplateFromJSON,
111
- PendingTemplateToJSON,
112
- RenameFolderDataFromJSON,
113
- RenameFolderDataToJSON,
114
- SubmissionFromJSON,
115
- SubmissionToJSON,
116
- SubmissionBatchFromJSON,
117
- SubmissionBatchToJSON,
118
- SubmissionBatchDataFromJSON,
119
- SubmissionBatchDataToJSON,
120
- SubmissionDataFromJSON,
121
- SubmissionDataToJSON,
122
- SubmissionDataRequestFromJSON,
123
- SubmissionDataRequestToJSON,
124
- TemplateFromJSON,
125
- TemplateToJSON,
126
- UpdateDataRequestResponseFromJSON,
127
- UpdateDataRequestResponseToJSON,
128
- UpdateSubmissionDataRequestDataFromJSON,
129
- UpdateSubmissionDataRequestDataToJSON,
130
- UpdateTemplateDataFromJSON,
131
- UpdateTemplateDataToJSON,
132
- UpdateTemplateResponseFromJSON,
133
- UpdateTemplateResponseToJSON,
134
- } from '../models/index';
135
-
136
- export interface AddFieldsToTemplateRequest {
137
- templateId: string;
138
- data: AddFieldsData;
139
- }
140
-
141
- export interface BatchGeneratePdfV1Request {
142
- templateId: string;
143
- data: Array<SubmissionData>;
144
- }
145
-
146
- export interface BatchGeneratePdfsRequest {
147
- data: SubmissionBatchData;
148
- }
149
-
150
- export interface CombinePdfsRequest {
151
- data: CombinePdfsData;
152
- }
153
-
154
- export interface CombineSubmissionsRequest {
155
- data: CombinedSubmissionData;
156
- }
157
-
158
- export interface CopyTemplateRequest {
159
- templateId: string;
160
- data?: CopyTemplateData;
161
- }
162
-
163
- export interface CreateCustomFileFromUploadRequest {
164
- data: CreateCustomFileData;
165
- }
166
-
167
- export interface CreateDataRequestTokenRequest {
168
- dataRequestId: string;
169
- }
170
-
171
- export interface CreateFolderRequest {
172
- data: CreateFolderData;
173
- }
174
-
175
- export interface CreateHTMLTemplateRequest {
176
- data: CreateHtmlTemplateData;
177
- }
178
-
179
- export interface CreatePDFTemplateRequest {
180
- templateDocument: Blob;
181
- templateName: string;
182
- templateParentFolderId?: string;
183
- }
184
-
185
- export interface CreatePDFTemplateFromUploadRequest {
186
- data: CreateTemplateFromUploadData;
187
- }
188
-
189
- export interface DeleteFolderRequest {
190
- folderId: string;
191
- }
192
-
193
- export interface DeleteTemplateRequest {
194
- templateId: string;
195
- }
196
-
197
- export interface ExpireCombinedSubmissionRequest {
198
- combinedSubmissionId: string;
199
- }
200
-
201
- export interface ExpireSubmissionRequest {
202
- submissionId: string;
203
- }
204
-
205
- export interface GeneratePDFRequest {
206
- templateId: string;
207
- submission: CreateSubmissionData;
208
- }
209
-
210
- export interface GetCombinedSubmissionRequest {
211
- combinedSubmissionId: string;
212
- }
213
-
214
- export interface GetDataRequestRequest {
215
- dataRequestId: string;
216
- }
217
-
218
- export interface GetFullTemplateRequest {
219
- templateId: string;
220
- }
221
-
222
- export interface GetSubmissionRequest {
223
- submissionId: string;
224
- includeData?: boolean;
225
- }
226
-
227
- export interface GetSubmissionBatchRequest {
228
- submissionBatchId: string;
229
- includeSubmissions?: boolean;
230
- }
231
-
232
- export interface GetTemplateRequest {
233
- templateId: string;
234
- }
235
-
236
- export interface GetTemplateSchemaRequest {
237
- templateId: string;
238
- }
239
-
240
- export interface ListCombinedSubmissionsRequest {
241
- page?: number;
242
- perPage?: number;
243
- }
244
-
245
- export interface ListFoldersRequest {
246
- parentFolderId?: string;
247
- }
248
-
249
- export interface ListSubmissionsRequest {
250
- cursor?: string;
251
- limit?: number;
252
- createdAfter?: string;
253
- createdBefore?: string;
254
- type?: string;
255
- includeData?: boolean;
256
- }
257
-
258
- export interface ListTemplateSubmissionsRequest {
259
- templateId: string;
260
- cursor?: string;
261
- limit?: number;
262
- createdAfter?: string;
263
- createdBefore?: string;
264
- type?: string;
265
- includeData?: boolean;
266
- }
267
-
268
- export interface ListTemplatesRequest {
269
- query?: string;
270
- parentFolderId?: string;
271
- page?: number;
272
- perPage?: number;
273
- }
274
-
275
- export interface MoveFolderToFolderRequest {
276
- folderId: string;
277
- data: MoveFolderData;
278
- }
279
-
280
- export interface MoveTemplateToFolderRequest {
281
- templateId: string;
282
- data: MoveTemplateData;
283
- }
284
-
285
- export interface RenameFolderRequest {
286
- folderId: string;
287
- data: RenameFolderData;
288
- }
289
-
290
- export interface UpdateDataRequestRequest {
291
- dataRequestId: string;
292
- data: UpdateSubmissionDataRequestData;
293
- }
294
-
295
- export interface UpdateTemplateRequest {
296
- templateId: string;
297
- data: UpdateTemplateData;
298
- }
299
-
300
- /**
301
- *
302
- */
303
- export class PDFApi extends runtime.BaseAPI {
304
-
305
- /**
306
- * Add new fields to a Template
307
- */
308
- async addFieldsToTemplateRaw(requestParameters: AddFieldsToTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddFieldsTemplateResponse>> {
309
- if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
310
- throw new runtime.RequiredError('templateId','Required parameter requestParameters.templateId was null or undefined when calling addFieldsToTemplate.');
311
- }
312
-
313
- if (requestParameters.data === null || requestParameters.data === undefined) {
314
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling addFieldsToTemplate.');
315
- }
316
-
317
- const queryParameters: any = {};
318
-
319
- const headerParameters: runtime.HTTPHeaders = {};
320
-
321
- headerParameters['Content-Type'] = 'application/json';
322
-
323
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
324
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
325
- }
326
- const response = await this.request({
327
- path: `/templates/{template_id}/add_fields`.replace(`{${"template_id"}}`, encodeURIComponent(String(requestParameters.templateId))),
328
- method: 'PUT',
329
- headers: headerParameters,
330
- query: queryParameters,
331
- body: AddFieldsDataToJSON(requestParameters.data),
332
- }, initOverrides);
333
-
334
- return new runtime.JSONApiResponse(response, (jsonValue) => AddFieldsTemplateResponseFromJSON(jsonValue));
335
- }
336
-
337
- /**
338
- * Add new fields to a Template
339
- */
340
- async addFieldsToTemplate(requestParameters: AddFieldsToTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddFieldsTemplateResponse> {
341
- const response = await this.addFieldsToTemplateRaw(requestParameters, initOverrides);
342
- return await response.value();
343
- }
344
-
345
- /**
346
- * Generates multiple PDFs
347
- */
348
- async batchGeneratePdfV1Raw(requestParameters: BatchGeneratePdfV1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CreateSubmissionResponse>>> {
349
- if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
350
- throw new runtime.RequiredError('templateId','Required parameter requestParameters.templateId was null or undefined when calling batchGeneratePdfV1.');
351
- }
352
-
353
- if (requestParameters.data === null || requestParameters.data === undefined) {
354
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling batchGeneratePdfV1.');
355
- }
356
-
357
- const queryParameters: any = {};
358
-
359
- const headerParameters: runtime.HTTPHeaders = {};
360
-
361
- headerParameters['Content-Type'] = 'application/json';
362
-
363
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
364
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
365
- }
366
- const response = await this.request({
367
- path: `/templates/{template_id}/submissions/batch`.replace(`{${"template_id"}}`, encodeURIComponent(String(requestParameters.templateId))),
368
- method: 'POST',
369
- headers: headerParameters,
370
- query: queryParameters,
371
- body: requestParameters.data.map(SubmissionDataToJSON),
372
- }, initOverrides);
373
-
374
- return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CreateSubmissionResponseFromJSON));
375
- }
376
-
377
- /**
378
- * Generates multiple PDFs
379
- */
380
- async batchGeneratePdfV1(requestParameters: BatchGeneratePdfV1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CreateSubmissionResponse>> {
381
- const response = await this.batchGeneratePdfV1Raw(requestParameters, initOverrides);
382
- return await response.value();
383
- }
384
-
385
- /**
386
- * Generates multiple PDFs
387
- */
388
- async batchGeneratePdfsRaw(requestParameters: BatchGeneratePdfsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateSubmissionBatchResponse>> {
389
- if (requestParameters.data === null || requestParameters.data === undefined) {
390
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling batchGeneratePdfs.');
391
- }
392
-
393
- const queryParameters: any = {};
394
-
395
- const headerParameters: runtime.HTTPHeaders = {};
396
-
397
- headerParameters['Content-Type'] = 'application/json';
398
-
399
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
400
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
401
- }
402
- const response = await this.request({
403
- path: `/submissions/batches`,
404
- method: 'POST',
405
- headers: headerParameters,
406
- query: queryParameters,
407
- body: SubmissionBatchDataToJSON(requestParameters.data),
408
- }, initOverrides);
409
-
410
- return new runtime.JSONApiResponse(response, (jsonValue) => CreateSubmissionBatchResponseFromJSON(jsonValue));
411
- }
412
-
413
- /**
414
- * Generates multiple PDFs
415
- */
416
- async batchGeneratePdfs(requestParameters: BatchGeneratePdfsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSubmissionBatchResponse> {
417
- const response = await this.batchGeneratePdfsRaw(requestParameters, initOverrides);
418
- return await response.value();
419
- }
420
-
421
- /**
422
- * Merge submission PDFs, template PDFs, or custom files
423
- */
424
- async combinePdfsRaw(requestParameters: CombinePdfsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCombinedSubmissionResponse>> {
425
- if (requestParameters.data === null || requestParameters.data === undefined) {
426
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling combinePdfs.');
427
- }
428
-
429
- const queryParameters: any = {};
430
-
431
- const headerParameters: runtime.HTTPHeaders = {};
432
-
433
- headerParameters['Content-Type'] = 'application/json';
434
-
435
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
436
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
437
- }
438
- const response = await this.request({
439
- path: `/combined_submissions?v=2`,
440
- method: 'POST',
441
- headers: headerParameters,
442
- query: queryParameters,
443
- body: CombinePdfsDataToJSON(requestParameters.data),
444
- }, initOverrides);
445
-
446
- return new runtime.JSONApiResponse(response, (jsonValue) => CreateCombinedSubmissionResponseFromJSON(jsonValue));
447
- }
448
-
449
- /**
450
- * Merge submission PDFs, template PDFs, or custom files
451
- */
452
- async combinePdfs(requestParameters: CombinePdfsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCombinedSubmissionResponse> {
453
- const response = await this.combinePdfsRaw(requestParameters, initOverrides);
454
- return await response.value();
455
- }
456
-
457
- /**
458
- * Merge generated PDFs together
459
- */
460
- async combineSubmissionsRaw(requestParameters: CombineSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCombinedSubmissionResponse>> {
461
- if (requestParameters.data === null || requestParameters.data === undefined) {
462
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling combineSubmissions.');
463
- }
464
-
465
- const queryParameters: any = {};
466
-
467
- const headerParameters: runtime.HTTPHeaders = {};
468
-
469
- headerParameters['Content-Type'] = 'application/json';
470
-
471
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
472
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
473
- }
474
- const response = await this.request({
475
- path: `/combined_submissions`,
476
- method: 'POST',
477
- headers: headerParameters,
478
- query: queryParameters,
479
- body: CombinedSubmissionDataToJSON(requestParameters.data),
480
- }, initOverrides);
481
-
482
- return new runtime.JSONApiResponse(response, (jsonValue) => CreateCombinedSubmissionResponseFromJSON(jsonValue));
483
- }
484
-
485
- /**
486
- * Merge generated PDFs together
487
- */
488
- async combineSubmissions(requestParameters: CombineSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCombinedSubmissionResponse> {
489
- const response = await this.combineSubmissionsRaw(requestParameters, initOverrides);
490
- return await response.value();
491
- }
492
-
493
- /**
494
- * Copy a Template
495
- */
496
- async copyTemplateRaw(requestParameters: CopyTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Template>> {
497
- if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
498
- throw new runtime.RequiredError('templateId','Required parameter requestParameters.templateId was null or undefined when calling copyTemplate.');
499
- }
500
-
501
- const queryParameters: any = {};
502
-
503
- const headerParameters: runtime.HTTPHeaders = {};
504
-
505
- headerParameters['Content-Type'] = 'application/json';
506
-
507
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
508
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
509
- }
510
- const response = await this.request({
511
- path: `/templates/{template_id}/copy`.replace(`{${"template_id"}}`, encodeURIComponent(String(requestParameters.templateId))),
512
- method: 'POST',
513
- headers: headerParameters,
514
- query: queryParameters,
515
- body: CopyTemplateDataToJSON(requestParameters.data),
516
- }, initOverrides);
517
-
518
- return new runtime.JSONApiResponse(response, (jsonValue) => TemplateFromJSON(jsonValue));
519
- }
520
-
521
- /**
522
- * Copy a Template
523
- */
524
- async copyTemplate(requestParameters: CopyTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Template> {
525
- const response = await this.copyTemplateRaw(requestParameters, initOverrides);
526
- return await response.value();
527
- }
528
-
529
- /**
530
- * Create a new custom file from a cached presign upload
531
- */
532
- async createCustomFileFromUploadRaw(requestParameters: CreateCustomFileFromUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCustomFileResponse>> {
533
- if (requestParameters.data === null || requestParameters.data === undefined) {
534
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling createCustomFileFromUpload.');
535
- }
536
-
537
- const queryParameters: any = {};
538
-
539
- const headerParameters: runtime.HTTPHeaders = {};
540
-
541
- headerParameters['Content-Type'] = 'application/json';
542
-
543
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
544
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
545
- }
546
- const response = await this.request({
547
- path: `/custom_files`,
548
- method: 'POST',
549
- headers: headerParameters,
550
- query: queryParameters,
551
- body: CreateCustomFileDataToJSON(requestParameters.data),
552
- }, initOverrides);
553
-
554
- return new runtime.JSONApiResponse(response, (jsonValue) => CreateCustomFileResponseFromJSON(jsonValue));
555
- }
556
-
557
- /**
558
- * Create a new custom file from a cached presign upload
559
- */
560
- async createCustomFileFromUpload(requestParameters: CreateCustomFileFromUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCustomFileResponse> {
561
- const response = await this.createCustomFileFromUploadRaw(requestParameters, initOverrides);
562
- return await response.value();
563
- }
564
-
565
- /**
566
- * Creates a new data request token for form authentication
567
- */
568
- async createDataRequestTokenRaw(requestParameters: CreateDataRequestTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateSubmissionDataRequestTokenResponse>> {
569
- if (requestParameters.dataRequestId === null || requestParameters.dataRequestId === undefined) {
570
- throw new runtime.RequiredError('dataRequestId','Required parameter requestParameters.dataRequestId was null or undefined when calling createDataRequestToken.');
571
- }
572
-
573
- const queryParameters: any = {};
574
-
575
- const headerParameters: runtime.HTTPHeaders = {};
576
-
577
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
578
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
579
- }
580
- const response = await this.request({
581
- path: `/data_requests/{data_request_id}/tokens`.replace(`{${"data_request_id"}}`, encodeURIComponent(String(requestParameters.dataRequestId))),
582
- method: 'POST',
583
- headers: headerParameters,
584
- query: queryParameters,
585
- }, initOverrides);
586
-
587
- return new runtime.JSONApiResponse(response, (jsonValue) => CreateSubmissionDataRequestTokenResponseFromJSON(jsonValue));
588
- }
589
-
590
- /**
591
- * Creates a new data request token for form authentication
592
- */
593
- async createDataRequestToken(requestParameters: CreateDataRequestTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSubmissionDataRequestTokenResponse> {
594
- const response = await this.createDataRequestTokenRaw(requestParameters, initOverrides);
595
- return await response.value();
596
- }
597
-
598
- /**
599
- * Create a folder
600
- */
601
- async createFolderRaw(requestParameters: CreateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Folder>> {
602
- if (requestParameters.data === null || requestParameters.data === undefined) {
603
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling createFolder.');
604
- }
605
-
606
- const queryParameters: any = {};
607
-
608
- const headerParameters: runtime.HTTPHeaders = {};
609
-
610
- headerParameters['Content-Type'] = 'application/json';
611
-
612
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
613
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
614
- }
615
- const response = await this.request({
616
- path: `/folders/`,
617
- method: 'POST',
618
- headers: headerParameters,
619
- query: queryParameters,
620
- body: CreateFolderDataToJSON(requestParameters.data),
621
- }, initOverrides);
622
-
623
- return new runtime.JSONApiResponse(response, (jsonValue) => FolderFromJSON(jsonValue));
624
- }
625
-
626
- /**
627
- * Create a folder
628
- */
629
- async createFolder(requestParameters: CreateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Folder> {
630
- const response = await this.createFolderRaw(requestParameters, initOverrides);
631
- return await response.value();
632
- }
633
-
634
- /**
635
- * Create a new HTML template
636
- */
637
- async createHTMLTemplateRaw(requestParameters: CreateHTMLTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PendingTemplate>> {
638
- if (requestParameters.data === null || requestParameters.data === undefined) {
639
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling createHTMLTemplate.');
640
- }
641
-
642
- const queryParameters: any = {};
643
-
644
- const headerParameters: runtime.HTTPHeaders = {};
645
-
646
- headerParameters['Content-Type'] = 'application/json';
647
-
648
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
649
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
650
- }
651
- const response = await this.request({
652
- path: `/templates?desc=html`,
653
- method: 'POST',
654
- headers: headerParameters,
655
- query: queryParameters,
656
- body: CreateHtmlTemplateDataToJSON(requestParameters.data),
657
- }, initOverrides);
658
-
659
- return new runtime.JSONApiResponse(response, (jsonValue) => PendingTemplateFromJSON(jsonValue));
660
- }
661
-
662
- /**
663
- * Create a new HTML template
664
- */
665
- async createHTMLTemplate(requestParameters: CreateHTMLTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PendingTemplate> {
666
- const response = await this.createHTMLTemplateRaw(requestParameters, initOverrides);
667
- return await response.value();
668
- }
669
-
670
- /**
671
- * Create a new PDF template with a form POST file upload
672
- */
673
- async createPDFTemplateRaw(requestParameters: CreatePDFTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PendingTemplate>> {
674
- if (requestParameters.templateDocument === null || requestParameters.templateDocument === undefined) {
675
- throw new runtime.RequiredError('templateDocument','Required parameter requestParameters.templateDocument was null or undefined when calling createPDFTemplate.');
676
- }
677
-
678
- if (requestParameters.templateName === null || requestParameters.templateName === undefined) {
679
- throw new runtime.RequiredError('templateName','Required parameter requestParameters.templateName was null or undefined when calling createPDFTemplate.');
680
- }
681
-
682
- const queryParameters: any = {};
683
-
684
- const headerParameters: runtime.HTTPHeaders = {};
685
-
686
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
687
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
688
- }
689
- const consumes: runtime.Consume[] = [
690
- { contentType: 'multipart/form-data' },
691
- ];
692
- // @ts-ignore: canConsumeForm may be unused
693
- const canConsumeForm = runtime.canConsumeForm(consumes);
694
-
695
- let formParams: { append(param: string, value: any): any };
696
- let useForm = false;
697
- // use FormData to transmit files using content-type "multipart/form-data"
698
- useForm = canConsumeForm;
699
- if (useForm) {
700
- formParams = new FormData();
701
- } else {
702
- formParams = new URLSearchParams();
703
- }
704
-
705
- if (requestParameters.templateDocument !== undefined) {
706
- formParams.append('template[document]', requestParameters.templateDocument as any);
707
- }
708
-
709
- if (requestParameters.templateName !== undefined) {
710
- formParams.append('template[name]', requestParameters.templateName as any);
711
- }
712
-
713
- if (requestParameters.templateParentFolderId !== undefined) {
714
- formParams.append('template[parent_folder_id]', requestParameters.templateParentFolderId as any);
715
- }
716
-
717
- const response = await this.request({
718
- path: `/templates`,
719
- method: 'POST',
720
- headers: headerParameters,
721
- query: queryParameters,
722
- body: formParams,
723
- }, initOverrides);
724
-
725
- return new runtime.JSONApiResponse(response, (jsonValue) => PendingTemplateFromJSON(jsonValue));
726
- }
727
-
728
- /**
729
- * Create a new PDF template with a form POST file upload
730
- */
731
- async createPDFTemplate(requestParameters: CreatePDFTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PendingTemplate> {
732
- const response = await this.createPDFTemplateRaw(requestParameters, initOverrides);
733
- return await response.value();
734
- }
735
-
736
- /**
737
- * Create a new PDF template from a cached presign upload
738
- */
739
- async createPDFTemplateFromUploadRaw(requestParameters: CreatePDFTemplateFromUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PendingTemplate>> {
740
- if (requestParameters.data === null || requestParameters.data === undefined) {
741
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling createPDFTemplateFromUpload.');
742
- }
743
-
744
- const queryParameters: any = {};
745
-
746
- const headerParameters: runtime.HTTPHeaders = {};
747
-
748
- headerParameters['Content-Type'] = 'application/json';
749
-
750
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
751
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
752
- }
753
- const response = await this.request({
754
- path: `/templates?desc=cached_upload`,
755
- method: 'POST',
756
- headers: headerParameters,
757
- query: queryParameters,
758
- body: CreateTemplateFromUploadDataToJSON(requestParameters.data),
759
- }, initOverrides);
760
-
761
- return new runtime.JSONApiResponse(response, (jsonValue) => PendingTemplateFromJSON(jsonValue));
762
- }
763
-
764
- /**
765
- * Create a new PDF template from a cached presign upload
766
- */
767
- async createPDFTemplateFromUpload(requestParameters: CreatePDFTemplateFromUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PendingTemplate> {
768
- const response = await this.createPDFTemplateFromUploadRaw(requestParameters, initOverrides);
769
- return await response.value();
770
- }
771
-
772
- /**
773
- * Delete a folder
774
- */
775
- async deleteFolderRaw(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Folder>> {
776
- if (requestParameters.folderId === null || requestParameters.folderId === undefined) {
777
- throw new runtime.RequiredError('folderId','Required parameter requestParameters.folderId was null or undefined when calling deleteFolder.');
778
- }
779
-
780
- const queryParameters: any = {};
781
-
782
- const headerParameters: runtime.HTTPHeaders = {};
783
-
784
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
785
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
786
- }
787
- const response = await this.request({
788
- path: `/folders/{folder_id}`.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters.folderId))),
789
- method: 'DELETE',
790
- headers: headerParameters,
791
- query: queryParameters,
792
- }, initOverrides);
793
-
794
- return new runtime.JSONApiResponse(response, (jsonValue) => FolderFromJSON(jsonValue));
795
- }
796
-
797
- /**
798
- * Delete a folder
799
- */
800
- async deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Folder> {
801
- const response = await this.deleteFolderRaw(requestParameters, initOverrides);
802
- return await response.value();
803
- }
804
-
805
- /**
806
- * Delete a template
807
- */
808
- async deleteTemplateRaw(requestParameters: DeleteTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteTemplateResponse>> {
809
- if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
810
- throw new runtime.RequiredError('templateId','Required parameter requestParameters.templateId was null or undefined when calling deleteTemplate.');
811
- }
812
-
813
- const queryParameters: any = {};
814
-
815
- const headerParameters: runtime.HTTPHeaders = {};
816
-
817
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
818
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
819
- }
820
- const response = await this.request({
821
- path: `/templates/{template_id}`.replace(`{${"template_id"}}`, encodeURIComponent(String(requestParameters.templateId))),
822
- method: 'DELETE',
823
- headers: headerParameters,
824
- query: queryParameters,
825
- }, initOverrides);
826
-
827
- return new runtime.JSONApiResponse(response, (jsonValue) => DeleteTemplateResponseFromJSON(jsonValue));
828
- }
829
-
830
- /**
831
- * Delete a template
832
- */
833
- async deleteTemplate(requestParameters: DeleteTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteTemplateResponse> {
834
- const response = await this.deleteTemplateRaw(requestParameters, initOverrides);
835
- return await response.value();
836
- }
837
-
838
- /**
839
- * Expire a combined submission
840
- */
841
- async expireCombinedSubmissionRaw(requestParameters: ExpireCombinedSubmissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CombinedSubmission>> {
842
- if (requestParameters.combinedSubmissionId === null || requestParameters.combinedSubmissionId === undefined) {
843
- throw new runtime.RequiredError('combinedSubmissionId','Required parameter requestParameters.combinedSubmissionId was null or undefined when calling expireCombinedSubmission.');
844
- }
845
-
846
- const queryParameters: any = {};
847
-
848
- const headerParameters: runtime.HTTPHeaders = {};
849
-
850
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
851
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
852
- }
853
- const response = await this.request({
854
- path: `/combined_submissions/{combined_submission_id}`.replace(`{${"combined_submission_id"}}`, encodeURIComponent(String(requestParameters.combinedSubmissionId))),
855
- method: 'DELETE',
856
- headers: headerParameters,
857
- query: queryParameters,
858
- }, initOverrides);
859
-
860
- return new runtime.JSONApiResponse(response, (jsonValue) => CombinedSubmissionFromJSON(jsonValue));
861
- }
862
-
863
- /**
864
- * Expire a combined submission
865
- */
866
- async expireCombinedSubmission(requestParameters: ExpireCombinedSubmissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CombinedSubmission> {
867
- const response = await this.expireCombinedSubmissionRaw(requestParameters, initOverrides);
868
- return await response.value();
869
- }
870
-
871
- /**
872
- * Expire a PDF submission
873
- */
874
- async expireSubmissionRaw(requestParameters: ExpireSubmissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Submission>> {
875
- if (requestParameters.submissionId === null || requestParameters.submissionId === undefined) {
876
- throw new runtime.RequiredError('submissionId','Required parameter requestParameters.submissionId was null or undefined when calling expireSubmission.');
877
- }
878
-
879
- const queryParameters: any = {};
880
-
881
- const headerParameters: runtime.HTTPHeaders = {};
882
-
883
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
884
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
885
- }
886
- const response = await this.request({
887
- path: `/submissions/{submission_id}`.replace(`{${"submission_id"}}`, encodeURIComponent(String(requestParameters.submissionId))),
888
- method: 'DELETE',
889
- headers: headerParameters,
890
- query: queryParameters,
891
- }, initOverrides);
892
-
893
- return new runtime.JSONApiResponse(response, (jsonValue) => SubmissionFromJSON(jsonValue));
894
- }
895
-
896
- /**
897
- * Expire a PDF submission
898
- */
899
- async expireSubmission(requestParameters: ExpireSubmissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Submission> {
900
- const response = await this.expireSubmissionRaw(requestParameters, initOverrides);
901
- return await response.value();
902
- }
903
-
904
- /**
905
- * Generates a new PDF
906
- */
907
- async generatePDFRaw(requestParameters: GeneratePDFRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateSubmissionResponse>> {
908
- if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
909
- throw new runtime.RequiredError('templateId','Required parameter requestParameters.templateId was null or undefined when calling generatePDF.');
910
- }
911
-
912
- if (requestParameters.submission === null || requestParameters.submission === undefined) {
913
- throw new runtime.RequiredError('submission','Required parameter requestParameters.submission was null or undefined when calling generatePDF.');
914
- }
915
-
916
- const queryParameters: any = {};
917
-
918
- const headerParameters: runtime.HTTPHeaders = {};
919
-
920
- headerParameters['Content-Type'] = 'application/json';
921
-
922
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
923
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
924
- }
925
- const response = await this.request({
926
- path: `/templates/{template_id}/submissions`.replace(`{${"template_id"}}`, encodeURIComponent(String(requestParameters.templateId))),
927
- method: 'POST',
928
- headers: headerParameters,
929
- query: queryParameters,
930
- body: CreateSubmissionDataToJSON(requestParameters.submission),
931
- }, initOverrides);
932
-
933
- return new runtime.JSONApiResponse(response, (jsonValue) => CreateSubmissionResponseFromJSON(jsonValue));
934
- }
935
-
936
- /**
937
- * Generates a new PDF
938
- */
939
- async generatePDF(requestParameters: GeneratePDFRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSubmissionResponse> {
940
- const response = await this.generatePDFRaw(requestParameters, initOverrides);
941
- return await response.value();
942
- }
943
-
944
- /**
945
- * Check the status of a combined submission (merged PDFs)
946
- */
947
- async getCombinedSubmissionRaw(requestParameters: GetCombinedSubmissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CombinedSubmission>> {
948
- if (requestParameters.combinedSubmissionId === null || requestParameters.combinedSubmissionId === undefined) {
949
- throw new runtime.RequiredError('combinedSubmissionId','Required parameter requestParameters.combinedSubmissionId was null or undefined when calling getCombinedSubmission.');
950
- }
951
-
952
- const queryParameters: any = {};
953
-
954
- const headerParameters: runtime.HTTPHeaders = {};
955
-
956
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
957
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
958
- }
959
- const response = await this.request({
960
- path: `/combined_submissions/{combined_submission_id}`.replace(`{${"combined_submission_id"}}`, encodeURIComponent(String(requestParameters.combinedSubmissionId))),
961
- method: 'GET',
962
- headers: headerParameters,
963
- query: queryParameters,
964
- }, initOverrides);
965
-
966
- return new runtime.JSONApiResponse(response, (jsonValue) => CombinedSubmissionFromJSON(jsonValue));
967
- }
968
-
969
- /**
970
- * Check the status of a combined submission (merged PDFs)
971
- */
972
- async getCombinedSubmission(requestParameters: GetCombinedSubmissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CombinedSubmission> {
973
- const response = await this.getCombinedSubmissionRaw(requestParameters, initOverrides);
974
- return await response.value();
975
- }
976
-
977
- /**
978
- * Look up a submission data request
979
- */
980
- async getDataRequestRaw(requestParameters: GetDataRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubmissionDataRequest>> {
981
- if (requestParameters.dataRequestId === null || requestParameters.dataRequestId === undefined) {
982
- throw new runtime.RequiredError('dataRequestId','Required parameter requestParameters.dataRequestId was null or undefined when calling getDataRequest.');
983
- }
984
-
985
- const queryParameters: any = {};
986
-
987
- const headerParameters: runtime.HTTPHeaders = {};
988
-
989
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
990
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
991
- }
992
- const response = await this.request({
993
- path: `/data_requests/{data_request_id}`.replace(`{${"data_request_id"}}`, encodeURIComponent(String(requestParameters.dataRequestId))),
994
- method: 'GET',
995
- headers: headerParameters,
996
- query: queryParameters,
997
- }, initOverrides);
998
-
999
- return new runtime.JSONApiResponse(response, (jsonValue) => SubmissionDataRequestFromJSON(jsonValue));
1000
- }
1001
-
1002
- /**
1003
- * Look up a submission data request
1004
- */
1005
- async getDataRequest(requestParameters: GetDataRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubmissionDataRequest> {
1006
- const response = await this.getDataRequestRaw(requestParameters, initOverrides);
1007
- return await response.value();
1008
- }
1009
-
1010
- /**
1011
- * Fetch the full template attributes
1012
- */
1013
- async getFullTemplateRaw(requestParameters: GetFullTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FullTemplate>> {
1014
- if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
1015
- throw new runtime.RequiredError('templateId','Required parameter requestParameters.templateId was null or undefined when calling getFullTemplate.');
1016
- }
1017
-
1018
- const queryParameters: any = {};
1019
-
1020
- const headerParameters: runtime.HTTPHeaders = {};
1021
-
1022
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1023
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1024
- }
1025
- const response = await this.request({
1026
- path: `/templates/{template_id}?full=true`.replace(`{${"template_id"}}`, encodeURIComponent(String(requestParameters.templateId))),
1027
- method: 'GET',
1028
- headers: headerParameters,
1029
- query: queryParameters,
1030
- }, initOverrides);
1031
-
1032
- return new runtime.JSONApiResponse(response, (jsonValue) => FullTemplateFromJSON(jsonValue));
1033
- }
1034
-
1035
- /**
1036
- * Fetch the full template attributes
1037
- */
1038
- async getFullTemplate(requestParameters: GetFullTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FullTemplate> {
1039
- const response = await this.getFullTemplateRaw(requestParameters, initOverrides);
1040
- return await response.value();
1041
- }
1042
-
1043
- /**
1044
- * Get a presigned URL so that you can upload a file to our AWS S3 bucket
1045
- */
1046
- async getPresignUrlRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
1047
- const queryParameters: any = {};
1048
-
1049
- const headerParameters: runtime.HTTPHeaders = {};
1050
-
1051
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1052
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1053
- }
1054
- const response = await this.request({
1055
- path: `/uploads/presign`,
1056
- method: 'GET',
1057
- headers: headerParameters,
1058
- query: queryParameters,
1059
- }, initOverrides);
1060
-
1061
- return new runtime.JSONApiResponse<any>(response);
1062
- }
1063
-
1064
- /**
1065
- * Get a presigned URL so that you can upload a file to our AWS S3 bucket
1066
- */
1067
- async getPresignUrl(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
1068
- const response = await this.getPresignUrlRaw(initOverrides);
1069
- return await response.value();
1070
- }
1071
-
1072
- /**
1073
- * Check the status of a PDF
1074
- */
1075
- async getSubmissionRaw(requestParameters: GetSubmissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Submission>> {
1076
- if (requestParameters.submissionId === null || requestParameters.submissionId === undefined) {
1077
- throw new runtime.RequiredError('submissionId','Required parameter requestParameters.submissionId was null or undefined when calling getSubmission.');
1078
- }
1079
-
1080
- const queryParameters: any = {};
1081
-
1082
- if (requestParameters.includeData !== undefined) {
1083
- queryParameters['include_data'] = requestParameters.includeData;
1084
- }
1085
-
1086
- const headerParameters: runtime.HTTPHeaders = {};
1087
-
1088
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1089
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1090
- }
1091
- const response = await this.request({
1092
- path: `/submissions/{submission_id}`.replace(`{${"submission_id"}}`, encodeURIComponent(String(requestParameters.submissionId))),
1093
- method: 'GET',
1094
- headers: headerParameters,
1095
- query: queryParameters,
1096
- }, initOverrides);
1097
-
1098
- return new runtime.JSONApiResponse(response, (jsonValue) => SubmissionFromJSON(jsonValue));
1099
- }
1100
-
1101
- /**
1102
- * Check the status of a PDF
1103
- */
1104
- async getSubmission(requestParameters: GetSubmissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Submission> {
1105
- const response = await this.getSubmissionRaw(requestParameters, initOverrides);
1106
- return await response.value();
1107
- }
1108
-
1109
- /**
1110
- * Check the status of a submission batch job
1111
- */
1112
- async getSubmissionBatchRaw(requestParameters: GetSubmissionBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubmissionBatch>> {
1113
- if (requestParameters.submissionBatchId === null || requestParameters.submissionBatchId === undefined) {
1114
- throw new runtime.RequiredError('submissionBatchId','Required parameter requestParameters.submissionBatchId was null or undefined when calling getSubmissionBatch.');
1115
- }
1116
-
1117
- const queryParameters: any = {};
1118
-
1119
- if (requestParameters.includeSubmissions !== undefined) {
1120
- queryParameters['include_submissions'] = requestParameters.includeSubmissions;
1121
- }
1122
-
1123
- const headerParameters: runtime.HTTPHeaders = {};
1124
-
1125
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1126
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1127
- }
1128
- const response = await this.request({
1129
- path: `/submissions/batches/{submission_batch_id}`.replace(`{${"submission_batch_id"}}`, encodeURIComponent(String(requestParameters.submissionBatchId))),
1130
- method: 'GET',
1131
- headers: headerParameters,
1132
- query: queryParameters,
1133
- }, initOverrides);
1134
-
1135
- return new runtime.JSONApiResponse(response, (jsonValue) => SubmissionBatchFromJSON(jsonValue));
1136
- }
1137
-
1138
- /**
1139
- * Check the status of a submission batch job
1140
- */
1141
- async getSubmissionBatch(requestParameters: GetSubmissionBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubmissionBatch> {
1142
- const response = await this.getSubmissionBatchRaw(requestParameters, initOverrides);
1143
- return await response.value();
1144
- }
1145
-
1146
- /**
1147
- * Check the status of an uploaded template
1148
- */
1149
- async getTemplateRaw(requestParameters: GetTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Template>> {
1150
- if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
1151
- throw new runtime.RequiredError('templateId','Required parameter requestParameters.templateId was null or undefined when calling getTemplate.');
1152
- }
1153
-
1154
- const queryParameters: any = {};
1155
-
1156
- const headerParameters: runtime.HTTPHeaders = {};
1157
-
1158
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1159
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1160
- }
1161
- const response = await this.request({
1162
- path: `/templates/{template_id}`.replace(`{${"template_id"}}`, encodeURIComponent(String(requestParameters.templateId))),
1163
- method: 'GET',
1164
- headers: headerParameters,
1165
- query: queryParameters,
1166
- }, initOverrides);
1167
-
1168
- return new runtime.JSONApiResponse(response, (jsonValue) => TemplateFromJSON(jsonValue));
1169
- }
1170
-
1171
- /**
1172
- * Check the status of an uploaded template
1173
- */
1174
- async getTemplate(requestParameters: GetTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Template> {
1175
- const response = await this.getTemplateRaw(requestParameters, initOverrides);
1176
- return await response.value();
1177
- }
1178
-
1179
- /**
1180
- * Fetch the JSON schema for a template
1181
- */
1182
- async getTemplateSchemaRaw(requestParameters: GetTemplateSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
1183
- if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
1184
- throw new runtime.RequiredError('templateId','Required parameter requestParameters.templateId was null or undefined when calling getTemplateSchema.');
1185
- }
1186
-
1187
- const queryParameters: any = {};
1188
-
1189
- const headerParameters: runtime.HTTPHeaders = {};
1190
-
1191
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1192
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1193
- }
1194
- const response = await this.request({
1195
- path: `/templates/{template_id}/schema`.replace(`{${"template_id"}}`, encodeURIComponent(String(requestParameters.templateId))),
1196
- method: 'GET',
1197
- headers: headerParameters,
1198
- query: queryParameters,
1199
- }, initOverrides);
1200
-
1201
- return new runtime.JSONApiResponse<any>(response);
1202
- }
1203
-
1204
- /**
1205
- * Fetch the JSON schema for a template
1206
- */
1207
- async getTemplateSchema(requestParameters: GetTemplateSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
1208
- const response = await this.getTemplateSchemaRaw(requestParameters, initOverrides);
1209
- return await response.value();
1210
- }
1211
-
1212
- /**
1213
- * Get a list of all combined submissions
1214
- */
1215
- async listCombinedSubmissionsRaw(requestParameters: ListCombinedSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CombinedSubmission>>> {
1216
- const queryParameters: any = {};
1217
-
1218
- if (requestParameters.page !== undefined) {
1219
- queryParameters['page'] = requestParameters.page;
1220
- }
1221
-
1222
- if (requestParameters.perPage !== undefined) {
1223
- queryParameters['per_page'] = requestParameters.perPage;
1224
- }
1225
-
1226
- const headerParameters: runtime.HTTPHeaders = {};
1227
-
1228
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1229
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1230
- }
1231
- const response = await this.request({
1232
- path: `/combined_submissions`,
1233
- method: 'GET',
1234
- headers: headerParameters,
1235
- query: queryParameters,
1236
- }, initOverrides);
1237
-
1238
- return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CombinedSubmissionFromJSON));
1239
- }
1240
-
1241
- /**
1242
- * Get a list of all combined submissions
1243
- */
1244
- async listCombinedSubmissions(requestParameters: ListCombinedSubmissionsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CombinedSubmission>> {
1245
- const response = await this.listCombinedSubmissionsRaw(requestParameters, initOverrides);
1246
- return await response.value();
1247
- }
1248
-
1249
- /**
1250
- * Get a list of all folders
1251
- */
1252
- async listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Folder>>> {
1253
- const queryParameters: any = {};
1254
-
1255
- if (requestParameters.parentFolderId !== undefined) {
1256
- queryParameters['parent_folder_id'] = requestParameters.parentFolderId;
1257
- }
1258
-
1259
- const headerParameters: runtime.HTTPHeaders = {};
1260
-
1261
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1262
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1263
- }
1264
- const response = await this.request({
1265
- path: `/folders/`,
1266
- method: 'GET',
1267
- headers: headerParameters,
1268
- query: queryParameters,
1269
- }, initOverrides);
1270
-
1271
- return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(FolderFromJSON));
1272
- }
1273
-
1274
- /**
1275
- * Get a list of all folders
1276
- */
1277
- async listFolders(requestParameters: ListFoldersRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Folder>> {
1278
- const response = await this.listFoldersRaw(requestParameters, initOverrides);
1279
- return await response.value();
1280
- }
1281
-
1282
- /**
1283
- * List all submissions
1284
- */
1285
- async listSubmissionsRaw(requestParameters: ListSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListSubmissionsResponse>> {
1286
- const queryParameters: any = {};
1287
-
1288
- if (requestParameters.cursor !== undefined) {
1289
- queryParameters['cursor'] = requestParameters.cursor;
1290
- }
1291
-
1292
- if (requestParameters.limit !== undefined) {
1293
- queryParameters['limit'] = requestParameters.limit;
1294
- }
1295
-
1296
- if (requestParameters.createdAfter !== undefined) {
1297
- queryParameters['created_after'] = requestParameters.createdAfter;
1298
- }
1299
-
1300
- if (requestParameters.createdBefore !== undefined) {
1301
- queryParameters['created_before'] = requestParameters.createdBefore;
1302
- }
1303
-
1304
- if (requestParameters.type !== undefined) {
1305
- queryParameters['type'] = requestParameters.type;
1306
- }
1307
-
1308
- if (requestParameters.includeData !== undefined) {
1309
- queryParameters['include_data'] = requestParameters.includeData;
1310
- }
1311
-
1312
- const headerParameters: runtime.HTTPHeaders = {};
1313
-
1314
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1315
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1316
- }
1317
- const response = await this.request({
1318
- path: `/submissions`,
1319
- method: 'GET',
1320
- headers: headerParameters,
1321
- query: queryParameters,
1322
- }, initOverrides);
1323
-
1324
- return new runtime.JSONApiResponse(response, (jsonValue) => ListSubmissionsResponseFromJSON(jsonValue));
1325
- }
1326
-
1327
- /**
1328
- * List all submissions
1329
- */
1330
- async listSubmissions(requestParameters: ListSubmissionsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSubmissionsResponse> {
1331
- const response = await this.listSubmissionsRaw(requestParameters, initOverrides);
1332
- return await response.value();
1333
- }
1334
-
1335
- /**
1336
- * List all submissions for a given template
1337
- */
1338
- async listTemplateSubmissionsRaw(requestParameters: ListTemplateSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListSubmissionsResponse>> {
1339
- if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
1340
- throw new runtime.RequiredError('templateId','Required parameter requestParameters.templateId was null or undefined when calling listTemplateSubmissions.');
1341
- }
1342
-
1343
- const queryParameters: any = {};
1344
-
1345
- if (requestParameters.cursor !== undefined) {
1346
- queryParameters['cursor'] = requestParameters.cursor;
1347
- }
1348
-
1349
- if (requestParameters.limit !== undefined) {
1350
- queryParameters['limit'] = requestParameters.limit;
1351
- }
1352
-
1353
- if (requestParameters.createdAfter !== undefined) {
1354
- queryParameters['created_after'] = requestParameters.createdAfter;
1355
- }
1356
-
1357
- if (requestParameters.createdBefore !== undefined) {
1358
- queryParameters['created_before'] = requestParameters.createdBefore;
1359
- }
1360
-
1361
- if (requestParameters.type !== undefined) {
1362
- queryParameters['type'] = requestParameters.type;
1363
- }
1364
-
1365
- if (requestParameters.includeData !== undefined) {
1366
- queryParameters['include_data'] = requestParameters.includeData;
1367
- }
1368
-
1369
- const headerParameters: runtime.HTTPHeaders = {};
1370
-
1371
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1372
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1373
- }
1374
- const response = await this.request({
1375
- path: `/templates/{template_id}/submissions`.replace(`{${"template_id"}}`, encodeURIComponent(String(requestParameters.templateId))),
1376
- method: 'GET',
1377
- headers: headerParameters,
1378
- query: queryParameters,
1379
- }, initOverrides);
1380
-
1381
- return new runtime.JSONApiResponse(response, (jsonValue) => ListSubmissionsResponseFromJSON(jsonValue));
1382
- }
1383
-
1384
- /**
1385
- * List all submissions for a given template
1386
- */
1387
- async listTemplateSubmissions(requestParameters: ListTemplateSubmissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSubmissionsResponse> {
1388
- const response = await this.listTemplateSubmissionsRaw(requestParameters, initOverrides);
1389
- return await response.value();
1390
- }
1391
-
1392
- /**
1393
- * Get a list of all templates
1394
- */
1395
- async listTemplatesRaw(requestParameters: ListTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Template>>> {
1396
- const queryParameters: any = {};
1397
-
1398
- if (requestParameters.query !== undefined) {
1399
- queryParameters['query'] = requestParameters.query;
1400
- }
1401
-
1402
- if (requestParameters.parentFolderId !== undefined) {
1403
- queryParameters['parent_folder_id'] = requestParameters.parentFolderId;
1404
- }
1405
-
1406
- if (requestParameters.page !== undefined) {
1407
- queryParameters['page'] = requestParameters.page;
1408
- }
1409
-
1410
- if (requestParameters.perPage !== undefined) {
1411
- queryParameters['per_page'] = requestParameters.perPage;
1412
- }
1413
-
1414
- const headerParameters: runtime.HTTPHeaders = {};
1415
-
1416
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1417
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1418
- }
1419
- const response = await this.request({
1420
- path: `/templates`,
1421
- method: 'GET',
1422
- headers: headerParameters,
1423
- query: queryParameters,
1424
- }, initOverrides);
1425
-
1426
- return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(TemplateFromJSON));
1427
- }
1428
-
1429
- /**
1430
- * Get a list of all templates
1431
- */
1432
- async listTemplates(requestParameters: ListTemplatesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Template>> {
1433
- const response = await this.listTemplatesRaw(requestParameters, initOverrides);
1434
- return await response.value();
1435
- }
1436
-
1437
- /**
1438
- * Move a folder
1439
- */
1440
- async moveFolderToFolderRaw(requestParameters: MoveFolderToFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Folder>> {
1441
- if (requestParameters.folderId === null || requestParameters.folderId === undefined) {
1442
- throw new runtime.RequiredError('folderId','Required parameter requestParameters.folderId was null or undefined when calling moveFolderToFolder.');
1443
- }
1444
-
1445
- if (requestParameters.data === null || requestParameters.data === undefined) {
1446
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling moveFolderToFolder.');
1447
- }
1448
-
1449
- const queryParameters: any = {};
1450
-
1451
- const headerParameters: runtime.HTTPHeaders = {};
1452
-
1453
- headerParameters['Content-Type'] = 'application/json';
1454
-
1455
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1456
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1457
- }
1458
- const response = await this.request({
1459
- path: `/folders/{folder_id}/move`.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters.folderId))),
1460
- method: 'POST',
1461
- headers: headerParameters,
1462
- query: queryParameters,
1463
- body: MoveFolderDataToJSON(requestParameters.data),
1464
- }, initOverrides);
1465
-
1466
- return new runtime.JSONApiResponse(response, (jsonValue) => FolderFromJSON(jsonValue));
1467
- }
1468
-
1469
- /**
1470
- * Move a folder
1471
- */
1472
- async moveFolderToFolder(requestParameters: MoveFolderToFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Folder> {
1473
- const response = await this.moveFolderToFolderRaw(requestParameters, initOverrides);
1474
- return await response.value();
1475
- }
1476
-
1477
- /**
1478
- * Move Template to folder
1479
- */
1480
- async moveTemplateToFolderRaw(requestParameters: MoveTemplateToFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Template>> {
1481
- if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
1482
- throw new runtime.RequiredError('templateId','Required parameter requestParameters.templateId was null or undefined when calling moveTemplateToFolder.');
1483
- }
1484
-
1485
- if (requestParameters.data === null || requestParameters.data === undefined) {
1486
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling moveTemplateToFolder.');
1487
- }
1488
-
1489
- const queryParameters: any = {};
1490
-
1491
- const headerParameters: runtime.HTTPHeaders = {};
1492
-
1493
- headerParameters['Content-Type'] = 'application/json';
1494
-
1495
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1496
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1497
- }
1498
- const response = await this.request({
1499
- path: `/templates/{template_id}/move`.replace(`{${"template_id"}}`, encodeURIComponent(String(requestParameters.templateId))),
1500
- method: 'POST',
1501
- headers: headerParameters,
1502
- query: queryParameters,
1503
- body: MoveTemplateDataToJSON(requestParameters.data),
1504
- }, initOverrides);
1505
-
1506
- return new runtime.JSONApiResponse(response, (jsonValue) => TemplateFromJSON(jsonValue));
1507
- }
1508
-
1509
- /**
1510
- * Move Template to folder
1511
- */
1512
- async moveTemplateToFolder(requestParameters: MoveTemplateToFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Template> {
1513
- const response = await this.moveTemplateToFolderRaw(requestParameters, initOverrides);
1514
- return await response.value();
1515
- }
1516
-
1517
- /**
1518
- * Rename a folder
1519
- */
1520
- async renameFolderRaw(requestParameters: RenameFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
1521
- if (requestParameters.folderId === null || requestParameters.folderId === undefined) {
1522
- throw new runtime.RequiredError('folderId','Required parameter requestParameters.folderId was null or undefined when calling renameFolder.');
1523
- }
1524
-
1525
- if (requestParameters.data === null || requestParameters.data === undefined) {
1526
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling renameFolder.');
1527
- }
1528
-
1529
- const queryParameters: any = {};
1530
-
1531
- const headerParameters: runtime.HTTPHeaders = {};
1532
-
1533
- headerParameters['Content-Type'] = 'application/json';
1534
-
1535
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1536
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1537
- }
1538
- const response = await this.request({
1539
- path: `/folders/{folder_id}/rename`.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters.folderId))),
1540
- method: 'POST',
1541
- headers: headerParameters,
1542
- query: queryParameters,
1543
- body: RenameFolderDataToJSON(requestParameters.data),
1544
- }, initOverrides);
1545
-
1546
- return new runtime.VoidApiResponse(response);
1547
- }
1548
-
1549
- /**
1550
- * Rename a folder
1551
- */
1552
- async renameFolder(requestParameters: RenameFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
1553
- await this.renameFolderRaw(requestParameters, initOverrides);
1554
- }
1555
-
1556
- /**
1557
- * Test Authentication
1558
- */
1559
- async testAuthenticationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthenticationSuccessResponse>> {
1560
- const queryParameters: any = {};
1561
-
1562
- const headerParameters: runtime.HTTPHeaders = {};
1563
-
1564
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1565
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1566
- }
1567
- const response = await this.request({
1568
- path: `/authentication`,
1569
- method: 'GET',
1570
- headers: headerParameters,
1571
- query: queryParameters,
1572
- }, initOverrides);
1573
-
1574
- return new runtime.JSONApiResponse(response, (jsonValue) => AuthenticationSuccessResponseFromJSON(jsonValue));
1575
- }
1576
-
1577
- /**
1578
- * Test Authentication
1579
- */
1580
- async testAuthentication(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthenticationSuccessResponse> {
1581
- const response = await this.testAuthenticationRaw(initOverrides);
1582
- return await response.value();
1583
- }
1584
-
1585
- /**
1586
- * Update a submission data request
1587
- */
1588
- async updateDataRequestRaw(requestParameters: UpdateDataRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateDataRequestResponse>> {
1589
- if (requestParameters.dataRequestId === null || requestParameters.dataRequestId === undefined) {
1590
- throw new runtime.RequiredError('dataRequestId','Required parameter requestParameters.dataRequestId was null or undefined when calling updateDataRequest.');
1591
- }
1592
-
1593
- if (requestParameters.data === null || requestParameters.data === undefined) {
1594
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling updateDataRequest.');
1595
- }
1596
-
1597
- const queryParameters: any = {};
1598
-
1599
- const headerParameters: runtime.HTTPHeaders = {};
1600
-
1601
- headerParameters['Content-Type'] = 'application/json';
1602
-
1603
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1604
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1605
- }
1606
- const response = await this.request({
1607
- path: `/data_requests/{data_request_id}`.replace(`{${"data_request_id"}}`, encodeURIComponent(String(requestParameters.dataRequestId))),
1608
- method: 'PUT',
1609
- headers: headerParameters,
1610
- query: queryParameters,
1611
- body: UpdateSubmissionDataRequestDataToJSON(requestParameters.data),
1612
- }, initOverrides);
1613
-
1614
- return new runtime.JSONApiResponse(response, (jsonValue) => UpdateDataRequestResponseFromJSON(jsonValue));
1615
- }
1616
-
1617
- /**
1618
- * Update a submission data request
1619
- */
1620
- async updateDataRequest(requestParameters: UpdateDataRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateDataRequestResponse> {
1621
- const response = await this.updateDataRequestRaw(requestParameters, initOverrides);
1622
- return await response.value();
1623
- }
1624
-
1625
- /**
1626
- * Update a Template
1627
- */
1628
- async updateTemplateRaw(requestParameters: UpdateTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateTemplateResponse>> {
1629
- if (requestParameters.templateId === null || requestParameters.templateId === undefined) {
1630
- throw new runtime.RequiredError('templateId','Required parameter requestParameters.templateId was null or undefined when calling updateTemplate.');
1631
- }
1632
-
1633
- if (requestParameters.data === null || requestParameters.data === undefined) {
1634
- throw new runtime.RequiredError('data','Required parameter requestParameters.data was null or undefined when calling updateTemplate.');
1635
- }
1636
-
1637
- const queryParameters: any = {};
1638
-
1639
- const headerParameters: runtime.HTTPHeaders = {};
1640
-
1641
- headerParameters['Content-Type'] = 'application/json';
1642
-
1643
- if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
1644
- headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
1645
- }
1646
- const response = await this.request({
1647
- path: `/templates/{template_id}`.replace(`{${"template_id"}}`, encodeURIComponent(String(requestParameters.templateId))),
1648
- method: 'PUT',
1649
- headers: headerParameters,
1650
- query: queryParameters,
1651
- body: UpdateTemplateDataToJSON(requestParameters.data),
1652
- }, initOverrides);
1653
-
1654
- return new runtime.JSONApiResponse(response, (jsonValue) => UpdateTemplateResponseFromJSON(jsonValue));
1655
- }
1656
-
1657
- /**
1658
- * Update a Template
1659
- */
1660
- async updateTemplate(requestParameters: UpdateTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateTemplateResponse> {
1661
- const response = await this.updateTemplateRaw(requestParameters, initOverrides);
1662
- return await response.value();
1663
- }
1664
-
1665
- }