@orq-ai/node 3.0.0-rc.19 → 3.0.1
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 +1 -1
- package/RUNTIMES.md +27 -1
- package/funcs/contactsCreate.d.ts.map +1 -1
- package/funcs/contactsCreate.js +7 -6
- package/funcs/contactsCreate.js.map +1 -1
- package/funcs/deploymentsAll.d.ts.map +1 -1
- package/funcs/deploymentsAll.js +9 -8
- package/funcs/deploymentsAll.js.map +1 -1
- package/funcs/deploymentsGetConfig.d.ts.map +1 -1
- package/funcs/deploymentsGetConfig.js +7 -6
- package/funcs/deploymentsGetConfig.js.map +1 -1
- package/funcs/deploymentsInvoke.d.ts.map +1 -1
- package/funcs/deploymentsInvoke.js +8 -7
- package/funcs/deploymentsInvoke.js.map +1 -1
- package/funcs/deploymentsMetricsCreate.d.ts.map +1 -1
- package/funcs/deploymentsMetricsCreate.js +7 -6
- package/funcs/deploymentsMetricsCreate.js.map +1 -1
- package/funcs/feedbackCreate.d.ts.map +1 -1
- package/funcs/feedbackCreate.js +7 -6
- package/funcs/feedbackCreate.js.map +1 -1
- package/funcs/filesBulkUpload.d.ts.map +1 -1
- package/funcs/filesBulkUpload.js +10 -8
- package/funcs/filesBulkUpload.js.map +1 -1
- package/funcs/filesDelete.d.ts.map +1 -1
- package/funcs/filesDelete.js +7 -6
- package/funcs/filesDelete.js.map +1 -1
- package/funcs/filesGet.d.ts.map +1 -1
- package/funcs/filesGet.js +7 -6
- package/funcs/filesGet.js.map +1 -1
- package/funcs/filesList.d.ts.map +1 -1
- package/funcs/filesList.js +11 -10
- package/funcs/filesList.js.map +1 -1
- package/funcs/filesUpdate.d.ts.map +1 -1
- package/funcs/filesUpdate.js +7 -6
- package/funcs/filesUpdate.js.map +1 -1
- package/funcs/filesUpload.d.ts.map +1 -1
- package/funcs/filesUpload.js +17 -15
- package/funcs/filesUpload.js.map +1 -1
- package/funcs/promptSnippetsFindOne.d.ts.map +1 -1
- package/funcs/promptSnippetsFindOne.js +7 -6
- package/funcs/promptSnippetsFindOne.js.map +1 -1
- package/funcs/promptTemplatesGetAll.d.ts.map +1 -1
- package/funcs/promptTemplatesGetAll.js +10 -9
- package/funcs/promptTemplatesGetAll.js.map +1 -1
- package/funcs/promptsCreate.d.ts.map +1 -1
- package/funcs/promptsCreate.js +7 -6
- package/funcs/promptsCreate.js.map +1 -1
- package/funcs/promptsCreateVersion.d.ts.map +1 -1
- package/funcs/promptsCreateVersion.js +7 -6
- package/funcs/promptsCreateVersion.js.map +1 -1
- package/funcs/promptsDelete.d.ts.map +1 -1
- package/funcs/promptsDelete.js +7 -6
- package/funcs/promptsDelete.js.map +1 -1
- package/funcs/promptsDuplicate.d.ts.map +1 -1
- package/funcs/promptsDuplicate.js +7 -6
- package/funcs/promptsDuplicate.js.map +1 -1
- package/funcs/promptsGetAll.d.ts.map +1 -1
- package/funcs/promptsGetAll.js +7 -6
- package/funcs/promptsGetAll.js.map +1 -1
- package/funcs/promptsGetOne.d.ts.map +1 -1
- package/funcs/promptsGetOne.js +7 -6
- package/funcs/promptsGetOne.js.map +1 -1
- package/funcs/promptsUpdate.d.ts.map +1 -1
- package/funcs/promptsUpdate.js +7 -6
- package/funcs/promptsUpdate.js.map +1 -1
- package/funcs/remoteconfigGetConfig.d.ts.map +1 -1
- package/funcs/remoteconfigGetConfig.js +7 -6
- package/funcs/remoteconfigGetConfig.js.map +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +5 -6
- package/lib/config.js.map +1 -1
- package/lib/encodings.d.ts +10 -9
- package/lib/encodings.d.ts.map +1 -1
- package/lib/encodings.js +91 -66
- package/lib/encodings.js.map +1 -1
- package/lib/env.js +1 -2
- package/lib/env.js.map +1 -1
- package/lib/event-streams.js +2 -3
- package/lib/event-streams.js.map +1 -1
- package/lib/http.js +1 -2
- package/lib/http.js.map +1 -1
- package/lib/matchers.js +5 -6
- package/lib/matchers.js.map +1 -1
- package/lib/primitives.d.ts +1 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +11 -1
- package/lib/primitives.js.map +1 -1
- package/lib/retries.js +3 -4
- package/lib/retries.js.map +1 -1
- package/lib/sdks.d.ts.map +1 -1
- package/lib/sdks.js +19 -17
- package/lib/sdks.js.map +1 -1
- package/lib/security.js +2 -3
- package/lib/security.js.map +1 -1
- package/lib/url.js +1 -1
- package/lib/url.js.map +1 -1
- package/models/errors/httpclienterrors.js +2 -2
- package/models/errors/httpclienterrors.js.map +1 -1
- package/package.json +2 -3
- package/packages/orq-rc/FUNCTIONS.md +106 -0
- package/packages/orq-rc/README.md +564 -0
- package/packages/orq-rc/RUNTIMES.md +22 -0
- package/packages/orq-rc/docs/sdks/contacts/README.md +84 -0
- package/packages/orq-rc/docs/sdks/deployments/README.md +239 -0
- package/packages/orq-rc/docs/sdks/feedback/README.md +92 -0
- package/packages/orq-rc/docs/sdks/files/README.md +473 -0
- package/packages/orq-rc/docs/sdks/metrics/README.md +86 -0
- package/packages/orq-rc/docs/sdks/orq/README.md +10 -0
- package/packages/orq-rc/docs/sdks/prompt/README.md +6 -0
- package/packages/orq-rc/docs/sdks/prompts/README.md +533 -0
- package/packages/orq-rc/docs/sdks/remoteconfig/README.md +80 -0
- package/packages/orq-rc/docs/sdks/snippets/README.md +84 -0
- package/packages/orq-rc/docs/sdks/templates/README.md +80 -0
- package/packages/orq-rc/src/core.ts +13 -0
- package/packages/orq-rc/src/funcs/contactsCreate.ts +124 -0
- package/packages/orq-rc/src/funcs/deploymentsAll.ts +138 -0
- package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +132 -0
- package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +135 -0
- package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +132 -0
- package/packages/orq-rc/src/funcs/feedbackCreate.ts +124 -0
- package/packages/orq-rc/src/funcs/filesBulkUpload.ts +126 -0
- package/packages/orq-rc/src/funcs/filesDelete.ts +128 -0
- package/packages/orq-rc/src/funcs/filesGet.ts +127 -0
- package/packages/orq-rc/src/funcs/filesList.ts +129 -0
- package/packages/orq-rc/src/funcs/filesUpdate.ts +128 -0
- package/packages/orq-rc/src/funcs/filesUpload.ts +145 -0
- package/packages/orq-rc/src/funcs/promptSnippetsFindOne.ts +128 -0
- package/packages/orq-rc/src/funcs/promptTemplatesGetAll.ts +130 -0
- package/packages/orq-rc/src/funcs/promptsCreate.ts +124 -0
- package/packages/orq-rc/src/funcs/promptsCreateVersion.ts +129 -0
- package/packages/orq-rc/src/funcs/promptsDelete.ts +128 -0
- package/packages/orq-rc/src/funcs/promptsDuplicate.ts +128 -0
- package/packages/orq-rc/src/funcs/promptsGetAll.ts +126 -0
- package/packages/orq-rc/src/funcs/promptsGetOne.ts +128 -0
- package/packages/orq-rc/src/funcs/promptsUpdate.ts +136 -0
- package/packages/orq-rc/src/funcs/remoteconfigGetConfig.ts +125 -0
- package/packages/orq-rc/src/hooks/hooks.ts +132 -0
- package/packages/orq-rc/src/hooks/index.ts +6 -0
- package/packages/orq-rc/src/hooks/registration.ts +14 -0
- package/packages/orq-rc/src/hooks/types.ts +109 -0
- package/packages/orq-rc/src/index.ts +7 -0
- package/packages/orq-rc/src/lib/base64.ts +37 -0
- package/packages/orq-rc/src/lib/config.ts +60 -0
- package/packages/orq-rc/src/lib/dlv.ts +53 -0
- package/packages/orq-rc/src/lib/encodings.ts +449 -0
- package/packages/orq-rc/src/lib/env.ts +41 -0
- package/packages/orq-rc/src/lib/event-streams.ts +264 -0
- package/packages/orq-rc/src/lib/files.ts +40 -0
- package/packages/orq-rc/src/lib/http.ts +323 -0
- package/packages/orq-rc/src/lib/is-plain-object.ts +43 -0
- package/packages/orq-rc/src/lib/logger.ts +9 -0
- package/packages/orq-rc/src/lib/matchers.ts +325 -0
- package/packages/orq-rc/src/lib/primitives.ts +122 -0
- package/packages/orq-rc/src/lib/retries.ts +219 -0
- package/packages/orq-rc/src/lib/schemas.ts +86 -0
- package/packages/orq-rc/src/lib/sdks.ts +397 -0
- package/packages/orq-rc/src/lib/security.ts +254 -0
- package/packages/orq-rc/src/lib/url.ts +33 -0
- package/packages/orq-rc/src/models/components/deployments.ts +1673 -0
- package/packages/orq-rc/src/models/components/index.ts +6 -0
- package/packages/orq-rc/src/models/components/security.ts +71 -0
- package/packages/orq-rc/src/models/errors/apierror.ts +27 -0
- package/packages/orq-rc/src/models/errors/honoapierror.ts +82 -0
- package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
- package/packages/orq-rc/src/models/errors/index.ts +9 -0
- package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +97 -0
- package/packages/orq-rc/src/models/errors/updateprompt.ts +71 -0
- package/packages/orq-rc/src/models/operations/bulkfileupload.ts +315 -0
- package/packages/orq-rc/src/models/operations/createcontact.ts +256 -0
- package/packages/orq-rc/src/models/operations/createfeedback.ts +286 -0
- package/packages/orq-rc/src/models/operations/createprompt.ts +3461 -0
- package/packages/orq-rc/src/models/operations/createpromptversion.ts +3703 -0
- package/packages/orq-rc/src/models/operations/deleteprompt.ts +69 -0
- package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +1790 -0
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +3483 -0
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +2385 -0
- package/packages/orq-rc/src/models/operations/deployments.ts +2098 -0
- package/packages/orq-rc/src/models/operations/duplicateprompt.ts +69 -0
- package/packages/orq-rc/src/models/operations/filedelete.ts +78 -0
- package/packages/orq-rc/src/models/operations/fileget.ts +222 -0
- package/packages/orq-rc/src/models/operations/filelist.ts +333 -0
- package/packages/orq-rc/src/models/operations/fileupdate.ts +298 -0
- package/packages/orq-rc/src/models/operations/fileupload.ts +322 -0
- package/packages/orq-rc/src/models/operations/findonepromptsnippet.ts +13629 -0
- package/packages/orq-rc/src/models/operations/getallprompts.ts +18640 -0
- package/packages/orq-rc/src/models/operations/getallprompttemplates.ts +13690 -0
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +69 -0
- package/packages/orq-rc/src/models/operations/index.ts +26 -0
- package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +190 -0
- package/packages/orq-rc/src/models/operations/updateprompt.ts +14407 -0
- package/packages/orq-rc/src/sdk/contacts.ts +27 -0
- package/packages/orq-rc/src/sdk/deployments.ts +75 -0
- package/packages/orq-rc/src/sdk/feedback.ts +27 -0
- package/packages/orq-rc/src/sdk/files.ts +105 -0
- package/packages/orq-rc/src/sdk/index.ts +5 -0
- package/packages/orq-rc/src/sdk/metrics.ts +27 -0
- package/packages/orq-rc/src/sdk/prompt.ts +19 -0
- package/packages/orq-rc/src/sdk/prompts.ts +114 -0
- package/packages/orq-rc/src/sdk/remoteconfig.ts +24 -0
- package/packages/orq-rc/src/sdk/sdk.ts +49 -0
- package/packages/orq-rc/src/sdk/snippets.ts +24 -0
- package/packages/orq-rc/src/sdk/templates.ts +24 -0
- package/packages/orq-rc/src/types/blobs.ts +31 -0
- package/packages/orq-rc/src/types/constdatetime.ts +15 -0
- package/packages/orq-rc/src/types/enums.ts +16 -0
- package/packages/orq-rc/src/types/fp.ts +50 -0
- package/packages/orq-rc/src/types/index.ts +11 -0
- package/packages/orq-rc/src/types/operations.ts +105 -0
- package/packages/orq-rc/src/types/rfcdate.ts +54 -0
- package/packages/orq-rc/src/types/streams.ts +21 -0
- package/sdk/deployments.js +1 -2
- package/sdk/deployments.js.map +1 -1
- package/sdk/prompt.js +2 -4
- package/sdk/prompt.js.map +1 -1
- package/sdk/sdk.js +7 -14
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/contactsCreate.ts +3 -2
- package/src/funcs/deploymentsAll.ts +3 -2
- package/src/funcs/deploymentsGetConfig.ts +3 -2
- package/src/funcs/deploymentsInvoke.ts +3 -2
- package/src/funcs/deploymentsMetricsCreate.ts +3 -2
- package/src/funcs/feedbackCreate.ts +3 -2
- package/src/funcs/filesBulkUpload.ts +6 -4
- package/src/funcs/filesDelete.ts +3 -2
- package/src/funcs/filesGet.ts +3 -2
- package/src/funcs/filesList.ts +3 -2
- package/src/funcs/filesUpdate.ts +3 -2
- package/src/funcs/filesUpload.ts +9 -6
- package/src/funcs/promptSnippetsFindOne.ts +3 -2
- package/src/funcs/promptTemplatesGetAll.ts +3 -2
- package/src/funcs/promptsCreate.ts +3 -2
- package/src/funcs/promptsCreateVersion.ts +3 -2
- package/src/funcs/promptsDelete.ts +3 -2
- package/src/funcs/promptsDuplicate.ts +3 -2
- package/src/funcs/promptsGetAll.ts +3 -2
- package/src/funcs/promptsGetOne.ts +3 -2
- package/src/funcs/promptsUpdate.ts +3 -2
- package/src/funcs/remoteconfigGetConfig.ts +3 -2
- package/src/lib/config.ts +4 -4
- package/src/lib/encodings.ts +95 -61
- package/src/lib/primitives.ts +14 -0
- package/src/lib/sdks.ts +4 -1
- package/src/lib/security.ts +1 -1
|
@@ -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
|
+
}
|
|
@@ -0,0 +1,256 @@
|
|
|
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
|
+
/**
|
|
12
|
+
* Update user information payload
|
|
13
|
+
*/
|
|
14
|
+
export type CreateContactRequestBody = {
|
|
15
|
+
/**
|
|
16
|
+
* Unique string value to identify the contact user in the customer's system
|
|
17
|
+
*/
|
|
18
|
+
externalId: string;
|
|
19
|
+
/**
|
|
20
|
+
* Display name or nickname of the user
|
|
21
|
+
*/
|
|
22
|
+
displayName?: string | null | undefined;
|
|
23
|
+
/**
|
|
24
|
+
* Email address of the user
|
|
25
|
+
*/
|
|
26
|
+
email?: string | null | undefined;
|
|
27
|
+
/**
|
|
28
|
+
* URL linking to the user's avatar image
|
|
29
|
+
*/
|
|
30
|
+
avatarUrl?: string | null | undefined;
|
|
31
|
+
/**
|
|
32
|
+
* Array of UUIDs representing tags associated with the user
|
|
33
|
+
*/
|
|
34
|
+
tags?: Array<string> | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* Additional custom metadata associated with the user as key-value pairs
|
|
37
|
+
*/
|
|
38
|
+
metadata?: { [k: string]: any } | undefined;
|
|
39
|
+
};
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Successful operation
|
|
43
|
+
*/
|
|
44
|
+
export type CreateContactResponseBody = {
|
|
45
|
+
/**
|
|
46
|
+
* Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the user
|
|
47
|
+
*/
|
|
48
|
+
id: string;
|
|
49
|
+
/**
|
|
50
|
+
* Unique string value to identify the contact user in the customer's system
|
|
51
|
+
*/
|
|
52
|
+
externalId: string;
|
|
53
|
+
/**
|
|
54
|
+
* Display name or nickname of the user
|
|
55
|
+
*/
|
|
56
|
+
displayName?: string | null | undefined;
|
|
57
|
+
/**
|
|
58
|
+
* Email address of the user
|
|
59
|
+
*/
|
|
60
|
+
email?: string | null | undefined;
|
|
61
|
+
/**
|
|
62
|
+
* URL linking to the user's avatar image
|
|
63
|
+
*/
|
|
64
|
+
avatarUrl?: string | null | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* Array of UUIDs representing tags associated with the user
|
|
67
|
+
*/
|
|
68
|
+
tags?: Array<string> | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* Additional custom metadata associated with the user as key-value pairs
|
|
71
|
+
*/
|
|
72
|
+
metadata?: { [k: string]: any } | undefined;
|
|
73
|
+
/**
|
|
74
|
+
* The date and time the resource was created
|
|
75
|
+
*/
|
|
76
|
+
created?: Date | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* The date and time the resource was last updated
|
|
79
|
+
*/
|
|
80
|
+
updated?: Date | undefined;
|
|
81
|
+
};
|
|
82
|
+
|
|
83
|
+
/** @internal */
|
|
84
|
+
export const CreateContactRequestBody$inboundSchema: z.ZodType<
|
|
85
|
+
CreateContactRequestBody,
|
|
86
|
+
z.ZodTypeDef,
|
|
87
|
+
unknown
|
|
88
|
+
> = z.object({
|
|
89
|
+
external_id: z.string(),
|
|
90
|
+
display_name: z.nullable(z.string()).optional(),
|
|
91
|
+
email: z.nullable(z.string()).optional(),
|
|
92
|
+
avatar_url: z.nullable(z.string()).optional(),
|
|
93
|
+
tags: z.array(z.string()).optional(),
|
|
94
|
+
metadata: z.record(z.any()).optional(),
|
|
95
|
+
}).transform((v) => {
|
|
96
|
+
return remap$(v, {
|
|
97
|
+
"external_id": "externalId",
|
|
98
|
+
"display_name": "displayName",
|
|
99
|
+
"avatar_url": "avatarUrl",
|
|
100
|
+
});
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
/** @internal */
|
|
104
|
+
export type CreateContactRequestBody$Outbound = {
|
|
105
|
+
external_id: string;
|
|
106
|
+
display_name?: string | null | undefined;
|
|
107
|
+
email?: string | null | undefined;
|
|
108
|
+
avatar_url?: string | null | undefined;
|
|
109
|
+
tags?: Array<string> | undefined;
|
|
110
|
+
metadata?: { [k: string]: any } | undefined;
|
|
111
|
+
};
|
|
112
|
+
|
|
113
|
+
/** @internal */
|
|
114
|
+
export const CreateContactRequestBody$outboundSchema: z.ZodType<
|
|
115
|
+
CreateContactRequestBody$Outbound,
|
|
116
|
+
z.ZodTypeDef,
|
|
117
|
+
CreateContactRequestBody
|
|
118
|
+
> = z.object({
|
|
119
|
+
externalId: z.string(),
|
|
120
|
+
displayName: z.nullable(z.string()).optional(),
|
|
121
|
+
email: z.nullable(z.string()).optional(),
|
|
122
|
+
avatarUrl: z.nullable(z.string()).optional(),
|
|
123
|
+
tags: z.array(z.string()).optional(),
|
|
124
|
+
metadata: z.record(z.any()).optional(),
|
|
125
|
+
}).transform((v) => {
|
|
126
|
+
return remap$(v, {
|
|
127
|
+
externalId: "external_id",
|
|
128
|
+
displayName: "display_name",
|
|
129
|
+
avatarUrl: "avatar_url",
|
|
130
|
+
});
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* @internal
|
|
135
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
136
|
+
*/
|
|
137
|
+
export namespace CreateContactRequestBody$ {
|
|
138
|
+
/** @deprecated use `CreateContactRequestBody$inboundSchema` instead. */
|
|
139
|
+
export const inboundSchema = CreateContactRequestBody$inboundSchema;
|
|
140
|
+
/** @deprecated use `CreateContactRequestBody$outboundSchema` instead. */
|
|
141
|
+
export const outboundSchema = CreateContactRequestBody$outboundSchema;
|
|
142
|
+
/** @deprecated use `CreateContactRequestBody$Outbound` instead. */
|
|
143
|
+
export type Outbound = CreateContactRequestBody$Outbound;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
export function createContactRequestBodyToJSON(
|
|
147
|
+
createContactRequestBody: CreateContactRequestBody,
|
|
148
|
+
): string {
|
|
149
|
+
return JSON.stringify(
|
|
150
|
+
CreateContactRequestBody$outboundSchema.parse(createContactRequestBody),
|
|
151
|
+
);
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
export function createContactRequestBodyFromJSON(
|
|
155
|
+
jsonString: string,
|
|
156
|
+
): SafeParseResult<CreateContactRequestBody, SDKValidationError> {
|
|
157
|
+
return safeParse(
|
|
158
|
+
jsonString,
|
|
159
|
+
(x) => CreateContactRequestBody$inboundSchema.parse(JSON.parse(x)),
|
|
160
|
+
`Failed to parse 'CreateContactRequestBody' from JSON`,
|
|
161
|
+
);
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
/** @internal */
|
|
165
|
+
export const CreateContactResponseBody$inboundSchema: z.ZodType<
|
|
166
|
+
CreateContactResponseBody,
|
|
167
|
+
z.ZodTypeDef,
|
|
168
|
+
unknown
|
|
169
|
+
> = z.object({
|
|
170
|
+
id: z.string(),
|
|
171
|
+
external_id: z.string(),
|
|
172
|
+
display_name: z.nullable(z.string()).optional(),
|
|
173
|
+
email: z.nullable(z.string()).optional(),
|
|
174
|
+
avatar_url: z.nullable(z.string()).optional(),
|
|
175
|
+
tags: z.array(z.string()).optional(),
|
|
176
|
+
metadata: z.record(z.any()).optional(),
|
|
177
|
+
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
178
|
+
.optional(),
|
|
179
|
+
updated: z.string().datetime({ offset: true }).default(
|
|
180
|
+
"2025-01-02T13:55:01.056Z",
|
|
181
|
+
).transform(v => new Date(v)),
|
|
182
|
+
}).transform((v) => {
|
|
183
|
+
return remap$(v, {
|
|
184
|
+
"external_id": "externalId",
|
|
185
|
+
"display_name": "displayName",
|
|
186
|
+
"avatar_url": "avatarUrl",
|
|
187
|
+
});
|
|
188
|
+
});
|
|
189
|
+
|
|
190
|
+
/** @internal */
|
|
191
|
+
export type CreateContactResponseBody$Outbound = {
|
|
192
|
+
id: string;
|
|
193
|
+
external_id: string;
|
|
194
|
+
display_name?: string | null | undefined;
|
|
195
|
+
email?: string | null | undefined;
|
|
196
|
+
avatar_url?: string | null | undefined;
|
|
197
|
+
tags?: Array<string> | undefined;
|
|
198
|
+
metadata?: { [k: string]: any } | undefined;
|
|
199
|
+
created?: string | undefined;
|
|
200
|
+
updated: string;
|
|
201
|
+
};
|
|
202
|
+
|
|
203
|
+
/** @internal */
|
|
204
|
+
export const CreateContactResponseBody$outboundSchema: z.ZodType<
|
|
205
|
+
CreateContactResponseBody$Outbound,
|
|
206
|
+
z.ZodTypeDef,
|
|
207
|
+
CreateContactResponseBody
|
|
208
|
+
> = z.object({
|
|
209
|
+
id: z.string(),
|
|
210
|
+
externalId: z.string(),
|
|
211
|
+
displayName: z.nullable(z.string()).optional(),
|
|
212
|
+
email: z.nullable(z.string()).optional(),
|
|
213
|
+
avatarUrl: z.nullable(z.string()).optional(),
|
|
214
|
+
tags: z.array(z.string()).optional(),
|
|
215
|
+
metadata: z.record(z.any()).optional(),
|
|
216
|
+
created: z.date().transform(v => v.toISOString()).optional(),
|
|
217
|
+
updated: z.date().default(() => new Date("2025-01-02T13:55:01.056Z"))
|
|
218
|
+
.transform(v => v.toISOString()),
|
|
219
|
+
}).transform((v) => {
|
|
220
|
+
return remap$(v, {
|
|
221
|
+
externalId: "external_id",
|
|
222
|
+
displayName: "display_name",
|
|
223
|
+
avatarUrl: "avatar_url",
|
|
224
|
+
});
|
|
225
|
+
});
|
|
226
|
+
|
|
227
|
+
/**
|
|
228
|
+
* @internal
|
|
229
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
230
|
+
*/
|
|
231
|
+
export namespace CreateContactResponseBody$ {
|
|
232
|
+
/** @deprecated use `CreateContactResponseBody$inboundSchema` instead. */
|
|
233
|
+
export const inboundSchema = CreateContactResponseBody$inboundSchema;
|
|
234
|
+
/** @deprecated use `CreateContactResponseBody$outboundSchema` instead. */
|
|
235
|
+
export const outboundSchema = CreateContactResponseBody$outboundSchema;
|
|
236
|
+
/** @deprecated use `CreateContactResponseBody$Outbound` instead. */
|
|
237
|
+
export type Outbound = CreateContactResponseBody$Outbound;
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
export function createContactResponseBodyToJSON(
|
|
241
|
+
createContactResponseBody: CreateContactResponseBody,
|
|
242
|
+
): string {
|
|
243
|
+
return JSON.stringify(
|
|
244
|
+
CreateContactResponseBody$outboundSchema.parse(createContactResponseBody),
|
|
245
|
+
);
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
export function createContactResponseBodyFromJSON(
|
|
249
|
+
jsonString: string,
|
|
250
|
+
): SafeParseResult<CreateContactResponseBody, SDKValidationError> {
|
|
251
|
+
return safeParse(
|
|
252
|
+
jsonString,
|
|
253
|
+
(x) => CreateContactResponseBody$inboundSchema.parse(JSON.parse(x)),
|
|
254
|
+
`Failed to parse 'CreateContactResponseBody' from JSON`,
|
|
255
|
+
);
|
|
256
|
+
}
|