@orq-ai/node 3.1.0 → 3.1.2

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 (304) hide show
  1. package/README.md +34 -34
  2. package/docs/sdks/deployments/README.md +9 -86
  3. package/docs/sdks/files/README.md +174 -2
  4. package/docs/sdks/orq/README.md +1 -1
  5. package/docs/sdks/prompt/README.md +6 -0
  6. package/docs/sdks/prompts/README.md +128 -135
  7. package/docs/sdks/snippets/README.md +84 -0
  8. package/docs/sdks/templates/README.md +80 -0
  9. package/funcs/{deploymentsList.d.ts → deploymentsAll.d.ts} +2 -2
  10. package/funcs/deploymentsAll.d.ts.map +1 -0
  11. package/funcs/{deploymentsList.js → deploymentsAll.js} +4 -5
  12. package/funcs/deploymentsAll.js.map +1 -0
  13. package/funcs/deploymentsInvoke.d.ts +7 -1
  14. package/funcs/deploymentsInvoke.d.ts.map +1 -1
  15. package/funcs/deploymentsInvoke.js +11 -10
  16. package/funcs/deploymentsInvoke.js.map +1 -1
  17. package/funcs/filesBulkUpload.d.ts +15 -0
  18. package/funcs/filesBulkUpload.d.ts.map +1 -0
  19. package/funcs/{promptsList.js → filesBulkUpload.js} +15 -18
  20. package/funcs/filesBulkUpload.js.map +1 -0
  21. package/funcs/{promptSnippetsDelete.d.ts → filesUpdate.d.ts} +3 -3
  22. package/funcs/filesUpdate.d.ts.map +1 -0
  23. package/funcs/{promptSnippetsGetByKey.js → filesUpdate.js} +13 -12
  24. package/funcs/filesUpdate.js.map +1 -0
  25. package/funcs/{promptSnippetsList.d.ts → promptSnippetsFindOne.d.ts} +3 -3
  26. package/funcs/promptSnippetsFindOne.d.ts.map +1 -0
  27. package/funcs/{promptSnippetsGet.js → promptSnippetsFindOne.js} +6 -6
  28. package/funcs/promptSnippetsFindOne.js.map +1 -0
  29. package/funcs/{promptSnippetsCreate.d.ts → promptTemplatesGetAll.d.ts} +3 -3
  30. package/funcs/promptTemplatesGetAll.d.ts.map +1 -0
  31. package/funcs/{promptSnippetsList.js → promptTemplatesGetAll.js} +13 -13
  32. package/funcs/promptTemplatesGetAll.js.map +1 -0
  33. package/funcs/promptsCreate.d.ts +1 -1
  34. package/funcs/promptsCreate.js +2 -2
  35. package/funcs/promptsCreate.js.map +1 -1
  36. package/funcs/{promptsRetrieve.d.ts → promptsCreateVersion.d.ts} +3 -6
  37. package/funcs/{promptSnippetsDelete.d.ts.map → promptsCreateVersion.d.ts.map} +1 -1
  38. package/funcs/promptsCreateVersion.js +110 -0
  39. package/funcs/promptsCreateVersion.js.map +1 -0
  40. package/funcs/promptsDelete.js +1 -1
  41. package/funcs/promptsDelete.js.map +1 -1
  42. package/funcs/{promptSnippetsGet.d.ts → promptsDuplicate.d.ts} +3 -3
  43. package/funcs/promptsDuplicate.d.ts.map +1 -0
  44. package/funcs/{promptSnippetsDelete.js → promptsDuplicate.js} +8 -8
  45. package/funcs/promptsDuplicate.js.map +1 -0
  46. package/funcs/promptsGetAll.d.ts +12 -0
  47. package/funcs/promptsGetAll.d.ts.map +1 -0
  48. package/funcs/{promptSnippetsCreate.js → promptsGetAll.js} +8 -8
  49. package/funcs/promptsGetAll.js.map +1 -0
  50. package/funcs/promptsGetOne.d.ts +12 -0
  51. package/funcs/promptsGetOne.d.ts.map +1 -0
  52. package/funcs/{promptsRetrieve.js → promptsGetOne.js} +8 -10
  53. package/funcs/promptsGetOne.js.map +1 -0
  54. package/funcs/promptsUpdate.js +1 -1
  55. package/funcs/promptsUpdate.js.map +1 -1
  56. package/jsr.json +1 -1
  57. package/lib/config.d.ts +2 -10
  58. package/lib/config.d.ts.map +1 -1
  59. package/lib/config.js +2 -2
  60. package/lib/config.js.map +1 -1
  61. package/lib/env.d.ts +0 -13
  62. package/lib/env.d.ts.map +1 -1
  63. package/lib/env.js +0 -17
  64. package/lib/env.js.map +1 -1
  65. package/lib/sdks.js +1 -1
  66. package/lib/sdks.js.map +1 -1
  67. package/models/components/deployments.d.ts +5 -0
  68. package/models/components/deployments.d.ts.map +1 -1
  69. package/models/components/deployments.js +2 -0
  70. package/models/components/deployments.js.map +1 -1
  71. package/models/errors/index.d.ts +0 -2
  72. package/models/errors/index.d.ts.map +1 -1
  73. package/models/errors/index.js +0 -2
  74. package/models/errors/index.js.map +1 -1
  75. package/models/operations/bulkfileupload.d.ts +173 -0
  76. package/models/operations/bulkfileupload.d.ts.map +1 -0
  77. package/models/operations/bulkfileupload.js +210 -0
  78. package/models/operations/bulkfileupload.js.map +1 -0
  79. package/models/operations/createcontact.js +2 -2
  80. package/models/operations/createprompt.d.ts +381 -702
  81. package/models/operations/createprompt.d.ts.map +1 -1
  82. package/models/operations/createprompt.js +481 -641
  83. package/models/operations/createprompt.js.map +1 -1
  84. package/models/operations/createpromptversion.d.ts +2003 -0
  85. package/models/operations/createpromptversion.d.ts.map +1 -0
  86. package/models/operations/createpromptversion.js +1852 -0
  87. package/models/operations/createpromptversion.js.map +1 -0
  88. package/models/operations/deleteprompt.d.ts +1 -1
  89. package/models/operations/deploymentgetconfig.d.ts +0 -39
  90. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  91. package/models/operations/deploymentgetconfig.js +4 -29
  92. package/models/operations/deploymentgetconfig.js.map +1 -1
  93. package/models/operations/deploymentinvoke.d.ts +683 -23
  94. package/models/operations/deploymentinvoke.d.ts.map +1 -1
  95. package/models/operations/deploymentinvoke.js +614 -23
  96. package/models/operations/deploymentinvoke.js.map +1 -1
  97. package/models/operations/deployments.d.ts +8 -54
  98. package/models/operations/deployments.d.ts.map +1 -1
  99. package/models/operations/deployments.js +13 -44
  100. package/models/operations/deployments.js.map +1 -1
  101. package/models/operations/duplicateprompt.d.ts +32 -0
  102. package/models/operations/duplicateprompt.d.ts.map +1 -0
  103. package/models/operations/{deletepromptsnippet.js → duplicateprompt.js} +17 -17
  104. package/models/operations/duplicateprompt.js.map +1 -0
  105. package/models/operations/fileget.js +2 -2
  106. package/models/operations/filelist.d.ts +5 -1
  107. package/models/operations/filelist.d.ts.map +1 -1
  108. package/models/operations/filelist.js +12 -4
  109. package/models/operations/filelist.js.map +1 -1
  110. package/models/operations/fileupdate.d.ts +143 -0
  111. package/models/operations/fileupdate.d.ts.map +1 -0
  112. package/models/operations/fileupdate.js +193 -0
  113. package/models/operations/fileupdate.js.map +1 -0
  114. package/models/operations/fileupload.js +2 -2
  115. package/models/operations/findonepromptsnippet.d.ts +4768 -938
  116. package/models/operations/findonepromptsnippet.d.ts.map +1 -1
  117. package/models/operations/findonepromptsnippet.js +4751 -984
  118. package/models/operations/findonepromptsnippet.js.map +1 -1
  119. package/models/operations/getallprompts.d.ts +9926 -546
  120. package/models/operations/getallprompts.d.ts.map +1 -1
  121. package/models/operations/getallprompts.js +8805 -557
  122. package/models/operations/getallprompts.js.map +1 -1
  123. package/models/operations/getallprompttemplates.d.ts +6607 -0
  124. package/models/operations/getallprompttemplates.d.ts.map +1 -0
  125. package/models/operations/getallprompttemplates.js +6225 -0
  126. package/models/operations/getallprompttemplates.js.map +1 -0
  127. package/models/operations/getoneprompt.d.ts +1 -1203
  128. package/models/operations/getoneprompt.d.ts.map +1 -1
  129. package/models/operations/getoneprompt.js +1 -1011
  130. package/models/operations/getoneprompt.js.map +1 -1
  131. package/models/operations/index.d.ts +5 -8
  132. package/models/operations/index.d.ts.map +1 -1
  133. package/models/operations/index.js +5 -8
  134. package/models/operations/index.js.map +1 -1
  135. package/models/operations/updateprompt.d.ts +5979 -1121
  136. package/models/operations/updateprompt.d.ts.map +1 -1
  137. package/models/operations/updateprompt.js +5729 -1119
  138. package/models/operations/updateprompt.js.map +1 -1
  139. package/package.json +1 -1
  140. package/sdk/deployments.d.ts +6 -10
  141. package/sdk/deployments.d.ts.map +1 -1
  142. package/sdk/deployments.js +6 -14
  143. package/sdk/deployments.js.map +1 -1
  144. package/sdk/files.d.ts +11 -0
  145. package/sdk/files.d.ts.map +1 -1
  146. package/sdk/files.js +17 -0
  147. package/sdk/files.js.map +1 -1
  148. package/sdk/prompt.d.ts +10 -0
  149. package/sdk/prompt.d.ts.map +1 -0
  150. package/sdk/prompt.js +19 -0
  151. package/sdk/prompt.js.map +1 -0
  152. package/sdk/prompts.d.ts +14 -26
  153. package/sdk/prompts.d.ts.map +1 -1
  154. package/sdk/prompts.js +25 -37
  155. package/sdk/prompts.js.map +1 -1
  156. package/sdk/sdk.d.ts +3 -3
  157. package/sdk/sdk.d.ts.map +1 -1
  158. package/sdk/sdk.js +3 -3
  159. package/sdk/sdk.js.map +1 -1
  160. package/sdk/snippets.d.ts +9 -0
  161. package/sdk/snippets.d.ts.map +1 -0
  162. package/sdk/snippets.js +19 -0
  163. package/sdk/snippets.js.map +1 -0
  164. package/sdk/templates.d.ts +9 -0
  165. package/sdk/templates.d.ts.map +1 -0
  166. package/sdk/templates.js +19 -0
  167. package/sdk/templates.js.map +1 -0
  168. package/src/funcs/{deploymentsList.ts → deploymentsAll.ts} +2 -3
  169. package/src/funcs/deploymentsInvoke.ts +16 -21
  170. package/src/funcs/filesBulkUpload.ts +129 -0
  171. package/src/funcs/{promptSnippetsGetByKey.ts → filesUpdate.ts} +16 -18
  172. package/src/funcs/{promptSnippetsGet.ts → promptSnippetsFindOne.ts} +4 -4
  173. package/src/funcs/{promptSnippetsList.ts → promptTemplatesGetAll.ts} +16 -16
  174. package/src/funcs/promptsCreate.ts +2 -2
  175. package/src/funcs/promptsCreateVersion.ts +131 -0
  176. package/src/funcs/promptsDelete.ts +1 -1
  177. package/src/funcs/{promptSnippetsDelete.ts → promptsDuplicate.ts} +7 -8
  178. package/src/funcs/{promptSnippetsCreate.ts → promptsGetAll.ts} +9 -9
  179. package/src/funcs/{promptsRetrieve.ts → promptsGetOne.ts} +8 -10
  180. package/src/funcs/promptsUpdate.ts +1 -1
  181. package/src/lib/config.ts +2 -12
  182. package/src/lib/env.ts +0 -32
  183. package/src/lib/sdks.ts +2 -2
  184. package/src/models/components/deployments.ts +7 -0
  185. package/src/models/errors/index.ts +0 -2
  186. package/src/models/operations/bulkfileupload.ts +315 -0
  187. package/src/models/operations/createcontact.ts +2 -2
  188. package/src/models/operations/createprompt.ts +690 -1048
  189. package/src/models/operations/createpromptversion.ts +3703 -0
  190. package/src/models/operations/deleteprompt.ts +1 -1
  191. package/src/models/operations/deploymentgetconfig.ts +0 -44
  192. package/src/models/operations/deploymentinvoke.ts +1415 -174
  193. package/src/models/operations/deployments.ts +18 -68
  194. package/src/models/operations/duplicateprompt.ts +69 -0
  195. package/src/models/operations/fileget.ts +2 -2
  196. package/src/models/operations/filelist.ts +17 -5
  197. package/src/models/operations/fileupdate.ts +298 -0
  198. package/src/models/operations/fileupload.ts +2 -2
  199. package/src/models/operations/findonepromptsnippet.ts +11104 -1818
  200. package/src/models/operations/getallprompts.ts +17860 -1336
  201. package/src/models/operations/getallprompttemplates.ts +13690 -0
  202. package/src/models/operations/getoneprompt.ts +1 -1914
  203. package/src/models/operations/index.ts +5 -8
  204. package/src/models/operations/updateprompt.ts +12561 -2071
  205. package/src/sdk/deployments.ts +11 -25
  206. package/src/sdk/files.ts +33 -0
  207. package/src/sdk/prompt.ts +19 -0
  208. package/src/sdk/prompts.ts +39 -51
  209. package/src/sdk/sdk.ts +4 -4
  210. package/src/sdk/snippets.ts +24 -0
  211. package/src/sdk/templates.ts +24 -0
  212. package/docs/sdks/promptsnippets/README.md +0 -488
  213. package/funcs/deploymentsList.d.ts.map +0 -1
  214. package/funcs/deploymentsList.js.map +0 -1
  215. package/funcs/deploymentsStream.d.ts +0 -16
  216. package/funcs/deploymentsStream.d.ts.map +0 -1
  217. package/funcs/deploymentsStream.js +0 -125
  218. package/funcs/deploymentsStream.js.map +0 -1
  219. package/funcs/promptSnippetsCreate.d.ts.map +0 -1
  220. package/funcs/promptSnippetsCreate.js.map +0 -1
  221. package/funcs/promptSnippetsDelete.js.map +0 -1
  222. package/funcs/promptSnippetsGet.d.ts.map +0 -1
  223. package/funcs/promptSnippetsGet.js.map +0 -1
  224. package/funcs/promptSnippetsGetByKey.d.ts +0 -12
  225. package/funcs/promptSnippetsGetByKey.d.ts.map +0 -1
  226. package/funcs/promptSnippetsGetByKey.js.map +0 -1
  227. package/funcs/promptSnippetsList.d.ts.map +0 -1
  228. package/funcs/promptSnippetsList.js.map +0 -1
  229. package/funcs/promptSnippetsUpdate.d.ts +0 -13
  230. package/funcs/promptSnippetsUpdate.d.ts.map +0 -1
  231. package/funcs/promptSnippetsUpdate.js +0 -114
  232. package/funcs/promptSnippetsUpdate.js.map +0 -1
  233. package/funcs/promptsGetVersion.d.ts +0 -16
  234. package/funcs/promptsGetVersion.d.ts.map +0 -1
  235. package/funcs/promptsGetVersion.js +0 -120
  236. package/funcs/promptsGetVersion.js.map +0 -1
  237. package/funcs/promptsList.d.ts +0 -15
  238. package/funcs/promptsList.d.ts.map +0 -1
  239. package/funcs/promptsList.js.map +0 -1
  240. package/funcs/promptsListVersions.d.ts +0 -15
  241. package/funcs/promptsListVersions.d.ts.map +0 -1
  242. package/funcs/promptsListVersions.js +0 -118
  243. package/funcs/promptsListVersions.js.map +0 -1
  244. package/funcs/promptsRetrieve.d.ts.map +0 -1
  245. package/funcs/promptsRetrieve.js.map +0 -1
  246. package/models/errors/getpromptversion.d.ts +0 -36
  247. package/models/errors/getpromptversion.d.ts.map +0 -1
  248. package/models/errors/getpromptversion.js +0 -79
  249. package/models/errors/getpromptversion.js.map +0 -1
  250. package/models/errors/updatepromptsnippet.d.ts +0 -36
  251. package/models/errors/updatepromptsnippet.d.ts.map +0 -1
  252. package/models/errors/updatepromptsnippet.js +0 -79
  253. package/models/errors/updatepromptsnippet.js.map +0 -1
  254. package/models/operations/createpromptsnippet.d.ts +0 -3567
  255. package/models/operations/createpromptsnippet.d.ts.map +0 -1
  256. package/models/operations/createpromptsnippet.js +0 -3056
  257. package/models/operations/createpromptsnippet.js.map +0 -1
  258. package/models/operations/deletepromptsnippet.d.ts +0 -32
  259. package/models/operations/deletepromptsnippet.d.ts.map +0 -1
  260. package/models/operations/deletepromptsnippet.js.map +0 -1
  261. package/models/operations/deploymentstream.d.ts +0 -1622
  262. package/models/operations/deploymentstream.d.ts.map +0 -1
  263. package/models/operations/deploymentstream.js +0 -1571
  264. package/models/operations/deploymentstream.js.map +0 -1
  265. package/models/operations/findonebykeypromptsnippet.d.ts +0 -2448
  266. package/models/operations/findonebykeypromptsnippet.d.ts.map +0 -1
  267. package/models/operations/findonebykeypromptsnippet.js +0 -2133
  268. package/models/operations/findonebykeypromptsnippet.js.map +0 -1
  269. package/models/operations/getallpromptsnippets.d.ts +0 -2512
  270. package/models/operations/getallpromptsnippets.d.ts.map +0 -1
  271. package/models/operations/getallpromptsnippets.js +0 -2195
  272. package/models/operations/getallpromptsnippets.js.map +0 -1
  273. package/models/operations/getpromptversion.d.ts +0 -1228
  274. package/models/operations/getpromptversion.d.ts.map +0 -1
  275. package/models/operations/getpromptversion.js +0 -1080
  276. package/models/operations/getpromptversion.js.map +0 -1
  277. package/models/operations/listpromptversions.d.ts +0 -1286
  278. package/models/operations/listpromptversions.d.ts.map +0 -1
  279. package/models/operations/listpromptversions.js +0 -1142
  280. package/models/operations/listpromptversions.js.map +0 -1
  281. package/models/operations/updatepromptsnippet.d.ts +0 -3595
  282. package/models/operations/updatepromptsnippet.d.ts.map +0 -1
  283. package/models/operations/updatepromptsnippet.js +0 -3116
  284. package/models/operations/updatepromptsnippet.js.map +0 -1
  285. package/sdk/promptsnippets.d.ts +0 -29
  286. package/sdk/promptsnippets.d.ts.map +0 -1
  287. package/sdk/promptsnippets.js +0 -54
  288. package/sdk/promptsnippets.js.map +0 -1
  289. package/src/funcs/deploymentsStream.ts +0 -150
  290. package/src/funcs/promptSnippetsUpdate.ts +0 -139
  291. package/src/funcs/promptsGetVersion.ts +0 -146
  292. package/src/funcs/promptsList.ts +0 -133
  293. package/src/funcs/promptsListVersions.ts +0 -139
  294. package/src/models/errors/getpromptversion.ts +0 -71
  295. package/src/models/errors/updatepromptsnippet.ts +0 -71
  296. package/src/models/operations/createpromptsnippet.ts +0 -6239
  297. package/src/models/operations/deletepromptsnippet.ts +0 -69
  298. package/src/models/operations/deploymentstream.ts +0 -3062
  299. package/src/models/operations/findonebykeypromptsnippet.ts +0 -4483
  300. package/src/models/operations/getallpromptsnippets.ts +0 -4472
  301. package/src/models/operations/getpromptversion.ts +0 -2012
  302. package/src/models/operations/listpromptversions.ts +0 -2146
  303. package/src/models/operations/updatepromptsnippet.ts +0 -6544
  304. package/src/sdk/promptsnippets.ts +0 -99
