@kivox/client 0.1.0-beta.37 → 0.1.0-beta.39
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/dist/index.cjs +1 -6
- package/dist/index.d.ts +1985 -680
- package/dist/index.mjs +1 -6
- package/package.json +2 -3
package/dist/index.d.ts
CHANGED
|
@@ -1,660 +1,1938 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
import createClient from "openapi-fetch";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by openapi-typescript.
|
|
4
|
+
* Do not make direct changes to the file.
|
|
5
|
+
*/
|
|
6
|
+
interface paths {
|
|
7
|
+
"/auth/signup": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never
|
|
10
|
+
header?: never
|
|
11
|
+
path?: never
|
|
12
|
+
cookie?: never
|
|
13
|
+
}
|
|
14
|
+
get?: never
|
|
15
|
+
put?: never
|
|
16
|
+
/** Register a new user account */
|
|
17
|
+
post: operations["signup"]
|
|
18
|
+
delete?: never
|
|
19
|
+
options?: never
|
|
20
|
+
head?: never
|
|
21
|
+
patch?: never
|
|
22
|
+
trace?: never
|
|
23
|
+
};
|
|
24
|
+
"/auth/sessions": {
|
|
25
|
+
parameters: {
|
|
26
|
+
query?: never
|
|
27
|
+
header?: never
|
|
28
|
+
path?: never
|
|
29
|
+
cookie?: never
|
|
30
|
+
}
|
|
31
|
+
get?: never
|
|
32
|
+
put?: never
|
|
33
|
+
/** Log in and start a session */
|
|
34
|
+
post: operations["createSession"]
|
|
35
|
+
/** Log out of all sessions */
|
|
36
|
+
delete: operations["revokeAllSessions"]
|
|
37
|
+
options?: never
|
|
38
|
+
head?: never
|
|
39
|
+
patch?: never
|
|
40
|
+
trace?: never
|
|
41
|
+
};
|
|
42
|
+
"/auth/sessions/me": {
|
|
43
|
+
parameters: {
|
|
44
|
+
query?: never
|
|
45
|
+
header?: never
|
|
46
|
+
path?: never
|
|
47
|
+
cookie?: never
|
|
48
|
+
}
|
|
49
|
+
get?: never
|
|
50
|
+
put?: never
|
|
51
|
+
post?: never
|
|
52
|
+
/** Log out of the current session */
|
|
53
|
+
delete: operations["revokeSession"]
|
|
54
|
+
options?: never
|
|
55
|
+
head?: never
|
|
56
|
+
patch?: never
|
|
57
|
+
trace?: never
|
|
58
|
+
};
|
|
59
|
+
"/auth/password/recover": {
|
|
60
|
+
parameters: {
|
|
61
|
+
query?: never
|
|
62
|
+
header?: never
|
|
63
|
+
path?: never
|
|
64
|
+
cookie?: never
|
|
65
|
+
}
|
|
66
|
+
get?: never
|
|
67
|
+
put?: never
|
|
68
|
+
/**
|
|
69
|
+
* Request a password reset email
|
|
70
|
+
* @description Always returns 204 regardless of whether the email exists,
|
|
71
|
+
* to prevent email enumeration.
|
|
72
|
+
*/
|
|
73
|
+
post: operations["recoverPassword"]
|
|
74
|
+
delete?: never
|
|
75
|
+
options?: never
|
|
76
|
+
head?: never
|
|
77
|
+
patch?: never
|
|
78
|
+
trace?: never
|
|
79
|
+
};
|
|
80
|
+
"/auth/password/reset": {
|
|
81
|
+
parameters: {
|
|
82
|
+
query?: never
|
|
83
|
+
header?: never
|
|
84
|
+
path?: never
|
|
85
|
+
cookie?: never
|
|
86
|
+
}
|
|
87
|
+
get?: never
|
|
88
|
+
put?: never
|
|
89
|
+
/**
|
|
90
|
+
* Reset password using a recovery token
|
|
91
|
+
* @description Consumes the token and updates the password.
|
|
92
|
+
* All existing sessions are revoked on success.
|
|
93
|
+
*/
|
|
94
|
+
post: operations["resetPassword"]
|
|
95
|
+
delete?: never
|
|
96
|
+
options?: never
|
|
97
|
+
head?: never
|
|
98
|
+
patch?: never
|
|
99
|
+
trace?: never
|
|
100
|
+
};
|
|
101
|
+
"/auth/api-keys": {
|
|
102
|
+
parameters: {
|
|
103
|
+
query?: never
|
|
104
|
+
header?: never
|
|
105
|
+
path?: never
|
|
106
|
+
cookie?: never
|
|
107
|
+
}
|
|
108
|
+
/** List API keys owned by the authenticated user */
|
|
109
|
+
get: operations["listAPIKeys"]
|
|
110
|
+
put?: never
|
|
111
|
+
/** Create a new API key */
|
|
112
|
+
post: operations["createAPIKey"]
|
|
113
|
+
delete?: never
|
|
114
|
+
options?: never
|
|
115
|
+
head?: never
|
|
116
|
+
patch?: never
|
|
117
|
+
trace?: never
|
|
118
|
+
};
|
|
119
|
+
"/auth/api-keys/{keyID}": {
|
|
120
|
+
parameters: {
|
|
121
|
+
query?: never
|
|
122
|
+
header?: never
|
|
123
|
+
path: {
|
|
124
|
+
keyID: components["parameters"]["KeyID"]
|
|
125
|
+
}
|
|
126
|
+
cookie?: never
|
|
127
|
+
}
|
|
128
|
+
get?: never
|
|
129
|
+
put?: never
|
|
130
|
+
post?: never
|
|
131
|
+
/** Revoke an API key */
|
|
132
|
+
delete: operations["revokeAPIKey"]
|
|
133
|
+
options?: never
|
|
134
|
+
head?: never
|
|
135
|
+
patch?: never
|
|
136
|
+
trace?: never
|
|
137
|
+
};
|
|
138
|
+
"/users/me": {
|
|
139
|
+
parameters: {
|
|
140
|
+
query?: never
|
|
141
|
+
header?: never
|
|
142
|
+
path?: never
|
|
143
|
+
cookie?: never
|
|
144
|
+
}
|
|
145
|
+
/** Get the authenticated user's profile */
|
|
146
|
+
get: operations["getMe"]
|
|
147
|
+
put?: never
|
|
148
|
+
post?: never
|
|
149
|
+
/** Soft-delete the authenticated user's account */
|
|
150
|
+
delete: operations["deleteMe"]
|
|
151
|
+
options?: never
|
|
152
|
+
head?: never
|
|
153
|
+
/** Update the authenticated user's profile */
|
|
154
|
+
patch: operations["updateMe"]
|
|
155
|
+
trace?: never
|
|
156
|
+
};
|
|
157
|
+
"/users/me/email": {
|
|
158
|
+
parameters: {
|
|
159
|
+
query?: never
|
|
160
|
+
header?: never
|
|
161
|
+
path?: never
|
|
162
|
+
cookie?: never
|
|
163
|
+
}
|
|
164
|
+
get?: never
|
|
165
|
+
put?: never
|
|
166
|
+
post?: never
|
|
167
|
+
delete?: never
|
|
168
|
+
options?: never
|
|
169
|
+
head?: never
|
|
170
|
+
/** Update the authenticated user's email address */
|
|
171
|
+
patch: operations["updateMyEmail"]
|
|
172
|
+
trace?: never
|
|
173
|
+
};
|
|
174
|
+
"/orgs": {
|
|
175
|
+
parameters: {
|
|
176
|
+
query?: never
|
|
177
|
+
header?: never
|
|
178
|
+
path?: never
|
|
179
|
+
cookie?: never
|
|
180
|
+
}
|
|
181
|
+
/** List organizations the authenticated user belongs to */
|
|
182
|
+
get: operations["listOrgs"]
|
|
183
|
+
put?: never
|
|
184
|
+
/** Create a new organization */
|
|
185
|
+
post: operations["createOrg"]
|
|
186
|
+
delete?: never
|
|
187
|
+
options?: never
|
|
188
|
+
head?: never
|
|
189
|
+
patch?: never
|
|
190
|
+
trace?: never
|
|
191
|
+
};
|
|
192
|
+
"/orgs/{orgSlug}": {
|
|
193
|
+
parameters: {
|
|
194
|
+
query?: never
|
|
195
|
+
header?: never
|
|
196
|
+
path: {
|
|
197
|
+
/** @description URL-safe organization identifier. */
|
|
198
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
199
|
+
}
|
|
200
|
+
cookie?: never
|
|
201
|
+
}
|
|
202
|
+
/** Get an organization by slug */
|
|
203
|
+
get: operations["getOrg"]
|
|
204
|
+
put?: never
|
|
205
|
+
post?: never
|
|
206
|
+
/** Soft-delete an organization (requires owner) */
|
|
207
|
+
delete: operations["deleteOrg"]
|
|
208
|
+
options?: never
|
|
209
|
+
head?: never
|
|
210
|
+
/** Update an organization (requires admin) */
|
|
211
|
+
patch: operations["updateOrg"]
|
|
212
|
+
trace?: never
|
|
213
|
+
};
|
|
214
|
+
"/orgs/{orgSlug}/members": {
|
|
215
|
+
parameters: {
|
|
216
|
+
query?: never
|
|
217
|
+
header?: never
|
|
218
|
+
path: {
|
|
219
|
+
/** @description URL-safe organization identifier. */
|
|
220
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
221
|
+
}
|
|
222
|
+
cookie?: never
|
|
223
|
+
}
|
|
224
|
+
/** List members of an organization (requires viewer) */
|
|
225
|
+
get: operations["listOrgMembers"]
|
|
226
|
+
put?: never
|
|
227
|
+
/** Add a member to an organization (requires admin) */
|
|
228
|
+
post: operations["addOrgMember"]
|
|
229
|
+
delete?: never
|
|
230
|
+
options?: never
|
|
231
|
+
head?: never
|
|
232
|
+
patch?: never
|
|
233
|
+
trace?: never
|
|
234
|
+
};
|
|
235
|
+
"/orgs/{orgSlug}/members/{userID}": {
|
|
236
|
+
parameters: {
|
|
237
|
+
query?: never
|
|
238
|
+
header?: never
|
|
239
|
+
path: {
|
|
240
|
+
/** @description URL-safe organization identifier. */
|
|
241
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
242
|
+
userID: components["parameters"]["UserID"]
|
|
243
|
+
}
|
|
244
|
+
cookie?: never
|
|
245
|
+
}
|
|
246
|
+
get?: never
|
|
247
|
+
put?: never
|
|
248
|
+
post?: never
|
|
249
|
+
/** Remove a member (admin required, unless removing self) */
|
|
250
|
+
delete: operations["removeOrgMember"]
|
|
251
|
+
options?: never
|
|
252
|
+
head?: never
|
|
253
|
+
/** Update a member's role (requires admin) */
|
|
254
|
+
patch: operations["updateOrgMember"]
|
|
255
|
+
trace?: never
|
|
256
|
+
};
|
|
257
|
+
"/users/me/agents": {
|
|
258
|
+
parameters: {
|
|
259
|
+
query?: never
|
|
260
|
+
header?: never
|
|
261
|
+
path?: never
|
|
262
|
+
cookie?: never
|
|
263
|
+
}
|
|
264
|
+
/** List agents owned by the authenticated user */
|
|
265
|
+
get: operations["listUserAgents"]
|
|
266
|
+
put?: never
|
|
267
|
+
/** Create an agent owned by the authenticated user */
|
|
268
|
+
post: operations["createUserAgent"]
|
|
269
|
+
delete?: never
|
|
270
|
+
options?: never
|
|
271
|
+
head?: never
|
|
272
|
+
patch?: never
|
|
273
|
+
trace?: never
|
|
274
|
+
};
|
|
275
|
+
"/orgs/{orgSlug}/agents": {
|
|
276
|
+
parameters: {
|
|
277
|
+
query?: never
|
|
278
|
+
header?: never
|
|
279
|
+
path: {
|
|
280
|
+
/** @description URL-safe organization identifier. */
|
|
281
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
282
|
+
}
|
|
283
|
+
cookie?: never
|
|
284
|
+
}
|
|
285
|
+
/** List agents owned by an organization (requires viewer) */
|
|
286
|
+
get: operations["listOrgAgents"]
|
|
287
|
+
put?: never
|
|
288
|
+
/** Create an agent owned by an organization (requires member) */
|
|
289
|
+
post: operations["createOrgAgent"]
|
|
290
|
+
delete?: never
|
|
291
|
+
options?: never
|
|
292
|
+
head?: never
|
|
293
|
+
patch?: never
|
|
294
|
+
trace?: never
|
|
295
|
+
};
|
|
296
|
+
"/agents/{agentID}": {
|
|
297
|
+
parameters: {
|
|
298
|
+
query?: never
|
|
299
|
+
header?: never
|
|
300
|
+
path: {
|
|
301
|
+
agentID: components["parameters"]["AgentID"]
|
|
302
|
+
}
|
|
303
|
+
cookie?: never
|
|
304
|
+
}
|
|
305
|
+
/** Get an agent by ID (requires viewer) */
|
|
306
|
+
get: operations["getAgent"]
|
|
307
|
+
put?: never
|
|
308
|
+
post?: never
|
|
309
|
+
/** Soft-delete an agent (requires admin) */
|
|
310
|
+
delete: operations["deleteAgent"]
|
|
311
|
+
options?: never
|
|
312
|
+
head?: never
|
|
313
|
+
/** Update an agent's config, secrets, or blueprint (requires member) */
|
|
314
|
+
patch: operations["updateAgent"]
|
|
315
|
+
trace?: never
|
|
316
|
+
};
|
|
317
|
+
"/agents/{agentID}/status": {
|
|
318
|
+
parameters: {
|
|
319
|
+
query?: never
|
|
320
|
+
header?: never
|
|
321
|
+
path: {
|
|
322
|
+
agentID: components["parameters"]["AgentID"]
|
|
323
|
+
}
|
|
324
|
+
cookie?: never
|
|
325
|
+
}
|
|
326
|
+
get?: never
|
|
327
|
+
put?: never
|
|
328
|
+
post?: never
|
|
329
|
+
delete?: never
|
|
330
|
+
options?: never
|
|
331
|
+
head?: never
|
|
332
|
+
/** Transition an agent's status (requires admin) */
|
|
333
|
+
patch: operations["updateAgentStatus"]
|
|
334
|
+
trace?: never
|
|
335
|
+
};
|
|
336
|
+
"/agents/{agentID}/lint": {
|
|
337
|
+
parameters: {
|
|
338
|
+
query?: never
|
|
339
|
+
header?: never
|
|
340
|
+
path: {
|
|
341
|
+
agentID: components["parameters"]["AgentID"]
|
|
342
|
+
}
|
|
343
|
+
cookie?: never
|
|
344
|
+
}
|
|
345
|
+
get?: never
|
|
346
|
+
put?: never
|
|
347
|
+
/**
|
|
348
|
+
* Lint an agent's blueprint (requires viewer)
|
|
349
|
+
* @description Pass a `blueprint` in the request body to lint that instead of the
|
|
350
|
+
* agent's saved blueprint. Useful for pre-save validation in the editor.
|
|
351
|
+
*/
|
|
352
|
+
post: operations["lintAgent"]
|
|
353
|
+
delete?: never
|
|
354
|
+
options?: never
|
|
355
|
+
head?: never
|
|
356
|
+
patch?: never
|
|
357
|
+
trace?: never
|
|
358
|
+
};
|
|
359
|
+
"/agents/{agentID}/conversations": {
|
|
360
|
+
parameters: {
|
|
361
|
+
query?: never
|
|
362
|
+
header?: never
|
|
363
|
+
path: {
|
|
364
|
+
agentID: components["parameters"]["AgentID"]
|
|
365
|
+
}
|
|
366
|
+
cookie?: never
|
|
367
|
+
}
|
|
368
|
+
/** List conversations for an agent (requires viewer) */
|
|
369
|
+
get: operations["listAgentConversations"]
|
|
370
|
+
put?: never
|
|
371
|
+
post?: never
|
|
372
|
+
delete?: never
|
|
373
|
+
options?: never
|
|
374
|
+
head?: never
|
|
375
|
+
patch?: never
|
|
376
|
+
trace?: never
|
|
377
|
+
};
|
|
378
|
+
"/conversations/{conversationID}": {
|
|
379
|
+
parameters: {
|
|
380
|
+
query?: never
|
|
381
|
+
header?: never
|
|
382
|
+
path: {
|
|
383
|
+
conversationID: components["parameters"]["ConversationID"]
|
|
384
|
+
}
|
|
385
|
+
cookie?: never
|
|
386
|
+
}
|
|
387
|
+
/** Get a conversation by ID (requires viewer on the parent agent) */
|
|
388
|
+
get: operations["getConversation"]
|
|
389
|
+
put?: never
|
|
390
|
+
post?: never
|
|
391
|
+
/** Soft-delete a conversation (requires admin on the parent agent) */
|
|
392
|
+
delete: operations["deleteConversation"]
|
|
393
|
+
options?: never
|
|
394
|
+
head?: never
|
|
395
|
+
patch?: never
|
|
396
|
+
trace?: never
|
|
397
|
+
};
|
|
398
|
+
"/conversations/{conversationID}/messages": {
|
|
399
|
+
parameters: {
|
|
400
|
+
query?: never
|
|
401
|
+
header?: never
|
|
402
|
+
path: {
|
|
403
|
+
conversationID: components["parameters"]["ConversationID"]
|
|
404
|
+
}
|
|
405
|
+
cookie?: never
|
|
406
|
+
}
|
|
407
|
+
/** List messages in a conversation (requires viewer on the parent agent) */
|
|
408
|
+
get: operations["listConversationMessages"]
|
|
409
|
+
put?: never
|
|
410
|
+
post?: never
|
|
411
|
+
delete?: never
|
|
412
|
+
options?: never
|
|
413
|
+
head?: never
|
|
414
|
+
patch?: never
|
|
415
|
+
trace?: never
|
|
416
|
+
};
|
|
417
|
+
"/users/me/templates": {
|
|
418
|
+
parameters: {
|
|
419
|
+
query?: never
|
|
420
|
+
header?: never
|
|
421
|
+
path?: never
|
|
422
|
+
cookie?: never
|
|
423
|
+
}
|
|
424
|
+
/** List templates owned by the authenticated user */
|
|
425
|
+
get: operations["listUserTemplates"]
|
|
426
|
+
put?: never
|
|
427
|
+
/** Create a template owned by the authenticated user */
|
|
428
|
+
post: operations["createUserTemplate"]
|
|
429
|
+
delete?: never
|
|
430
|
+
options?: never
|
|
431
|
+
head?: never
|
|
432
|
+
patch?: never
|
|
433
|
+
trace?: never
|
|
434
|
+
};
|
|
435
|
+
"/orgs/{orgSlug}/templates": {
|
|
436
|
+
parameters: {
|
|
437
|
+
query?: never
|
|
438
|
+
header?: never
|
|
439
|
+
path: {
|
|
440
|
+
/** @description URL-safe organization identifier. */
|
|
441
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
442
|
+
}
|
|
443
|
+
cookie?: never
|
|
444
|
+
}
|
|
445
|
+
/** List templates owned by an organization (requires viewer) */
|
|
446
|
+
get: operations["listOrgTemplates"]
|
|
447
|
+
put?: never
|
|
448
|
+
/** Create a template owned by an organization (requires member) */
|
|
449
|
+
post: operations["createOrgTemplate"]
|
|
450
|
+
delete?: never
|
|
451
|
+
options?: never
|
|
452
|
+
head?: never
|
|
453
|
+
patch?: never
|
|
454
|
+
trace?: never
|
|
455
|
+
};
|
|
456
|
+
"/templates/{templateID}": {
|
|
457
|
+
parameters: {
|
|
458
|
+
query?: never
|
|
459
|
+
header?: never
|
|
460
|
+
path: {
|
|
461
|
+
templateID: components["parameters"]["TemplateID"]
|
|
462
|
+
}
|
|
463
|
+
cookie?: never
|
|
464
|
+
}
|
|
465
|
+
/** Get a template by ID */
|
|
466
|
+
get: operations["getTemplate"]
|
|
467
|
+
put?: never
|
|
468
|
+
post?: never
|
|
469
|
+
/** Soft-delete a template (requires admin if org-owned) */
|
|
470
|
+
delete: operations["deleteTemplate"]
|
|
471
|
+
options?: never
|
|
472
|
+
head?: never
|
|
473
|
+
/** Update a template (requires member if org-owned) */
|
|
474
|
+
patch: operations["updateTemplate"]
|
|
475
|
+
trace?: never
|
|
476
|
+
};
|
|
3
477
|
}
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
}
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
}
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
}
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
}
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
}
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
478
|
+
interface components {
|
|
479
|
+
schemas: {
|
|
480
|
+
Error: {
|
|
481
|
+
/**
|
|
482
|
+
* @description Stable dot-notation error identifier, e.g. `resource.not_found`.
|
|
483
|
+
* Use this for programmatic handling; never parse `message`.
|
|
484
|
+
* @example resource.not_found
|
|
485
|
+
*/
|
|
486
|
+
code: string
|
|
487
|
+
/** @description Localized, human-readable description of the error. */
|
|
488
|
+
message: string
|
|
489
|
+
/**
|
|
490
|
+
* Format: uri
|
|
491
|
+
* @description Link to the canonical documentation page for this error code.
|
|
492
|
+
* @example https://kivox.com.co/docs/reference/errors#resource-not-found
|
|
493
|
+
*/
|
|
494
|
+
doc_url: string
|
|
495
|
+
/**
|
|
496
|
+
* @description Named interpolation values used to render `message`.
|
|
497
|
+
* Present only when the error carries contextual parameters.
|
|
498
|
+
*/
|
|
499
|
+
params?: {
|
|
500
|
+
[key: string]: unknown
|
|
501
|
+
}
|
|
502
|
+
}
|
|
503
|
+
SignupRequest: {
|
|
504
|
+
/** Format: email */
|
|
505
|
+
email: string
|
|
506
|
+
password: string
|
|
507
|
+
name: string
|
|
508
|
+
}
|
|
509
|
+
LoginRequest: {
|
|
510
|
+
/** Format: email */
|
|
511
|
+
email: string
|
|
512
|
+
password: string
|
|
513
|
+
}
|
|
514
|
+
RecoverPasswordRequest: {
|
|
515
|
+
/** Format: email */
|
|
516
|
+
email: string
|
|
517
|
+
}
|
|
518
|
+
ResetPasswordRequest: {
|
|
519
|
+
token: string
|
|
520
|
+
password: string
|
|
521
|
+
}
|
|
522
|
+
/**
|
|
523
|
+
* @description Returned after a successful login or signup.
|
|
524
|
+
* The session token is delivered as an HttpOnly cookie (`kivox_session`),
|
|
525
|
+
* not in this response body.
|
|
526
|
+
*/
|
|
527
|
+
AuthSessionResponse: {
|
|
528
|
+
/** Format: date-time */
|
|
529
|
+
expires_at: string
|
|
530
|
+
}
|
|
531
|
+
/** @description API key record. The raw key value is never returned after creation. */
|
|
532
|
+
AuthAPIKey: {
|
|
533
|
+
/** Format: uuid */
|
|
534
|
+
id: string
|
|
535
|
+
/** Format: uuid */
|
|
536
|
+
owner_user_id?: string
|
|
537
|
+
/** Format: uuid */
|
|
538
|
+
owner_org_id?: string
|
|
539
|
+
/** Format: uuid */
|
|
540
|
+
created_by_user_id: string
|
|
541
|
+
name: string
|
|
542
|
+
/** @example sk_live */
|
|
543
|
+
prefix: string
|
|
544
|
+
scopes: string[]
|
|
545
|
+
/** Format: date-time */
|
|
546
|
+
last_used_at?: string
|
|
547
|
+
/** Format: date-time */
|
|
548
|
+
expires_at?: string
|
|
549
|
+
/** Format: date-time */
|
|
550
|
+
created_at: string
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* @description Returned **once** when an API key is created.
|
|
554
|
+
* The `key` field contains the full raw value. Store it now, it will not be shown again.
|
|
555
|
+
*/
|
|
556
|
+
AuthAPIKeyResponse: {
|
|
557
|
+
/** Format: uuid */
|
|
558
|
+
id: string
|
|
559
|
+
name: string
|
|
560
|
+
prefix: string
|
|
561
|
+
/**
|
|
562
|
+
* @description Full API key. Only present in this creation response.
|
|
563
|
+
* @example sk_live_xxxxxxxxxxxx
|
|
564
|
+
*/
|
|
565
|
+
key: string
|
|
566
|
+
scopes: string[]
|
|
567
|
+
/** Format: date-time */
|
|
568
|
+
expires_at?: string
|
|
569
|
+
/** Format: date-time */
|
|
570
|
+
created_at: string
|
|
571
|
+
}
|
|
572
|
+
CreateAPIKeyRequest: {
|
|
573
|
+
name: string
|
|
574
|
+
scopes?: string[]
|
|
575
|
+
/** Format: date-time */
|
|
576
|
+
expires_at?: string
|
|
577
|
+
}
|
|
578
|
+
User: {
|
|
579
|
+
/** Format: uuid */
|
|
580
|
+
id: string
|
|
581
|
+
/** Format: email */
|
|
582
|
+
email: string
|
|
583
|
+
name: string
|
|
584
|
+
/** Format: uri */
|
|
585
|
+
avatar_url?: string
|
|
586
|
+
/** Format: date-time */
|
|
587
|
+
created_at: string
|
|
588
|
+
/** Format: date-time */
|
|
589
|
+
updated_at: string
|
|
590
|
+
}
|
|
591
|
+
UpdateUserRequest: {
|
|
592
|
+
name?: string
|
|
593
|
+
/** Format: uri */
|
|
594
|
+
avatar_url?: string
|
|
595
|
+
}
|
|
596
|
+
UpdateEmailRequest: {
|
|
597
|
+
/** Format: email */
|
|
598
|
+
email: string
|
|
599
|
+
}
|
|
600
|
+
Org: {
|
|
601
|
+
/** Format: uuid */
|
|
602
|
+
id: string
|
|
603
|
+
/** Format: uuid */
|
|
604
|
+
created_by?: string
|
|
605
|
+
name: string
|
|
606
|
+
description?: string
|
|
607
|
+
/** Format: uri */
|
|
608
|
+
avatar_url?: string
|
|
609
|
+
slug: string
|
|
610
|
+
tier: components["schemas"]["OrgTier"]
|
|
611
|
+
/** Format: date-time */
|
|
612
|
+
created_at: string
|
|
613
|
+
/** Format: date-time */
|
|
614
|
+
updated_at: string
|
|
615
|
+
}
|
|
616
|
+
OrgMember: {
|
|
617
|
+
/** Format: uuid */
|
|
618
|
+
org_id: string
|
|
619
|
+
/** Format: uuid */
|
|
620
|
+
user_id: string
|
|
621
|
+
role: components["schemas"]["MemberRole"]
|
|
622
|
+
/** Format: date-time */
|
|
623
|
+
created_at: string
|
|
624
|
+
/** Format: date-time */
|
|
625
|
+
updated_at: string
|
|
626
|
+
}
|
|
627
|
+
/**
|
|
628
|
+
* @description Role hierarchy (highest → lowest): `owner > admin > member > viewer`.
|
|
629
|
+
* @enum {string}
|
|
630
|
+
*/
|
|
631
|
+
MemberRole: "owner" | "admin" | "member" | "viewer"
|
|
632
|
+
CreateOrgRequest: {
|
|
633
|
+
name: string
|
|
634
|
+
description?: string
|
|
635
|
+
slug: string
|
|
636
|
+
}
|
|
637
|
+
UpdateOrgRequest: {
|
|
638
|
+
name?: string
|
|
639
|
+
description?: string
|
|
640
|
+
/** Format: uri */
|
|
641
|
+
avatar_url?: string
|
|
642
|
+
}
|
|
643
|
+
AddMemberRequest: {
|
|
644
|
+
/** Format: uuid */
|
|
645
|
+
user_id: string
|
|
646
|
+
/** @enum {string} */
|
|
647
|
+
role: "admin" | "member" | "viewer"
|
|
648
|
+
}
|
|
649
|
+
UpdateMemberRequest: {
|
|
650
|
+
role: components["schemas"]["MemberRole"]
|
|
651
|
+
}
|
|
652
|
+
Agent: {
|
|
653
|
+
/** Format: uuid */
|
|
654
|
+
id: string
|
|
655
|
+
/** Format: uuid */
|
|
656
|
+
owner_user_id?: string
|
|
657
|
+
/** Format: uuid */
|
|
658
|
+
owner_org_id?: string
|
|
659
|
+
/** Format: uuid */
|
|
660
|
+
template_id?: string
|
|
661
|
+
config: components["schemas"]["AgentConfig"]
|
|
662
|
+
secrets: components["schemas"]["AgentSecret"][]
|
|
663
|
+
blueprint: components["schemas"]["Blueprint"]
|
|
664
|
+
status: components["schemas"]["AgentStatus"]
|
|
665
|
+
/** Format: date-time */
|
|
666
|
+
created_at: string
|
|
667
|
+
/** Format: date-time */
|
|
668
|
+
updated_at: string
|
|
669
|
+
}
|
|
670
|
+
/** @enum {string} */
|
|
671
|
+
AgentStatus: "draft" | "live" | "archived"
|
|
672
|
+
/** @enum {string} */
|
|
673
|
+
AgentLLMEngine: "deepseek" | "mistral" | "gemini" | "openai"
|
|
674
|
+
AgentConfig: {
|
|
675
|
+
/** Format: uri */
|
|
676
|
+
avatar_url?: string
|
|
677
|
+
name: string
|
|
678
|
+
description?: string
|
|
679
|
+
/** @example es */
|
|
680
|
+
language?: string
|
|
681
|
+
/** @example UTC */
|
|
682
|
+
timezone?: string
|
|
683
|
+
global_system_prompt?: string
|
|
684
|
+
max_session_duration_minutes?: number
|
|
685
|
+
max_silence_timeout_seconds?: number
|
|
686
|
+
allow_interruptions?: boolean
|
|
687
|
+
llm_engine?: components["schemas"]["AgentLLMEngine"]
|
|
688
|
+
llm_model?: string
|
|
689
|
+
}
|
|
690
|
+
AgentSecret: {
|
|
691
|
+
key: string
|
|
692
|
+
value: string
|
|
693
|
+
description?: string
|
|
694
|
+
}
|
|
695
|
+
AgentLintDiagnostics: {
|
|
696
|
+
errors: string[]
|
|
697
|
+
}
|
|
698
|
+
CreateAgentRequest: {
|
|
699
|
+
/** Format: uuid */
|
|
700
|
+
template_id?: string
|
|
701
|
+
config?: components["schemas"]["AgentConfig"]
|
|
702
|
+
secrets?: components["schemas"]["AgentSecret"][]
|
|
703
|
+
blueprint?: components["schemas"]["Blueprint"]
|
|
704
|
+
}
|
|
705
|
+
UpdateAgentRequest: {
|
|
706
|
+
config?: components["schemas"]["AgentConfig"]
|
|
707
|
+
secrets?: components["schemas"]["AgentSecret"][]
|
|
708
|
+
blueprint?: components["schemas"]["Blueprint"]
|
|
709
|
+
}
|
|
710
|
+
UpdateAgentStatusRequest: {
|
|
711
|
+
status: components["schemas"]["AgentStatus"]
|
|
712
|
+
}
|
|
713
|
+
LintAgentRequest: {
|
|
714
|
+
blueprint?: components["schemas"]["Blueprint"]
|
|
715
|
+
}
|
|
716
|
+
AgentPage: {
|
|
717
|
+
items: components["schemas"]["Agent"][]
|
|
718
|
+
total: number
|
|
719
|
+
limit: number
|
|
720
|
+
page: number
|
|
721
|
+
}
|
|
722
|
+
Blueprint: {
|
|
723
|
+
/** @default 1 */
|
|
724
|
+
version: string
|
|
725
|
+
entries: {
|
|
726
|
+
name: string
|
|
727
|
+
workflow: {
|
|
728
|
+
nodes: components["schemas"]["BlueprintNode"][]
|
|
729
|
+
edges: components["schemas"]["BlueprintEdge"][]
|
|
730
|
+
}
|
|
731
|
+
}[]
|
|
732
|
+
}
|
|
733
|
+
BlueprintNode: {
|
|
734
|
+
id: string
|
|
735
|
+
type: string
|
|
736
|
+
data: {
|
|
737
|
+
[key: string]: unknown
|
|
738
|
+
}
|
|
739
|
+
} & {
|
|
740
|
+
[key: string]: unknown
|
|
741
|
+
}
|
|
742
|
+
BlueprintEdge: {
|
|
743
|
+
source: string
|
|
744
|
+
target: string
|
|
745
|
+
} & {
|
|
746
|
+
[key: string]: unknown
|
|
747
|
+
}
|
|
748
|
+
Conversation: {
|
|
749
|
+
/** Format: uuid */
|
|
750
|
+
id: string
|
|
751
|
+
/** Format: uuid */
|
|
752
|
+
agent_id: string
|
|
753
|
+
status: components["schemas"]["ConversationStatus"]
|
|
754
|
+
summary?: string
|
|
755
|
+
/** Format: date-time */
|
|
756
|
+
started_at: string
|
|
757
|
+
/** Format: date-time */
|
|
758
|
+
ended_at?: string
|
|
759
|
+
end_reason?: components["schemas"]["ConversationEndReason"]
|
|
760
|
+
}
|
|
761
|
+
ConversationMessage: {
|
|
762
|
+
/** Format: uuid */
|
|
763
|
+
id: string
|
|
764
|
+
/** Format: uuid */
|
|
765
|
+
conversation_id: string
|
|
766
|
+
role: components["schemas"]["ConversationMessageRole"]
|
|
767
|
+
content: string
|
|
768
|
+
/** Format: date-time */
|
|
769
|
+
created_at: string
|
|
770
|
+
}
|
|
771
|
+
/** @enum {string} */
|
|
772
|
+
ConversationStatus: "active" | "ended"
|
|
773
|
+
/** @enum {string} */
|
|
774
|
+
ConversationEndReason: "user_exit" | "timeout" | "script_terminate" | "socket_shutdown" | "error" | "flow_end" | "client_end" | "agent_transfer"
|
|
775
|
+
/** @enum {string} */
|
|
776
|
+
ConversationMessageRole: "user" | "assistant" | "system" | "tool"
|
|
777
|
+
ConversationPage: {
|
|
778
|
+
items: components["schemas"]["Conversation"][]
|
|
779
|
+
next_cursor: string
|
|
780
|
+
has_more: boolean
|
|
781
|
+
}
|
|
782
|
+
ConversationMessagePage: {
|
|
783
|
+
items: components["schemas"]["ConversationMessage"][]
|
|
784
|
+
next_cursor: string
|
|
785
|
+
has_more: boolean
|
|
786
|
+
}
|
|
787
|
+
Template: {
|
|
788
|
+
/** Format: uuid */
|
|
789
|
+
id: string
|
|
790
|
+
/** Format: uuid */
|
|
791
|
+
owner_user_id?: string
|
|
792
|
+
/** Format: uuid */
|
|
793
|
+
owner_org_id?: string
|
|
794
|
+
name: string
|
|
795
|
+
description?: string
|
|
796
|
+
config: components["schemas"]["AgentConfig"]
|
|
797
|
+
blueprint: components["schemas"]["Blueprint"]
|
|
798
|
+
/** Format: date-time */
|
|
799
|
+
created_at: string
|
|
800
|
+
/** Format: date-time */
|
|
801
|
+
updated_at: string
|
|
802
|
+
}
|
|
803
|
+
CreateTemplateRequest: {
|
|
804
|
+
name: string
|
|
805
|
+
description?: string
|
|
806
|
+
config?: components["schemas"]["AgentConfig"]
|
|
807
|
+
secrets?: components["schemas"]["AgentSecret"][]
|
|
808
|
+
blueprint?: components["schemas"]["Blueprint"]
|
|
809
|
+
}
|
|
810
|
+
UpdateTemplateRequest: {
|
|
811
|
+
name?: string
|
|
812
|
+
description?: string
|
|
813
|
+
config?: components["schemas"]["AgentConfig"]
|
|
814
|
+
secrets?: components["schemas"]["AgentSecret"][]
|
|
815
|
+
blueprint?: components["schemas"]["Blueprint"]
|
|
816
|
+
}
|
|
817
|
+
TemplatePage: {
|
|
818
|
+
items: components["schemas"]["Template"][]
|
|
819
|
+
total: number
|
|
820
|
+
limit: number
|
|
821
|
+
page: number
|
|
822
|
+
}
|
|
823
|
+
/** @enum {string} */
|
|
824
|
+
OrgTier: "free" | "enterprise"
|
|
825
|
+
};
|
|
826
|
+
responses: {
|
|
827
|
+
/** @description Not authenticated. */
|
|
828
|
+
Unauthorized: {
|
|
829
|
+
headers: {
|
|
830
|
+
[name: string]: unknown
|
|
831
|
+
}
|
|
832
|
+
content: {
|
|
833
|
+
"application/json": components["schemas"]["Error"]
|
|
834
|
+
}
|
|
835
|
+
}
|
|
836
|
+
/** @description Insufficient permissions. */
|
|
837
|
+
Forbidden: {
|
|
838
|
+
headers: {
|
|
839
|
+
[name: string]: unknown
|
|
840
|
+
}
|
|
841
|
+
content: {
|
|
842
|
+
"application/json": components["schemas"]["Error"]
|
|
843
|
+
}
|
|
844
|
+
}
|
|
845
|
+
/** @description Resource not found. */
|
|
846
|
+
NotFound: {
|
|
847
|
+
headers: {
|
|
848
|
+
[name: string]: unknown
|
|
849
|
+
}
|
|
850
|
+
content: {
|
|
851
|
+
"application/json": components["schemas"]["Error"]
|
|
852
|
+
}
|
|
853
|
+
}
|
|
854
|
+
/** @description Resource already exists or state conflict. */
|
|
855
|
+
Conflict: {
|
|
856
|
+
headers: {
|
|
857
|
+
[name: string]: unknown
|
|
858
|
+
}
|
|
859
|
+
content: {
|
|
860
|
+
"application/json": components["schemas"]["Error"]
|
|
861
|
+
}
|
|
862
|
+
}
|
|
863
|
+
/** @description Request body failed validation. */
|
|
864
|
+
UnprocessableEntity: {
|
|
865
|
+
headers: {
|
|
866
|
+
[name: string]: unknown
|
|
867
|
+
}
|
|
868
|
+
content: {
|
|
869
|
+
"application/json": components["schemas"]["Error"]
|
|
870
|
+
}
|
|
871
|
+
}
|
|
872
|
+
/** @description An unexpected error occurred. */
|
|
873
|
+
DefaultError: {
|
|
874
|
+
headers: {
|
|
875
|
+
[name: string]: unknown
|
|
876
|
+
}
|
|
877
|
+
content: {
|
|
878
|
+
"application/json": components["schemas"]["Error"]
|
|
879
|
+
}
|
|
880
|
+
}
|
|
881
|
+
};
|
|
882
|
+
parameters: {
|
|
883
|
+
/** @description URL-safe organization identifier. */
|
|
884
|
+
OrgSlug: string
|
|
885
|
+
AgentID: string
|
|
886
|
+
KeyID: string
|
|
887
|
+
ConversationID: string
|
|
888
|
+
TemplateID: string
|
|
889
|
+
UserID: string
|
|
890
|
+
LimitParam: number
|
|
891
|
+
PageParam: number
|
|
892
|
+
/** @description Opaque cursor returned in the previous response's `next_cursor`. */
|
|
893
|
+
AfterParam: string
|
|
894
|
+
/** @description Full-text search filter. */
|
|
895
|
+
SearchParam: string
|
|
896
|
+
};
|
|
897
|
+
requestBodies: never;
|
|
898
|
+
headers: never;
|
|
899
|
+
pathItems: never;
|
|
372
900
|
}
|
|
373
|
-
interface
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
901
|
+
interface operations {
|
|
902
|
+
signup: {
|
|
903
|
+
parameters: {
|
|
904
|
+
query?: never
|
|
905
|
+
header: {
|
|
906
|
+
/** @description Cloudflare Turnstile challenge token. */
|
|
907
|
+
"X-Turnstile-Token": string
|
|
908
|
+
}
|
|
909
|
+
path?: never
|
|
910
|
+
cookie?: never
|
|
911
|
+
}
|
|
912
|
+
requestBody: {
|
|
913
|
+
content: {
|
|
914
|
+
"application/json": components["schemas"]["SignupRequest"]
|
|
915
|
+
}
|
|
916
|
+
}
|
|
917
|
+
responses: {
|
|
918
|
+
/** @description Account created. Session cookie is set in `Set-Cookie`. */
|
|
919
|
+
201: {
|
|
920
|
+
headers: {
|
|
921
|
+
"Set-Cookie"?: string
|
|
922
|
+
[name: string]: unknown
|
|
923
|
+
}
|
|
924
|
+
content: {
|
|
925
|
+
"application/json": components["schemas"]["AuthSessionResponse"]
|
|
926
|
+
}
|
|
927
|
+
}
|
|
928
|
+
default: components["responses"]["DefaultError"]
|
|
929
|
+
}
|
|
930
|
+
};
|
|
931
|
+
createSession: {
|
|
932
|
+
parameters: {
|
|
933
|
+
query?: never
|
|
934
|
+
header: {
|
|
935
|
+
"X-Turnstile-Token": string
|
|
936
|
+
}
|
|
937
|
+
path?: never
|
|
938
|
+
cookie?: never
|
|
939
|
+
}
|
|
940
|
+
requestBody: {
|
|
941
|
+
content: {
|
|
942
|
+
"application/json": components["schemas"]["LoginRequest"]
|
|
943
|
+
}
|
|
944
|
+
}
|
|
945
|
+
responses: {
|
|
946
|
+
/** @description Session created. Session cookie is set in `Set-Cookie`. */
|
|
947
|
+
201: {
|
|
948
|
+
headers: {
|
|
949
|
+
"Set-Cookie"?: string
|
|
950
|
+
[name: string]: unknown
|
|
951
|
+
}
|
|
952
|
+
content: {
|
|
953
|
+
"application/json": components["schemas"]["AuthSessionResponse"]
|
|
954
|
+
}
|
|
955
|
+
}
|
|
956
|
+
default: components["responses"]["DefaultError"]
|
|
957
|
+
}
|
|
958
|
+
};
|
|
959
|
+
revokeAllSessions: {
|
|
960
|
+
parameters: {
|
|
961
|
+
query?: never
|
|
962
|
+
header?: never
|
|
963
|
+
path?: never
|
|
964
|
+
cookie?: never
|
|
965
|
+
}
|
|
966
|
+
requestBody?: never
|
|
967
|
+
responses: {
|
|
968
|
+
/** @description All sessions revoked. */
|
|
969
|
+
204: {
|
|
970
|
+
headers: {
|
|
971
|
+
[name: string]: unknown
|
|
972
|
+
}
|
|
973
|
+
content?: never
|
|
974
|
+
}
|
|
975
|
+
default: components["responses"]["DefaultError"]
|
|
976
|
+
}
|
|
977
|
+
};
|
|
978
|
+
revokeSession: {
|
|
979
|
+
parameters: {
|
|
980
|
+
query?: never
|
|
981
|
+
header?: never
|
|
982
|
+
path?: never
|
|
983
|
+
cookie?: never
|
|
984
|
+
}
|
|
985
|
+
requestBody?: never
|
|
986
|
+
responses: {
|
|
987
|
+
/** @description Session revoked. */
|
|
988
|
+
204: {
|
|
989
|
+
headers: {
|
|
990
|
+
[name: string]: unknown
|
|
991
|
+
}
|
|
992
|
+
content?: never
|
|
993
|
+
}
|
|
994
|
+
default: components["responses"]["DefaultError"]
|
|
995
|
+
}
|
|
996
|
+
};
|
|
997
|
+
recoverPassword: {
|
|
998
|
+
parameters: {
|
|
999
|
+
query?: never
|
|
1000
|
+
header: {
|
|
1001
|
+
"X-Turnstile-Token": string
|
|
1002
|
+
}
|
|
1003
|
+
path?: never
|
|
1004
|
+
cookie?: never
|
|
1005
|
+
}
|
|
1006
|
+
requestBody: {
|
|
1007
|
+
content: {
|
|
1008
|
+
"application/json": components["schemas"]["RecoverPasswordRequest"]
|
|
1009
|
+
}
|
|
1010
|
+
}
|
|
1011
|
+
responses: {
|
|
1012
|
+
/** @description Reset email sent (or silently dropped if email not found). */
|
|
1013
|
+
204: {
|
|
1014
|
+
headers: {
|
|
1015
|
+
[name: string]: unknown
|
|
1016
|
+
}
|
|
1017
|
+
content?: never
|
|
1018
|
+
}
|
|
1019
|
+
default: components["responses"]["DefaultError"]
|
|
1020
|
+
}
|
|
1021
|
+
};
|
|
1022
|
+
resetPassword: {
|
|
1023
|
+
parameters: {
|
|
1024
|
+
query?: never
|
|
1025
|
+
header?: never
|
|
1026
|
+
path?: never
|
|
1027
|
+
cookie?: never
|
|
1028
|
+
}
|
|
1029
|
+
requestBody: {
|
|
1030
|
+
content: {
|
|
1031
|
+
"application/json": components["schemas"]["ResetPasswordRequest"]
|
|
1032
|
+
}
|
|
1033
|
+
}
|
|
1034
|
+
responses: {
|
|
1035
|
+
/** @description Password updated; all sessions revoked. */
|
|
1036
|
+
204: {
|
|
1037
|
+
headers: {
|
|
1038
|
+
[name: string]: unknown
|
|
1039
|
+
}
|
|
1040
|
+
content?: never
|
|
1041
|
+
}
|
|
1042
|
+
default: components["responses"]["DefaultError"]
|
|
1043
|
+
}
|
|
1044
|
+
};
|
|
1045
|
+
listAPIKeys: {
|
|
1046
|
+
parameters: {
|
|
1047
|
+
query?: never
|
|
1048
|
+
header?: never
|
|
1049
|
+
path?: never
|
|
1050
|
+
cookie?: never
|
|
1051
|
+
}
|
|
1052
|
+
requestBody?: never
|
|
1053
|
+
responses: {
|
|
1054
|
+
/** @description OK */
|
|
1055
|
+
200: {
|
|
1056
|
+
headers: {
|
|
1057
|
+
[name: string]: unknown
|
|
1058
|
+
}
|
|
1059
|
+
content: {
|
|
1060
|
+
"application/json": components["schemas"]["AuthAPIKey"][]
|
|
1061
|
+
}
|
|
1062
|
+
}
|
|
1063
|
+
default: components["responses"]["DefaultError"]
|
|
1064
|
+
}
|
|
1065
|
+
};
|
|
1066
|
+
createAPIKey: {
|
|
1067
|
+
parameters: {
|
|
1068
|
+
query?: never
|
|
1069
|
+
header?: never
|
|
1070
|
+
path?: never
|
|
1071
|
+
cookie?: never
|
|
1072
|
+
}
|
|
1073
|
+
requestBody: {
|
|
1074
|
+
content: {
|
|
1075
|
+
"application/json": components["schemas"]["CreateAPIKeyRequest"]
|
|
1076
|
+
}
|
|
1077
|
+
}
|
|
1078
|
+
responses: {
|
|
1079
|
+
/**
|
|
1080
|
+
* @description API key created. The `key` field contains the full raw value.
|
|
1081
|
+
* It will **not** be returned again.
|
|
1082
|
+
*/
|
|
1083
|
+
201: {
|
|
1084
|
+
headers: {
|
|
1085
|
+
[name: string]: unknown
|
|
1086
|
+
}
|
|
1087
|
+
content: {
|
|
1088
|
+
"application/json": components["schemas"]["AuthAPIKeyResponse"]
|
|
1089
|
+
}
|
|
1090
|
+
}
|
|
1091
|
+
default: components["responses"]["DefaultError"]
|
|
1092
|
+
}
|
|
1093
|
+
};
|
|
1094
|
+
revokeAPIKey: {
|
|
1095
|
+
parameters: {
|
|
1096
|
+
query?: never
|
|
1097
|
+
header?: never
|
|
1098
|
+
path: {
|
|
1099
|
+
keyID: components["parameters"]["KeyID"]
|
|
1100
|
+
}
|
|
1101
|
+
cookie?: never
|
|
1102
|
+
}
|
|
1103
|
+
requestBody?: never
|
|
1104
|
+
responses: {
|
|
1105
|
+
/** @description Key revoked. */
|
|
1106
|
+
204: {
|
|
1107
|
+
headers: {
|
|
1108
|
+
[name: string]: unknown
|
|
1109
|
+
}
|
|
1110
|
+
content?: never
|
|
1111
|
+
}
|
|
1112
|
+
default: components["responses"]["DefaultError"]
|
|
1113
|
+
}
|
|
1114
|
+
};
|
|
1115
|
+
getMe: {
|
|
1116
|
+
parameters: {
|
|
1117
|
+
query?: never
|
|
1118
|
+
header?: never
|
|
1119
|
+
path?: never
|
|
1120
|
+
cookie?: never
|
|
1121
|
+
}
|
|
1122
|
+
requestBody?: never
|
|
1123
|
+
responses: {
|
|
1124
|
+
/** @description OK */
|
|
1125
|
+
200: {
|
|
1126
|
+
headers: {
|
|
1127
|
+
[name: string]: unknown
|
|
1128
|
+
}
|
|
1129
|
+
content: {
|
|
1130
|
+
"application/json": components["schemas"]["User"]
|
|
1131
|
+
}
|
|
1132
|
+
}
|
|
1133
|
+
default: components["responses"]["DefaultError"]
|
|
1134
|
+
}
|
|
1135
|
+
};
|
|
1136
|
+
deleteMe: {
|
|
1137
|
+
parameters: {
|
|
1138
|
+
query?: never
|
|
1139
|
+
header?: never
|
|
1140
|
+
path?: never
|
|
1141
|
+
cookie?: never
|
|
1142
|
+
}
|
|
1143
|
+
requestBody?: never
|
|
1144
|
+
responses: {
|
|
1145
|
+
/** @description Account deleted. */
|
|
1146
|
+
204: {
|
|
1147
|
+
headers: {
|
|
1148
|
+
[name: string]: unknown
|
|
1149
|
+
}
|
|
1150
|
+
content?: never
|
|
1151
|
+
}
|
|
1152
|
+
default: components["responses"]["DefaultError"]
|
|
1153
|
+
}
|
|
1154
|
+
};
|
|
1155
|
+
updateMe: {
|
|
1156
|
+
parameters: {
|
|
1157
|
+
query?: never
|
|
1158
|
+
header?: never
|
|
1159
|
+
path?: never
|
|
1160
|
+
cookie?: never
|
|
1161
|
+
}
|
|
1162
|
+
requestBody: {
|
|
1163
|
+
content: {
|
|
1164
|
+
"application/json": components["schemas"]["UpdateUserRequest"]
|
|
1165
|
+
}
|
|
1166
|
+
}
|
|
1167
|
+
responses: {
|
|
1168
|
+
/** @description Updated. */
|
|
1169
|
+
200: {
|
|
1170
|
+
headers: {
|
|
1171
|
+
[name: string]: unknown
|
|
1172
|
+
}
|
|
1173
|
+
content: {
|
|
1174
|
+
"application/json": components["schemas"]["User"]
|
|
1175
|
+
}
|
|
1176
|
+
}
|
|
1177
|
+
default: components["responses"]["DefaultError"]
|
|
1178
|
+
}
|
|
1179
|
+
};
|
|
1180
|
+
updateMyEmail: {
|
|
1181
|
+
parameters: {
|
|
1182
|
+
query?: never
|
|
1183
|
+
header?: never
|
|
1184
|
+
path?: never
|
|
1185
|
+
cookie?: never
|
|
1186
|
+
}
|
|
1187
|
+
requestBody: {
|
|
1188
|
+
content: {
|
|
1189
|
+
"application/json": components["schemas"]["UpdateEmailRequest"]
|
|
1190
|
+
}
|
|
1191
|
+
}
|
|
1192
|
+
responses: {
|
|
1193
|
+
/** @description Email updated. */
|
|
1194
|
+
200: {
|
|
1195
|
+
headers: {
|
|
1196
|
+
[name: string]: unknown
|
|
1197
|
+
}
|
|
1198
|
+
content: {
|
|
1199
|
+
"application/json": components["schemas"]["User"]
|
|
1200
|
+
}
|
|
1201
|
+
}
|
|
1202
|
+
default: components["responses"]["DefaultError"]
|
|
1203
|
+
}
|
|
1204
|
+
};
|
|
1205
|
+
listOrgs: {
|
|
1206
|
+
parameters: {
|
|
1207
|
+
query?: never
|
|
1208
|
+
header?: never
|
|
1209
|
+
path?: never
|
|
1210
|
+
cookie?: never
|
|
1211
|
+
}
|
|
1212
|
+
requestBody?: never
|
|
1213
|
+
responses: {
|
|
1214
|
+
/** @description OK */
|
|
1215
|
+
200: {
|
|
1216
|
+
headers: {
|
|
1217
|
+
[name: string]: unknown
|
|
1218
|
+
}
|
|
1219
|
+
content: {
|
|
1220
|
+
"application/json": components["schemas"]["Org"][]
|
|
1221
|
+
}
|
|
1222
|
+
}
|
|
1223
|
+
default: components["responses"]["DefaultError"]
|
|
1224
|
+
}
|
|
1225
|
+
};
|
|
1226
|
+
createOrg: {
|
|
1227
|
+
parameters: {
|
|
1228
|
+
query?: never
|
|
1229
|
+
header?: never
|
|
1230
|
+
path?: never
|
|
1231
|
+
cookie?: never
|
|
1232
|
+
}
|
|
1233
|
+
requestBody: {
|
|
1234
|
+
content: {
|
|
1235
|
+
"application/json": components["schemas"]["CreateOrgRequest"]
|
|
1236
|
+
}
|
|
1237
|
+
}
|
|
1238
|
+
responses: {
|
|
1239
|
+
/** @description Organization created. */
|
|
1240
|
+
201: {
|
|
1241
|
+
headers: {
|
|
1242
|
+
[name: string]: unknown
|
|
1243
|
+
}
|
|
1244
|
+
content: {
|
|
1245
|
+
"application/json": components["schemas"]["Org"]
|
|
1246
|
+
}
|
|
1247
|
+
}
|
|
1248
|
+
default: components["responses"]["DefaultError"]
|
|
1249
|
+
}
|
|
1250
|
+
};
|
|
1251
|
+
getOrg: {
|
|
1252
|
+
parameters: {
|
|
1253
|
+
query?: never
|
|
1254
|
+
header?: never
|
|
1255
|
+
path: {
|
|
1256
|
+
/** @description URL-safe organization identifier. */
|
|
1257
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
1258
|
+
}
|
|
1259
|
+
cookie?: never
|
|
1260
|
+
}
|
|
1261
|
+
requestBody?: never
|
|
1262
|
+
responses: {
|
|
1263
|
+
/** @description OK */
|
|
1264
|
+
200: {
|
|
1265
|
+
headers: {
|
|
1266
|
+
[name: string]: unknown
|
|
1267
|
+
}
|
|
1268
|
+
content: {
|
|
1269
|
+
"application/json": components["schemas"]["Org"]
|
|
1270
|
+
}
|
|
1271
|
+
}
|
|
1272
|
+
default: components["responses"]["DefaultError"]
|
|
1273
|
+
}
|
|
1274
|
+
};
|
|
1275
|
+
deleteOrg: {
|
|
1276
|
+
parameters: {
|
|
1277
|
+
query?: never
|
|
1278
|
+
header?: never
|
|
1279
|
+
path: {
|
|
1280
|
+
/** @description URL-safe organization identifier. */
|
|
1281
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
1282
|
+
}
|
|
1283
|
+
cookie?: never
|
|
1284
|
+
}
|
|
1285
|
+
requestBody?: never
|
|
1286
|
+
responses: {
|
|
1287
|
+
/** @description Organization deleted. */
|
|
1288
|
+
204: {
|
|
1289
|
+
headers: {
|
|
1290
|
+
[name: string]: unknown
|
|
1291
|
+
}
|
|
1292
|
+
content?: never
|
|
1293
|
+
}
|
|
1294
|
+
default: components["responses"]["DefaultError"]
|
|
1295
|
+
}
|
|
1296
|
+
};
|
|
1297
|
+
updateOrg: {
|
|
1298
|
+
parameters: {
|
|
1299
|
+
query?: never
|
|
1300
|
+
header?: never
|
|
1301
|
+
path: {
|
|
1302
|
+
/** @description URL-safe organization identifier. */
|
|
1303
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
1304
|
+
}
|
|
1305
|
+
cookie?: never
|
|
1306
|
+
}
|
|
1307
|
+
requestBody: {
|
|
1308
|
+
content: {
|
|
1309
|
+
"application/json": components["schemas"]["UpdateOrgRequest"]
|
|
1310
|
+
}
|
|
1311
|
+
}
|
|
1312
|
+
responses: {
|
|
1313
|
+
/** @description Updated. */
|
|
1314
|
+
200: {
|
|
1315
|
+
headers: {
|
|
1316
|
+
[name: string]: unknown
|
|
1317
|
+
}
|
|
1318
|
+
content: {
|
|
1319
|
+
"application/json": components["schemas"]["Org"]
|
|
1320
|
+
}
|
|
1321
|
+
}
|
|
1322
|
+
default: components["responses"]["DefaultError"]
|
|
1323
|
+
}
|
|
1324
|
+
};
|
|
1325
|
+
listOrgMembers: {
|
|
1326
|
+
parameters: {
|
|
1327
|
+
query?: never
|
|
1328
|
+
header?: never
|
|
1329
|
+
path: {
|
|
1330
|
+
/** @description URL-safe organization identifier. */
|
|
1331
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
1332
|
+
}
|
|
1333
|
+
cookie?: never
|
|
1334
|
+
}
|
|
1335
|
+
requestBody?: never
|
|
1336
|
+
responses: {
|
|
1337
|
+
/** @description OK */
|
|
1338
|
+
200: {
|
|
1339
|
+
headers: {
|
|
1340
|
+
[name: string]: unknown
|
|
1341
|
+
}
|
|
1342
|
+
content: {
|
|
1343
|
+
"application/json": components["schemas"]["OrgMember"][]
|
|
1344
|
+
}
|
|
1345
|
+
}
|
|
1346
|
+
default: components["responses"]["DefaultError"]
|
|
1347
|
+
}
|
|
1348
|
+
};
|
|
1349
|
+
addOrgMember: {
|
|
1350
|
+
parameters: {
|
|
1351
|
+
query?: never
|
|
1352
|
+
header?: never
|
|
1353
|
+
path: {
|
|
1354
|
+
/** @description URL-safe organization identifier. */
|
|
1355
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
1356
|
+
}
|
|
1357
|
+
cookie?: never
|
|
1358
|
+
}
|
|
1359
|
+
requestBody: {
|
|
1360
|
+
content: {
|
|
1361
|
+
"application/json": components["schemas"]["AddMemberRequest"]
|
|
1362
|
+
}
|
|
1363
|
+
}
|
|
1364
|
+
responses: {
|
|
1365
|
+
/** @description Member added. */
|
|
1366
|
+
201: {
|
|
1367
|
+
headers: {
|
|
1368
|
+
[name: string]: unknown
|
|
1369
|
+
}
|
|
1370
|
+
content: {
|
|
1371
|
+
"application/json": components["schemas"]["OrgMember"]
|
|
1372
|
+
}
|
|
1373
|
+
}
|
|
1374
|
+
default: components["responses"]["DefaultError"]
|
|
1375
|
+
}
|
|
1376
|
+
};
|
|
1377
|
+
removeOrgMember: {
|
|
1378
|
+
parameters: {
|
|
1379
|
+
query?: never
|
|
1380
|
+
header?: never
|
|
1381
|
+
path: {
|
|
1382
|
+
/** @description URL-safe organization identifier. */
|
|
1383
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
1384
|
+
userID: components["parameters"]["UserID"]
|
|
1385
|
+
}
|
|
1386
|
+
cookie?: never
|
|
1387
|
+
}
|
|
1388
|
+
requestBody?: never
|
|
1389
|
+
responses: {
|
|
1390
|
+
/** @description Member removed. */
|
|
1391
|
+
204: {
|
|
1392
|
+
headers: {
|
|
1393
|
+
[name: string]: unknown
|
|
1394
|
+
}
|
|
1395
|
+
content?: never
|
|
1396
|
+
}
|
|
1397
|
+
default: components["responses"]["DefaultError"]
|
|
1398
|
+
}
|
|
1399
|
+
};
|
|
1400
|
+
updateOrgMember: {
|
|
1401
|
+
parameters: {
|
|
1402
|
+
query?: never
|
|
1403
|
+
header?: never
|
|
1404
|
+
path: {
|
|
1405
|
+
/** @description URL-safe organization identifier. */
|
|
1406
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
1407
|
+
userID: components["parameters"]["UserID"]
|
|
1408
|
+
}
|
|
1409
|
+
cookie?: never
|
|
1410
|
+
}
|
|
1411
|
+
requestBody: {
|
|
1412
|
+
content: {
|
|
1413
|
+
"application/json": components["schemas"]["UpdateMemberRequest"]
|
|
1414
|
+
}
|
|
1415
|
+
}
|
|
1416
|
+
responses: {
|
|
1417
|
+
/** @description Role updated. */
|
|
1418
|
+
200: {
|
|
1419
|
+
headers: {
|
|
1420
|
+
[name: string]: unknown
|
|
1421
|
+
}
|
|
1422
|
+
content: {
|
|
1423
|
+
"application/json": components["schemas"]["OrgMember"]
|
|
1424
|
+
}
|
|
1425
|
+
}
|
|
1426
|
+
default: components["responses"]["DefaultError"]
|
|
1427
|
+
}
|
|
1428
|
+
};
|
|
1429
|
+
listUserAgents: {
|
|
1430
|
+
parameters: {
|
|
1431
|
+
query?: {
|
|
1432
|
+
limit?: components["parameters"]["LimitParam"]
|
|
1433
|
+
page?: components["parameters"]["PageParam"]
|
|
1434
|
+
/** @description Full-text search filter. */
|
|
1435
|
+
search?: components["parameters"]["SearchParam"]
|
|
1436
|
+
}
|
|
1437
|
+
header?: never
|
|
1438
|
+
path?: never
|
|
1439
|
+
cookie?: never
|
|
1440
|
+
}
|
|
1441
|
+
requestBody?: never
|
|
1442
|
+
responses: {
|
|
1443
|
+
/** @description OK */
|
|
1444
|
+
200: {
|
|
1445
|
+
headers: {
|
|
1446
|
+
[name: string]: unknown
|
|
1447
|
+
}
|
|
1448
|
+
content: {
|
|
1449
|
+
"application/json": components["schemas"]["AgentPage"]
|
|
1450
|
+
}
|
|
1451
|
+
}
|
|
1452
|
+
default: components["responses"]["DefaultError"]
|
|
1453
|
+
}
|
|
1454
|
+
};
|
|
1455
|
+
createUserAgent: {
|
|
1456
|
+
parameters: {
|
|
1457
|
+
query?: never
|
|
1458
|
+
header?: never
|
|
1459
|
+
path?: never
|
|
1460
|
+
cookie?: never
|
|
1461
|
+
}
|
|
1462
|
+
requestBody: {
|
|
1463
|
+
content: {
|
|
1464
|
+
"application/json": components["schemas"]["CreateAgentRequest"]
|
|
1465
|
+
}
|
|
1466
|
+
}
|
|
1467
|
+
responses: {
|
|
1468
|
+
/** @description Agent created. */
|
|
1469
|
+
201: {
|
|
1470
|
+
headers: {
|
|
1471
|
+
[name: string]: unknown
|
|
1472
|
+
}
|
|
1473
|
+
content: {
|
|
1474
|
+
"application/json": components["schemas"]["Agent"]
|
|
1475
|
+
}
|
|
1476
|
+
}
|
|
1477
|
+
default: components["responses"]["DefaultError"]
|
|
1478
|
+
}
|
|
1479
|
+
};
|
|
1480
|
+
listOrgAgents: {
|
|
1481
|
+
parameters: {
|
|
1482
|
+
query?: {
|
|
1483
|
+
limit?: components["parameters"]["LimitParam"]
|
|
1484
|
+
page?: components["parameters"]["PageParam"]
|
|
1485
|
+
/** @description Full-text search filter. */
|
|
1486
|
+
search?: components["parameters"]["SearchParam"]
|
|
1487
|
+
}
|
|
1488
|
+
header?: never
|
|
1489
|
+
path: {
|
|
1490
|
+
/** @description URL-safe organization identifier. */
|
|
1491
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
1492
|
+
}
|
|
1493
|
+
cookie?: never
|
|
1494
|
+
}
|
|
1495
|
+
requestBody?: never
|
|
1496
|
+
responses: {
|
|
1497
|
+
/** @description OK */
|
|
1498
|
+
200: {
|
|
1499
|
+
headers: {
|
|
1500
|
+
[name: string]: unknown
|
|
1501
|
+
}
|
|
1502
|
+
content: {
|
|
1503
|
+
"application/json": components["schemas"]["AgentPage"]
|
|
1504
|
+
}
|
|
1505
|
+
}
|
|
1506
|
+
default: components["responses"]["DefaultError"]
|
|
1507
|
+
}
|
|
1508
|
+
};
|
|
1509
|
+
createOrgAgent: {
|
|
1510
|
+
parameters: {
|
|
1511
|
+
query?: never
|
|
1512
|
+
header?: never
|
|
1513
|
+
path: {
|
|
1514
|
+
/** @description URL-safe organization identifier. */
|
|
1515
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
1516
|
+
}
|
|
1517
|
+
cookie?: never
|
|
1518
|
+
}
|
|
1519
|
+
requestBody: {
|
|
1520
|
+
content: {
|
|
1521
|
+
"application/json": components["schemas"]["CreateAgentRequest"]
|
|
1522
|
+
}
|
|
1523
|
+
}
|
|
1524
|
+
responses: {
|
|
1525
|
+
/** @description Agent created. */
|
|
1526
|
+
201: {
|
|
1527
|
+
headers: {
|
|
1528
|
+
[name: string]: unknown
|
|
1529
|
+
}
|
|
1530
|
+
content: {
|
|
1531
|
+
"application/json": components["schemas"]["Agent"]
|
|
1532
|
+
}
|
|
1533
|
+
}
|
|
1534
|
+
default: components["responses"]["DefaultError"]
|
|
1535
|
+
}
|
|
1536
|
+
};
|
|
1537
|
+
getAgent: {
|
|
1538
|
+
parameters: {
|
|
1539
|
+
query?: never
|
|
1540
|
+
header?: never
|
|
1541
|
+
path: {
|
|
1542
|
+
agentID: components["parameters"]["AgentID"]
|
|
1543
|
+
}
|
|
1544
|
+
cookie?: never
|
|
1545
|
+
}
|
|
1546
|
+
requestBody?: never
|
|
1547
|
+
responses: {
|
|
1548
|
+
/** @description OK */
|
|
1549
|
+
200: {
|
|
1550
|
+
headers: {
|
|
1551
|
+
[name: string]: unknown
|
|
1552
|
+
}
|
|
1553
|
+
content: {
|
|
1554
|
+
"application/json": components["schemas"]["Agent"]
|
|
1555
|
+
}
|
|
1556
|
+
}
|
|
1557
|
+
default: components["responses"]["DefaultError"]
|
|
1558
|
+
}
|
|
1559
|
+
};
|
|
1560
|
+
deleteAgent: {
|
|
1561
|
+
parameters: {
|
|
1562
|
+
query?: never
|
|
1563
|
+
header?: never
|
|
1564
|
+
path: {
|
|
1565
|
+
agentID: components["parameters"]["AgentID"]
|
|
1566
|
+
}
|
|
1567
|
+
cookie?: never
|
|
1568
|
+
}
|
|
1569
|
+
requestBody?: never
|
|
1570
|
+
responses: {
|
|
1571
|
+
/** @description Agent deleted. */
|
|
1572
|
+
204: {
|
|
1573
|
+
headers: {
|
|
1574
|
+
[name: string]: unknown
|
|
1575
|
+
}
|
|
1576
|
+
content?: never
|
|
1577
|
+
}
|
|
1578
|
+
default: components["responses"]["DefaultError"]
|
|
1579
|
+
}
|
|
1580
|
+
};
|
|
1581
|
+
updateAgent: {
|
|
1582
|
+
parameters: {
|
|
1583
|
+
query?: never
|
|
1584
|
+
header?: never
|
|
1585
|
+
path: {
|
|
1586
|
+
agentID: components["parameters"]["AgentID"]
|
|
1587
|
+
}
|
|
1588
|
+
cookie?: never
|
|
1589
|
+
}
|
|
1590
|
+
requestBody: {
|
|
1591
|
+
content: {
|
|
1592
|
+
"application/json": components["schemas"]["UpdateAgentRequest"]
|
|
1593
|
+
}
|
|
1594
|
+
}
|
|
1595
|
+
responses: {
|
|
1596
|
+
/** @description Updated. */
|
|
1597
|
+
200: {
|
|
1598
|
+
headers: {
|
|
1599
|
+
[name: string]: unknown
|
|
1600
|
+
}
|
|
1601
|
+
content: {
|
|
1602
|
+
"application/json": components["schemas"]["Agent"]
|
|
1603
|
+
}
|
|
1604
|
+
}
|
|
1605
|
+
default: components["responses"]["DefaultError"]
|
|
1606
|
+
}
|
|
1607
|
+
};
|
|
1608
|
+
updateAgentStatus: {
|
|
1609
|
+
parameters: {
|
|
1610
|
+
query?: never
|
|
1611
|
+
header?: never
|
|
1612
|
+
path: {
|
|
1613
|
+
agentID: components["parameters"]["AgentID"]
|
|
1614
|
+
}
|
|
1615
|
+
cookie?: never
|
|
1616
|
+
}
|
|
1617
|
+
requestBody: {
|
|
1618
|
+
content: {
|
|
1619
|
+
"application/json": components["schemas"]["UpdateAgentStatusRequest"]
|
|
1620
|
+
}
|
|
1621
|
+
}
|
|
1622
|
+
responses: {
|
|
1623
|
+
/** @description Status updated. */
|
|
1624
|
+
200: {
|
|
1625
|
+
headers: {
|
|
1626
|
+
[name: string]: unknown
|
|
1627
|
+
}
|
|
1628
|
+
content: {
|
|
1629
|
+
"application/json": components["schemas"]["Agent"]
|
|
1630
|
+
}
|
|
1631
|
+
}
|
|
1632
|
+
default: components["responses"]["DefaultError"]
|
|
1633
|
+
}
|
|
1634
|
+
};
|
|
1635
|
+
lintAgent: {
|
|
1636
|
+
parameters: {
|
|
1637
|
+
query?: never
|
|
1638
|
+
header?: never
|
|
1639
|
+
path: {
|
|
1640
|
+
agentID: components["parameters"]["AgentID"]
|
|
1641
|
+
}
|
|
1642
|
+
cookie?: never
|
|
1643
|
+
}
|
|
1644
|
+
requestBody: {
|
|
1645
|
+
content: {
|
|
1646
|
+
"application/json": components["schemas"]["LintAgentRequest"]
|
|
1647
|
+
}
|
|
1648
|
+
}
|
|
1649
|
+
responses: {
|
|
1650
|
+
/** @description Lint result. An empty `errors` array means the blueprint is valid. */
|
|
1651
|
+
200: {
|
|
1652
|
+
headers: {
|
|
1653
|
+
[name: string]: unknown
|
|
1654
|
+
}
|
|
1655
|
+
content: {
|
|
1656
|
+
"application/json": components["schemas"]["AgentLintDiagnostics"]
|
|
1657
|
+
}
|
|
1658
|
+
}
|
|
1659
|
+
default: components["responses"]["DefaultError"]
|
|
1660
|
+
}
|
|
1661
|
+
};
|
|
1662
|
+
listAgentConversations: {
|
|
1663
|
+
parameters: {
|
|
1664
|
+
query?: {
|
|
1665
|
+
/** @description Opaque cursor returned in the previous response's `next_cursor`. */
|
|
1666
|
+
after?: components["parameters"]["AfterParam"]
|
|
1667
|
+
limit?: components["parameters"]["LimitParam"]
|
|
1668
|
+
}
|
|
1669
|
+
header?: never
|
|
1670
|
+
path: {
|
|
1671
|
+
agentID: components["parameters"]["AgentID"]
|
|
1672
|
+
}
|
|
1673
|
+
cookie?: never
|
|
1674
|
+
}
|
|
1675
|
+
requestBody?: never
|
|
1676
|
+
responses: {
|
|
1677
|
+
/** @description OK */
|
|
1678
|
+
200: {
|
|
1679
|
+
headers: {
|
|
1680
|
+
[name: string]: unknown
|
|
1681
|
+
}
|
|
1682
|
+
content: {
|
|
1683
|
+
"application/json": components["schemas"]["ConversationPage"]
|
|
1684
|
+
}
|
|
1685
|
+
}
|
|
1686
|
+
default: components["responses"]["DefaultError"]
|
|
1687
|
+
}
|
|
1688
|
+
};
|
|
1689
|
+
getConversation: {
|
|
1690
|
+
parameters: {
|
|
1691
|
+
query?: never
|
|
1692
|
+
header?: never
|
|
1693
|
+
path: {
|
|
1694
|
+
conversationID: components["parameters"]["ConversationID"]
|
|
1695
|
+
}
|
|
1696
|
+
cookie?: never
|
|
1697
|
+
}
|
|
1698
|
+
requestBody?: never
|
|
1699
|
+
responses: {
|
|
1700
|
+
/** @description OK */
|
|
1701
|
+
200: {
|
|
1702
|
+
headers: {
|
|
1703
|
+
[name: string]: unknown
|
|
1704
|
+
}
|
|
1705
|
+
content: {
|
|
1706
|
+
"application/json": components["schemas"]["Conversation"]
|
|
1707
|
+
}
|
|
1708
|
+
}
|
|
1709
|
+
default: components["responses"]["DefaultError"]
|
|
1710
|
+
}
|
|
1711
|
+
};
|
|
1712
|
+
deleteConversation: {
|
|
1713
|
+
parameters: {
|
|
1714
|
+
query?: never
|
|
1715
|
+
header?: never
|
|
1716
|
+
path: {
|
|
1717
|
+
conversationID: components["parameters"]["ConversationID"]
|
|
1718
|
+
}
|
|
1719
|
+
cookie?: never
|
|
1720
|
+
}
|
|
1721
|
+
requestBody?: never
|
|
1722
|
+
responses: {
|
|
1723
|
+
/** @description Conversation deleted. */
|
|
1724
|
+
204: {
|
|
1725
|
+
headers: {
|
|
1726
|
+
[name: string]: unknown
|
|
1727
|
+
}
|
|
1728
|
+
content?: never
|
|
1729
|
+
}
|
|
1730
|
+
default: components["responses"]["DefaultError"]
|
|
1731
|
+
}
|
|
1732
|
+
};
|
|
1733
|
+
listConversationMessages: {
|
|
1734
|
+
parameters: {
|
|
1735
|
+
query?: {
|
|
1736
|
+
/** @description Opaque cursor returned in the previous response's `next_cursor`. */
|
|
1737
|
+
after?: components["parameters"]["AfterParam"]
|
|
1738
|
+
limit?: components["parameters"]["LimitParam"]
|
|
1739
|
+
}
|
|
1740
|
+
header?: never
|
|
1741
|
+
path: {
|
|
1742
|
+
conversationID: components["parameters"]["ConversationID"]
|
|
1743
|
+
}
|
|
1744
|
+
cookie?: never
|
|
1745
|
+
}
|
|
1746
|
+
requestBody?: never
|
|
1747
|
+
responses: {
|
|
1748
|
+
/** @description OK */
|
|
1749
|
+
200: {
|
|
1750
|
+
headers: {
|
|
1751
|
+
[name: string]: unknown
|
|
1752
|
+
}
|
|
1753
|
+
content: {
|
|
1754
|
+
"application/json": components["schemas"]["ConversationMessagePage"]
|
|
1755
|
+
}
|
|
1756
|
+
}
|
|
1757
|
+
default: components["responses"]["DefaultError"]
|
|
1758
|
+
}
|
|
1759
|
+
};
|
|
1760
|
+
listUserTemplates: {
|
|
1761
|
+
parameters: {
|
|
1762
|
+
query?: {
|
|
1763
|
+
limit?: components["parameters"]["LimitParam"]
|
|
1764
|
+
page?: components["parameters"]["PageParam"]
|
|
1765
|
+
}
|
|
1766
|
+
header?: never
|
|
1767
|
+
path?: never
|
|
1768
|
+
cookie?: never
|
|
1769
|
+
}
|
|
1770
|
+
requestBody?: never
|
|
1771
|
+
responses: {
|
|
1772
|
+
/** @description OK */
|
|
1773
|
+
200: {
|
|
1774
|
+
headers: {
|
|
1775
|
+
[name: string]: unknown
|
|
1776
|
+
}
|
|
1777
|
+
content: {
|
|
1778
|
+
"application/json": components["schemas"]["TemplatePage"]
|
|
1779
|
+
}
|
|
1780
|
+
}
|
|
1781
|
+
default: components["responses"]["DefaultError"]
|
|
1782
|
+
}
|
|
1783
|
+
};
|
|
1784
|
+
createUserTemplate: {
|
|
1785
|
+
parameters: {
|
|
1786
|
+
query?: never
|
|
1787
|
+
header?: never
|
|
1788
|
+
path?: never
|
|
1789
|
+
cookie?: never
|
|
1790
|
+
}
|
|
1791
|
+
requestBody: {
|
|
1792
|
+
content: {
|
|
1793
|
+
"application/json": components["schemas"]["CreateTemplateRequest"]
|
|
1794
|
+
}
|
|
1795
|
+
}
|
|
1796
|
+
responses: {
|
|
1797
|
+
/** @description Template created. */
|
|
1798
|
+
201: {
|
|
1799
|
+
headers: {
|
|
1800
|
+
[name: string]: unknown
|
|
1801
|
+
}
|
|
1802
|
+
content: {
|
|
1803
|
+
"application/json": components["schemas"]["Template"]
|
|
1804
|
+
}
|
|
1805
|
+
}
|
|
1806
|
+
default: components["responses"]["DefaultError"]
|
|
1807
|
+
}
|
|
1808
|
+
};
|
|
1809
|
+
listOrgTemplates: {
|
|
1810
|
+
parameters: {
|
|
1811
|
+
query?: {
|
|
1812
|
+
limit?: components["parameters"]["LimitParam"]
|
|
1813
|
+
page?: components["parameters"]["PageParam"]
|
|
1814
|
+
}
|
|
1815
|
+
header?: never
|
|
1816
|
+
path: {
|
|
1817
|
+
/** @description URL-safe organization identifier. */
|
|
1818
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
1819
|
+
}
|
|
1820
|
+
cookie?: never
|
|
1821
|
+
}
|
|
1822
|
+
requestBody?: never
|
|
1823
|
+
responses: {
|
|
1824
|
+
/** @description OK */
|
|
1825
|
+
200: {
|
|
1826
|
+
headers: {
|
|
1827
|
+
[name: string]: unknown
|
|
1828
|
+
}
|
|
1829
|
+
content: {
|
|
1830
|
+
"application/json": components["schemas"]["TemplatePage"]
|
|
1831
|
+
}
|
|
1832
|
+
}
|
|
1833
|
+
default: components["responses"]["DefaultError"]
|
|
1834
|
+
}
|
|
1835
|
+
};
|
|
1836
|
+
createOrgTemplate: {
|
|
1837
|
+
parameters: {
|
|
1838
|
+
query?: never
|
|
1839
|
+
header?: never
|
|
1840
|
+
path: {
|
|
1841
|
+
/** @description URL-safe organization identifier. */
|
|
1842
|
+
orgSlug: components["parameters"]["OrgSlug"]
|
|
1843
|
+
}
|
|
1844
|
+
cookie?: never
|
|
1845
|
+
}
|
|
1846
|
+
requestBody: {
|
|
1847
|
+
content: {
|
|
1848
|
+
"application/json": components["schemas"]["CreateTemplateRequest"]
|
|
1849
|
+
}
|
|
1850
|
+
}
|
|
1851
|
+
responses: {
|
|
1852
|
+
/** @description Template created. */
|
|
1853
|
+
201: {
|
|
1854
|
+
headers: {
|
|
1855
|
+
[name: string]: unknown
|
|
1856
|
+
}
|
|
1857
|
+
content: {
|
|
1858
|
+
"application/json": components["schemas"]["Template"]
|
|
1859
|
+
}
|
|
1860
|
+
}
|
|
1861
|
+
default: components["responses"]["DefaultError"]
|
|
1862
|
+
}
|
|
1863
|
+
};
|
|
1864
|
+
getTemplate: {
|
|
1865
|
+
parameters: {
|
|
1866
|
+
query?: never
|
|
1867
|
+
header?: never
|
|
1868
|
+
path: {
|
|
1869
|
+
templateID: components["parameters"]["TemplateID"]
|
|
1870
|
+
}
|
|
1871
|
+
cookie?: never
|
|
1872
|
+
}
|
|
1873
|
+
requestBody?: never
|
|
1874
|
+
responses: {
|
|
1875
|
+
/** @description OK */
|
|
1876
|
+
200: {
|
|
1877
|
+
headers: {
|
|
1878
|
+
[name: string]: unknown
|
|
1879
|
+
}
|
|
1880
|
+
content: {
|
|
1881
|
+
"application/json": components["schemas"]["Template"]
|
|
1882
|
+
}
|
|
1883
|
+
}
|
|
1884
|
+
default: components["responses"]["DefaultError"]
|
|
1885
|
+
}
|
|
1886
|
+
};
|
|
1887
|
+
deleteTemplate: {
|
|
1888
|
+
parameters: {
|
|
1889
|
+
query?: never
|
|
1890
|
+
header?: never
|
|
1891
|
+
path: {
|
|
1892
|
+
templateID: components["parameters"]["TemplateID"]
|
|
1893
|
+
}
|
|
1894
|
+
cookie?: never
|
|
1895
|
+
}
|
|
1896
|
+
requestBody?: never
|
|
1897
|
+
responses: {
|
|
1898
|
+
/** @description Template deleted. */
|
|
1899
|
+
204: {
|
|
1900
|
+
headers: {
|
|
1901
|
+
[name: string]: unknown
|
|
1902
|
+
}
|
|
1903
|
+
content?: never
|
|
1904
|
+
}
|
|
1905
|
+
default: components["responses"]["DefaultError"]
|
|
1906
|
+
}
|
|
1907
|
+
};
|
|
1908
|
+
updateTemplate: {
|
|
1909
|
+
parameters: {
|
|
1910
|
+
query?: never
|
|
1911
|
+
header?: never
|
|
1912
|
+
path: {
|
|
1913
|
+
templateID: components["parameters"]["TemplateID"]
|
|
1914
|
+
}
|
|
1915
|
+
cookie?: never
|
|
1916
|
+
}
|
|
1917
|
+
requestBody: {
|
|
1918
|
+
content: {
|
|
1919
|
+
"application/json": components["schemas"]["UpdateTemplateRequest"]
|
|
1920
|
+
}
|
|
1921
|
+
}
|
|
1922
|
+
responses: {
|
|
1923
|
+
/** @description Updated. */
|
|
1924
|
+
200: {
|
|
1925
|
+
headers: {
|
|
1926
|
+
[name: string]: unknown
|
|
1927
|
+
}
|
|
1928
|
+
content: {
|
|
1929
|
+
"application/json": components["schemas"]["Template"]
|
|
1930
|
+
}
|
|
1931
|
+
}
|
|
1932
|
+
default: components["responses"]["DefaultError"]
|
|
1933
|
+
}
|
|
1934
|
+
};
|
|
379
1935
|
}
|
|
380
|
-
interface User {
|
|
381
|
-
/** A URL to the JSON Schema for this object. */
|
|
382
|
-
readonly $schema?: string;
|
|
383
|
-
/** @nullable */
|
|
384
|
-
avatar_url: string | null;
|
|
385
|
-
created_at: string;
|
|
386
|
-
email: string;
|
|
387
|
-
id: string;
|
|
388
|
-
name: string;
|
|
389
|
-
updated_at: string;
|
|
390
|
-
}
|
|
391
|
-
type ListConversationsParams = {
|
|
392
|
-
after?: string
|
|
393
|
-
/**
|
|
394
|
-
* @minimum 1
|
|
395
|
-
* @maximum 100
|
|
396
|
-
*/
|
|
397
|
-
limit?: number
|
|
398
|
-
};
|
|
399
|
-
type ListMessagesParams = {
|
|
400
|
-
after?: string
|
|
401
|
-
/**
|
|
402
|
-
* @minimum 1
|
|
403
|
-
* @maximum 100
|
|
404
|
-
*/
|
|
405
|
-
limit?: number
|
|
406
|
-
};
|
|
407
|
-
type ListOrgAgentsParams = {
|
|
408
|
-
/**
|
|
409
|
-
* @minimum 1
|
|
410
|
-
* @maximum 100
|
|
411
|
-
*/
|
|
412
|
-
limit?: number
|
|
413
|
-
/**
|
|
414
|
-
* @minimum 1
|
|
415
|
-
*/
|
|
416
|
-
page?: number
|
|
417
|
-
search?: string
|
|
418
|
-
};
|
|
419
|
-
type ListOrgTemplatesParams = {
|
|
420
|
-
/**
|
|
421
|
-
* @minimum 1
|
|
422
|
-
* @maximum 100
|
|
423
|
-
*/
|
|
424
|
-
limit?: number
|
|
425
|
-
/**
|
|
426
|
-
* @minimum 1
|
|
427
|
-
*/
|
|
428
|
-
page?: number
|
|
429
|
-
};
|
|
430
|
-
type ListUserAgentsParams = {
|
|
431
|
-
/**
|
|
432
|
-
* @minimum 1
|
|
433
|
-
* @maximum 100
|
|
434
|
-
*/
|
|
435
|
-
limit?: number
|
|
436
|
-
/**
|
|
437
|
-
* @minimum 1
|
|
438
|
-
*/
|
|
439
|
-
page?: number
|
|
440
|
-
search?: string
|
|
441
|
-
};
|
|
442
|
-
type ListUserTemplatesParams = {
|
|
443
|
-
/**
|
|
444
|
-
* @minimum 1
|
|
445
|
-
* @maximum 100
|
|
446
|
-
*/
|
|
447
|
-
limit?: number
|
|
448
|
-
/**
|
|
449
|
-
* @minimum 1
|
|
450
|
-
*/
|
|
451
|
-
page?: number
|
|
452
|
-
};
|
|
453
|
-
/**
|
|
454
|
-
* @summary Soft-delete an agent
|
|
455
|
-
*/
|
|
456
|
-
declare const deleteAgent: (agentID: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<void>>;
|
|
457
|
-
/**
|
|
458
|
-
* @summary Get an agent by ID
|
|
459
|
-
*/
|
|
460
|
-
declare const getAgent: (agentID: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<Agent>>;
|
|
461
|
-
/**
|
|
462
|
-
* @summary Update an agent
|
|
463
|
-
*/
|
|
464
|
-
declare const updateAgent: (agentID: string, updateAgentInBody: NonReadonly<UpdateAgentInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<Agent>>;
|
|
465
|
-
/**
|
|
466
|
-
* @summary List conversations for an agent
|
|
467
|
-
*/
|
|
468
|
-
declare const listConversations: (agentID: string, params?: ListConversationsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<CursorResponseConversation>>;
|
|
469
|
-
/**
|
|
470
|
-
* @summary Lint an agent's orchestration source
|
|
471
|
-
*/
|
|
472
|
-
declare const lintAgent: (agentID: string, lintAgentInBody: NonReadonly<LintAgentInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<AgentLintDiagnostics>>;
|
|
473
|
-
/**
|
|
474
|
-
* @summary Transition an agent's lifecycle status
|
|
475
|
-
*/
|
|
476
|
-
declare const updateAgentStatus: (agentID: string, updateAgentStatusInBody: NonReadonly<UpdateAgentStatusInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<Agent>>;
|
|
477
|
-
/**
|
|
478
|
-
* @summary List API keys
|
|
479
|
-
*/
|
|
480
|
-
declare const listApiKeys: (options?: AxiosRequestConfig) => Promise<AxiosResponse<AuthAPIKey[] | null>>;
|
|
481
|
-
/**
|
|
482
|
-
* @summary Create a new API key
|
|
483
|
-
*/
|
|
484
|
-
declare const createApiKey: (createAPIKeyInBody: NonReadonly<CreateAPIKeyInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<AuthAPIKeyResponse>>;
|
|
485
|
-
/**
|
|
486
|
-
* @summary Revoke an API key
|
|
487
|
-
*/
|
|
488
|
-
declare const revokeApiKey: (keyID: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<void>>;
|
|
489
|
-
/**
|
|
490
|
-
* @summary Revoke all sessions
|
|
491
|
-
*/
|
|
492
|
-
declare const logoutAll: (options?: AxiosRequestConfig) => Promise<AxiosResponse<void>>;
|
|
493
|
-
/**
|
|
494
|
-
* @summary Authenticate and create a session
|
|
495
|
-
*/
|
|
496
|
-
declare const login: (loginInBody: NonReadonly<LoginInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<AuthSessionResponse>>;
|
|
497
|
-
/**
|
|
498
|
-
* @summary Revoke the current session
|
|
499
|
-
*/
|
|
500
|
-
declare const logout: (options?: AxiosRequestConfig) => Promise<AxiosResponse<void>>;
|
|
501
|
-
/**
|
|
502
|
-
* @summary Create a new account and session
|
|
503
|
-
*/
|
|
504
|
-
declare const signup: (signupInBody: NonReadonly<SignupInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<AuthSessionResponse>>;
|
|
505
|
-
/**
|
|
506
|
-
* @summary Soft-delete a conversation
|
|
507
|
-
*/
|
|
508
|
-
declare const deleteConversation: (conversationID: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<void>>;
|
|
509
|
-
/**
|
|
510
|
-
* @summary Get a conversation by ID
|
|
511
|
-
*/
|
|
512
|
-
declare const getConversation: (conversationID: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<Conversation>>;
|
|
513
|
-
/**
|
|
514
|
-
* @summary List messages in a conversation
|
|
515
|
-
*/
|
|
516
|
-
declare const listMessages: (conversationID: string, params?: ListMessagesParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<CursorResponseConversationMessage>>;
|
|
517
|
-
/**
|
|
518
|
-
* @summary List organizations
|
|
519
|
-
*/
|
|
520
|
-
declare const listOrgs: (options?: AxiosRequestConfig) => Promise<AxiosResponse<Org[] | null>>;
|
|
521
|
-
/**
|
|
522
|
-
* @summary Create a new organization
|
|
523
|
-
*/
|
|
524
|
-
declare const createOrg: (createOrgInBody: NonReadonly<CreateOrgInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<Org>>;
|
|
525
|
-
/**
|
|
526
|
-
* @summary Soft-delete an organization
|
|
527
|
-
*/
|
|
528
|
-
declare const deleteOrg: (orgSlug: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<void>>;
|
|
529
|
-
/**
|
|
530
|
-
* @summary Get an organization by slug
|
|
531
|
-
*/
|
|
532
|
-
declare const getOrg: (orgSlug: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<Org>>;
|
|
533
|
-
/**
|
|
534
|
-
* @summary Update an organization
|
|
535
|
-
*/
|
|
536
|
-
declare const updateOrg: (orgSlug: string, updateOrgInBody: NonReadonly<UpdateOrgInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<Org>>;
|
|
537
|
-
/**
|
|
538
|
-
* @summary List agents owned by an organization
|
|
539
|
-
*/
|
|
540
|
-
declare const listOrgAgents: (orgSlug: string, params?: ListOrgAgentsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<PageResponseAgent>>;
|
|
541
|
-
/**
|
|
542
|
-
* @summary Create an agent owned by an organization
|
|
543
|
-
*/
|
|
544
|
-
declare const createOrgAgent: (orgSlug: string, createOrgAgentInBody: NonReadonly<CreateOrgAgentInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<Agent>>;
|
|
545
|
-
/**
|
|
546
|
-
* @summary List organization members
|
|
547
|
-
*/
|
|
548
|
-
declare const listOrgMembers: (orgSlug: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<OrgMember[] | null>>;
|
|
549
|
-
/**
|
|
550
|
-
* @summary Add a member
|
|
551
|
-
*/
|
|
552
|
-
declare const addOrgMember: (orgSlug: string, addMemberInBody: NonReadonly<AddMemberInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<OrgMember>>;
|
|
553
|
-
/**
|
|
554
|
-
* @summary Remove a member
|
|
555
|
-
*/
|
|
556
|
-
declare const removeOrgMember: (orgSlug: string, userID: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<void>>;
|
|
557
|
-
/**
|
|
558
|
-
* @summary Update a member's role
|
|
559
|
-
*/
|
|
560
|
-
declare const updateOrgMember: (orgSlug: string, userID: string, updateMemberInBody: NonReadonly<UpdateMemberInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<OrgMember>>;
|
|
561
|
-
/**
|
|
562
|
-
* @summary List templates owned by an organization
|
|
563
|
-
*/
|
|
564
|
-
declare const listOrgTemplates: (orgSlug: string, params?: ListOrgTemplatesParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<PageResponseTemplate>>;
|
|
565
|
-
/**
|
|
566
|
-
* @summary Create a template owned by an organization
|
|
567
|
-
*/
|
|
568
|
-
declare const createOrgTemplate: (orgSlug: string, createOrgTemplateInBody: NonReadonly<CreateOrgTemplateInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<Template>>;
|
|
569
|
-
/**
|
|
570
|
-
* @summary Soft-delete a template
|
|
571
|
-
*/
|
|
572
|
-
declare const deleteTemplate: (templateID: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<void>>;
|
|
573
|
-
/**
|
|
574
|
-
* @summary Get a template by ID
|
|
575
|
-
*/
|
|
576
|
-
declare const getTemplate: (templateID: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<Template>>;
|
|
577
|
-
/**
|
|
578
|
-
* @summary Update a template
|
|
579
|
-
*/
|
|
580
|
-
declare const updateTemplate: (templateID: string, updateTemplateInBody: NonReadonly<UpdateTemplateInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<Template>>;
|
|
581
|
-
/**
|
|
582
|
-
* @summary Soft-delete the account
|
|
583
|
-
*/
|
|
584
|
-
declare const deleteCurrentUser: (options?: AxiosRequestConfig) => Promise<AxiosResponse<void>>;
|
|
585
|
-
/**
|
|
586
|
-
* @summary Get the authenticated user's profile
|
|
587
|
-
*/
|
|
588
|
-
declare const getCurrentUser: (options?: AxiosRequestConfig) => Promise<AxiosResponse<User>>;
|
|
589
|
-
/**
|
|
590
|
-
* @summary Update the authenticated user's profile
|
|
591
|
-
*/
|
|
592
|
-
declare const updateCurrentUser: (updateUserInBody: NonReadonly<UpdateUserInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<User>>;
|
|
593
|
-
/**
|
|
594
|
-
* @summary List agents owned by the authenticated user
|
|
595
|
-
*/
|
|
596
|
-
declare const listUserAgents: (params?: ListUserAgentsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<PageResponseAgent>>;
|
|
597
|
-
/**
|
|
598
|
-
* @summary Create an agent owned by the authenticated user
|
|
599
|
-
*/
|
|
600
|
-
declare const createUserAgent: (createUserAgentInBody: NonReadonly<CreateUserAgentInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<Agent>>;
|
|
601
|
-
/**
|
|
602
|
-
* @summary Update email
|
|
603
|
-
*/
|
|
604
|
-
declare const updateCurrentUserEmail: (updateEmailInBody: NonReadonly<UpdateEmailInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<User>>;
|
|
605
|
-
/**
|
|
606
|
-
* @summary List templates owned by the authenticated user
|
|
607
|
-
*/
|
|
608
|
-
declare const listUserTemplates: (params?: ListUserTemplatesParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<PageResponseTemplate>>;
|
|
609
|
-
/**
|
|
610
|
-
* @summary Create a template owned by the authenticated user
|
|
611
|
-
*/
|
|
612
|
-
declare const createUserTemplate: (createUserTemplateInBody: NonReadonly<CreateUserTemplateInBody>, options?: AxiosRequestConfig) => Promise<AxiosResponse<Template>>;
|
|
613
|
-
/**
|
|
614
|
-
* @summary Get a user by ID
|
|
615
|
-
*/
|
|
616
|
-
declare const getUser: (userID: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<User>>;
|
|
617
|
-
type DeleteAgentResult = AxiosResponse<void>;
|
|
618
|
-
type GetAgentResult = AxiosResponse<Agent>;
|
|
619
|
-
type UpdateAgentResult = AxiosResponse<Agent>;
|
|
620
|
-
type ListConversationsResult = AxiosResponse<CursorResponseConversation>;
|
|
621
|
-
type LintAgentResult = AxiosResponse<AgentLintDiagnostics>;
|
|
622
|
-
type UpdateAgentStatusResult = AxiosResponse<Agent>;
|
|
623
|
-
type ListApiKeysResult = AxiosResponse<AuthAPIKey[] | null>;
|
|
624
|
-
type CreateApiKeyResult = AxiosResponse<AuthAPIKeyResponse>;
|
|
625
|
-
type RevokeApiKeyResult = AxiosResponse<void>;
|
|
626
|
-
type LogoutAllResult = AxiosResponse<void>;
|
|
627
|
-
type LoginResult = AxiosResponse<AuthSessionResponse>;
|
|
628
|
-
type LogoutResult = AxiosResponse<void>;
|
|
629
|
-
type SignupResult = AxiosResponse<AuthSessionResponse>;
|
|
630
|
-
type DeleteConversationResult = AxiosResponse<void>;
|
|
631
|
-
type GetConversationResult = AxiosResponse<Conversation>;
|
|
632
|
-
type ListMessagesResult = AxiosResponse<CursorResponseConversationMessage>;
|
|
633
|
-
type ListOrgsResult = AxiosResponse<Org[] | null>;
|
|
634
|
-
type CreateOrgResult = AxiosResponse<Org>;
|
|
635
|
-
type DeleteOrgResult = AxiosResponse<void>;
|
|
636
|
-
type GetOrgResult = AxiosResponse<Org>;
|
|
637
|
-
type UpdateOrgResult = AxiosResponse<Org>;
|
|
638
|
-
type ListOrgAgentsResult = AxiosResponse<PageResponseAgent>;
|
|
639
|
-
type CreateOrgAgentResult = AxiosResponse<Agent>;
|
|
640
|
-
type ListOrgMembersResult = AxiosResponse<OrgMember[] | null>;
|
|
641
|
-
type AddOrgMemberResult = AxiosResponse<OrgMember>;
|
|
642
|
-
type RemoveOrgMemberResult = AxiosResponse<void>;
|
|
643
|
-
type UpdateOrgMemberResult = AxiosResponse<OrgMember>;
|
|
644
|
-
type ListOrgTemplatesResult = AxiosResponse<PageResponseTemplate>;
|
|
645
|
-
type CreateOrgTemplateResult = AxiosResponse<Template>;
|
|
646
|
-
type DeleteTemplateResult = AxiosResponse<void>;
|
|
647
|
-
type GetTemplateResult = AxiosResponse<Template>;
|
|
648
|
-
type UpdateTemplateResult = AxiosResponse<Template>;
|
|
649
|
-
type DeleteCurrentUserResult = AxiosResponse<void>;
|
|
650
|
-
type GetCurrentUserResult = AxiosResponse<User>;
|
|
651
|
-
type UpdateCurrentUserResult = AxiosResponse<User>;
|
|
652
|
-
type ListUserAgentsResult = AxiosResponse<PageResponseAgent>;
|
|
653
|
-
type CreateUserAgentResult = AxiosResponse<Agent>;
|
|
654
|
-
type UpdateCurrentUserEmailResult = AxiosResponse<User>;
|
|
655
|
-
type ListUserTemplatesResult = AxiosResponse<PageResponseTemplate>;
|
|
656
|
-
type CreateUserTemplateResult = AxiosResponse<Template>;
|
|
657
|
-
type GetUserResult = AxiosResponse<User>;
|
|
658
1936
|
/**
|
|
659
1937
|
* Initializes a new conversational session.
|
|
660
1938
|
* It must be the first message sent after connection establishment.
|
|
@@ -1005,41 +2283,68 @@ declare class RealtimeClient {
|
|
|
1005
2283
|
*/
|
|
1006
2284
|
connect(params: ConversationConnectParams): Promise<ConversationSession>;
|
|
1007
2285
|
}
|
|
1008
|
-
|
|
2286
|
+
/**
|
|
2287
|
+
* Extract a schema type from `components.schemas` by key.
|
|
2288
|
+
*
|
|
2289
|
+
* @typeParam T - Schema name
|
|
2290
|
+
*/
|
|
2291
|
+
type ApiSchema<T extends keyof components["schemas"]> = components["schemas"][T];
|
|
2292
|
+
/**
|
|
2293
|
+
* Extract the JSON request body type for an operation.
|
|
2294
|
+
*
|
|
2295
|
+
* Returns `never` if no JSON body is defined.
|
|
2296
|
+
*
|
|
2297
|
+
* @typeParam T - Operation name
|
|
2298
|
+
*/
|
|
2299
|
+
type ApiRequest<T extends keyof operations> = operations[T] extends {
|
|
2300
|
+
requestBody?: {
|
|
2301
|
+
content: {
|
|
2302
|
+
"application/json": infer Body
|
|
2303
|
+
}
|
|
2304
|
+
}
|
|
2305
|
+
} ? Body : never;
|
|
2306
|
+
/**
|
|
2307
|
+
* Extract the JSON response type for an operation.
|
|
2308
|
+
*
|
|
2309
|
+
* Supports `200` and `201` responses. Returns `never` if neither exists.
|
|
2310
|
+
*
|
|
2311
|
+
* @typeParam T - Operation name
|
|
2312
|
+
*/
|
|
2313
|
+
type ApiResponse<T extends keyof operations> = operations[T] extends {
|
|
2314
|
+
responses: {
|
|
2315
|
+
200: {
|
|
2316
|
+
content: {
|
|
2317
|
+
"application/json": infer Res
|
|
2318
|
+
}
|
|
2319
|
+
}
|
|
2320
|
+
}
|
|
2321
|
+
} ? Res : operations[T] extends {
|
|
2322
|
+
responses: {
|
|
2323
|
+
201: {
|
|
2324
|
+
content: {
|
|
2325
|
+
"application/json": infer Res
|
|
2326
|
+
}
|
|
2327
|
+
}
|
|
2328
|
+
}
|
|
2329
|
+
} ? Res : never;
|
|
2330
|
+
type KivoxFetchClient = ReturnType<typeof createClient<paths>>;
|
|
2331
|
+
type KivoxClient = {
|
|
2332
|
+
api: KivoxFetchClient
|
|
1009
2333
|
realtime: RealtimeClient
|
|
1010
2334
|
};
|
|
1011
2335
|
type SessionClientOptions = {
|
|
1012
|
-
/** Base URL of the Kivox API. Defaults to 'https://server.kivox.com.co'. */
|
|
1013
2336
|
baseUrl?: string
|
|
1014
2337
|
};
|
|
1015
|
-
type
|
|
1016
|
-
|
|
1017
|
-
apiKey: string
|
|
1018
|
-
/** Base URL of the Kivox API. Defaults to 'https://server.kivox.com.co'. */
|
|
2338
|
+
type BearerClientOptions = {
|
|
2339
|
+
bearerToken: string
|
|
1019
2340
|
baseUrl?: string
|
|
1020
2341
|
};
|
|
1021
2342
|
/**
|
|
1022
|
-
*
|
|
1023
|
-
* Authenticates via HttpOnly session cookie — no token required in JS.
|
|
1024
|
-
* Requires the user to be logged in via `POST /auth/sessions` first.
|
|
1025
|
-
*
|
|
1026
|
-
* @example
|
|
1027
|
-
* ```ts
|
|
1028
|
-
* const client = createSessionClient();
|
|
1029
|
-
* await client.postAuthSessions({ email, password });
|
|
1030
|
-
* const { data: agents } = await client.getUsersMeAgents();
|
|
1031
|
-
* ```
|
|
2343
|
+
* Browser/Studio client. Authenticates via HttpOnly session cookie.
|
|
1032
2344
|
*/
|
|
1033
2345
|
declare function createSessionClient({ baseUrl }?: SessionClientOptions): KivoxClient;
|
|
1034
2346
|
/**
|
|
1035
|
-
*
|
|
1036
|
-
* Authenticates via `Authorization: Bearer <apiKey>` on every request.
|
|
1037
|
-
*
|
|
1038
|
-
* @example
|
|
1039
|
-
* ```ts
|
|
1040
|
-
* const client = createApiKeyClient({ apiKey: 'sk_live_...' });
|
|
1041
|
-
* const { data: agents } = await client.getUsersMeAgents();
|
|
1042
|
-
* ```
|
|
2347
|
+
* Server-side / programmatic client. Authenticates via Bearer token.
|
|
1043
2348
|
*/
|
|
1044
|
-
declare function
|
|
1045
|
-
export {
|
|
2349
|
+
declare function createBearerClient({ bearerToken, baseUrl }: BearerClientOptions): KivoxClient;
|
|
2350
|
+
export { paths, operations, createSessionClient, createBearerClient, components, SessionConnectionLostEvent, SessionClientOptions, ServerTurnComplete, ServerTransfer, ServerTick, ServerTextFull, ServerTextDelta, ServerSignal, ServerSessionEvent, ServerSessionClosed, ServerMessage, ServerHandshakeOK, ServerHandshakeError, ServerFlowComplete, ServerError, ServerConnectionMessage, ServerAudioDelta, KivoxFetchClient, KivoxClient, ConversationTransportError, ConversationSessionConfig, ConversationSession, ClientMessage, ClientInputText, ClientInputAudioStream, ClientInputAudio, ClientHandshake, ClientEndSession, ClientCancel, BearerClientOptions, ApiSchema, ApiResponse, ApiRequest };
|