@orq-ai/node 1.31.11 → 1.32.0-rc.6

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 (283) hide show
  1. package/README.md +31 -1
  2. package/funcs/contactsCreate.d.ts.map +1 -1
  3. package/funcs/contactsCreate.js +1 -0
  4. package/funcs/contactsCreate.js.map +1 -1
  5. package/funcs/deploymentsAll.d.ts.map +1 -1
  6. package/funcs/deploymentsAll.js +1 -0
  7. package/funcs/deploymentsAll.js.map +1 -1
  8. package/funcs/deploymentsGetConfig.d.ts.map +1 -1
  9. package/funcs/deploymentsGetConfig.js +1 -0
  10. package/funcs/deploymentsGetConfig.js.map +1 -1
  11. package/funcs/deploymentsInvalidate.d.ts.map +1 -1
  12. package/funcs/deploymentsInvalidate.js +1 -0
  13. package/funcs/deploymentsInvalidate.js.map +1 -1
  14. package/funcs/deploymentsInvoke.d.ts.map +1 -1
  15. package/funcs/deploymentsInvoke.js +1 -0
  16. package/funcs/deploymentsInvoke.js.map +1 -1
  17. package/funcs/deploymentsMetricsCreate.d.ts.map +1 -1
  18. package/funcs/deploymentsMetricsCreate.js +1 -0
  19. package/funcs/deploymentsMetricsCreate.js.map +1 -1
  20. package/funcs/feedbackCreate.d.ts.map +1 -1
  21. package/funcs/feedbackCreate.js +1 -0
  22. package/funcs/feedbackCreate.js.map +1 -1
  23. package/funcs/filesBulkUpload.d.ts.map +1 -1
  24. package/funcs/filesBulkUpload.js +1 -0
  25. package/funcs/filesBulkUpload.js.map +1 -1
  26. package/funcs/filesUpload.d.ts.map +1 -1
  27. package/funcs/filesUpload.js +1 -0
  28. package/funcs/filesUpload.js.map +1 -1
  29. package/funcs/promptSnippetsFindOne.d.ts +12 -0
  30. package/funcs/promptSnippetsFindOne.d.ts.map +1 -0
  31. package/funcs/promptSnippetsFindOne.js +108 -0
  32. package/funcs/promptSnippetsFindOne.js.map +1 -0
  33. package/funcs/promptTemplatesGetAll.d.ts +12 -0
  34. package/funcs/promptTemplatesGetAll.d.ts.map +1 -0
  35. package/funcs/promptTemplatesGetAll.js +108 -0
  36. package/funcs/promptTemplatesGetAll.js.map +1 -0
  37. package/funcs/promptsCreate.d.ts +12 -0
  38. package/funcs/promptsCreate.d.ts.map +1 -0
  39. package/funcs/promptsCreate.js +105 -0
  40. package/funcs/promptsCreate.js.map +1 -0
  41. package/funcs/promptsCreateVersion.d.ts +12 -0
  42. package/funcs/promptsCreateVersion.d.ts.map +1 -0
  43. package/funcs/promptsCreateVersion.js +109 -0
  44. package/funcs/promptsCreateVersion.js.map +1 -0
  45. package/funcs/promptsDelete.d.ts +12 -0
  46. package/funcs/promptsDelete.d.ts.map +1 -0
  47. package/funcs/promptsDelete.js +109 -0
  48. package/funcs/promptsDelete.js.map +1 -0
  49. package/funcs/promptsDuplicate.d.ts +12 -0
  50. package/funcs/promptsDuplicate.d.ts.map +1 -0
  51. package/funcs/promptsDuplicate.js +109 -0
  52. package/funcs/promptsDuplicate.js.map +1 -0
  53. package/funcs/promptsGetAll.d.ts +12 -0
  54. package/funcs/promptsGetAll.d.ts.map +1 -0
  55. package/funcs/promptsGetAll.js +108 -0
  56. package/funcs/promptsGetAll.js.map +1 -0
  57. package/funcs/promptsGetOne.d.ts +12 -0
  58. package/funcs/promptsGetOne.d.ts.map +1 -0
  59. package/funcs/promptsGetOne.js +109 -0
  60. package/funcs/promptsGetOne.js.map +1 -0
  61. package/funcs/promptsUpdate.d.ts +13 -0
  62. package/funcs/promptsUpdate.d.ts.map +1 -0
  63. package/funcs/promptsUpdate.js +113 -0
  64. package/funcs/promptsUpdate.js.map +1 -0
  65. package/funcs/remoteconfigGetConfig.d.ts.map +1 -1
  66. package/funcs/remoteconfigGetConfig.js +1 -0
  67. package/funcs/remoteconfigGetConfig.js.map +1 -1
  68. package/lib/config.d.ts +4 -4
  69. package/lib/config.d.ts.map +1 -1
  70. package/lib/config.js +4 -4
  71. package/lib/config.js.map +1 -1
  72. package/lib/sdks.d.ts +5 -1
  73. package/lib/sdks.d.ts.map +1 -1
  74. package/lib/sdks.js +1 -0
  75. package/lib/sdks.js.map +1 -1
  76. package/models/errors/index.d.ts +1 -0
  77. package/models/errors/index.d.ts.map +1 -1
  78. package/models/errors/index.js +1 -0
  79. package/models/errors/index.js.map +1 -1
  80. package/models/errors/updateprompt.d.ts +36 -0
  81. package/models/errors/updateprompt.d.ts.map +1 -0
  82. package/models/errors/updateprompt.js +79 -0
  83. package/models/errors/updateprompt.js.map +1 -0
  84. package/models/operations/bulkfileupload.js +2 -2
  85. package/models/operations/createcontact.js +2 -2
  86. package/models/operations/createprompt.d.ts +2035 -0
  87. package/models/operations/createprompt.d.ts.map +1 -0
  88. package/models/operations/createprompt.js +1853 -0
  89. package/models/operations/createprompt.js.map +1 -0
  90. package/models/operations/createpromptversion.d.ts +2001 -0
  91. package/models/operations/createpromptversion.d.ts.map +1 -0
  92. package/models/operations/createpromptversion.js +1848 -0
  93. package/models/operations/createpromptversion.js.map +1 -0
  94. package/models/operations/deleteprompt.d.ts +32 -0
  95. package/models/operations/deleteprompt.d.ts.map +1 -0
  96. package/models/operations/deleteprompt.js +69 -0
  97. package/models/operations/deleteprompt.js.map +1 -0
  98. package/models/operations/deploymentgetconfig.d.ts +96 -96
  99. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  100. package/models/operations/deploymentgetconfig.js +136 -135
  101. package/models/operations/deploymentgetconfig.js.map +1 -1
  102. package/models/operations/deploymentinvoke.d.ts +46 -49
  103. package/models/operations/deploymentinvoke.d.ts.map +1 -1
  104. package/models/operations/deploymentinvoke.js +61 -63
  105. package/models/operations/deploymentinvoke.js.map +1 -1
  106. package/models/operations/deployments.d.ts +53 -53
  107. package/models/operations/deployments.d.ts.map +1 -1
  108. package/models/operations/deployments.js +66 -67
  109. package/models/operations/deployments.js.map +1 -1
  110. package/models/operations/duplicateprompt.d.ts +32 -0
  111. package/models/operations/duplicateprompt.d.ts.map +1 -0
  112. package/models/operations/duplicateprompt.js +69 -0
  113. package/models/operations/duplicateprompt.js.map +1 -0
  114. package/models/operations/fileupload.js +2 -2
  115. package/models/operations/findonepromptsnippet.d.ts +6278 -0
  116. package/models/operations/findonepromptsnippet.d.ts.map +1 -0
  117. package/models/operations/findonepromptsnippet.js +5891 -0
  118. package/models/operations/findonepromptsnippet.js.map +1 -0
  119. package/models/operations/getallprompts.d.ts +6613 -0
  120. package/models/operations/getallprompts.d.ts.map +1 -0
  121. package/models/operations/getallprompts.js +6161 -0
  122. package/models/operations/getallprompts.js.map +1 -0
  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 +32 -0
  128. package/models/operations/getoneprompt.d.ts.map +1 -0
  129. package/models/operations/getoneprompt.js +69 -0
  130. package/models/operations/getoneprompt.js.map +1 -0
  131. package/models/operations/index.d.ts +9 -0
  132. package/models/operations/index.d.ts.map +1 -1
  133. package/models/operations/index.js +9 -0
  134. package/models/operations/index.js.map +1 -1
  135. package/models/operations/updateprompt.d.ts +7251 -0
  136. package/models/operations/updateprompt.d.ts.map +1 -0
  137. package/models/operations/updateprompt.js +6678 -0
  138. package/models/operations/updateprompt.js.map +1 -0
  139. package/package.json +3 -2
  140. package/sdk/prompt.d.ts +10 -0
  141. package/sdk/prompt.d.ts.map +1 -0
  142. package/sdk/prompt.js +21 -0
  143. package/sdk/prompt.js.map +1 -0
  144. package/sdk/prompts.d.ts +33 -0
  145. package/sdk/prompts.d.ts.map +1 -0
  146. package/sdk/prompts.js +61 -0
  147. package/sdk/prompts.js.map +1 -0
  148. package/sdk/sdk.d.ts +6 -0
  149. package/sdk/sdk.d.ts.map +1 -1
  150. package/sdk/sdk.js +10 -0
  151. package/sdk/sdk.js.map +1 -1
  152. package/sdk/snippets.d.ts +9 -0
  153. package/sdk/snippets.d.ts.map +1 -0
  154. package/sdk/snippets.js +19 -0
  155. package/sdk/snippets.js.map +1 -0
  156. package/sdk/templates.d.ts +9 -0
  157. package/sdk/templates.d.ts.map +1 -0
  158. package/sdk/templates.js +19 -0
  159. package/sdk/templates.js.map +1 -0
  160. package/src/funcs/contactsCreate.ts +1 -0
  161. package/src/funcs/deploymentsAll.ts +1 -0
  162. package/src/funcs/deploymentsGetConfig.ts +1 -0
  163. package/src/funcs/deploymentsInvalidate.ts +1 -0
  164. package/src/funcs/deploymentsInvoke.ts +1 -0
  165. package/src/funcs/deploymentsMetricsCreate.ts +1 -0
  166. package/src/funcs/feedbackCreate.ts +1 -0
  167. package/src/funcs/filesBulkUpload.ts +1 -0
  168. package/src/funcs/filesUpload.ts +1 -0
  169. package/{packages/orq-rc/src → src}/funcs/promptSnippetsFindOne.ts +1 -0
  170. package/{packages/orq-rc/src → src}/funcs/promptTemplatesGetAll.ts +1 -0
  171. package/{packages/orq-rc/src → src}/funcs/promptsCreate.ts +1 -0
  172. package/{packages/orq-rc/src → src}/funcs/promptsCreateVersion.ts +1 -0
  173. package/{packages/orq-rc/src → src}/funcs/promptsDelete.ts +1 -0
  174. package/{packages/orq-rc/src → src}/funcs/promptsDuplicate.ts +1 -0
  175. package/{packages/orq-rc/src → src}/funcs/promptsGetAll.ts +1 -0
  176. package/{packages/orq-rc/src → src}/funcs/promptsGetOne.ts +1 -0
  177. package/{packages/orq-rc/src → src}/funcs/promptsUpdate.ts +1 -0
  178. package/src/funcs/remoteconfigGetConfig.ts +1 -0
  179. package/src/lib/config.ts +4 -4
  180. package/src/lib/sdks.ts +6 -1
  181. package/src/models/errors/index.ts +1 -0
  182. package/src/models/operations/bulkfileupload.ts +2 -2
  183. package/src/models/operations/createcontact.ts +2 -2
  184. package/src/models/operations/deploymentgetconfig.ts +255 -188
  185. package/src/models/operations/deploymentinvoke.ts +95 -81
  186. package/src/models/operations/deployments.ts +101 -88
  187. package/src/models/operations/fileupload.ts +2 -2
  188. package/{packages/orq-rc/src → src}/models/operations/findonepromptsnippet.ts +26 -26
  189. package/{packages/orq-rc/src → src}/models/operations/getallprompts.ts +10 -10
  190. package/{packages/orq-rc/src → src}/models/operations/getallprompttemplates.ts +10 -10
  191. package/src/models/operations/index.ts +9 -0
  192. package/{packages/orq-rc/src → src}/models/operations/updateprompt.ts +10 -10
  193. package/src/sdk/sdk.ts +12 -0
  194. package/packages/orq-rc/README.md +0 -556
  195. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -84
  196. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -314
  197. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -92
  198. package/packages/orq-rc/docs/sdks/files/README.md +0 -171
  199. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -86
  200. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  201. package/packages/orq-rc/docs/sdks/remoteconfig/README.md +0 -80
  202. package/packages/orq-rc/src/core.ts +0 -13
  203. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -123
  204. package/packages/orq-rc/src/funcs/deploymentsAll.ts +0 -137
  205. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -131
  206. package/packages/orq-rc/src/funcs/deploymentsInvalidate.ts +0 -132
  207. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -134
  208. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -131
  209. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -123
  210. package/packages/orq-rc/src/funcs/filesBulkUpload.ts +0 -125
  211. package/packages/orq-rc/src/funcs/filesUpload.ts +0 -144
  212. package/packages/orq-rc/src/funcs/remoteconfigGetConfig.ts +0 -124
  213. package/packages/orq-rc/src/hooks/hooks.ts +0 -112
  214. package/packages/orq-rc/src/hooks/index.ts +0 -6
  215. package/packages/orq-rc/src/hooks/registration.ts +0 -14
  216. package/packages/orq-rc/src/hooks/types.ts +0 -102
  217. package/packages/orq-rc/src/index.ts +0 -7
  218. package/packages/orq-rc/src/lib/base64.ts +0 -37
  219. package/packages/orq-rc/src/lib/config.ts +0 -60
  220. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  221. package/packages/orq-rc/src/lib/encodings.ts +0 -449
  222. package/packages/orq-rc/src/lib/env.ts +0 -41
  223. package/packages/orq-rc/src/lib/event-streams.ts +0 -264
  224. package/packages/orq-rc/src/lib/files.ts +0 -40
  225. package/packages/orq-rc/src/lib/http.ts +0 -323
  226. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  227. package/packages/orq-rc/src/lib/logger.ts +0 -9
  228. package/packages/orq-rc/src/lib/matchers.ts +0 -325
  229. package/packages/orq-rc/src/lib/primitives.ts +0 -122
  230. package/packages/orq-rc/src/lib/retries.ts +0 -219
  231. package/packages/orq-rc/src/lib/schemas.ts +0 -86
  232. package/packages/orq-rc/src/lib/sdks.ts +0 -392
  233. package/packages/orq-rc/src/lib/security.ts +0 -254
  234. package/packages/orq-rc/src/lib/url.ts +0 -33
  235. package/packages/orq-rc/src/models/components/deployments.ts +0 -1607
  236. package/packages/orq-rc/src/models/components/index.ts +0 -6
  237. package/packages/orq-rc/src/models/components/security.ts +0 -71
  238. package/packages/orq-rc/src/models/errors/apierror.ts +0 -27
  239. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -82
  240. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  241. package/packages/orq-rc/src/models/errors/index.ts +0 -9
  242. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -97
  243. package/packages/orq-rc/src/models/operations/bulkfileupload.ts +0 -304
  244. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -256
  245. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  246. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -1790
  247. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -3417
  248. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -2384
  249. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2086
  250. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -311
  251. package/packages/orq-rc/src/models/operations/index.ts +0 -23
  252. package/packages/orq-rc/src/models/operations/invaliddeployment.ts +0 -75
  253. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  254. package/packages/orq-rc/src/sdk/contacts.ts +0 -27
  255. package/packages/orq-rc/src/sdk/deployments.ts +0 -93
  256. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  257. package/packages/orq-rc/src/sdk/files.ts +0 -45
  258. package/packages/orq-rc/src/sdk/index.ts +0 -5
  259. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  260. package/packages/orq-rc/src/sdk/remoteconfig.ts +0 -24
  261. package/packages/orq-rc/src/sdk/sdk.ts +0 -49
  262. package/packages/orq-rc/src/types/blobs.ts +0 -31
  263. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  264. package/packages/orq-rc/src/types/enums.ts +0 -16
  265. package/packages/orq-rc/src/types/fp.ts +0 -50
  266. package/packages/orq-rc/src/types/index.ts +0 -11
  267. package/packages/orq-rc/src/types/operations.ts +0 -105
  268. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  269. package/packages/orq-rc/src/types/streams.ts +0 -21
  270. /package/{packages/orq-rc/docs → docs}/sdks/prompt/README.md +0 -0
  271. /package/{packages/orq-rc/docs → docs}/sdks/prompts/README.md +0 -0
  272. /package/{packages/orq-rc/docs → docs}/sdks/snippets/README.md +0 -0
  273. /package/{packages/orq-rc/docs → docs}/sdks/templates/README.md +0 -0
  274. /package/{packages/orq-rc/src → src}/models/errors/updateprompt.ts +0 -0
  275. /package/{packages/orq-rc/src → src}/models/operations/createprompt.ts +0 -0
  276. /package/{packages/orq-rc/src → src}/models/operations/createpromptversion.ts +0 -0
  277. /package/{packages/orq-rc/src → src}/models/operations/deleteprompt.ts +0 -0
  278. /package/{packages/orq-rc/src → src}/models/operations/duplicateprompt.ts +0 -0
  279. /package/{packages/orq-rc/src → src}/models/operations/getoneprompt.ts +0 -0
  280. /package/{packages/orq-rc/src → src}/sdk/prompt.ts +0 -0
  281. /package/{packages/orq-rc/src → src}/sdk/prompts.ts +0 -0
  282. /package/{packages/orq-rc/src → src}/sdk/snippets.ts +0 -0
  283. /package/{packages/orq-rc/src → src}/sdk/templates.ts +0 -0
