@orq-ai/node 3.6.5 → 3.6.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.
- package/FUNCTIONS.md +5 -22
- package/README.md +45 -47
- package/bin/mcp-server.js +43 -43
- package/bin/mcp-server.js.map +23 -23
- package/docs/sdks/contacts/README.md +5 -9
- package/docs/sdks/datasets/README.md +65 -111
- package/docs/sdks/deployments/README.md +34 -44
- package/docs/sdks/feedback/README.md +5 -9
- package/docs/sdks/files/README.md +20 -34
- package/docs/sdks/knowledge/README.md +80 -138
- package/docs/sdks/metrics/README.md +5 -9
- package/docs/sdks/models/README.md +5 -9
- package/docs/sdks/prompts/README.md +35 -61
- package/docs/sdks/remoteconfigs/README.md +5 -9
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.js +1 -1
- package/models/errors/apierror.d.ts +14 -2
- package/models/errors/apierror.d.ts.map +1 -1
- package/models/errors/apierror.js +1 -1
- package/models/errors/apierror.js.map +1 -1
- package/models/operations/bulkcreatedatapoints.js +2 -2
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.js +2 -2
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/listdatasetdatapoints.js +2 -2
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/retrievedatapoint.js +2 -2
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/updatedatapoint.js +2 -2
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/package.json +1 -1
- package/packages/orq-rc/FUNCTIONS.md +5 -22
- package/packages/orq-rc/README.md +129 -47
- package/packages/orq-rc/docs/sdks/contacts/README.md +344 -11
- package/packages/orq-rc/docs/sdks/datasets/README.md +60 -102
- package/packages/orq-rc/docs/sdks/deployments/README.md +34 -44
- package/packages/orq-rc/docs/sdks/evals/README.md +175 -315
- package/packages/orq-rc/docs/sdks/feedback/README.md +5 -9
- package/packages/orq-rc/docs/sdks/files/README.md +20 -34
- package/packages/orq-rc/docs/sdks/knowledge/README.md +80 -138
- package/packages/orq-rc/docs/sdks/metrics/README.md +5 -9
- package/packages/orq-rc/docs/sdks/models/README.md +5 -9
- package/packages/orq-rc/docs/sdks/prompts/README.md +35 -61
- package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +5 -9
- package/packages/orq-rc/jsr.json +1 -1
- package/packages/orq-rc/package-lock.json +2 -2
- package/packages/orq-rc/package.json +1 -1
- package/packages/orq-rc/src/funcs/contactsCreate.ts +12 -7
- package/packages/orq-rc/src/funcs/contactsDelete.ts +172 -0
- package/packages/orq-rc/src/funcs/contactsList.ts +165 -0
- package/packages/orq-rc/src/funcs/contactsRetrieve.ts +171 -0
- package/packages/orq-rc/src/funcs/contactsUpdate.ts +172 -0
- package/packages/orq-rc/src/lib/config.ts +3 -3
- package/packages/orq-rc/src/mcp-server/mcp-server.ts +1 -1
- package/packages/orq-rc/src/mcp-server/server.ts +9 -1
- package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +3 -3
- package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +37 -0
- package/packages/orq-rc/src/models/errors/apierror.ts +18 -3
- package/packages/orq-rc/src/models/errors/deletecontact.ts +81 -0
- package/packages/orq-rc/src/models/errors/index.ts +3 -0
- package/packages/orq-rc/src/models/errors/retrievecontact.ts +81 -0
- package/packages/orq-rc/src/models/errors/updatecontact.ts +74 -0
- package/packages/orq-rc/src/models/operations/createcontact.ts +30 -19
- package/packages/orq-rc/src/models/operations/createdataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/createdatasetitem.ts +2 -2
- package/packages/orq-rc/src/models/operations/createdatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/createeval.ts +16 -16
- package/packages/orq-rc/src/models/operations/deletecontact.ts +69 -0
- package/packages/orq-rc/src/models/operations/deployments.ts +69 -59
- package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
- package/packages/orq-rc/src/models/operations/filelist.ts +2 -2
- package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
- package/packages/orq-rc/src/models/operations/index.ts +4 -0
- package/packages/orq-rc/src/models/operations/listcontacts.ts +490 -0
- package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2 -2
- package/packages/orq-rc/src/models/operations/listdatasets.ts +2 -2
- package/packages/orq-rc/src/models/operations/listdatasources.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievecontact.ts +210 -0
- package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievedataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievedatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatecontact.ts +325 -0
- package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedatasource.ts +2 -2
- package/packages/orq-rc/src/sdk/contacts.ts +75 -3
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/src/models/errors/apierror.ts +18 -3
- package/src/models/operations/bulkcreatedatapoints.ts +2 -2
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +2 -2
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +2 -2
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +2 -2
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +2 -2
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
|
@@ -0,0 +1,210 @@
|
|
|
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 RetrieveContactRequest = {
|
|
12
|
+
/**
|
|
13
|
+
* Unique contact id or external id
|
|
14
|
+
*/
|
|
15
|
+
id: string;
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Contact details
|
|
20
|
+
*/
|
|
21
|
+
export type RetrieveContactResponseBody = {
|
|
22
|
+
/**
|
|
23
|
+
* Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the contact
|
|
24
|
+
*/
|
|
25
|
+
id: string;
|
|
26
|
+
/**
|
|
27
|
+
* Unique string value to identify the contact user in the customer's system. This should be the same ID you use in your system to reference this user.
|
|
28
|
+
*/
|
|
29
|
+
externalId: string;
|
|
30
|
+
/**
|
|
31
|
+
* Display name or nickname of the contact user. This is typically shown in user interfaces.
|
|
32
|
+
*/
|
|
33
|
+
displayName?: string | null | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* Email address of the contact user
|
|
36
|
+
*/
|
|
37
|
+
email?: string | null | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* URL linking to the contact user's avatar image
|
|
40
|
+
*/
|
|
41
|
+
avatarUrl?: string | null | undefined;
|
|
42
|
+
/**
|
|
43
|
+
* Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
|
|
44
|
+
*/
|
|
45
|
+
tags?: Array<string> | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
|
|
48
|
+
*/
|
|
49
|
+
metadata?: { [k: string]: any } | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* The date and time the resource was created
|
|
52
|
+
*/
|
|
53
|
+
created?: Date | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* The date and time the resource was last updated
|
|
56
|
+
*/
|
|
57
|
+
updated?: Date | undefined;
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
/** @internal */
|
|
61
|
+
export const RetrieveContactRequest$inboundSchema: z.ZodType<
|
|
62
|
+
RetrieveContactRequest,
|
|
63
|
+
z.ZodTypeDef,
|
|
64
|
+
unknown
|
|
65
|
+
> = z.object({
|
|
66
|
+
id: z.string(),
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
/** @internal */
|
|
70
|
+
export type RetrieveContactRequest$Outbound = {
|
|
71
|
+
id: string;
|
|
72
|
+
};
|
|
73
|
+
|
|
74
|
+
/** @internal */
|
|
75
|
+
export const RetrieveContactRequest$outboundSchema: z.ZodType<
|
|
76
|
+
RetrieveContactRequest$Outbound,
|
|
77
|
+
z.ZodTypeDef,
|
|
78
|
+
RetrieveContactRequest
|
|
79
|
+
> = z.object({
|
|
80
|
+
id: z.string(),
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* @internal
|
|
85
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
86
|
+
*/
|
|
87
|
+
export namespace RetrieveContactRequest$ {
|
|
88
|
+
/** @deprecated use `RetrieveContactRequest$inboundSchema` instead. */
|
|
89
|
+
export const inboundSchema = RetrieveContactRequest$inboundSchema;
|
|
90
|
+
/** @deprecated use `RetrieveContactRequest$outboundSchema` instead. */
|
|
91
|
+
export const outboundSchema = RetrieveContactRequest$outboundSchema;
|
|
92
|
+
/** @deprecated use `RetrieveContactRequest$Outbound` instead. */
|
|
93
|
+
export type Outbound = RetrieveContactRequest$Outbound;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
export function retrieveContactRequestToJSON(
|
|
97
|
+
retrieveContactRequest: RetrieveContactRequest,
|
|
98
|
+
): string {
|
|
99
|
+
return JSON.stringify(
|
|
100
|
+
RetrieveContactRequest$outboundSchema.parse(retrieveContactRequest),
|
|
101
|
+
);
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
export function retrieveContactRequestFromJSON(
|
|
105
|
+
jsonString: string,
|
|
106
|
+
): SafeParseResult<RetrieveContactRequest, SDKValidationError> {
|
|
107
|
+
return safeParse(
|
|
108
|
+
jsonString,
|
|
109
|
+
(x) => RetrieveContactRequest$inboundSchema.parse(JSON.parse(x)),
|
|
110
|
+
`Failed to parse 'RetrieveContactRequest' from JSON`,
|
|
111
|
+
);
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
/** @internal */
|
|
115
|
+
export const RetrieveContactResponseBody$inboundSchema: z.ZodType<
|
|
116
|
+
RetrieveContactResponseBody,
|
|
117
|
+
z.ZodTypeDef,
|
|
118
|
+
unknown
|
|
119
|
+
> = z.object({
|
|
120
|
+
_id: z.string(),
|
|
121
|
+
external_id: z.string(),
|
|
122
|
+
display_name: z.nullable(z.string()).optional(),
|
|
123
|
+
email: z.nullable(z.string()).optional(),
|
|
124
|
+
avatar_url: z.nullable(z.string()).optional(),
|
|
125
|
+
tags: z.array(z.string()).optional(),
|
|
126
|
+
metadata: z.record(z.any()).optional(),
|
|
127
|
+
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
128
|
+
.optional(),
|
|
129
|
+
updated: z.string().datetime({ offset: true }).default(
|
|
130
|
+
"2025-06-04T07:24:10.431Z",
|
|
131
|
+
).transform(v => new Date(v)),
|
|
132
|
+
}).transform((v) => {
|
|
133
|
+
return remap$(v, {
|
|
134
|
+
"_id": "id",
|
|
135
|
+
"external_id": "externalId",
|
|
136
|
+
"display_name": "displayName",
|
|
137
|
+
"avatar_url": "avatarUrl",
|
|
138
|
+
});
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
/** @internal */
|
|
142
|
+
export type RetrieveContactResponseBody$Outbound = {
|
|
143
|
+
_id: string;
|
|
144
|
+
external_id: string;
|
|
145
|
+
display_name?: string | null | undefined;
|
|
146
|
+
email?: string | null | undefined;
|
|
147
|
+
avatar_url?: string | null | undefined;
|
|
148
|
+
tags?: Array<string> | undefined;
|
|
149
|
+
metadata?: { [k: string]: any } | undefined;
|
|
150
|
+
created?: string | undefined;
|
|
151
|
+
updated: string;
|
|
152
|
+
};
|
|
153
|
+
|
|
154
|
+
/** @internal */
|
|
155
|
+
export const RetrieveContactResponseBody$outboundSchema: z.ZodType<
|
|
156
|
+
RetrieveContactResponseBody$Outbound,
|
|
157
|
+
z.ZodTypeDef,
|
|
158
|
+
RetrieveContactResponseBody
|
|
159
|
+
> = z.object({
|
|
160
|
+
id: z.string(),
|
|
161
|
+
externalId: z.string(),
|
|
162
|
+
displayName: z.nullable(z.string()).optional(),
|
|
163
|
+
email: z.nullable(z.string()).optional(),
|
|
164
|
+
avatarUrl: z.nullable(z.string()).optional(),
|
|
165
|
+
tags: z.array(z.string()).optional(),
|
|
166
|
+
metadata: z.record(z.any()).optional(),
|
|
167
|
+
created: z.date().transform(v => v.toISOString()).optional(),
|
|
168
|
+
updated: z.date().default(() => new Date("2025-06-04T07:24:10.431Z"))
|
|
169
|
+
.transform(v => v.toISOString()),
|
|
170
|
+
}).transform((v) => {
|
|
171
|
+
return remap$(v, {
|
|
172
|
+
id: "_id",
|
|
173
|
+
externalId: "external_id",
|
|
174
|
+
displayName: "display_name",
|
|
175
|
+
avatarUrl: "avatar_url",
|
|
176
|
+
});
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
/**
|
|
180
|
+
* @internal
|
|
181
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
182
|
+
*/
|
|
183
|
+
export namespace RetrieveContactResponseBody$ {
|
|
184
|
+
/** @deprecated use `RetrieveContactResponseBody$inboundSchema` instead. */
|
|
185
|
+
export const inboundSchema = RetrieveContactResponseBody$inboundSchema;
|
|
186
|
+
/** @deprecated use `RetrieveContactResponseBody$outboundSchema` instead. */
|
|
187
|
+
export const outboundSchema = RetrieveContactResponseBody$outboundSchema;
|
|
188
|
+
/** @deprecated use `RetrieveContactResponseBody$Outbound` instead. */
|
|
189
|
+
export type Outbound = RetrieveContactResponseBody$Outbound;
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
export function retrieveContactResponseBodyToJSON(
|
|
193
|
+
retrieveContactResponseBody: RetrieveContactResponseBody,
|
|
194
|
+
): string {
|
|
195
|
+
return JSON.stringify(
|
|
196
|
+
RetrieveContactResponseBody$outboundSchema.parse(
|
|
197
|
+
retrieveContactResponseBody,
|
|
198
|
+
),
|
|
199
|
+
);
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
export function retrieveContactResponseBodyFromJSON(
|
|
203
|
+
jsonString: string,
|
|
204
|
+
): SafeParseResult<RetrieveContactResponseBody, SDKValidationError> {
|
|
205
|
+
return safeParse(
|
|
206
|
+
jsonString,
|
|
207
|
+
(x) => RetrieveContactResponseBody$inboundSchema.parse(JSON.parse(x)),
|
|
208
|
+
`Failed to parse 'RetrieveContactResponseBody' from JSON`,
|
|
209
|
+
);
|
|
210
|
+
}
|
|
@@ -2481,7 +2481,7 @@ export const RetrieveDatapointResponseBody$inboundSchema: z.ZodType<
|
|
|
2481
2481
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
2482
2482
|
.optional(),
|
|
2483
2483
|
updated: z.string().datetime({ offset: true }).default(
|
|
2484
|
-
"2025-06-
|
|
2484
|
+
"2025-06-04T07:24:10.431Z",
|
|
2485
2485
|
).transform(v => new Date(v)),
|
|
2486
2486
|
}).transform((v) => {
|
|
2487
2487
|
return remap$(v, {
|
|
@@ -2539,7 +2539,7 @@ export const RetrieveDatapointResponseBody$outboundSchema: z.ZodType<
|
|
|
2539
2539
|
createdById: z.string().optional(),
|
|
2540
2540
|
updatedById: z.string().optional(),
|
|
2541
2541
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
2542
|
-
updated: z.date().default(() => new Date("2025-06-
|
|
2542
|
+
updated: z.date().default(() => new Date("2025-06-04T07:24:10.431Z"))
|
|
2543
2543
|
.transform(v => v.toISOString()),
|
|
2544
2544
|
}).transform((v) => {
|
|
2545
2545
|
return remap$(v, {
|
|
@@ -201,7 +201,7 @@ export const RetrieveDatasetResponseBody$inboundSchema: z.ZodType<
|
|
|
201
201
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
202
202
|
.optional(),
|
|
203
203
|
updated: z.string().datetime({ offset: true }).default(
|
|
204
|
-
"2025-06-
|
|
204
|
+
"2025-06-04T07:24:10.431Z",
|
|
205
205
|
).transform(v => new Date(v)),
|
|
206
206
|
}).transform((v) => {
|
|
207
207
|
return remap$(v, {
|
|
@@ -241,7 +241,7 @@ export const RetrieveDatasetResponseBody$outboundSchema: z.ZodType<
|
|
|
241
241
|
updatedById: z.string().optional(),
|
|
242
242
|
metadata: z.lazy(() => RetrieveDatasetMetadata$outboundSchema),
|
|
243
243
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
244
|
-
updated: z.date().default(() => new Date("2025-06-
|
|
244
|
+
updated: z.date().default(() => new Date("2025-06-04T07:24:10.431Z"))
|
|
245
245
|
.transform(v => v.toISOString()),
|
|
246
246
|
}).transform((v) => {
|
|
247
247
|
return remap$(v, {
|
|
@@ -172,7 +172,7 @@ export const RetrieveDatasourceResponseBody$inboundSchema: z.ZodType<
|
|
|
172
172
|
z.ZodTypeDef,
|
|
173
173
|
unknown
|
|
174
174
|
> = z.object({
|
|
175
|
-
_id: z.string().default("
|
|
175
|
+
_id: z.string().default("01JWWX75X1YJCF5754KBYQJ6QA"),
|
|
176
176
|
display_name: z.string(),
|
|
177
177
|
description: z.string().optional(),
|
|
178
178
|
status: RetrieveDatasourceStatus$inboundSchema,
|
|
@@ -216,7 +216,7 @@ export const RetrieveDatasourceResponseBody$outboundSchema: z.ZodType<
|
|
|
216
216
|
z.ZodTypeDef,
|
|
217
217
|
RetrieveDatasourceResponseBody
|
|
218
218
|
> = z.object({
|
|
219
|
-
id: z.string().default("
|
|
219
|
+
id: z.string().default("01JWWX75X1YJCF5754KBYQJ6QA"),
|
|
220
220
|
displayName: z.string(),
|
|
221
221
|
description: z.string().optional(),
|
|
222
222
|
status: RetrieveDatasourceStatus$outboundSchema,
|
|
@@ -0,0 +1,325 @@
|
|
|
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
|
+
* Contact fields to update
|
|
13
|
+
*/
|
|
14
|
+
export type UpdateContactRequestBody = {
|
|
15
|
+
/**
|
|
16
|
+
* Display name or nickname of the contact user. This is typically shown in user interfaces.
|
|
17
|
+
*/
|
|
18
|
+
displayName?: string | null | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* Email address of the contact user
|
|
21
|
+
*/
|
|
22
|
+
email?: string | null | undefined;
|
|
23
|
+
/**
|
|
24
|
+
* URL linking to the contact user's avatar image
|
|
25
|
+
*/
|
|
26
|
+
avatarUrl?: string | null | undefined;
|
|
27
|
+
/**
|
|
28
|
+
* Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
|
|
29
|
+
*/
|
|
30
|
+
tags?: Array<string> | undefined;
|
|
31
|
+
/**
|
|
32
|
+
* Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
|
|
33
|
+
*/
|
|
34
|
+
metadata?: { [k: string]: any } | undefined;
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
export type UpdateContactRequest = {
|
|
38
|
+
/**
|
|
39
|
+
* Unique contact id or external id
|
|
40
|
+
*/
|
|
41
|
+
id: string;
|
|
42
|
+
/**
|
|
43
|
+
* Contact fields to update
|
|
44
|
+
*/
|
|
45
|
+
requestBody?: UpdateContactRequestBody | undefined;
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Updated contact
|
|
50
|
+
*/
|
|
51
|
+
export type UpdateContactResponseBody = {
|
|
52
|
+
/**
|
|
53
|
+
* Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the contact
|
|
54
|
+
*/
|
|
55
|
+
id: string;
|
|
56
|
+
/**
|
|
57
|
+
* Unique string value to identify the contact user in the customer's system. This should be the same ID you use in your system to reference this user.
|
|
58
|
+
*/
|
|
59
|
+
externalId: string;
|
|
60
|
+
/**
|
|
61
|
+
* Display name or nickname of the contact user. This is typically shown in user interfaces.
|
|
62
|
+
*/
|
|
63
|
+
displayName?: string | null | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* Email address of the contact user
|
|
66
|
+
*/
|
|
67
|
+
email?: string | null | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* URL linking to the contact user's avatar image
|
|
70
|
+
*/
|
|
71
|
+
avatarUrl?: string | null | undefined;
|
|
72
|
+
/**
|
|
73
|
+
* Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
|
|
74
|
+
*/
|
|
75
|
+
tags?: Array<string> | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
|
|
78
|
+
*/
|
|
79
|
+
metadata?: { [k: string]: any } | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* The date and time the resource was created
|
|
82
|
+
*/
|
|
83
|
+
created?: Date | undefined;
|
|
84
|
+
/**
|
|
85
|
+
* The date and time the resource was last updated
|
|
86
|
+
*/
|
|
87
|
+
updated?: Date | undefined;
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
/** @internal */
|
|
91
|
+
export const UpdateContactRequestBody$inboundSchema: z.ZodType<
|
|
92
|
+
UpdateContactRequestBody,
|
|
93
|
+
z.ZodTypeDef,
|
|
94
|
+
unknown
|
|
95
|
+
> = z.object({
|
|
96
|
+
display_name: z.nullable(z.string()).optional(),
|
|
97
|
+
email: z.nullable(z.string()).optional(),
|
|
98
|
+
avatar_url: z.nullable(z.string()).optional(),
|
|
99
|
+
tags: z.array(z.string()).optional(),
|
|
100
|
+
metadata: z.record(z.any()).optional(),
|
|
101
|
+
}).transform((v) => {
|
|
102
|
+
return remap$(v, {
|
|
103
|
+
"display_name": "displayName",
|
|
104
|
+
"avatar_url": "avatarUrl",
|
|
105
|
+
});
|
|
106
|
+
});
|
|
107
|
+
|
|
108
|
+
/** @internal */
|
|
109
|
+
export type UpdateContactRequestBody$Outbound = {
|
|
110
|
+
display_name?: string | null | undefined;
|
|
111
|
+
email?: string | null | undefined;
|
|
112
|
+
avatar_url?: string | null | undefined;
|
|
113
|
+
tags?: Array<string> | undefined;
|
|
114
|
+
metadata?: { [k: string]: any } | undefined;
|
|
115
|
+
};
|
|
116
|
+
|
|
117
|
+
/** @internal */
|
|
118
|
+
export const UpdateContactRequestBody$outboundSchema: z.ZodType<
|
|
119
|
+
UpdateContactRequestBody$Outbound,
|
|
120
|
+
z.ZodTypeDef,
|
|
121
|
+
UpdateContactRequestBody
|
|
122
|
+
> = z.object({
|
|
123
|
+
displayName: z.nullable(z.string()).optional(),
|
|
124
|
+
email: z.nullable(z.string()).optional(),
|
|
125
|
+
avatarUrl: z.nullable(z.string()).optional(),
|
|
126
|
+
tags: z.array(z.string()).optional(),
|
|
127
|
+
metadata: z.record(z.any()).optional(),
|
|
128
|
+
}).transform((v) => {
|
|
129
|
+
return remap$(v, {
|
|
130
|
+
displayName: "display_name",
|
|
131
|
+
avatarUrl: "avatar_url",
|
|
132
|
+
});
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* @internal
|
|
137
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
138
|
+
*/
|
|
139
|
+
export namespace UpdateContactRequestBody$ {
|
|
140
|
+
/** @deprecated use `UpdateContactRequestBody$inboundSchema` instead. */
|
|
141
|
+
export const inboundSchema = UpdateContactRequestBody$inboundSchema;
|
|
142
|
+
/** @deprecated use `UpdateContactRequestBody$outboundSchema` instead. */
|
|
143
|
+
export const outboundSchema = UpdateContactRequestBody$outboundSchema;
|
|
144
|
+
/** @deprecated use `UpdateContactRequestBody$Outbound` instead. */
|
|
145
|
+
export type Outbound = UpdateContactRequestBody$Outbound;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
export function updateContactRequestBodyToJSON(
|
|
149
|
+
updateContactRequestBody: UpdateContactRequestBody,
|
|
150
|
+
): string {
|
|
151
|
+
return JSON.stringify(
|
|
152
|
+
UpdateContactRequestBody$outboundSchema.parse(updateContactRequestBody),
|
|
153
|
+
);
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
export function updateContactRequestBodyFromJSON(
|
|
157
|
+
jsonString: string,
|
|
158
|
+
): SafeParseResult<UpdateContactRequestBody, SDKValidationError> {
|
|
159
|
+
return safeParse(
|
|
160
|
+
jsonString,
|
|
161
|
+
(x) => UpdateContactRequestBody$inboundSchema.parse(JSON.parse(x)),
|
|
162
|
+
`Failed to parse 'UpdateContactRequestBody' from JSON`,
|
|
163
|
+
);
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
/** @internal */
|
|
167
|
+
export const UpdateContactRequest$inboundSchema: z.ZodType<
|
|
168
|
+
UpdateContactRequest,
|
|
169
|
+
z.ZodTypeDef,
|
|
170
|
+
unknown
|
|
171
|
+
> = z.object({
|
|
172
|
+
id: z.string(),
|
|
173
|
+
RequestBody: z.lazy(() => UpdateContactRequestBody$inboundSchema).optional(),
|
|
174
|
+
}).transform((v) => {
|
|
175
|
+
return remap$(v, {
|
|
176
|
+
"RequestBody": "requestBody",
|
|
177
|
+
});
|
|
178
|
+
});
|
|
179
|
+
|
|
180
|
+
/** @internal */
|
|
181
|
+
export type UpdateContactRequest$Outbound = {
|
|
182
|
+
id: string;
|
|
183
|
+
RequestBody?: UpdateContactRequestBody$Outbound | undefined;
|
|
184
|
+
};
|
|
185
|
+
|
|
186
|
+
/** @internal */
|
|
187
|
+
export const UpdateContactRequest$outboundSchema: z.ZodType<
|
|
188
|
+
UpdateContactRequest$Outbound,
|
|
189
|
+
z.ZodTypeDef,
|
|
190
|
+
UpdateContactRequest
|
|
191
|
+
> = z.object({
|
|
192
|
+
id: z.string(),
|
|
193
|
+
requestBody: z.lazy(() => UpdateContactRequestBody$outboundSchema).optional(),
|
|
194
|
+
}).transform((v) => {
|
|
195
|
+
return remap$(v, {
|
|
196
|
+
requestBody: "RequestBody",
|
|
197
|
+
});
|
|
198
|
+
});
|
|
199
|
+
|
|
200
|
+
/**
|
|
201
|
+
* @internal
|
|
202
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
203
|
+
*/
|
|
204
|
+
export namespace UpdateContactRequest$ {
|
|
205
|
+
/** @deprecated use `UpdateContactRequest$inboundSchema` instead. */
|
|
206
|
+
export const inboundSchema = UpdateContactRequest$inboundSchema;
|
|
207
|
+
/** @deprecated use `UpdateContactRequest$outboundSchema` instead. */
|
|
208
|
+
export const outboundSchema = UpdateContactRequest$outboundSchema;
|
|
209
|
+
/** @deprecated use `UpdateContactRequest$Outbound` instead. */
|
|
210
|
+
export type Outbound = UpdateContactRequest$Outbound;
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
export function updateContactRequestToJSON(
|
|
214
|
+
updateContactRequest: UpdateContactRequest,
|
|
215
|
+
): string {
|
|
216
|
+
return JSON.stringify(
|
|
217
|
+
UpdateContactRequest$outboundSchema.parse(updateContactRequest),
|
|
218
|
+
);
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
export function updateContactRequestFromJSON(
|
|
222
|
+
jsonString: string,
|
|
223
|
+
): SafeParseResult<UpdateContactRequest, SDKValidationError> {
|
|
224
|
+
return safeParse(
|
|
225
|
+
jsonString,
|
|
226
|
+
(x) => UpdateContactRequest$inboundSchema.parse(JSON.parse(x)),
|
|
227
|
+
`Failed to parse 'UpdateContactRequest' from JSON`,
|
|
228
|
+
);
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
/** @internal */
|
|
232
|
+
export const UpdateContactResponseBody$inboundSchema: z.ZodType<
|
|
233
|
+
UpdateContactResponseBody,
|
|
234
|
+
z.ZodTypeDef,
|
|
235
|
+
unknown
|
|
236
|
+
> = z.object({
|
|
237
|
+
_id: z.string(),
|
|
238
|
+
external_id: z.string(),
|
|
239
|
+
display_name: z.nullable(z.string()).optional(),
|
|
240
|
+
email: z.nullable(z.string()).optional(),
|
|
241
|
+
avatar_url: z.nullable(z.string()).optional(),
|
|
242
|
+
tags: z.array(z.string()).optional(),
|
|
243
|
+
metadata: z.record(z.any()).optional(),
|
|
244
|
+
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
245
|
+
.optional(),
|
|
246
|
+
updated: z.string().datetime({ offset: true }).default(
|
|
247
|
+
"2025-06-04T07:24:10.431Z",
|
|
248
|
+
).transform(v => new Date(v)),
|
|
249
|
+
}).transform((v) => {
|
|
250
|
+
return remap$(v, {
|
|
251
|
+
"_id": "id",
|
|
252
|
+
"external_id": "externalId",
|
|
253
|
+
"display_name": "displayName",
|
|
254
|
+
"avatar_url": "avatarUrl",
|
|
255
|
+
});
|
|
256
|
+
});
|
|
257
|
+
|
|
258
|
+
/** @internal */
|
|
259
|
+
export type UpdateContactResponseBody$Outbound = {
|
|
260
|
+
_id: string;
|
|
261
|
+
external_id: string;
|
|
262
|
+
display_name?: string | null | undefined;
|
|
263
|
+
email?: string | null | undefined;
|
|
264
|
+
avatar_url?: string | null | undefined;
|
|
265
|
+
tags?: Array<string> | undefined;
|
|
266
|
+
metadata?: { [k: string]: any } | undefined;
|
|
267
|
+
created?: string | undefined;
|
|
268
|
+
updated: string;
|
|
269
|
+
};
|
|
270
|
+
|
|
271
|
+
/** @internal */
|
|
272
|
+
export const UpdateContactResponseBody$outboundSchema: z.ZodType<
|
|
273
|
+
UpdateContactResponseBody$Outbound,
|
|
274
|
+
z.ZodTypeDef,
|
|
275
|
+
UpdateContactResponseBody
|
|
276
|
+
> = z.object({
|
|
277
|
+
id: z.string(),
|
|
278
|
+
externalId: z.string(),
|
|
279
|
+
displayName: z.nullable(z.string()).optional(),
|
|
280
|
+
email: z.nullable(z.string()).optional(),
|
|
281
|
+
avatarUrl: z.nullable(z.string()).optional(),
|
|
282
|
+
tags: z.array(z.string()).optional(),
|
|
283
|
+
metadata: z.record(z.any()).optional(),
|
|
284
|
+
created: z.date().transform(v => v.toISOString()).optional(),
|
|
285
|
+
updated: z.date().default(() => new Date("2025-06-04T07:24:10.431Z"))
|
|
286
|
+
.transform(v => v.toISOString()),
|
|
287
|
+
}).transform((v) => {
|
|
288
|
+
return remap$(v, {
|
|
289
|
+
id: "_id",
|
|
290
|
+
externalId: "external_id",
|
|
291
|
+
displayName: "display_name",
|
|
292
|
+
avatarUrl: "avatar_url",
|
|
293
|
+
});
|
|
294
|
+
});
|
|
295
|
+
|
|
296
|
+
/**
|
|
297
|
+
* @internal
|
|
298
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
299
|
+
*/
|
|
300
|
+
export namespace UpdateContactResponseBody$ {
|
|
301
|
+
/** @deprecated use `UpdateContactResponseBody$inboundSchema` instead. */
|
|
302
|
+
export const inboundSchema = UpdateContactResponseBody$inboundSchema;
|
|
303
|
+
/** @deprecated use `UpdateContactResponseBody$outboundSchema` instead. */
|
|
304
|
+
export const outboundSchema = UpdateContactResponseBody$outboundSchema;
|
|
305
|
+
/** @deprecated use `UpdateContactResponseBody$Outbound` instead. */
|
|
306
|
+
export type Outbound = UpdateContactResponseBody$Outbound;
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
export function updateContactResponseBodyToJSON(
|
|
310
|
+
updateContactResponseBody: UpdateContactResponseBody,
|
|
311
|
+
): string {
|
|
312
|
+
return JSON.stringify(
|
|
313
|
+
UpdateContactResponseBody$outboundSchema.parse(updateContactResponseBody),
|
|
314
|
+
);
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
export function updateContactResponseBodyFromJSON(
|
|
318
|
+
jsonString: string,
|
|
319
|
+
): SafeParseResult<UpdateContactResponseBody, SDKValidationError> {
|
|
320
|
+
return safeParse(
|
|
321
|
+
jsonString,
|
|
322
|
+
(x) => UpdateContactResponseBody$inboundSchema.parse(JSON.parse(x)),
|
|
323
|
+
`Failed to parse 'UpdateContactResponseBody' from JSON`,
|
|
324
|
+
);
|
|
325
|
+
}
|
|
@@ -5044,7 +5044,7 @@ export const UpdateDatapointResponseBody$inboundSchema: z.ZodType<
|
|
|
5044
5044
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
5045
5045
|
.optional(),
|
|
5046
5046
|
updated: z.string().datetime({ offset: true }).default(
|
|
5047
|
-
"2025-06-
|
|
5047
|
+
"2025-06-04T07:24:10.431Z",
|
|
5048
5048
|
).transform(v => new Date(v)),
|
|
5049
5049
|
}).transform((v) => {
|
|
5050
5050
|
return remap$(v, {
|
|
@@ -5106,7 +5106,7 @@ export const UpdateDatapointResponseBody$outboundSchema: z.ZodType<
|
|
|
5106
5106
|
createdById: z.string().optional(),
|
|
5107
5107
|
updatedById: z.string().optional(),
|
|
5108
5108
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
5109
|
-
updated: z.date().default(() => new Date("2025-06-
|
|
5109
|
+
updated: z.date().default(() => new Date("2025-06-04T07:24:10.431Z"))
|
|
5110
5110
|
.transform(v => v.toISOString()),
|
|
5111
5111
|
}).transform((v) => {
|
|
5112
5112
|
return remap$(v, {
|
|
@@ -302,7 +302,7 @@ export const UpdateDatasetResponseBody$inboundSchema: z.ZodType<
|
|
|
302
302
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
303
303
|
.optional(),
|
|
304
304
|
updated: z.string().datetime({ offset: true }).default(
|
|
305
|
-
"2025-06-
|
|
305
|
+
"2025-06-04T07:24:10.431Z",
|
|
306
306
|
).transform(v => new Date(v)),
|
|
307
307
|
}).transform((v) => {
|
|
308
308
|
return remap$(v, {
|
|
@@ -347,7 +347,7 @@ export const UpdateDatasetResponseBody$outboundSchema: z.ZodType<
|
|
|
347
347
|
parentId: z.string().optional(),
|
|
348
348
|
version: z.string().optional(),
|
|
349
349
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
350
|
-
updated: z.date().default(() => new Date("2025-06-
|
|
350
|
+
updated: z.date().default(() => new Date("2025-06-04T07:24:10.431Z"))
|
|
351
351
|
.transform(v => v.toISOString()),
|
|
352
352
|
}).transform((v) => {
|
|
353
353
|
return remap$(v, {
|
|
@@ -244,7 +244,7 @@ export const UpdateDatasourceResponseBody$inboundSchema: z.ZodType<
|
|
|
244
244
|
z.ZodTypeDef,
|
|
245
245
|
unknown
|
|
246
246
|
> = z.object({
|
|
247
|
-
_id: z.string().default("
|
|
247
|
+
_id: z.string().default("01JWWX75X2MVN8R8143WNM7DS6"),
|
|
248
248
|
display_name: z.string(),
|
|
249
249
|
description: z.string().optional(),
|
|
250
250
|
status: UpdateDatasourceStatus$inboundSchema,
|
|
@@ -288,7 +288,7 @@ export const UpdateDatasourceResponseBody$outboundSchema: z.ZodType<
|
|
|
288
288
|
z.ZodTypeDef,
|
|
289
289
|
UpdateDatasourceResponseBody
|
|
290
290
|
> = z.object({
|
|
291
|
-
id: z.string().default("
|
|
291
|
+
id: z.string().default("01JWWX75X2MVN8R8143WNM7DS6"),
|
|
292
292
|
displayName: z.string(),
|
|
293
293
|
description: z.string().optional(),
|
|
294
294
|
status: UpdateDatasourceStatus$outboundSchema,
|