@orq-ai/node 3.0.1 → 3.1.0-rc.7
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.
- package/README.md +11 -9
- package/docs/sdks/deployments/README.md +195 -5
- package/docs/sdks/files/README.md +8 -4
- package/funcs/contactsCreate.d.ts.map +1 -1
- package/funcs/contactsCreate.js +1 -1
- package/funcs/contactsCreate.js.map +1 -1
- package/funcs/deploymentsGetConfig.d.ts.map +1 -1
- package/funcs/deploymentsGetConfig.js +1 -1
- package/funcs/deploymentsGetConfig.js.map +1 -1
- package/funcs/deploymentsGetLogs.d.ts +15 -0
- package/funcs/deploymentsGetLogs.d.ts.map +1 -0
- package/funcs/deploymentsGetLogs.js +113 -0
- package/funcs/deploymentsGetLogs.js.map +1 -0
- package/funcs/deploymentsInvalidate.d.ts +15 -0
- package/funcs/deploymentsInvalidate.d.ts.map +1 -0
- package/funcs/deploymentsInvalidate.js +113 -0
- package/funcs/deploymentsInvalidate.js.map +1 -0
- package/funcs/deploymentsInvoke.d.ts.map +1 -1
- package/funcs/deploymentsInvoke.js +1 -1
- package/funcs/deploymentsInvoke.js.map +1 -1
- package/funcs/{deploymentsAll.d.ts → deploymentsList.d.ts} +2 -2
- package/funcs/deploymentsList.d.ts.map +1 -0
- package/funcs/{deploymentsAll.js → deploymentsList.js} +6 -5
- package/funcs/deploymentsList.js.map +1 -0
- package/funcs/deploymentsMetricsCreate.d.ts.map +1 -1
- package/funcs/deploymentsMetricsCreate.js +1 -1
- package/funcs/deploymentsMetricsCreate.js.map +1 -1
- package/funcs/feedbackCreate.d.ts.map +1 -1
- package/funcs/feedbackCreate.js +1 -1
- package/funcs/feedbackCreate.js.map +1 -1
- package/funcs/filesBulkUpload.d.ts.map +1 -1
- package/funcs/filesBulkUpload.js +1 -1
- package/funcs/filesBulkUpload.js.map +1 -1
- package/funcs/filesDelete.d.ts.map +1 -1
- package/funcs/filesDelete.js +1 -1
- package/funcs/filesDelete.js.map +1 -1
- package/funcs/filesGet.d.ts.map +1 -1
- package/funcs/filesGet.js +1 -1
- package/funcs/filesGet.js.map +1 -1
- package/funcs/filesList.d.ts.map +1 -1
- package/funcs/filesList.js +1 -1
- package/funcs/filesList.js.map +1 -1
- package/funcs/filesUpdate.d.ts.map +1 -1
- package/funcs/filesUpdate.js +1 -1
- package/funcs/filesUpdate.js.map +1 -1
- package/funcs/filesUpload.d.ts.map +1 -1
- package/funcs/filesUpload.js +1 -1
- package/funcs/filesUpload.js.map +1 -1
- package/funcs/promptSnippetsFindOne.d.ts.map +1 -1
- package/funcs/promptSnippetsFindOne.js +1 -1
- package/funcs/promptSnippetsFindOne.js.map +1 -1
- package/funcs/promptTemplatesGetAll.d.ts.map +1 -1
- package/funcs/promptTemplatesGetAll.js +1 -1
- package/funcs/promptTemplatesGetAll.js.map +1 -1
- package/funcs/promptsCreate.d.ts.map +1 -1
- package/funcs/promptsCreate.js +1 -1
- package/funcs/promptsCreate.js.map +1 -1
- package/funcs/promptsCreateVersion.d.ts.map +1 -1
- package/funcs/promptsCreateVersion.js +1 -1
- package/funcs/promptsCreateVersion.js.map +1 -1
- package/funcs/promptsDelete.d.ts.map +1 -1
- package/funcs/promptsDelete.js +1 -1
- package/funcs/promptsDelete.js.map +1 -1
- package/funcs/promptsDuplicate.d.ts.map +1 -1
- package/funcs/promptsDuplicate.js +1 -1
- package/funcs/promptsDuplicate.js.map +1 -1
- package/funcs/promptsGetAll.d.ts.map +1 -1
- package/funcs/promptsGetAll.js +1 -1
- package/funcs/promptsGetAll.js.map +1 -1
- package/funcs/promptsGetOne.d.ts.map +1 -1
- package/funcs/promptsGetOne.js +1 -1
- package/funcs/promptsGetOne.js.map +1 -1
- package/funcs/promptsUpdate.d.ts.map +1 -1
- package/funcs/promptsUpdate.js +1 -1
- package/funcs/promptsUpdate.js.map +1 -1
- package/funcs/remoteconfigGetConfig.d.ts.map +1 -1
- package/funcs/remoteconfigGetConfig.js +1 -1
- package/funcs/remoteconfigGetConfig.js.map +1 -1
- package/jsr.json +28 -0
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/lib/schemas.d.ts +1 -1
- package/lib/schemas.d.ts.map +1 -1
- package/lib/schemas.js +4 -1
- package/lib/schemas.js.map +1 -1
- package/models/operations/bulkfileupload.js +2 -2
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createprompt.d.ts +12 -0
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +4 -0
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/createpromptversion.d.ts +12 -0
- package/models/operations/createpromptversion.d.ts.map +1 -1
- package/models/operations/createpromptversion.js +4 -0
- package/models/operations/createpromptversion.js.map +1 -1
- package/models/operations/deploymentgetlogs.d.ts +52406 -0
- package/models/operations/deploymentgetlogs.d.ts.map +1 -0
- package/models/operations/deploymentgetlogs.js +53803 -0
- package/models/operations/deploymentgetlogs.js.map +1 -0
- package/models/operations/deploymentinvoke.d.ts +6 -0
- package/models/operations/deploymentinvoke.d.ts.map +1 -1
- package/models/operations/deploymentinvoke.js +2 -0
- package/models/operations/deploymentinvoke.js.map +1 -1
- package/models/operations/deployments.d.ts +15 -8
- package/models/operations/deployments.d.ts.map +1 -1
- package/models/operations/deployments.js +16 -10
- package/models/operations/deployments.js.map +1 -1
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.d.ts +1 -5
- package/models/operations/filelist.d.ts.map +1 -1
- package/models/operations/filelist.js +4 -12
- package/models/operations/filelist.js.map +1 -1
- package/models/operations/fileupdate.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/findonepromptsnippet.d.ts +36 -0
- package/models/operations/findonepromptsnippet.d.ts.map +1 -1
- package/models/operations/findonepromptsnippet.js +18 -6
- package/models/operations/findonepromptsnippet.js.map +1 -1
- package/models/operations/getallprompts.d.ts +944 -912
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +1372 -1362
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getallprompttemplates.d.ts +151 -115
- package/models/operations/getallprompttemplates.d.ts.map +1 -1
- package/models/operations/getallprompttemplates.js +182 -173
- package/models/operations/getallprompttemplates.js.map +1 -1
- package/models/operations/index.d.ts +2 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +2 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/invaliddeployment.d.ts +29 -0
- package/models/operations/invaliddeployment.d.ts.map +1 -0
- package/models/operations/invaliddeployment.js +78 -0
- package/models/operations/invaliddeployment.js.map +1 -0
- package/models/operations/updateprompt.d.ts +42 -0
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +20 -6
- package/models/operations/updateprompt.js.map +1 -1
- package/package.json +3 -2
- package/sdk/deployments.d.ts +15 -1
- package/sdk/deployments.d.ts.map +1 -1
- package/sdk/deployments.js +23 -3
- package/sdk/deployments.js.map +1 -1
- package/src/funcs/contactsCreate.ts +2 -1
- package/src/funcs/deploymentsGetConfig.ts +2 -1
- package/{packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts → src/funcs/deploymentsGetLogs.ts} +17 -16
- package/{packages/orq-rc/src/funcs/promptsDelete.ts → src/funcs/deploymentsInvalidate.ts} +18 -11
- package/src/funcs/deploymentsInvoke.ts +2 -1
- package/src/funcs/{deploymentsAll.ts → deploymentsList.ts} +5 -3
- package/src/funcs/deploymentsMetricsCreate.ts +2 -1
- package/src/funcs/feedbackCreate.ts +2 -1
- package/src/funcs/filesBulkUpload.ts +2 -1
- package/src/funcs/filesDelete.ts +2 -1
- package/src/funcs/filesGet.ts +2 -1
- package/src/funcs/filesList.ts +2 -1
- package/src/funcs/filesUpdate.ts +2 -1
- package/src/funcs/filesUpload.ts +2 -1
- package/src/funcs/promptSnippetsFindOne.ts +2 -1
- package/src/funcs/promptTemplatesGetAll.ts +2 -1
- package/src/funcs/promptsCreate.ts +2 -1
- package/src/funcs/promptsCreateVersion.ts +2 -1
- package/src/funcs/promptsDelete.ts +2 -1
- package/src/funcs/promptsDuplicate.ts +2 -1
- package/src/funcs/promptsGetAll.ts +2 -1
- package/src/funcs/promptsGetOne.ts +2 -1
- package/src/funcs/promptsUpdate.ts +2 -1
- package/src/funcs/remoteconfigGetConfig.ts +2 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/schemas.ts +5 -0
- package/src/models/operations/bulkfileupload.ts +2 -2
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createprompt.ts +4 -0
- package/src/models/operations/createpromptversion.ts +4 -0
- package/src/models/operations/deploymentgetlogs.ts +119430 -0
- package/src/models/operations/deploymentinvoke.ts +2 -0
- package/src/models/operations/deployments.ts +25 -18
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +5 -17
- package/src/models/operations/fileupdate.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/src/models/operations/findonepromptsnippet.ts +18 -6
- package/src/models/operations/getallprompts.ts +2464 -2159
- package/src/models/operations/getallprompttemplates.ts +321 -232
- package/src/models/operations/index.ts +2 -0
- package/src/models/operations/invaliddeployment.ts +75 -0
- package/src/models/operations/updateprompt.ts +20 -6
- package/src/sdk/deployments.ts +39 -3
- package/tsconfig.json +41 -0
- package/funcs/deploymentsAll.d.ts.map +0 -1
- package/funcs/deploymentsAll.js.map +0 -1
- package/packages/orq-rc/FUNCTIONS.md +0 -106
- package/packages/orq-rc/README.md +0 -564
- package/packages/orq-rc/RUNTIMES.md +0 -22
- package/packages/orq-rc/docs/sdks/contacts/README.md +0 -84
- package/packages/orq-rc/docs/sdks/deployments/README.md +0 -239
- package/packages/orq-rc/docs/sdks/feedback/README.md +0 -92
- package/packages/orq-rc/docs/sdks/files/README.md +0 -473
- package/packages/orq-rc/docs/sdks/metrics/README.md +0 -86
- package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
- package/packages/orq-rc/docs/sdks/prompt/README.md +0 -6
- package/packages/orq-rc/docs/sdks/prompts/README.md +0 -533
- package/packages/orq-rc/docs/sdks/remoteconfig/README.md +0 -80
- package/packages/orq-rc/docs/sdks/snippets/README.md +0 -84
- package/packages/orq-rc/docs/sdks/templates/README.md +0 -80
- package/packages/orq-rc/src/core.ts +0 -13
- package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -124
- package/packages/orq-rc/src/funcs/deploymentsAll.ts +0 -138
- package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -132
- package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -135
- package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -124
- package/packages/orq-rc/src/funcs/filesBulkUpload.ts +0 -126
- package/packages/orq-rc/src/funcs/filesDelete.ts +0 -128
- package/packages/orq-rc/src/funcs/filesGet.ts +0 -127
- package/packages/orq-rc/src/funcs/filesList.ts +0 -129
- package/packages/orq-rc/src/funcs/filesUpdate.ts +0 -128
- package/packages/orq-rc/src/funcs/filesUpload.ts +0 -145
- package/packages/orq-rc/src/funcs/promptSnippetsFindOne.ts +0 -128
- package/packages/orq-rc/src/funcs/promptTemplatesGetAll.ts +0 -130
- package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -124
- package/packages/orq-rc/src/funcs/promptsCreateVersion.ts +0 -129
- package/packages/orq-rc/src/funcs/promptsDuplicate.ts +0 -128
- package/packages/orq-rc/src/funcs/promptsGetAll.ts +0 -126
- package/packages/orq-rc/src/funcs/promptsGetOne.ts +0 -128
- package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -136
- package/packages/orq-rc/src/funcs/remoteconfigGetConfig.ts +0 -125
- package/packages/orq-rc/src/hooks/hooks.ts +0 -132
- package/packages/orq-rc/src/hooks/index.ts +0 -6
- package/packages/orq-rc/src/hooks/registration.ts +0 -14
- package/packages/orq-rc/src/hooks/types.ts +0 -109
- package/packages/orq-rc/src/index.ts +0 -7
- package/packages/orq-rc/src/lib/base64.ts +0 -37
- package/packages/orq-rc/src/lib/config.ts +0 -60
- package/packages/orq-rc/src/lib/dlv.ts +0 -53
- package/packages/orq-rc/src/lib/encodings.ts +0 -449
- package/packages/orq-rc/src/lib/env.ts +0 -41
- package/packages/orq-rc/src/lib/event-streams.ts +0 -264
- package/packages/orq-rc/src/lib/files.ts +0 -40
- package/packages/orq-rc/src/lib/http.ts +0 -323
- package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
- package/packages/orq-rc/src/lib/logger.ts +0 -9
- package/packages/orq-rc/src/lib/matchers.ts +0 -325
- package/packages/orq-rc/src/lib/primitives.ts +0 -122
- package/packages/orq-rc/src/lib/retries.ts +0 -219
- package/packages/orq-rc/src/lib/schemas.ts +0 -86
- package/packages/orq-rc/src/lib/sdks.ts +0 -397
- package/packages/orq-rc/src/lib/security.ts +0 -254
- package/packages/orq-rc/src/lib/url.ts +0 -33
- package/packages/orq-rc/src/models/components/deployments.ts +0 -1673
- package/packages/orq-rc/src/models/components/index.ts +0 -6
- package/packages/orq-rc/src/models/components/security.ts +0 -71
- package/packages/orq-rc/src/models/errors/apierror.ts +0 -27
- package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -82
- package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
- package/packages/orq-rc/src/models/errors/index.ts +0 -9
- package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -97
- package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -71
- package/packages/orq-rc/src/models/operations/bulkfileupload.ts +0 -315
- package/packages/orq-rc/src/models/operations/createcontact.ts +0 -256
- package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
- package/packages/orq-rc/src/models/operations/createprompt.ts +0 -3461
- package/packages/orq-rc/src/models/operations/createpromptversion.ts +0 -3703
- package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
- package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -1790
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -3483
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -2385
- package/packages/orq-rc/src/models/operations/deployments.ts +0 -2098
- package/packages/orq-rc/src/models/operations/duplicateprompt.ts +0 -69
- package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
- package/packages/orq-rc/src/models/operations/fileget.ts +0 -222
- package/packages/orq-rc/src/models/operations/filelist.ts +0 -333
- package/packages/orq-rc/src/models/operations/fileupdate.ts +0 -298
- package/packages/orq-rc/src/models/operations/fileupload.ts +0 -322
- package/packages/orq-rc/src/models/operations/findonepromptsnippet.ts +0 -13629
- package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -18640
- package/packages/orq-rc/src/models/operations/getallprompttemplates.ts +0 -13690
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -69
- package/packages/orq-rc/src/models/operations/index.ts +0 -26
- package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
- package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -14407
- package/packages/orq-rc/src/sdk/contacts.ts +0 -27
- package/packages/orq-rc/src/sdk/deployments.ts +0 -75
- package/packages/orq-rc/src/sdk/feedback.ts +0 -27
- package/packages/orq-rc/src/sdk/files.ts +0 -105
- package/packages/orq-rc/src/sdk/index.ts +0 -5
- package/packages/orq-rc/src/sdk/metrics.ts +0 -27
- package/packages/orq-rc/src/sdk/prompt.ts +0 -19
- package/packages/orq-rc/src/sdk/prompts.ts +0 -114
- package/packages/orq-rc/src/sdk/remoteconfig.ts +0 -24
- package/packages/orq-rc/src/sdk/sdk.ts +0 -49
- package/packages/orq-rc/src/sdk/snippets.ts +0 -24
- package/packages/orq-rc/src/sdk/templates.ts +0 -24
- package/packages/orq-rc/src/types/blobs.ts +0 -31
- package/packages/orq-rc/src/types/constdatetime.ts +0 -15
- package/packages/orq-rc/src/types/enums.ts +0 -16
- package/packages/orq-rc/src/types/fp.ts +0 -50
- package/packages/orq-rc/src/types/index.ts +0 -11
- package/packages/orq-rc/src/types/operations.ts +0 -105
- package/packages/orq-rc/src/types/rfcdate.ts +0 -54
- package/packages/orq-rc/src/types/streams.ts +0 -21
|
@@ -10,6 +10,7 @@ export * from "./createpromptversion.js";
|
|
|
10
10
|
export * from "./deleteprompt.js";
|
|
11
11
|
export * from "./deploymentcreatemetric.js";
|
|
12
12
|
export * from "./deploymentgetconfig.js";
|
|
13
|
+
export * from "./deploymentgetlogs.js";
|
|
13
14
|
export * from "./deploymentinvoke.js";
|
|
14
15
|
export * from "./deployments.js";
|
|
15
16
|
export * from "./duplicateprompt.js";
|
|
@@ -22,5 +23,6 @@ export * from "./findonepromptsnippet.js";
|
|
|
22
23
|
export * from "./getallprompts.js";
|
|
23
24
|
export * from "./getallprompttemplates.js";
|
|
24
25
|
export * from "./getoneprompt.js";
|
|
26
|
+
export * from "./invaliddeployment.js";
|
|
25
27
|
export * from "./remoteconfigsgetconfig.js";
|
|
26
28
|
export * from "./updateprompt.js";
|
|
@@ -0,0 +1,75 @@
|
|
|
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 { Result as SafeParseResult } from "../../types/fp.js";
|
|
9
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
10
|
+
|
|
11
|
+
export type InvalidDeploymentRequest = {
|
|
12
|
+
deploymentId: string;
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
/** @internal */
|
|
16
|
+
export const InvalidDeploymentRequest$inboundSchema: z.ZodType<
|
|
17
|
+
InvalidDeploymentRequest,
|
|
18
|
+
z.ZodTypeDef,
|
|
19
|
+
unknown
|
|
20
|
+
> = z.object({
|
|
21
|
+
deployment_id: z.string(),
|
|
22
|
+
}).transform((v) => {
|
|
23
|
+
return remap$(v, {
|
|
24
|
+
"deployment_id": "deploymentId",
|
|
25
|
+
});
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
/** @internal */
|
|
29
|
+
export type InvalidDeploymentRequest$Outbound = {
|
|
30
|
+
deployment_id: string;
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
/** @internal */
|
|
34
|
+
export const InvalidDeploymentRequest$outboundSchema: z.ZodType<
|
|
35
|
+
InvalidDeploymentRequest$Outbound,
|
|
36
|
+
z.ZodTypeDef,
|
|
37
|
+
InvalidDeploymentRequest
|
|
38
|
+
> = z.object({
|
|
39
|
+
deploymentId: z.string(),
|
|
40
|
+
}).transform((v) => {
|
|
41
|
+
return remap$(v, {
|
|
42
|
+
deploymentId: "deployment_id",
|
|
43
|
+
});
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* @internal
|
|
48
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
49
|
+
*/
|
|
50
|
+
export namespace InvalidDeploymentRequest$ {
|
|
51
|
+
/** @deprecated use `InvalidDeploymentRequest$inboundSchema` instead. */
|
|
52
|
+
export const inboundSchema = InvalidDeploymentRequest$inboundSchema;
|
|
53
|
+
/** @deprecated use `InvalidDeploymentRequest$outboundSchema` instead. */
|
|
54
|
+
export const outboundSchema = InvalidDeploymentRequest$outboundSchema;
|
|
55
|
+
/** @deprecated use `InvalidDeploymentRequest$Outbound` instead. */
|
|
56
|
+
export type Outbound = InvalidDeploymentRequest$Outbound;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function invalidDeploymentRequestToJSON(
|
|
60
|
+
invalidDeploymentRequest: InvalidDeploymentRequest,
|
|
61
|
+
): string {
|
|
62
|
+
return JSON.stringify(
|
|
63
|
+
InvalidDeploymentRequest$outboundSchema.parse(invalidDeploymentRequest),
|
|
64
|
+
);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export function invalidDeploymentRequestFromJSON(
|
|
68
|
+
jsonString: string,
|
|
69
|
+
): SafeParseResult<InvalidDeploymentRequest, SDKValidationError> {
|
|
70
|
+
return safeParse(
|
|
71
|
+
jsonString,
|
|
72
|
+
(x) => InvalidDeploymentRequest$inboundSchema.parse(JSON.parse(x)),
|
|
73
|
+
`Failed to parse 'InvalidDeploymentRequest' from JSON`,
|
|
74
|
+
);
|
|
75
|
+
}
|
|
@@ -221,6 +221,8 @@ export const UpdatePromptProvider = {
|
|
|
221
221
|
Leonardoai: "leonardoai",
|
|
222
222
|
Nvidia: "nvidia",
|
|
223
223
|
Jina: "jina",
|
|
224
|
+
Togetherai: "togetherai",
|
|
225
|
+
Elevenlabs: "elevenlabs",
|
|
224
226
|
} as const;
|
|
225
227
|
export type UpdatePromptProvider = ClosedEnum<typeof UpdatePromptProvider>;
|
|
226
228
|
|
|
@@ -594,6 +596,8 @@ export const UpdatePromptResponseBodyPromptsProvider = {
|
|
|
594
596
|
Leonardoai: "leonardoai",
|
|
595
597
|
Nvidia: "nvidia",
|
|
596
598
|
Jina: "jina",
|
|
599
|
+
Togetherai: "togetherai",
|
|
600
|
+
Elevenlabs: "elevenlabs",
|
|
597
601
|
} as const;
|
|
598
602
|
export type UpdatePromptResponseBodyPromptsProvider = ClosedEnum<
|
|
599
603
|
typeof UpdatePromptResponseBodyPromptsProvider
|
|
@@ -994,6 +998,8 @@ export const UpdatePromptResponseBodyPromptsResponse200ApplicationJSONProvider =
|
|
|
994
998
|
Leonardoai: "leonardoai",
|
|
995
999
|
Nvidia: "nvidia",
|
|
996
1000
|
Jina: "jina",
|
|
1001
|
+
Togetherai: "togetherai",
|
|
1002
|
+
Elevenlabs: "elevenlabs",
|
|
997
1003
|
} as const;
|
|
998
1004
|
export type UpdatePromptResponseBodyPromptsResponse200ApplicationJSONProvider =
|
|
999
1005
|
ClosedEnum<
|
|
@@ -1449,6 +1455,8 @@ export const UpdatePromptResponseBodyProvider = {
|
|
|
1449
1455
|
Leonardoai: "leonardoai",
|
|
1450
1456
|
Nvidia: "nvidia",
|
|
1451
1457
|
Jina: "jina",
|
|
1458
|
+
Togetherai: "togetherai",
|
|
1459
|
+
Elevenlabs: "elevenlabs",
|
|
1452
1460
|
} as const;
|
|
1453
1461
|
export type UpdatePromptResponseBodyProvider = ClosedEnum<
|
|
1454
1462
|
typeof UpdatePromptResponseBodyProvider
|
|
@@ -1826,6 +1834,8 @@ export const UpdatePromptResponseBodyPromptsResponseProvider = {
|
|
|
1826
1834
|
Leonardoai: "leonardoai",
|
|
1827
1835
|
Nvidia: "nvidia",
|
|
1828
1836
|
Jina: "jina",
|
|
1837
|
+
Togetherai: "togetherai",
|
|
1838
|
+
Elevenlabs: "elevenlabs",
|
|
1829
1839
|
} as const;
|
|
1830
1840
|
export type UpdatePromptResponseBodyPromptsResponseProvider = ClosedEnum<
|
|
1831
1841
|
typeof UpdatePromptResponseBodyPromptsResponseProvider
|
|
@@ -2253,6 +2263,8 @@ export const ResponseBodyProvider = {
|
|
|
2253
2263
|
Leonardoai: "leonardoai",
|
|
2254
2264
|
Nvidia: "nvidia",
|
|
2255
2265
|
Jina: "jina",
|
|
2266
|
+
Togetherai: "togetherai",
|
|
2267
|
+
Elevenlabs: "elevenlabs",
|
|
2256
2268
|
} as const;
|
|
2257
2269
|
export type ResponseBodyProvider = ClosedEnum<typeof ResponseBodyProvider>;
|
|
2258
2270
|
|
|
@@ -2626,6 +2638,8 @@ export const UpdatePromptResponseBodyPromptsResponse200Provider = {
|
|
|
2626
2638
|
Leonardoai: "leonardoai",
|
|
2627
2639
|
Nvidia: "nvidia",
|
|
2628
2640
|
Jina: "jina",
|
|
2641
|
+
Togetherai: "togetherai",
|
|
2642
|
+
Elevenlabs: "elevenlabs",
|
|
2629
2643
|
} as const;
|
|
2630
2644
|
export type UpdatePromptResponseBodyPromptsResponse200Provider = ClosedEnum<
|
|
2631
2645
|
typeof UpdatePromptResponseBodyPromptsResponse200Provider
|
|
@@ -7659,7 +7673,7 @@ export const ResponseBody3$inboundSchema: z.ZodType<
|
|
|
7659
7673
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
7660
7674
|
.optional(),
|
|
7661
7675
|
updated: z.string().datetime({ offset: true }).default(
|
|
7662
|
-
"2025-01-
|
|
7676
|
+
"2025-01-21T09:55:10.979Z",
|
|
7663
7677
|
).transform(v => new Date(v)),
|
|
7664
7678
|
versions: z.array(
|
|
7665
7679
|
z.lazy(() => UpdatePromptResponseBodyVersions$inboundSchema),
|
|
@@ -7713,7 +7727,7 @@ export const ResponseBody3$outboundSchema: z.ZodType<
|
|
|
7713
7727
|
UpdatePromptResponseBodyPromptsMetadata$outboundSchema
|
|
7714
7728
|
),
|
|
7715
7729
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
7716
|
-
updated: z.date().default(() => new Date("2025-01-
|
|
7730
|
+
updated: z.date().default(() => new Date("2025-01-21T09:55:10.979Z"))
|
|
7717
7731
|
.transform(v => v.toISOString()),
|
|
7718
7732
|
versions: z.array(
|
|
7719
7733
|
z.lazy(() => UpdatePromptResponseBodyVersions$outboundSchema),
|
|
@@ -11015,7 +11029,7 @@ export const ResponseBody2$inboundSchema: z.ZodType<
|
|
|
11015
11029
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
11016
11030
|
.optional(),
|
|
11017
11031
|
updated: z.string().datetime({ offset: true }).default(
|
|
11018
|
-
"2025-01-
|
|
11032
|
+
"2025-01-21T09:55:10.979Z",
|
|
11019
11033
|
).transform(v => new Date(v)),
|
|
11020
11034
|
versions: z.array(z.lazy(() => ResponseBodyVersions$inboundSchema)),
|
|
11021
11035
|
key: z.string(),
|
|
@@ -11067,7 +11081,7 @@ export const ResponseBody2$outboundSchema: z.ZodType<
|
|
|
11067
11081
|
),
|
|
11068
11082
|
metadata: z.lazy(() => UpdatePromptResponseBodyMetadata$outboundSchema),
|
|
11069
11083
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
11070
|
-
updated: z.date().default(() => new Date("2025-01-
|
|
11084
|
+
updated: z.date().default(() => new Date("2025-01-21T09:55:10.979Z"))
|
|
11071
11085
|
.transform(v => v.toISOString()),
|
|
11072
11086
|
versions: z.array(z.lazy(() => ResponseBodyVersions$outboundSchema)),
|
|
11073
11087
|
key: z.string(),
|
|
@@ -14257,7 +14271,7 @@ export const ResponseBody1$inboundSchema: z.ZodType<
|
|
|
14257
14271
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
14258
14272
|
.optional(),
|
|
14259
14273
|
updated: z.string().datetime({ offset: true }).default(
|
|
14260
|
-
"2025-01-
|
|
14274
|
+
"2025-01-21T09:55:10.979Z",
|
|
14261
14275
|
).transform(v => new Date(v)),
|
|
14262
14276
|
versions: z.array(z.lazy(() => Versions$inboundSchema)),
|
|
14263
14277
|
type: ResponseBodyType$inboundSchema,
|
|
@@ -14305,7 +14319,7 @@ export const ResponseBody1$outboundSchema: z.ZodType<
|
|
|
14305
14319
|
promptConfig: z.lazy(() => ResponseBodyPromptConfig$outboundSchema),
|
|
14306
14320
|
metadata: z.lazy(() => ResponseBodyMetadata$outboundSchema),
|
|
14307
14321
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
14308
|
-
updated: z.date().default(() => new Date("2025-01-
|
|
14322
|
+
updated: z.date().default(() => new Date("2025-01-21T09:55:10.979Z"))
|
|
14309
14323
|
.transform(v => v.toISOString()),
|
|
14310
14324
|
versions: z.array(z.lazy(() => Versions$outboundSchema)),
|
|
14311
14325
|
type: ResponseBodyType$outboundSchema,
|
package/src/sdk/deployments.ts
CHANGED
|
@@ -2,12 +2,14 @@
|
|
|
2
2
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
|
-
import { deploymentsAll } from "../funcs/deploymentsAll.js";
|
|
6
5
|
import { deploymentsGetConfig } from "../funcs/deploymentsGetConfig.js";
|
|
6
|
+
import { deploymentsGetLogs } from "../funcs/deploymentsGetLogs.js";
|
|
7
|
+
import { deploymentsInvalidate } from "../funcs/deploymentsInvalidate.js";
|
|
7
8
|
import {
|
|
8
9
|
deploymentsInvoke,
|
|
9
10
|
InvokeAcceptEnum,
|
|
10
11
|
} from "../funcs/deploymentsInvoke.js";
|
|
12
|
+
import { deploymentsList } from "../funcs/deploymentsList.js";
|
|
11
13
|
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
12
14
|
import * as components from "../models/components/index.js";
|
|
13
15
|
import * as operations from "../models/operations/index.js";
|
|
@@ -28,11 +30,28 @@ export class Deployments extends ClientSDK {
|
|
|
28
30
|
* @remarks
|
|
29
31
|
* Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first.
|
|
30
32
|
*/
|
|
31
|
-
async
|
|
33
|
+
async list(
|
|
32
34
|
request?: operations.DeploymentsRequest | undefined,
|
|
33
35
|
options?: RequestOptions,
|
|
34
36
|
): Promise<operations.DeploymentsResponseBody> {
|
|
35
|
-
return unwrapAsync(
|
|
37
|
+
return unwrapAsync(deploymentsList(
|
|
38
|
+
this,
|
|
39
|
+
request,
|
|
40
|
+
options,
|
|
41
|
+
));
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Invalidates cache
|
|
46
|
+
*
|
|
47
|
+
* @remarks
|
|
48
|
+
* Explicitly invalidate a cache of a deployment
|
|
49
|
+
*/
|
|
50
|
+
async invalidate(
|
|
51
|
+
request: operations.InvalidDeploymentRequest,
|
|
52
|
+
options?: RequestOptions,
|
|
53
|
+
): Promise<void> {
|
|
54
|
+
return unwrapAsync(deploymentsInvalidate(
|
|
36
55
|
this,
|
|
37
56
|
request,
|
|
38
57
|
options,
|
|
@@ -72,4 +91,21 @@ export class Deployments extends ClientSDK {
|
|
|
72
91
|
options,
|
|
73
92
|
));
|
|
74
93
|
}
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Get Logs
|
|
97
|
+
*
|
|
98
|
+
* @remarks
|
|
99
|
+
* Retrieve the logs based on deployment key
|
|
100
|
+
*/
|
|
101
|
+
async getLogs(
|
|
102
|
+
request: operations.DeploymentGetLogsRequest,
|
|
103
|
+
options?: RequestOptions,
|
|
104
|
+
): Promise<operations.DeploymentGetLogsResponseBody> {
|
|
105
|
+
return unwrapAsync(deploymentsGetLogs(
|
|
106
|
+
this,
|
|
107
|
+
request,
|
|
108
|
+
options,
|
|
109
|
+
));
|
|
110
|
+
}
|
|
75
111
|
}
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"incremental": true,
|
|
4
|
+
"tsBuildInfoFile": ".tsbuildinfo",
|
|
5
|
+
"target": "ES2020",
|
|
6
|
+
"lib": ["ES2022", "DOM", "DOM.Iterable"],
|
|
7
|
+
"jsx": "react-jsx",
|
|
8
|
+
|
|
9
|
+
"module": "Node16",
|
|
10
|
+
"moduleResolution": "Node16",
|
|
11
|
+
|
|
12
|
+
"allowJs": true,
|
|
13
|
+
|
|
14
|
+
"declaration": true,
|
|
15
|
+
"declarationMap": true,
|
|
16
|
+
"sourceMap": true,
|
|
17
|
+
"outDir": ".",
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
// https://github.com/tsconfig/bases/blob/a1bf7c0fa2e094b068ca3e1448ca2ece4157977e/bases/strictest.json
|
|
21
|
+
"strict": true,
|
|
22
|
+
"allowUnusedLabels": false,
|
|
23
|
+
"allowUnreachableCode": false,
|
|
24
|
+
"exactOptionalPropertyTypes": true,
|
|
25
|
+
"useUnknownInCatchVariables": true,
|
|
26
|
+
"noFallthroughCasesInSwitch": true,
|
|
27
|
+
"noImplicitOverride": true,
|
|
28
|
+
"noImplicitReturns": true,
|
|
29
|
+
"noPropertyAccessFromIndexSignature": true,
|
|
30
|
+
"noUncheckedIndexedAccess": true,
|
|
31
|
+
"noUnusedLocals": true,
|
|
32
|
+
"noUnusedParameters": true,
|
|
33
|
+
"isolatedModules": true,
|
|
34
|
+
"checkJs": true,
|
|
35
|
+
"esModuleInterop": true,
|
|
36
|
+
"skipLibCheck": true,
|
|
37
|
+
"forceConsistentCasingInFileNames": true
|
|
38
|
+
},
|
|
39
|
+
"include": ["src"],
|
|
40
|
+
"exclude": ["node_modules"]
|
|
41
|
+
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"deploymentsAll.d.ts","sourceRoot":"","sources":["../src/funcs/deploymentsAll.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,UAAU,CAAC,kBAAkB,GAAG,SAAS,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,uBAAuB,EAChC,MAAM,CAAC,YAAY,GACnB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CA2FA"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"deploymentsAll.js","sourceRoot":"","sources":["../src/funcs/deploymentsAll.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BH,wCA2GC;AArID,sDAAsD;AACtD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAS3C,kEAAoD;AAEpD,0EAA4D;AAG5D;;;;;GAKG;AACI,KAAK,UAAU,cAAc,CAClC,MAAe,EACf,OAAmD,EACnD,OAAwB;IAcxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,iCAAiC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EACtE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,iBAAiB,CAAC,EAAE,CAAC;IAE7C,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,OAAO,EAAE,OAAO,EAAE,KAAK;QACvB,OAAO,EAAE,OAAO,EAAE,KAAK;KACxB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACrE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,WAAW,EAAE,aAAa;QAC1B,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;QACtC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,MAAM;KACrE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACjC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAW5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,qCAAqC,CAAC,EAC7D,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,0BAA0B,CAAC,EACjD,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CACvB,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
# Standalone Functions
|
|
2
|
-
|
|
3
|
-
> [!NOTE]
|
|
4
|
-
> This section is useful if you are using a bundler and targetting browsers and
|
|
5
|
-
> runtimes where the size of an application affects performance and load times.
|
|
6
|
-
|
|
7
|
-
Every method in this SDK is also available as a standalone function. This
|
|
8
|
-
alternative API is suitable when targetting the browser or serverless runtimes
|
|
9
|
-
and using a bundler to build your application since all unused functionality
|
|
10
|
-
will be tree-shaken away. This includes code for unused methods, Zod schemas,
|
|
11
|
-
encoding helpers and response handlers. The result is dramatically smaller
|
|
12
|
-
impact on the application's final bundle size which grows very slowly as you use
|
|
13
|
-
more and more functionality from this SDK.
|
|
14
|
-
|
|
15
|
-
Calling methods through the main SDK class remains a valid and generally more
|
|
16
|
-
more ergonomic option. Standalone functions represent an optimisation for a
|
|
17
|
-
specific category of applications.
|
|
18
|
-
|
|
19
|
-
## Example
|
|
20
|
-
|
|
21
|
-
```typescript
|
|
22
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
23
|
-
import { contactsCreate } from "@orq-ai/node/funcs/contactsCreate.js";
|
|
24
|
-
import { SDKValidationError } from "@orq-ai/node/models/errors/sdkvalidationerror.js";
|
|
25
|
-
|
|
26
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
27
|
-
// You can create one instance of it to use across an application.
|
|
28
|
-
const orq = new OrqCore({
|
|
29
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
30
|
-
});
|
|
31
|
-
|
|
32
|
-
async function run() {
|
|
33
|
-
const res = await contactsCreate(orq, {
|
|
34
|
-
externalId: "<id>",
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
switch (true) {
|
|
38
|
-
case res.ok:
|
|
39
|
-
// The success case will be handled outside of the switch block
|
|
40
|
-
break;
|
|
41
|
-
case res.error instanceof SDKValidationError:
|
|
42
|
-
// Pretty-print validation errors.
|
|
43
|
-
return console.log(res.error.pretty());
|
|
44
|
-
case res.error instanceof Error:
|
|
45
|
-
return console.log(res.error);
|
|
46
|
-
default:
|
|
47
|
-
// TypeScript's type checking will fail on the following line if the above
|
|
48
|
-
// cases were not exhaustive.
|
|
49
|
-
res.error satisfies never;
|
|
50
|
-
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
const { value: result } = res;
|
|
55
|
-
|
|
56
|
-
// Handle the result
|
|
57
|
-
console.log(result);
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
run();
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## Result types
|
|
64
|
-
|
|
65
|
-
Standalone functions differ from SDK methods in that they return a
|
|
66
|
-
`Result<Value, Error>` type to capture _known errors_ and document them using
|
|
67
|
-
the type system. By avoiding throwing errors, application code maintains clear
|
|
68
|
-
control flow and error-handling become part of the regular flow of application
|
|
69
|
-
code.
|
|
70
|
-
|
|
71
|
-
> We use the term "known errors" because standalone functions, and JavaScript
|
|
72
|
-
> code in general, can still throw unexpected errors such as `TypeError`s,
|
|
73
|
-
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
|
74
|
-
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
|
75
|
-
> of benefit from capturing most errors and turning them into values.
|
|
76
|
-
|
|
77
|
-
The second reason for this style of programming is because these functions will
|
|
78
|
-
typically be used in front-end applications where exception throwing is
|
|
79
|
-
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
|
80
|
-
and libraries tend to promote this style of programming so that components
|
|
81
|
-
render useful content under all states (loading, success, error and so on).
|
|
82
|
-
|
|
83
|
-
The general pattern when calling standalone functions looks like this:
|
|
84
|
-
|
|
85
|
-
```typescript
|
|
86
|
-
import { Core } from "<sdk-package-name>";
|
|
87
|
-
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
|
88
|
-
|
|
89
|
-
const client = new Core();
|
|
90
|
-
|
|
91
|
-
async function run() {
|
|
92
|
-
const result = await fetchSomething(client, { id: "123" });
|
|
93
|
-
if (!result.ok) {
|
|
94
|
-
// You can throw the error or handle it. It's your choice now.
|
|
95
|
-
throw result.error;
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
console.log(result.value);
|
|
99
|
-
}
|
|
100
|
-
|
|
101
|
-
run();
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
Notably, `result.error` above will have an explicit type compared to a try-catch
|
|
105
|
-
variation where the error in the catch block can only be of type `unknown` (or
|
|
106
|
-
`any` depending on your TypeScript settings).
|