@@ -2,6 +2,7 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
+ import * as z from "zod";
5
6
  import { OrqCore } from "../core.js";
6
7
  import { encodeSimple } from "../lib/encodings.js";
7
8
  import * as M from "../lib/matchers.js";
@@ -23,18 +24,15 @@ import * as operations from "../models/operations/index.js";
23
24
  import { Result } from "../types/fp.js";
24
25
 
25
26
  /**
26
- * Retrieve a prompt
27
- *
28
- * @remarks
29
- * Retrieves a prompt object
27
+ * Get one prompt
30
28
  */
31
- export async function promptsRetrieve(
29
+ export async function promptsGetOne(
32
30
  client: OrqCore,
33
31
  request: operations.GetOnePromptRequest,
34
32
  options?: RequestOptions,
35
33
  ): Promise<
36
34
  Result<
37
- operations.GetOnePromptResponseBody,
35
+ void,
38
36
  | APIError
39
37
  | SDKValidationError
40
38
  | UnexpectedClientError
@@ -62,10 +60,10 @@ export async function promptsRetrieve(
62
60
  }),
63
61
  };
64
62
 
65
- const path = pathToFunc("/v2/prompts/{id}")(pathParams);
63
+ const path = pathToFunc("/v2/resources/prompts/{id}")(pathParams);
66
64
 
