@orq-ai/node 3.1.2 → 3.1.3

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 (302) hide show
  1. package/README.md +34 -34
  2. package/docs/sdks/deployments/README.md +86 -9
  3. package/docs/sdks/files/README.md +2 -174
  4. package/docs/sdks/orq/README.md +1 -1
  5. package/docs/sdks/prompts/README.md +135 -128
  6. package/docs/sdks/promptsnippets/README.md +488 -0
  7. package/funcs/deploymentsInvoke.d.ts +1 -7
  8. package/funcs/deploymentsInvoke.d.ts.map +1 -1
  9. package/funcs/deploymentsInvoke.js +10 -11
  10. package/funcs/deploymentsInvoke.js.map +1 -1
  11. package/funcs/{deploymentsAll.d.ts → deploymentsList.d.ts} +2 -2
  12. package/funcs/deploymentsList.d.ts.map +1 -0
  13. package/funcs/{deploymentsAll.js → deploymentsList.js} +5 -4
  14. package/funcs/deploymentsList.js.map +1 -0
  15. package/funcs/deploymentsStream.d.ts +16 -0
  16. package/funcs/deploymentsStream.d.ts.map +1 -0
  17. package/funcs/deploymentsStream.js +125 -0
  18. package/funcs/deploymentsStream.js.map +1 -0
  19. package/funcs/{promptSnippetsFindOne.d.ts → promptSnippetsCreate.d.ts} +3 -3
  20. package/funcs/promptSnippetsCreate.d.ts.map +1 -0
  21. package/funcs/{promptsGetAll.js → promptSnippetsCreate.js} +8 -8
  22. package/funcs/promptSnippetsCreate.js.map +1 -0
  23. package/funcs/{filesUpdate.d.ts → promptSnippetsDelete.d.ts} +3 -3
  24. package/funcs/{promptsCreateVersion.d.ts.map → promptSnippetsDelete.d.ts.map} +1 -1
  25. package/funcs/{promptsDuplicate.js → promptSnippetsDelete.js} +8 -8
  26. package/funcs/promptSnippetsDelete.js.map +1 -0
  27. package/funcs/{promptsGetAll.d.ts → promptSnippetsGet.d.ts} +3 -3
  28. package/funcs/promptSnippetsGet.d.ts.map +1 -0
  29. package/funcs/{promptSnippetsFindOne.js → promptSnippetsGet.js} +6 -6
  30. package/funcs/promptSnippetsGet.js.map +1 -0
  31. package/funcs/{promptTemplatesGetAll.d.ts → promptSnippetsGetByKey.d.ts} +3 -3
  32. package/funcs/promptSnippetsGetByKey.d.ts.map +1 -0
  33. package/funcs/promptSnippetsGetByKey.js +109 -0
  34. package/funcs/promptSnippetsGetByKey.js.map +1 -0
  35. package/funcs/{promptsDuplicate.d.ts → promptSnippetsList.d.ts} +3 -3
  36. package/funcs/promptSnippetsList.d.ts.map +1 -0
  37. package/funcs/{promptTemplatesGetAll.js → promptSnippetsList.js} +13 -13
  38. package/funcs/promptSnippetsList.js.map +1 -0
  39. package/funcs/promptSnippetsUpdate.d.ts +13 -0
  40. package/funcs/promptSnippetsUpdate.d.ts.map +1 -0
  41. package/funcs/{promptsCreateVersion.js → promptSnippetsUpdate.js} +14 -10
  42. package/funcs/promptSnippetsUpdate.js.map +1 -0
  43. package/funcs/promptsCreate.d.ts +1 -1
  44. package/funcs/promptsCreate.js +2 -2
  45. package/funcs/promptsCreate.js.map +1 -1
  46. package/funcs/promptsDelete.js +1 -1
  47. package/funcs/promptsDelete.js.map +1 -1
  48. package/funcs/promptsGetVersion.d.ts +16 -0
  49. package/funcs/promptsGetVersion.d.ts.map +1 -0
  50. package/funcs/{filesUpdate.js → promptsGetVersion.js} +22 -12
  51. package/funcs/promptsGetVersion.js.map +1 -0
  52. package/funcs/promptsList.d.ts +15 -0
  53. package/funcs/promptsList.d.ts.map +1 -0
  54. package/funcs/promptsList.js +112 -0
  55. package/funcs/promptsList.js.map +1 -0
  56. package/funcs/promptsListVersions.d.ts +15 -0
  57. package/funcs/promptsListVersions.d.ts.map +1 -0
  58. package/funcs/promptsListVersions.js +118 -0
  59. package/funcs/promptsListVersions.js.map +1 -0
  60. package/funcs/{promptsCreateVersion.d.ts → promptsRetrieve.d.ts} +6 -3
  61. package/funcs/promptsRetrieve.d.ts.map +1 -0
  62. package/funcs/{promptsGetOne.js → promptsRetrieve.js} +10 -8
  63. package/funcs/promptsRetrieve.js.map +1 -0
  64. package/funcs/promptsUpdate.js +1 -1
  65. package/funcs/promptsUpdate.js.map +1 -1
  66. package/jsr.json +1 -1
  67. package/lib/config.d.ts +10 -2
  68. package/lib/config.d.ts.map +1 -1
  69. package/lib/config.js +2 -2
  70. package/lib/config.js.map +1 -1
  71. package/lib/env.d.ts +13 -0
  72. package/lib/env.d.ts.map +1 -1
  73. package/lib/env.js +17 -0
  74. package/lib/env.js.map +1 -1
  75. package/lib/sdks.js +1 -1
  76. package/lib/sdks.js.map +1 -1
  77. package/models/components/deployments.d.ts +0 -5
  78. package/models/components/deployments.d.ts.map +1 -1
  79. package/models/components/deployments.js +0 -2
  80. package/models/components/deployments.js.map +1 -1
  81. package/models/errors/getpromptversion.d.ts +36 -0
  82. package/models/errors/getpromptversion.d.ts.map +1 -0
  83. package/models/errors/getpromptversion.js +79 -0
  84. package/models/errors/getpromptversion.js.map +1 -0
  85. package/models/errors/index.d.ts +2 -0
  86. package/models/errors/index.d.ts.map +1 -1
  87. package/models/errors/index.js +2 -0
  88. package/models/errors/index.js.map +1 -1
  89. package/models/errors/updatepromptsnippet.d.ts +36 -0
  90. package/models/errors/updatepromptsnippet.d.ts.map +1 -0
  91. package/models/errors/updatepromptsnippet.js +79 -0
  92. package/models/errors/updatepromptsnippet.js.map +1 -0
  93. package/models/operations/createcontact.js +2 -2
  94. package/models/operations/createprompt.d.ts +702 -381
  95. package/models/operations/createprompt.d.ts.map +1 -1
  96. package/models/operations/createprompt.js +642 -482
  97. package/models/operations/createprompt.js.map +1 -1
  98. package/models/operations/createpromptsnippet.d.ts +3567 -0
  99. package/models/operations/createpromptsnippet.d.ts.map +1 -0
  100. package/models/operations/createpromptsnippet.js +3056 -0
  101. package/models/operations/createpromptsnippet.js.map +1 -0
  102. package/models/operations/deleteprompt.d.ts +1 -1
  103. package/models/operations/deletepromptsnippet.d.ts +32 -0
  104. package/models/operations/deletepromptsnippet.d.ts.map +1 -0
  105. package/models/operations/{duplicateprompt.js → deletepromptsnippet.js} +17 -17
  106. package/models/operations/deletepromptsnippet.js.map +1 -0
  107. package/models/operations/deploymentgetconfig.d.ts +39 -0
  108. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  109. package/models/operations/deploymentgetconfig.js +29 -4
  110. package/models/operations/deploymentgetconfig.js.map +1 -1
  111. package/models/operations/deploymentinvoke.d.ts +23 -683
  112. package/models/operations/deploymentinvoke.d.ts.map +1 -1
  113. package/models/operations/deploymentinvoke.js +23 -614
  114. package/models/operations/deploymentinvoke.js.map +1 -1
  115. package/models/operations/deployments.d.ts +54 -8
  116. package/models/operations/deployments.d.ts.map +1 -1
  117. package/models/operations/deployments.js +44 -13
  118. package/models/operations/deployments.js.map +1 -1
  119. package/models/operations/deploymentstream.d.ts +1622 -0
  120. package/models/operations/deploymentstream.d.ts.map +1 -0
  121. package/models/operations/deploymentstream.js +1571 -0
  122. package/models/operations/deploymentstream.js.map +1 -0
  123. package/models/operations/fileget.js +2 -2
  124. package/models/operations/filelist.d.ts +1 -5
  125. package/models/operations/filelist.d.ts.map +1 -1
  126. package/models/operations/filelist.js +4 -12
  127. package/models/operations/filelist.js.map +1 -1
  128. package/models/operations/fileupload.js +2 -2
  129. package/models/operations/findonebykeypromptsnippet.d.ts +2448 -0
  130. package/models/operations/findonebykeypromptsnippet.d.ts.map +1 -0
  131. package/models/operations/findonebykeypromptsnippet.js +2133 -0
  132. package/models/operations/findonebykeypromptsnippet.js.map +1 -0
  133. package/models/operations/findonepromptsnippet.d.ts +938 -4768
  134. package/models/operations/findonepromptsnippet.d.ts.map +1 -1
  135. package/models/operations/findonepromptsnippet.js +972 -4739
  136. package/models/operations/findonepromptsnippet.js.map +1 -1
  137. package/models/operations/getallprompts.d.ts +565 -9945
  138. package/models/operations/getallprompts.d.ts.map +1 -1
  139. package/models/operations/getallprompts.js +556 -8804
  140. package/models/operations/getallprompts.js.map +1 -1
  141. package/models/operations/getallpromptsnippets.d.ts +2512 -0
  142. package/models/operations/getallpromptsnippets.d.ts.map +1 -0
  143. package/models/operations/getallpromptsnippets.js +2195 -0
  144. package/models/operations/getallpromptsnippets.js.map +1 -0
  145. package/models/operations/getoneprompt.d.ts +1203 -1
  146. package/models/operations/getoneprompt.d.ts.map +1 -1
  147. package/models/operations/getoneprompt.js +1011 -1
  148. package/models/operations/getoneprompt.js.map +1 -1
  149. package/models/operations/getpromptversion.d.ts +1228 -0
  150. package/models/operations/getpromptversion.d.ts.map +1 -0
  151. package/models/operations/getpromptversion.js +1080 -0
  152. package/models/operations/getpromptversion.js.map +1 -0
  153. package/models/operations/index.d.ts +8 -5
  154. package/models/operations/index.d.ts.map +1 -1
  155. package/models/operations/index.js +8 -5
  156. package/models/operations/index.js.map +1 -1
  157. package/models/operations/listpromptversions.d.ts +1286 -0
  158. package/models/operations/listpromptversions.d.ts.map +1 -0
  159. package/models/operations/listpromptversions.js +1142 -0
  160. package/models/operations/listpromptversions.js.map +1 -0
  161. package/models/operations/updateprompt.d.ts +1113 -5971
  162. package/models/operations/updateprompt.d.ts.map +1 -1
  163. package/models/operations/updateprompt.js +1121 -5731
  164. package/models/operations/updateprompt.js.map +1 -1
  165. package/models/operations/updatepromptsnippet.d.ts +3595 -0
  166. package/models/operations/updatepromptsnippet.d.ts.map +1 -0
  167. package/models/operations/updatepromptsnippet.js +3116 -0
  168. package/models/operations/updatepromptsnippet.js.map +1 -0
  169. package/package.json +1 -1
  170. package/sdk/deployments.d.ts +10 -6
  171. package/sdk/deployments.d.ts.map +1 -1
  172. package/sdk/deployments.js +14 -6
  173. package/sdk/deployments.js.map +1 -1
  174. package/sdk/files.d.ts +0 -11
  175. package/sdk/files.d.ts.map +1 -1
  176. package/sdk/files.js +0 -17
  177. package/sdk/files.js.map +1 -1
  178. package/sdk/prompts.d.ts +26 -14
  179. package/sdk/prompts.d.ts.map +1 -1
  180. package/sdk/prompts.js +37 -25
  181. package/sdk/prompts.js.map +1 -1
  182. package/sdk/promptsnippets.d.ts +29 -0
  183. package/sdk/promptsnippets.d.ts.map +1 -0
  184. package/sdk/promptsnippets.js +54 -0
  185. package/sdk/promptsnippets.js.map +1 -0
  186. package/sdk/sdk.d.ts +3 -3
  187. package/sdk/sdk.d.ts.map +1 -1
  188. package/sdk/sdk.js +3 -3
  189. package/sdk/sdk.js.map +1 -1
  190. package/src/funcs/deploymentsInvoke.ts +21 -16
  191. package/src/funcs/{deploymentsAll.ts → deploymentsList.ts} +3 -2
  192. package/src/funcs/deploymentsStream.ts +150 -0
  193. package/src/funcs/{promptsGetAll.ts → promptSnippetsCreate.ts} +9 -9
  194. package/src/funcs/{promptsDuplicate.ts → promptSnippetsDelete.ts} +8 -7
  195. package/src/funcs/{promptSnippetsFindOne.ts → promptSnippetsGet.ts} +4 -4
  196. package/src/funcs/{filesUpdate.ts → promptSnippetsGetByKey.ts} +18 -16
  197. package/src/funcs/{promptTemplatesGetAll.ts → promptSnippetsList.ts} +16 -16
  198. package/src/funcs/{promptsCreateVersion.ts → promptSnippetsUpdate.ts} +20 -12
  199. package/src/funcs/promptsCreate.ts +2 -2
  200. package/src/funcs/promptsDelete.ts +1 -1
  201. package/src/funcs/promptsGetVersion.ts +146 -0
  202. package/src/funcs/promptsList.ts +133 -0
  203. package/src/funcs/promptsListVersions.ts +139 -0
  204. package/src/funcs/{promptsGetOne.ts → promptsRetrieve.ts} +10 -8
  205. package/src/funcs/promptsUpdate.ts +1 -1
  206. package/src/lib/config.ts +12 -2
  207. package/src/lib/env.ts +32 -0
  208. package/src/lib/sdks.ts +2 -2
  209. package/src/models/components/deployments.ts +0 -7
  210. package/src/models/errors/getpromptversion.ts +71 -0
  211. package/src/models/errors/index.ts +2 -0
  212. package/src/models/errors/updatepromptsnippet.ts +71 -0
  213. package/src/models/operations/createcontact.ts +2 -2
  214. package/src/models/operations/createprompt.ts +1049 -691
  215. package/src/models/operations/createpromptsnippet.ts +6239 -0
  216. package/src/models/operations/deleteprompt.ts +1 -1
  217. package/src/models/operations/deletepromptsnippet.ts +69 -0
  218. package/src/models/operations/deploymentgetconfig.ts +44 -0
  219. package/src/models/operations/deploymentinvoke.ts +182 -1423
  220. package/src/models/operations/deployments.ts +68 -18
  221. package/src/models/operations/deploymentstream.ts +3062 -0
  222. package/src/models/operations/fileget.ts +2 -2
  223. package/src/models/operations/filelist.ts +5 -17
  224. package/src/models/operations/fileupload.ts +2 -2
  225. package/src/models/operations/findonebykeypromptsnippet.ts +4483 -0
  226. package/src/models/operations/findonepromptsnippet.ts +1815 -11101
  227. package/src/models/operations/getallprompts.ts +1316 -17840
  228. package/src/models/operations/getallpromptsnippets.ts +4472 -0
  229. package/src/models/operations/getoneprompt.ts +1914 -1
  230. package/src/models/operations/getpromptversion.ts +2012 -0
  231. package/src/models/operations/index.ts +8 -5
  232. package/src/models/operations/listpromptversions.ts +2146 -0
  233. package/src/models/operations/updateprompt.ts +2003 -12493
  234. package/src/models/operations/updatepromptsnippet.ts +6544 -0
  235. package/src/sdk/deployments.ts +25 -11
  236. package/src/sdk/files.ts +0 -33
  237. package/src/sdk/prompts.ts +51 -39
  238. package/src/sdk/promptsnippets.ts +99 -0
  239. package/src/sdk/sdk.ts +4 -4
  240. package/docs/sdks/prompt/README.md +0 -6
  241. package/docs/sdks/snippets/README.md +0 -84
  242. package/docs/sdks/templates/README.md +0 -80
  243. package/funcs/deploymentsAll.d.ts.map +0 -1
  244. package/funcs/deploymentsAll.js.map +0 -1
  245. package/funcs/filesBulkUpload.d.ts +0 -15
  246. package/funcs/filesBulkUpload.d.ts.map +0 -1
  247. package/funcs/filesBulkUpload.js +0 -109
  248. package/funcs/filesBulkUpload.js.map +0 -1
  249. package/funcs/filesUpdate.d.ts.map +0 -1
  250. package/funcs/filesUpdate.js.map +0 -1
  251. package/funcs/promptSnippetsFindOne.d.ts.map +0 -1
  252. package/funcs/promptSnippetsFindOne.js.map +0 -1
  253. package/funcs/promptTemplatesGetAll.d.ts.map +0 -1
  254. package/funcs/promptTemplatesGetAll.js.map +0 -1
  255. package/funcs/promptsCreateVersion.js.map +0 -1
  256. package/funcs/promptsDuplicate.d.ts.map +0 -1
  257. package/funcs/promptsDuplicate.js.map +0 -1
  258. package/funcs/promptsGetAll.d.ts.map +0 -1
  259. package/funcs/promptsGetAll.js.map +0 -1
  260. package/funcs/promptsGetOne.d.ts +0 -12
  261. package/funcs/promptsGetOne.d.ts.map +0 -1
  262. package/funcs/promptsGetOne.js.map +0 -1
  263. package/models/operations/bulkfileupload.d.ts +0 -173
  264. package/models/operations/bulkfileupload.d.ts.map +0 -1
  265. package/models/operations/bulkfileupload.js +0 -210
  266. package/models/operations/bulkfileupload.js.map +0 -1
  267. package/models/operations/createpromptversion.d.ts +0 -2003
  268. package/models/operations/createpromptversion.d.ts.map +0 -1
  269. package/models/operations/createpromptversion.js +0 -1852
  270. package/models/operations/createpromptversion.js.map +0 -1
  271. package/models/operations/duplicateprompt.d.ts +0 -32
  272. package/models/operations/duplicateprompt.d.ts.map +0 -1
  273. package/models/operations/duplicateprompt.js.map +0 -1
  274. package/models/operations/fileupdate.d.ts +0 -143
  275. package/models/operations/fileupdate.d.ts.map +0 -1
  276. package/models/operations/fileupdate.js +0 -193
  277. package/models/operations/fileupdate.js.map +0 -1
  278. package/models/operations/getallprompttemplates.d.ts +0 -6607
  279. package/models/operations/getallprompttemplates.d.ts.map +0 -1
  280. package/models/operations/getallprompttemplates.js +0 -6225
  281. package/models/operations/getallprompttemplates.js.map +0 -1
  282. package/sdk/prompt.d.ts +0 -10
  283. package/sdk/prompt.d.ts.map +0 -1
  284. package/sdk/prompt.js +0 -19
  285. package/sdk/prompt.js.map +0 -1
  286. package/sdk/snippets.d.ts +0 -9
  287. package/sdk/snippets.d.ts.map +0 -1
  288. package/sdk/snippets.js +0 -19
  289. package/sdk/snippets.js.map +0 -1
  290. package/sdk/templates.d.ts +0 -9
  291. package/sdk/templates.d.ts.map +0 -1
  292. package/sdk/templates.js +0 -19
  293. package/sdk/templates.js.map +0 -1
  294. package/src/funcs/filesBulkUpload.ts +0 -129
  295. package/src/models/operations/bulkfileupload.ts +0 -315
  296. package/src/models/operations/createpromptversion.ts +0 -3703
  297. package/src/models/operations/duplicateprompt.ts +0 -69
  298. package/src/models/operations/fileupdate.ts +0 -298
  299. package/src/models/operations/getallprompttemplates.ts +0 -13690
  300. package/src/sdk/prompt.ts +0 -19
  301. package/src/sdk/snippets.ts +0 -24
  302. package/src/sdk/templates.ts +0 -24