@@ -1,86 +0,0 @@
1
- # Metrics
2
- (*deployments.metrics*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [create](#create) - Add metrics
9
-
10
- ## create
11
-
12
- Add metrics to a deployment
13
-
14
- ### Example Usage
15
-
16
- ```typescript
17
- import { Orq } from "@orq-ai/node";
18
-
19
- const orq = new Orq({
20
- apiKey: process.env["ORQ_API_KEY"] ?? "",
21
- });
22
-
23
- async function run() {
24
- const result = await orq.deployments.metrics.create({
25
- id: "<id>",
26
- requestBody: {},
27
- });
28
-
29
- // Handle the result
30
- console.log(result);
31
- }
32
-
33
- run();
34
- ```
35
-
36
- ### Standalone function
37
-
38
- The standalone function version of this method:
39
-
40
- ```typescript
41
- import { OrqCore } from "@orq-ai/node/core.js";
42
- import { deploymentsMetricsCreate } from "@orq-ai/node/funcs/deploymentsMetricsCreate.js";
43
-
44
- // Use `OrqCore` for best tree-shaking performance.
45
- // You can create one instance of it to use across an application.
46
- const orq = new OrqCore({
47
- apiKey: process.env["ORQ_API_KEY"] ?? "",
48
- });
49
-
50
- async function run() {
51
- const res = await deploymentsMetricsCreate(orq, {
52
- id: "<id>",
53
- requestBody: {},
54
- });
55
-
56
- if (!res.ok) {
57
- throw res.error;
58
- }
59
-
60
- const { value: result } = res;
61
-
62
- // Handle the result
63
- console.log(result);
64
- }
65
-
66
- run();
67
- ```
68
-
69
- ### Parameters
70
-
71
- | Parameter | Type | Required | Description |
72
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
73
- | `request` | [operations.DeploymentCreateMetricRequest](../../models/operations/deploymentcreatemetricrequest.md) | :heavy_check_mark: | The request object to use for the request. |
74
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
75
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
76
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
77
-
78
- ### Response
79
-
80
- **Promise\<[operations.DeploymentCreateMetricResponseBody](../../models/operations/deploymentcreatemetricresponsebody.md)\>**
81
-
82
- ### Errors
83
-
84
- | Error Type | Status Code | Content Type |
85
- | --------------- | --------------- | --------------- |
86
- | errors.APIError | 4XX, 5XX | \*/\* |
@@ -1,10 +0,0 @@
1
- # Orq SDK
2
-
3
- ## Overview
4
-
5
- [Dev] orq.ai API: The Orquesta API
6
-
7
- orq.ai Documentation
8
- <https://docs.orq.ai>
9
-
10
- ### Available Operations
@@ -1,80 +0,0 @@
1
- # Remoteconfig
2
- (*remoteconfig*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [getConfig](#getconfig) - Get Configurations
9
-
10
- ## getConfig
11
-
12
- Get Configurations
13
-
14
- ### Example Usage
15
-
16
- ```typescript
17
- import { Orq } from "@orq-ai/node";
18
-
19
- const orq = new Orq({
20
- apiKey: process.env["ORQ_API_KEY"] ?? "",
21
- });
22
-
23
- async function run() {
24
- const result = await orq.remoteconfig.getConfig();
25
-
26
- // Handle the result
27
- console.log(result);
28
- }
29
-
30
- run();
31
- ```
32
-
33
- ### Standalone function
34
-
35
- The standalone function version of this method:
36
-
37
- ```typescript
38
- import { OrqCore } from "@orq-ai/node/core.js";
39
- import { remoteconfigGetConfig } from "@orq-ai/node/funcs/remoteconfigGetConfig.js";
40
-
41
- // Use `OrqCore` for best tree-shaking performance.
42
- // You can create one instance of it to use across an application.
43
- const orq = new OrqCore({
44
- apiKey: process.env["ORQ_API_KEY"] ?? "",
45
- });
46
-
47
- async function run() {
48
- const res = await remoteconfigGetConfig(orq);
49
-
50
- if (!res.ok) {
51
- throw res.error;
52
- }
53
-
54
- const { value: result } = res;
55
-
56
- // Handle the result
57
- console.log(result);
58
- }
59
-
60
- run();
61
- ```
62
-
63
- ### Parameters
64
-
65
- | Parameter | Type | Required | Description |
66
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
67
- | `request` | [operations.RemoteConfigsGetConfigRequestBody](../../models/operations/remoteconfigsgetconfigrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
68
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
69
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
70
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
71
-
72
- ### Response
73
-
74
- **Promise\<[operations.RemoteConfigsGetConfigResponseBody](../../models/operations/remoteconfigsgetconfigresponsebody.md)\>**
75
-
76
- ### Errors
77
-
78
- | Error Type | Status Code | Content Type |
79
- | --------------- | --------------- | --------------- |
80
- | errors.APIError | 4XX, 5XX | \*/\* |
@@ -1,13 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import { ClientSDK } from "./lib/sdks.js";
6
-
7
- /**
8
- * A minimal client to use when calling standalone SDK functions. Typically, an
9
- * instance of this class would be instantiated once at the start of an
10
- * application and passed around through some dependency injection mechanism to
11
- * parts of an application that need to make SDK calls.
12
- */
13
- export class OrqCore extends ClientSDK {}
@@ -1,123 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import { OrqCore } from "../core.js";
6
- import { encodeJSON } from "../lib/encodings.js";
7
- import * as M from "../lib/matchers.js";
8
- import { safeParse } from "../lib/schemas.js";
9
- import { RequestOptions } from "../lib/sdks.js";
10
- import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
11
- import { pathToFunc } from "../lib/url.js";
12
- import { APIError } from "../models/errors/apierror.js";
13
- import {
14
- ConnectionError,
15
- InvalidRequestError,
16
- RequestAbortedError,
17
- RequestTimeoutError,
18
- UnexpectedClientError,
19
- } from "../models/errors/httpclienterrors.js";
20
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
21
- import * as operations from "../models/operations/index.js";
22
- import { Result } from "../types/fp.js";
23
-
24
- /**
25
- * Update user information
26
- *
27
- * @remarks
28
- * Update or add user information to workspace
29
- */
30
- export async function contactsCreate(
31
- client: OrqCore,
32
- request: operations.CreateContactRequestBody,
33
- options?: RequestOptions,
34
- ): Promise<
35
- Result<
36
- operations.CreateContactResponseBody,
37
- | APIError
38
- | SDKValidationError
39
- | UnexpectedClientError
40
- | InvalidRequestError
41
- | RequestAbortedError
42
- | RequestTimeoutError
43
- | ConnectionError
44
- >
45
- > {
46
- const parsed = safeParse(
47
- request,
48
- (value) => operations.CreateContactRequestBody$outboundSchema.parse(value),
49
- "Input validation failed",
50
- );
51
- if (!parsed.ok) {
52
- return parsed;
53
- }
54
- const payload = parsed.value;
55
- const body = encodeJSON("body", payload, { explode: true });
56
-
57
- const path = pathToFunc("/v2/contacts")();
58
-
59
- const headers = new Headers({
60
- "Content-Type": "application/json",
61
- Accept: "application/json",
62
- });
63
-
64
- const secConfig = await extractSecurity(client._options.apiKey);
65
- const securityInput = secConfig == null ? {} : { apiKey: secConfig };
66
- const requestSecurity = resolveGlobalSecurity(securityInput);
67
-
68
- const context = {
69
- operationID: "CreateContact",
70
- oAuth2Scopes: [],
71
-
72
- resolvedSecurity: requestSecurity,
73
-
74
- securitySource: client._options.apiKey,
75
- retryConfig: options?.retries
76
- || client._options.retryConfig
77
- || { strategy: "none" },
78
- retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
79
- };
80
-
81
- const requestRes = client._createRequest(context, {
82
- security: requestSecurity,
83
- method: "POST",
84
- path: path,
85
- headers: headers,
86
- body: body,
87
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
88
- }, options);
89
- if (!requestRes.ok) {
90
- return requestRes;
91
- }
92
- const req = requestRes.value;
93
-
94
- const doResult = await client._do(req, {
95
- context,
96
- errorCodes: ["4XX", "5XX"],
97
- retryConfig: context.retryConfig,
98
- retryCodes: context.retryCodes,
99
- });
100
- if (!doResult.ok) {
101
- return doResult;
102
- }
103
- const response = doResult.value;
104
-
105
- const [result] = await M.match<
106
- operations.CreateContactResponseBody,
107
- | APIError
108
- | SDKValidationError
109
- | UnexpectedClientError
110
- | InvalidRequestError
111
- | RequestAbortedError
112
- | RequestTimeoutError
113
- | ConnectionError
114
- >(
115
- M.json(200, operations.CreateContactResponseBody$inboundSchema),
116
- M.fail(["4XX", "5XX"]),
117
- )(response);
118
- if (!result.ok) {
119
- return result;
120
- }
121
-
122
- return result;
123
- }
@@ -1,137 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import { OrqCore } from "../core.js";
6
- import { encodeFormQuery } from "../lib/encodings.js";
7
- import * as M from "../lib/matchers.js";
8
- import { safeParse } from "../lib/schemas.js";
9
- import { RequestOptions } from "../lib/sdks.js";
10
- import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
11
- import { pathToFunc } from "../lib/url.js";
12
- import { APIError } from "../models/errors/apierror.js";
13
- import {
14
- ConnectionError,
15
- InvalidRequestError,
16
- RequestAbortedError,
17
- RequestTimeoutError,
18
- UnexpectedClientError,
19
- } from "../models/errors/httpclienterrors.js";
20
- import * as errors from "../models/errors/index.js";
21
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
22
- import * as operations from "../models/operations/index.js";
23
- import { Result } from "../types/fp.js";
24
-
25
- /**
26
- * List all deployments
27
- *
28
- * @remarks
29
- * Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first.
30
- */
31
- export async function deploymentsAll(
32
- client: OrqCore,
33
- request?: operations.DeploymentsRequest | undefined,
34
- options?: RequestOptions,
35
- ): Promise<
36
- Result<
37
- operations.DeploymentsResponseBody,
38
- | errors.HonoApiError
39
- | APIError
40
- | SDKValidationError
41
- | UnexpectedClientError
42
- | InvalidRequestError
43
- | RequestAbortedError
44
- | RequestTimeoutError
45
- | ConnectionError
46
- >
47
- > {
48
- const parsed = safeParse(
49
- request,
50
- (value) =>
51
- operations.DeploymentsRequest$outboundSchema.optional().parse(value),
52
- "Input validation failed",
53
- );
54
- if (!parsed.ok) {
55
- return parsed;
56
- }
57
- const payload = parsed.value;
58
- const body = null;
59
-
60
- const path = pathToFunc("/v2/deployments")();
61
-
62
- const query = encodeFormQuery({
63
- "after": payload?.after,
64
- "limit": payload?.limit,
65
- });
66
-
67
- const headers = new Headers({
68
- Accept: "application/json",
69
- });
70
-
71
- const secConfig = await extractSecurity(client._options.apiKey);
72
- const securityInput = secConfig == null ? {} : { apiKey: secConfig };
73
- const requestSecurity = resolveGlobalSecurity(securityInput);
74
-
75
- const context = {
76
- operationID: "Deployments",
77
- oAuth2Scopes: [],
78
-
79
- resolvedSecurity: requestSecurity,
80
-
81
- securitySource: client._options.apiKey,
82
- retryConfig: options?.retries
83
- || client._options.retryConfig
84
- || { strategy: "none" },
85
- retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
86
- };
87
-
88
- const requestRes = client._createRequest(context, {
89
- security: requestSecurity,
90
- method: "GET",
91
- path: path,
92
- headers: headers,
93
- query: query,
94
- body: body,
95
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
96
- }, options);
97
- if (!requestRes.ok) {
98
- return requestRes;
99
- }
100
- const req = requestRes.value;
101
-
102
- const doResult = await client._do(req, {
103
- context,
104
- errorCodes: ["4XX", "500", "5XX"],
105
- retryConfig: context.retryConfig,
106
- retryCodes: context.retryCodes,
107
- });
108
- if (!doResult.ok) {
109
- return doResult;
110
- }
111
- const response = doResult.value;
112
-
113
- const responseFields = {
114
- HttpMeta: { Response: response, Request: req },
115
- };
116
-
117
- const [result] = await M.match<
118
- operations.DeploymentsResponseBody,
119
- | errors.HonoApiError
120
- | APIError
121
- | SDKValidationError
122
- | UnexpectedClientError
123
- | InvalidRequestError
124
- | RequestAbortedError
125
- | RequestTimeoutError
126
- | ConnectionError
127
- >(
128
- M.json(200, operations.DeploymentsResponseBody$inboundSchema),
129
- M.jsonErr(500, errors.HonoApiError$inboundSchema),
130
- M.fail(["4XX", "5XX"]),
131
- )(response, { extraFields: responseFields });
132
- if (!result.ok) {
133
- return result;
134
- }
135
-
136
- return result;
137
- }
@@ -1,131 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import { OrqCore } from "../core.js";
6
- import { encodeJSON } from "../lib/encodings.js";
7
- import * as M from "../lib/matchers.js";
8
- import { safeParse } from "../lib/schemas.js";
9
- import { RequestOptions } from "../lib/sdks.js";
10
- import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
11
- import { pathToFunc } from "../lib/url.js";
12
- import { APIError } from "../models/errors/apierror.js";
13
- import {
14
- ConnectionError,
15
- InvalidRequestError,
16
- RequestAbortedError,
17
- RequestTimeoutError,
18
- UnexpectedClientError,
19
- } from "../models/errors/httpclienterrors.js";
20
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
21
- import * as operations from "../models/operations/index.js";
22
- import { Result } from "../types/fp.js";
23
-
24
- /**
25
- * Get config
26
- *
27
- * @remarks
28
- * Retrieve the deployment configuration
29
- */
30
- export async function deploymentsGetConfig(
31
- client: OrqCore,
32
- request: operations.DeploymentGetConfigRequestBody,
33
- options?: RequestOptions,
34
- ): Promise<
35
- Result<
36
- operations.DeploymentGetConfigResponseBody | undefined,
37
- | APIError
38
- | SDKValidationError
39
- | UnexpectedClientError
40
- | InvalidRequestError
41
- | RequestAbortedError
42
- | RequestTimeoutError
43
- | ConnectionError
44
- >
45
- > {
46
- const parsed = safeParse(
47
- request,
48
- (value) =>
49
- operations.DeploymentGetConfigRequestBody$outboundSchema.parse(value),
50
- "Input validation failed",
51
- );
52
- if (!parsed.ok) {
53
- return parsed;
54
- }
55
- const payload = parsed.value;
56
- const body = encodeJSON("body", payload, { explode: true });
57
-
58
- const path = pathToFunc("/v2/deployments/get_config")();
59
-
60
- const headers = new Headers({
61
- "Content-Type": "application/json",
62
- Accept: "application/json",
63
- });
64
-
65
- const secConfig = await extractSecurity(client._options.apiKey);
66
- const securityInput = secConfig == null ? {} : { apiKey: secConfig };
67
- const requestSecurity = resolveGlobalSecurity(securityInput);
68
-
69
- const context = {
70
- operationID: "DeploymentGetConfig",
71
- oAuth2Scopes: [],
72
-
73
- resolvedSecurity: requestSecurity,
74
-
75
- securitySource: client._options.apiKey,
76
- retryConfig: options?.retries
77
- || client._options.retryConfig
78
- || { strategy: "none" },
79
- retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
80
- };
81
-
82
- const requestRes = client._createRequest(context, {
83
- security: requestSecurity,
84
- method: "POST",
85
- path: path,
86
- headers: headers,
87
- body: body,
88
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
89
- }, options);
90
- if (!requestRes.ok) {
91
- return requestRes;
92
- }
93
- const req = requestRes.value;
94
-
95
- const doResult = await client._do(req, {
96
- context,
97
- errorCodes: ["401", "4XX", "5XX"],
98
- retryConfig: context.retryConfig,
99
- retryCodes: context.retryCodes,
100
- });
101
- if (!doResult.ok) {
102
- return doResult;
103
- }
104
- const response = doResult.value;
105
-
106
- const [result] = await M.match<
107
- operations.DeploymentGetConfigResponseBody | undefined,
108
- | APIError
109
- | SDKValidationError
110
- | UnexpectedClientError
111
- | InvalidRequestError
112
- | RequestAbortedError
113
- | RequestTimeoutError
114
- | ConnectionError
115
- >(
116
- M.json(
117
- 200,
118
- operations.DeploymentGetConfigResponseBody$inboundSchema.optional(),
119
- ),
120
- M.nil(
121
- 204,
122
- operations.DeploymentGetConfigResponseBody$inboundSchema.optional(),
123
- ),
124
- M.fail([401, "4XX", "5XX"]),
125
- )(response);
126
- if (!result.ok) {
127
- return result;
128
- }
129
-
130
- return result;
131
- }