67
65
  const headers = new Headers(compactMap({
68
- Accept: "application/json",
66
+ Accept: "*/*",
69
67
  }));
70
68
 
71
69
  const secConfig = await extractSecurity(client._options.apiKey);
@@ -111,7 +109,7 @@ export async function promptsRetrieve(
111
109
  const response = doResult.value;
112
110
 
113
111
  const [result] = await M.match<
114
- operations.GetOnePromptResponseBody,
112
+ void,
115
113
  | APIError
116
114
  | SDKValidationError
117
115
  | UnexpectedClientError
@@ -120,7 +118,7 @@ export async function promptsRetrieve(
120
118
  | RequestTimeoutError
121
119
  | ConnectionError
122
120
  >(
123
- M.json(200, operations.GetOnePromptResponseBody$inboundSchema),
121
+ M.nil(200, z.void()),
124
122
  M.fail("4XX"),
125
123
  M.fail("5XX"),
126
124
  )(response);
@@ -61,7 +61,7 @@ export async function promptsUpdate(
61
61
  }),
62
62
  };
63
63
 
64
- const path = pathToFunc("/v2/prompts/{id}")(pathParams);
64
+ const path = pathToFunc("/v2/resources/prompts/{id}")(pathParams);
65
65
 
66
66
  const headers = new Headers(compactMap({
67
67
  "Content-Type": "application/json",
package/src/lib/config.ts CHANGED
@@ -17,16 +17,6 @@ export const ServerList = [
17
17
  export type SDKOptions = {
18
18
  apiKey?: string | (() => Promise<string>);
19
19
 
20
- /**
21
- * Allows setting the contactId parameter for all supported operations
22
- */
23
- contactId?: string | undefined;
24
-
25
- /**
26
- * Allows setting the environment parameter for all supported operations
27
- */
28
- environment?: string | undefined;
29
-
30
20
  httpClient?: HTTPClient;
31
21
  /**
32
22
  * Allows overriding the default server used by the SDK
@@ -64,7 +54,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
64
54
  export const SDK_METADATA = {
65
55
  language: "typescript",
66
56
  openapiDocVersion: "2.0",
67
- sdkVersion: "3.1.0",
57
+ sdkVersion: "3.1.2",
68
58
  genVersion: "2.506.0",
69
- userAgent: "speakeasy-sdk/typescript 3.1.0 2.506.0 2.0 @orq-ai/node",
59
+ userAgent: "speakeasy-sdk/typescript 3.1.2 2.506.0 2.0 @orq-ai/node",
70
60
  } as const;
package/src/lib/env.ts CHANGED
@@ -5,30 +5,16 @@
5
5
  import { dlv } from "./dlv.js";
6
6
 
7
7
  import * as z from "zod";
8
- import { SDKOptions } from "./config.js";
9
8
 
10
9
  export interface Env {
11
10
  ORQ_API_KEY?: string | undefined;
12
11
 
13
- /**
14
- * Sets the contactId parameter for all supported operations
15
- */
16
- ORQ_CONTACT_ID?: string | undefined;
17
-
18
- /**
19
- * Sets the environment parameter for all supported operations
20
- */
21
- ORQ_ENVIRONMENT?: string | undefined;
22
-
23
12
  ORQ_DEBUG?: boolean | undefined;
24
13
  }
25
14
 
26
15
  export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
27
16
  ORQ_API_KEY: z.string().optional(),
28
17
 
29
- ORQ_CONTACT_ID: z.string().optional(),
30
- ORQ_ENVIRONMENT: z.string().optional(),
31
-
32
18
  ORQ_DEBUG: z.coerce.boolean().optional(),
33
19
  });
34
20
 
@@ -53,21 +39,3 @@ export function env(): Env {
53
39
  export function resetEnv() {
54
40
  envMemo = undefined;
55
41
  }
56
-
57
- /**
58
- * Populates global parameters with environment variables.
59
- */
60
- export function fillGlobals(options: SDKOptions): SDKOptions {
61
- const clone = { ...options };
62
-
63
- const envVars = env();
64
-
65
- if (typeof envVars.ORQ_CONTACT_ID !== "undefined") {
66
- clone.contactId ??= envVars.ORQ_CONTACT_ID;
67
- }
68
- if (typeof envVars.ORQ_ENVIRONMENT !== "undefined") {
69
- clone.environment ??= envVars.ORQ_ENVIRONMENT;
70
- }
71
-
72
- return clone;
73
- }
package/src/lib/sdks.ts CHANGED
@@ -15,7 +15,7 @@ import { ERR, OK, Result } from "../types/fp.js";
15
15
  import { stringToBase64 } from "./base64.js";
16
16
  import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "./config.js";
17
17
  import { encodeForm } from "./encodings.js";
18
- import { env, fillGlobals } from "./env.js";
18
+ import { env } from "./env.js";
19
19
  import {
20
20
  HTTPClient,
21
21
  isAbortError,
@@ -94,7 +94,7 @@ export class ClientSDK {
94
94
  } else {
95
95
  this.#hooks = new SDKHooks();
96
96
  }
97
- this._options = { ...fillGlobals(options), hooks: this.#hooks };
97
+ this._options = { ...options, hooks: this.#hooks };
98
98
 
99
99
  const url = serverURLFromOptions(options);
100
100
  if (url) {
@@ -247,6 +247,10 @@ export type Deployments = {
247
247
  * The deployment key to invoke
248
248
  */
249
249
  key: string;
250
+ /**
251
+ * If set, partial message content will be sent. Tokens will be sent as data-only `server-sent events` as they become available, with the stream terminated by a `data: [DONE]` message.
252
+ */
253
+ stream?: boolean | undefined;
250
254
  /**
251
255
  * Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used.
252
256
  */
@@ -1579,6 +1583,7 @@ export const Deployments$inboundSchema: z.ZodType<
1579
1583
  unknown
1580
1584
  > = z.object({
1581
1585
  key: z.string(),
1586
+ stream: z.boolean().default(false),
1582
1587
  inputs: z.record(z.union([z.string(), z.number(), z.boolean()])).optional(),
1583
1588
  context: z.record(z.any()).optional(),
1584
1589
  prefix_messages: z.array(z.lazy(() => PrefixMessages$inboundSchema))
@@ -1601,6 +1606,7 @@ export const Deployments$inboundSchema: z.ZodType<
1601
1606
  /** @internal */
1602
1607
  export type Deployments$Outbound = {
1603
1608
  key: string;
1609
+ stream: boolean;
1604
1610
  inputs?: { [k: string]: string | number | boolean } | undefined;
1605
1611
  context?: { [k: string]: any } | undefined;
1606
1612
  prefix_messages?: Array<PrefixMessages$Outbound> | undefined;
@@ -1619,6 +1625,7 @@ export const Deployments$outboundSchema: z.ZodType<
1619
1625
  Deployments
1620
1626
  > = z.object({
1621
1627
  key: z.string(),
1628
+ stream: z.boolean().default(false),
1622
1629
  inputs: z.record(z.union([z.string(), z.number(), z.boolean()])).optional(),
1623
1630
  context: z.record(z.any()).optional(),
1624
1631
  prefixMessages: z.array(z.lazy(() => PrefixMessages$outboundSchema))
@@ -3,9 +3,7 @@
3
3
  */
4
4
 
5
5
  export * from "./apierror.js";
6
- export * from "./getpromptversion.js";
7
6
  export * from "./honoapierror.js";
8
7
  export * from "./httpclienterrors.js";
9
8
  export * from "./sdkvalidationerror.js";
10
9
  export * from "./updateprompt.js";
11
- export * from "./updatepromptsnippet.js";
@@ -0,0 +1,315 @@
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
+ }
@@ -177,7 +177,7 @@ export const CreateContactResponseBody$inboundSchema: z.ZodType<
177
177
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
178
178
  .optional(),
179
179
  updated: z.string().datetime({ offset: true }).default(
180
- "2025-02-11T16:43:21.610Z",
180
+ "2025-01-02T13:55:01.056Z",
181
181
  ).transform(v => new Date(v)),
182
182
  }).transform((v) => {
183
183
  return remap$(v, {
@@ -214,7 +214,7 @@ export const CreateContactResponseBody$outboundSchema: z.ZodType<
214
214
  tags: z.array(z.string()).optional(),
215
215
  metadata: z.record(z.any()).optional(),
216
216
  created: z.date().transform(v => v.toISOString()).optional(),
217
- updated: z.date().default(() => new Date("2025-02-11T16:43:21.610Z"))
217
+ updated: z.date().default(() => new Date("2025-01-02T13:55:01.056Z"))
218
218
  .transform(v => v.toISOString()),
219
219
  }).transform((v) => {
220
220
  return remap$(v, {