@@ -1,129 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod";
6
- import { OrqCore } from "../core.js";
7
- import { appendForm } from "../lib/encodings.js";
8
- import * as M from "../lib/matchers.js";
9
- import { compactMap } from "../lib/primitives.js";
10
- import { safeParse } from "../lib/schemas.js";
11
- import { RequestOptions } from "../lib/sdks.js";
12
- import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
13
- import { pathToFunc } from "../lib/url.js";
14
- import { APIError } from "../models/errors/apierror.js";
15
- import {
16
- ConnectionError,
17
- InvalidRequestError,
18
- RequestAbortedError,
19
- RequestTimeoutError,
20
- UnexpectedClientError,
21
- } from "../models/errors/httpclienterrors.js";
22
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
23
- import * as operations from "../models/operations/index.js";
24
- import { Result } from "../types/fp.js";
25
-
26
- /**
27
- * Bulk upload file
28
- *
29
- * @remarks
30
- * Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config).
31
- */
32
- export async function filesBulkUpload(
33
- client: OrqCore,
34
- request: operations.BulkFileUploadRequestBody,
35
- options?: RequestOptions,
36
- ): Promise<
37
- Result<
38
- Array<operations.ResponseBody>,
39
- | APIError
40
- | SDKValidationError
41
- | UnexpectedClientError
42
- | InvalidRequestError
43
- | RequestAbortedError
44
- | RequestTimeoutError
45
- | ConnectionError
46
- >
47
- > {
48
- const parsed = safeParse(
49
- request,
50
- (value) => operations.BulkFileUploadRequestBody$outboundSchema.parse(value),
51
- "Input validation failed",
52
- );
53
- if (!parsed.ok) {
54
- return parsed;
55
- }
56
- const payload = parsed.value;
57
- const body = new FormData();
58
-
59
- appendForm(body, "files", payload.files);
60
- appendForm(body, "purpose", payload.purpose);
61
-
62
- const path = pathToFunc("/v2/files/bulk")();
63
-
64
- const headers = new Headers(compactMap({
65
- Accept: "application/json",
66
- }));
67
-
68
- const secConfig = await extractSecurity(client._options.apiKey);
69
- const securityInput = secConfig == null ? {} : { apiKey: secConfig };
70
- const requestSecurity = resolveGlobalSecurity(securityInput);
71
-
72
- const context = {
73
- operationID: "BulkFileUpload",
74
- oAuth2Scopes: [],
75
-
76
- resolvedSecurity: requestSecurity,
77
-
78
- securitySource: client._options.apiKey,
79
- retryConfig: options?.retries
80
- || client._options.retryConfig
81
- || { strategy: "none" },
82
- retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
83
- };
84
-
85
- const requestRes = client._createRequest(context, {
86
- security: requestSecurity,
87
- method: "POST",
88
- baseURL: options?.serverURL,
89
- path: path,
90
- headers: headers,
91
- body: body,
92
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
93
- }, options);
94
- if (!requestRes.ok) {
95
- return requestRes;
96
- }
97
- const req = requestRes.value;
98
-
99
- const doResult = await client._do(req, {
100
- context,
101
- errorCodes: ["400", "4XX", "5XX"],
102
- retryConfig: context.retryConfig,
103
- retryCodes: context.retryCodes,
104
- });
105
- if (!doResult.ok) {
106
- return doResult;
107
- }
108
- const response = doResult.value;
109
-
110
- const [result] = await M.match<
111
- Array<operations.ResponseBody>,
112
- | APIError
113
- | SDKValidationError
114
- | UnexpectedClientError
115
- | InvalidRequestError
116
- | RequestAbortedError
117
- | RequestTimeoutError
118
- | ConnectionError
119
- >(
120
- M.json(200, z.array(operations.ResponseBody$inboundSchema)),
121
- M.fail([400, "4XX"]),
122
- M.fail("5XX"),
123
- )(response);
124
- if (!result.ok) {
125
- return result;
126
- }
127
-
128
- return result;
129
- }
@@ -1,315 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod";
6
- import { remap as remap$ } from "../../lib/primitives.js";
7
- import { safeParse } from "../../lib/schemas.js";
8
- import { ClosedEnum } from "../../types/enums.js";
9
- import { Result as SafeParseResult } from "../../types/fp.js";
10
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
-
12
- export type Files = {
13
- fileName: string;
14
- content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
15
- };
16
-
17
- /**
18
- * The intended purpose of the uploaded file.
19
- */
20
- export const BulkFileUploadPurpose = {
21
- Retrieval: "retrieval",
22
- KnowledgeDatasource: "knowledge_datasource",
23
- } as const;
24
- /**
25
- * The intended purpose of the uploaded file.
26
- */
27
- export type BulkFileUploadPurpose = ClosedEnum<typeof BulkFileUploadPurpose>;
28
-
29
- export type BulkFileUploadRequestBody = {
30
- files: Array<Files>;
31
- /**
32
- * The intended purpose of the uploaded file.
33
- */
34
- purpose: BulkFileUploadPurpose;
35
- };
36
-
37
- /**
38
- * The intended purpose of the uploaded file.
39
- */
40
- export const BulkFileUploadFilesPurpose = {
41
- Retrieval: "retrieval",
42
- KnowledgeDatasource: "knowledge_datasource",
43
- } as const;
44
- /**
45
- * The intended purpose of the uploaded file.
46
- */
47
- export type BulkFileUploadFilesPurpose = ClosedEnum<
48
- typeof BulkFileUploadFilesPurpose
49
- >;
50
-
51
- export type ResponseBody = {
52
- id: string;
53
- /**
54
- * path to the file in the storage
55
- */
56
- objectName: string;
57
- /**
58
- * The intended purpose of the uploaded file.
59
- */
60
- purpose: BulkFileUploadFilesPurpose;
61
- bytes: number;
62
- fileName: string;
63
- /**
64
- * The id of the resource
65
- */
66
- workspaceId: string;
67
- /**
68
- * The date and time the resource was created
69
- */
70
- created?: Date | undefined;
71
- };
72
-
73
- /** @internal */
74
- export const Files$inboundSchema: z.ZodType<Files, z.ZodTypeDef, unknown> = z
75
- .object({
76
- fileName: z.string(),
77
- content: z.union([
78
- z.instanceof(ReadableStream<Uint8Array>),
79
- z.instanceof(Blob),
80
- z.instanceof(ArrayBuffer),
81
- z.instanceof(Uint8Array),
82
- ]),
83
- });
84
-
85
- /** @internal */
86
- export type Files$Outbound = {
87
- fileName: string;
88
- content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
89
- };
90
-
91
- /** @internal */
92
- export const Files$outboundSchema: z.ZodType<
93
- Files$Outbound,
94
- z.ZodTypeDef,
95
- Files
96
- > = z.object({
97
- fileName: z.string(),
98
- content: z.union([
99
- z.instanceof(ReadableStream<Uint8Array>),
100
- z.instanceof(Blob),
101
- z.instanceof(ArrayBuffer),
102
- z.instanceof(Uint8Array),
103
- ]),
104
- });
105
-
106
- /**
107
- * @internal
108
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
109
- */
110
- export namespace Files$ {
111
- /** @deprecated use `Files$inboundSchema` instead. */
112
- export const inboundSchema = Files$inboundSchema;
113
- /** @deprecated use `Files$outboundSchema` instead. */
114
- export const outboundSchema = Files$outboundSchema;
115
- /** @deprecated use `Files$Outbound` instead. */
116
- export type Outbound = Files$Outbound;
117
- }
118
-
119
- export function filesToJSON(files: Files): string {
120
- return JSON.stringify(Files$outboundSchema.parse(files));
121
- }
122
-
123
- export function filesFromJSON(
124
- jsonString: string,
125
- ): SafeParseResult<Files, SDKValidationError> {
126
- return safeParse(
127
- jsonString,
128
- (x) => Files$inboundSchema.parse(JSON.parse(x)),
129
- `Failed to parse 'Files' from JSON`,
130
- );
131
- }
132
-
133
- /** @internal */
134
- export const BulkFileUploadPurpose$inboundSchema: z.ZodNativeEnum<
135
- typeof BulkFileUploadPurpose
136
- > = z.nativeEnum(BulkFileUploadPurpose);
137
-
138
- /** @internal */
139
- export const BulkFileUploadPurpose$outboundSchema: z.ZodNativeEnum<
140
- typeof BulkFileUploadPurpose
141
- > = BulkFileUploadPurpose$inboundSchema;
142
-
143
- /**
144
- * @internal
145
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
146
- */
147
- export namespace BulkFileUploadPurpose$ {
148
- /** @deprecated use `BulkFileUploadPurpose$inboundSchema` instead. */
149
- export const inboundSchema = BulkFileUploadPurpose$inboundSchema;
150
- /** @deprecated use `BulkFileUploadPurpose$outboundSchema` instead. */
151
- export const outboundSchema = BulkFileUploadPurpose$outboundSchema;
152
- }
153
-
154
- /** @internal */
155
- export const BulkFileUploadRequestBody$inboundSchema: z.ZodType<
156
- BulkFileUploadRequestBody,
157
- z.ZodTypeDef,
158
- unknown
159
- > = z.object({
160
- files: z.array(z.lazy(() => Files$inboundSchema)),
161
- purpose: BulkFileUploadPurpose$inboundSchema,
162
- });
163
-
164
- /** @internal */
165
- export type BulkFileUploadRequestBody$Outbound = {
166
- files: Array<Files$Outbound>;
167
- purpose: string;
168
- };
169
-
170
- /** @internal */
171
- export const BulkFileUploadRequestBody$outboundSchema: z.ZodType<
172
- BulkFileUploadRequestBody$Outbound,
173
- z.ZodTypeDef,
174
- BulkFileUploadRequestBody
175
- > = z.object({
176
- files: z.array(z.lazy(() => Files$outboundSchema)),
177
- purpose: BulkFileUploadPurpose$outboundSchema,
178
- });
179
-
180
- /**
181
- * @internal
182
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
183
- */
184
- export namespace BulkFileUploadRequestBody$ {
185
- /** @deprecated use `BulkFileUploadRequestBody$inboundSchema` instead. */
186
- export const inboundSchema = BulkFileUploadRequestBody$inboundSchema;
187
- /** @deprecated use `BulkFileUploadRequestBody$outboundSchema` instead. */
188
- export const outboundSchema = BulkFileUploadRequestBody$outboundSchema;
189
- /** @deprecated use `BulkFileUploadRequestBody$Outbound` instead. */
190
- export type Outbound = BulkFileUploadRequestBody$Outbound;
191
- }
192
-
193
- export function bulkFileUploadRequestBodyToJSON(
194
- bulkFileUploadRequestBody: BulkFileUploadRequestBody,
195
- ): string {
196
- return JSON.stringify(
197
- BulkFileUploadRequestBody$outboundSchema.parse(bulkFileUploadRequestBody),
198
- );
199
- }
200
-
201
- export function bulkFileUploadRequestBodyFromJSON(
202
- jsonString: string,
203
- ): SafeParseResult<BulkFileUploadRequestBody, SDKValidationError> {
204
- return safeParse(
205
- jsonString,
206
- (x) => BulkFileUploadRequestBody$inboundSchema.parse(JSON.parse(x)),
207
- `Failed to parse 'BulkFileUploadRequestBody' from JSON`,
208
- );
209
- }
210
-
211
- /** @internal */
212
- export const BulkFileUploadFilesPurpose$inboundSchema: z.ZodNativeEnum<
213
- typeof BulkFileUploadFilesPurpose
214
- > = z.nativeEnum(BulkFileUploadFilesPurpose);
215
-
216
- /** @internal */
217
- export const BulkFileUploadFilesPurpose$outboundSchema: z.ZodNativeEnum<
218
- typeof BulkFileUploadFilesPurpose
219
- > = BulkFileUploadFilesPurpose$inboundSchema;
220
-
221
- /**
222
- * @internal
223
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
224
- */
225
- export namespace BulkFileUploadFilesPurpose$ {
226
- /** @deprecated use `BulkFileUploadFilesPurpose$inboundSchema` instead. */
227
- export const inboundSchema = BulkFileUploadFilesPurpose$inboundSchema;
228
- /** @deprecated use `BulkFileUploadFilesPurpose$outboundSchema` instead. */
229
- export const outboundSchema = BulkFileUploadFilesPurpose$outboundSchema;
230
- }
231
-
232
- /** @internal */
233
- export const ResponseBody$inboundSchema: z.ZodType<
234
- ResponseBody,
235
- z.ZodTypeDef,
236
- unknown
237
- > = z.object({
238
- _id: z.string(),
239
- object_name: z.string(),
240
- purpose: BulkFileUploadFilesPurpose$inboundSchema,
241
- bytes: z.number(),
242
- file_name: z.string(),
243
- workspace_id: z.string(),
244
- created: z.string().datetime({ offset: true }).default(
245
- "2025-01-02T13:55:01.176Z",
246
- ).transform(v => new Date(v)),
247
- }).transform((v) => {
248
- return remap$(v, {
249
- "_id": "id",
250
- "object_name": "objectName",
251
- "file_name": "fileName",
252
- "workspace_id": "workspaceId",
253
- });
254
- });
255
-
256
- /** @internal */
257
- export type ResponseBody$Outbound = {
258
- _id: string;
259
- object_name: string;
260
- purpose: string;
261
- bytes: number;
262
- file_name: string;
263
- workspace_id: string;
264
- created: string;
265
- };
266
-
267
- /** @internal */
268
- export const ResponseBody$outboundSchema: z.ZodType<
269
- ResponseBody$Outbound,
270
- z.ZodTypeDef,
271
- ResponseBody
272
- > = z.object({
273
- id: z.string(),
274
- objectName: z.string(),
275
- purpose: BulkFileUploadFilesPurpose$outboundSchema,
276
- bytes: z.number(),
277
- fileName: z.string(),
278
- workspaceId: z.string(),
279
- created: z.date().default(() => new Date("2025-01-02T13:55:01.176Z"))
280
- .transform(v => v.toISOString()),
281
- }).transform((v) => {
282
- return remap$(v, {
283
- id: "_id",
284
- objectName: "object_name",
285
- fileName: "file_name",
286
- workspaceId: "workspace_id",
287
- });
288
- });
289
-
290
- /**
291
- * @internal
292
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
293
- */
294
- export namespace ResponseBody$ {
295
- /** @deprecated use `ResponseBody$inboundSchema` instead. */
296
- export const inboundSchema = ResponseBody$inboundSchema;
297
- /** @deprecated use `ResponseBody$outboundSchema` instead. */
298
- export const outboundSchema = ResponseBody$outboundSchema;
299
- /** @deprecated use `ResponseBody$Outbound` instead. */
300
- export type Outbound = ResponseBody$Outbound;
301
- }
302
-
303
- export function responseBodyToJSON(responseBody: ResponseBody): string {
304
- return JSON.stringify(ResponseBody$outboundSchema.parse(responseBody));
305
- }
306
-
307
- export function responseBodyFromJSON(
308
- jsonString: string,
309
- ): SafeParseResult<ResponseBody, SDKValidationError> {
310
- return safeParse(
311
- jsonString,
312
- (x) => ResponseBody$inboundSchema.parse(JSON.parse(x)),
313
- `Failed to parse 'ResponseBody' from JSON`,
314
- );
315
- }