v0-api 0.1.3 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +68 -0
- package/dist/components.cjs +44 -44
- package/dist/components.d.cts +133 -132
- package/dist/components.d.cts.map +1 -1
- package/dist/components.d.mts +133 -132
- package/dist/components.d.mts.map +1 -1
- package/dist/components.mjs +44 -44
- package/dist/effect.cjs +10 -10
- package/dist/effect.d.cts +133 -132
- package/dist/effect.d.cts.map +1 -1
- package/dist/effect.d.mts +133 -132
- package/dist/effect.d.mts.map +1 -1
- package/dist/effect.mjs +10 -10
- package/dist/index.cjs +706 -702
- package/dist/index.d.cts +1832 -1822
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +1832 -1822
- package/dist/index.d.mts.map +1 -1
- package/dist/index.d.ts +1832 -1822
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +706 -703
- package/dist/schemas.cjs +674 -670
- package/dist/schemas.d.cts +5 -2
- package/dist/schemas.d.cts.map +1 -1
- package/dist/schemas.d.mts +5 -2
- package/dist/schemas.d.mts.map +1 -1
- package/dist/schemas.mjs +659 -656
- package/dist/types.cjs +3 -3
- package/dist/types.d.cts +1694 -1688
- package/dist/types.d.cts.map +1 -1
- package/dist/types.d.mts +1694 -1688
- package/dist/types.d.mts.map +1 -1
- package/dist/types.mjs +3 -3
- package/package.json +4 -4
package/dist/effect.d.cts
CHANGED
|
@@ -37,9 +37,9 @@ type FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> = {
|
|
|
37
37
|
declare function client<TData, TError, TBody, THeaders, TQueryParams, TPathParams>({ url, method, body, headers, queryParams, signal, token, baseUrl, fetchImpl, }: FetcherOptions<TBody, THeaders, TQueryParams, TPathParams>): Promise<TData>;
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
|
-
* Generated by Kubb (https://kubb.dev/).
|
|
41
|
-
* Do not edit manually.
|
|
42
|
-
*/
|
|
40
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
41
|
+
* Do not edit manually.
|
|
42
|
+
*/
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
45
|
* @summary Create Chat
|
|
@@ -56,13 +56,14 @@ declare function chatsCreate({ config }?: {
|
|
|
56
56
|
* @description Retrieves a list of existing chats, with support for pagination and filtering by favorite status, Vercel project, or Git branch. Helps manage and navigate chat history.
|
|
57
57
|
* @link /chats
|
|
58
58
|
*/
|
|
59
|
-
declare function chatsFind({ queryParams, config }?: {
|
|
59
|
+
declare function chatsFind({ queryParams, config, }?: {
|
|
60
60
|
queryParams?: {
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
61
|
+
limit?: number;
|
|
62
|
+
offset?: number;
|
|
63
|
+
isFavorite?: "true" | "false";
|
|
64
|
+
vercelProjectId?: string;
|
|
65
|
+
branch?: string;
|
|
66
|
+
metadata?: unknown;
|
|
66
67
|
};
|
|
67
68
|
config?: Partial<FetcherConfig> & {
|
|
68
69
|
client?: typeof client;
|
|
@@ -83,9 +84,9 @@ declare function chatsInit({ config }?: {
|
|
|
83
84
|
* @description Deletes a specific chat based on the provided chatId. The chat and its contents are moved to trash and stop being retrievable immediately, then retained for 30 days before being permanently removed.
|
|
84
85
|
* @link /chats/{chatId}
|
|
85
86
|
*/
|
|
86
|
-
declare function chatsDelete({ pathParams, config }?: {
|
|
87
|
+
declare function chatsDelete({ pathParams, config, }?: {
|
|
87
88
|
pathParams: {
|
|
88
|
-
|
|
89
|
+
chatId: string;
|
|
89
90
|
};
|
|
90
91
|
config?: Partial<FetcherConfig> & {
|
|
91
92
|
client?: typeof client;
|
|
@@ -96,9 +97,9 @@ declare function chatsDelete({ pathParams, config }?: {
|
|
|
96
97
|
* @description Retrieves the full details of a specific chat using its `chatId`. Includes messages, metadata, and associated configuration.
|
|
97
98
|
* @link /chats/{chatId}
|
|
98
99
|
*/
|
|
99
|
-
declare function chatsGetById({ pathParams, config }?: {
|
|
100
|
+
declare function chatsGetById({ pathParams, config, }?: {
|
|
100
101
|
pathParams: {
|
|
101
|
-
|
|
102
|
+
chatId: string;
|
|
102
103
|
};
|
|
103
104
|
config?: Partial<FetcherConfig> & {
|
|
104
105
|
client?: typeof client;
|
|
@@ -109,9 +110,9 @@ declare function chatsGetById({ pathParams, config }?: {
|
|
|
109
110
|
* @description Updates the metadata of an existing chat using its `chatId`. Supports changes to the chat name and privacy setting.
|
|
110
111
|
* @link /chats/{chatId}
|
|
111
112
|
*/
|
|
112
|
-
declare function chatsUpdate({ pathParams, config }?: {
|
|
113
|
+
declare function chatsUpdate({ pathParams, config, }?: {
|
|
113
114
|
pathParams: {
|
|
114
|
-
|
|
115
|
+
chatId: string;
|
|
115
116
|
};
|
|
116
117
|
config?: Partial<FetcherConfig> & {
|
|
117
118
|
client?: typeof client;
|
|
@@ -122,9 +123,9 @@ declare function chatsUpdate({ pathParams, config }?: {
|
|
|
122
123
|
* @description Marks or unmarks a chat as a favorite using its `chatId`. This helps with organizing and quickly accessing important chats.
|
|
123
124
|
* @link /chats/{chatId}/favorite
|
|
124
125
|
*/
|
|
125
|
-
declare function chatsFavorite({ pathParams, config }?: {
|
|
126
|
+
declare function chatsFavorite({ pathParams, config, }?: {
|
|
126
127
|
pathParams: {
|
|
127
|
-
|
|
128
|
+
chatId: string;
|
|
128
129
|
};
|
|
129
130
|
config?: Partial<FetcherConfig> & {
|
|
130
131
|
client?: typeof client;
|
|
@@ -132,12 +133,12 @@ declare function chatsFavorite({ pathParams, config }?: {
|
|
|
132
133
|
}): Promise<unknown>;
|
|
133
134
|
/**
|
|
134
135
|
* @summary Fork Chat
|
|
135
|
-
* @description Creates a new chat fork (duplicate) from a specific version within
|
|
136
|
+
* @description Creates a new chat fork (duplicate) from a specific version within a chat created through Platform API v1. To duplicate chats created in v0 web or Platform API v2, use POST /v2/chats/{chatId}/duplicate.
|
|
136
137
|
* @link /chats/{chatId}/fork
|
|
137
138
|
*/
|
|
138
|
-
declare function chatsFork({ pathParams, config }?: {
|
|
139
|
+
declare function chatsFork({ pathParams, config, }?: {
|
|
139
140
|
pathParams: {
|
|
140
|
-
|
|
141
|
+
chatId: string;
|
|
141
142
|
};
|
|
142
143
|
config?: Partial<FetcherConfig> & {
|
|
143
144
|
client?: typeof client;
|
|
@@ -148,9 +149,9 @@ declare function chatsFork({ pathParams, config }?: {
|
|
|
148
149
|
* @description Retrieves the v0 project associated with a given chat. Useful for determining the context or scope of a chat session.
|
|
149
150
|
* @link /chats/{chatId}/project
|
|
150
151
|
*/
|
|
151
|
-
declare function projectsGetByChatId({ pathParams, config }?: {
|
|
152
|
+
declare function projectsGetByChatId({ pathParams, config, }?: {
|
|
152
153
|
pathParams: {
|
|
153
|
-
|
|
154
|
+
chatId: string;
|
|
154
155
|
};
|
|
155
156
|
config?: Partial<FetcherConfig> & {
|
|
156
157
|
client?: typeof client;
|
|
@@ -161,13 +162,13 @@ declare function projectsGetByChatId({ pathParams, config }?: {
|
|
|
161
162
|
* @description Retrieves a list of all messages for a specific chat, ordered by creation date (newest first). Supports cursor-based pagination and includes message content, role, and type information.
|
|
162
163
|
* @link /chats/{chatId}/messages
|
|
163
164
|
*/
|
|
164
|
-
declare function chatsFindMessages({ pathParams, queryParams, config }?: {
|
|
165
|
+
declare function chatsFindMessages({ pathParams, queryParams, config, }?: {
|
|
165
166
|
pathParams: {
|
|
166
|
-
|
|
167
|
+
chatId: string;
|
|
167
168
|
};
|
|
168
169
|
queryParams?: {
|
|
169
|
-
|
|
170
|
-
|
|
170
|
+
limit?: number;
|
|
171
|
+
cursor?: string;
|
|
171
172
|
};
|
|
172
173
|
config?: Partial<FetcherConfig> & {
|
|
173
174
|
client?: typeof client;
|
|
@@ -178,9 +179,9 @@ declare function chatsFindMessages({ pathParams, queryParams, config }?: {
|
|
|
178
179
|
* @description Creates a new message in an existing chat. Triggers a model response using the provided prompt, with optional attachments and configuration settings.
|
|
179
180
|
* @link /chats/{chatId}/messages
|
|
180
181
|
*/
|
|
181
|
-
declare function chatsSendMessage({ pathParams, config }?: {
|
|
182
|
+
declare function chatsSendMessage({ pathParams, config, }?: {
|
|
182
183
|
pathParams: {
|
|
183
|
-
|
|
184
|
+
chatId: string;
|
|
184
185
|
};
|
|
185
186
|
config?: Partial<FetcherConfig> & {
|
|
186
187
|
client?: typeof client;
|
|
@@ -191,10 +192,10 @@ declare function chatsSendMessage({ pathParams, config }?: {
|
|
|
191
192
|
* @description Retrieves detailed information about a specific message within a chat, including content, files, model configuration, and demo URLs.
|
|
192
193
|
* @link /chats/{chatId}/messages/{messageId}
|
|
193
194
|
*/
|
|
194
|
-
declare function chatsGetMessage({ pathParams, config }?: {
|
|
195
|
+
declare function chatsGetMessage({ pathParams, config, }?: {
|
|
195
196
|
pathParams: {
|
|
196
|
-
|
|
197
|
-
|
|
197
|
+
chatId: string;
|
|
198
|
+
messageId: string;
|
|
198
199
|
};
|
|
199
200
|
config?: Partial<FetcherConfig> & {
|
|
200
201
|
client?: typeof client;
|
|
@@ -205,13 +206,13 @@ declare function chatsGetMessage({ pathParams, config }?: {
|
|
|
205
206
|
* @description Retrieves a list of all versions (iterations) for a specific chat, ordered by creation date (newest first). Supports cursor-based pagination and includes version status and demo URLs.
|
|
206
207
|
* @link /chats/{chatId}/versions
|
|
207
208
|
*/
|
|
208
|
-
declare function chatsFindVersions({ pathParams, queryParams, config }?: {
|
|
209
|
+
declare function chatsFindVersions({ pathParams, queryParams, config, }?: {
|
|
209
210
|
pathParams: {
|
|
210
|
-
|
|
211
|
+
chatId: string;
|
|
211
212
|
};
|
|
212
213
|
queryParams?: {
|
|
213
|
-
|
|
214
|
-
|
|
214
|
+
limit?: number;
|
|
215
|
+
cursor?: string;
|
|
215
216
|
};
|
|
216
217
|
config?: Partial<FetcherConfig> & {
|
|
217
218
|
client?: typeof client;
|
|
@@ -222,13 +223,13 @@ declare function chatsFindVersions({ pathParams, queryParams, config }?: {
|
|
|
222
223
|
* @description Retrieves detailed information about a specific version of a chat, including all files with their content and lock status.
|
|
223
224
|
* @link /chats/{chatId}/versions/{versionId}
|
|
224
225
|
*/
|
|
225
|
-
declare function chatsGetVersion({ pathParams, queryParams, config }?: {
|
|
226
|
+
declare function chatsGetVersion({ pathParams, queryParams, config, }?: {
|
|
226
227
|
pathParams: {
|
|
227
|
-
|
|
228
|
-
|
|
228
|
+
chatId: string;
|
|
229
|
+
versionId: string;
|
|
229
230
|
};
|
|
230
231
|
queryParams?: {
|
|
231
|
-
|
|
232
|
+
includeDefaultFiles?: "true" | "false";
|
|
232
233
|
};
|
|
233
234
|
config?: Partial<FetcherConfig> & {
|
|
234
235
|
client?: typeof client;
|
|
@@ -239,10 +240,10 @@ declare function chatsGetVersion({ pathParams, queryParams, config }?: {
|
|
|
239
240
|
* @description Updates the source files of a specific chat version (block) manually. This allows editing generated files directly through the API.
|
|
240
241
|
* @link /chats/{chatId}/versions/{versionId}
|
|
241
242
|
*/
|
|
242
|
-
declare function chatsUpdateVersion({ pathParams, config }?: {
|
|
243
|
+
declare function chatsUpdateVersion({ pathParams, config, }?: {
|
|
243
244
|
pathParams: {
|
|
244
|
-
|
|
245
|
-
|
|
245
|
+
chatId: string;
|
|
246
|
+
versionId: string;
|
|
246
247
|
};
|
|
247
248
|
config?: Partial<FetcherConfig> & {
|
|
248
249
|
client?: typeof client;
|
|
@@ -253,14 +254,14 @@ declare function chatsUpdateVersion({ pathParams, config }?: {
|
|
|
253
254
|
* @description Download all files for a specific chat version as a zip or tarball archive. Use includeDefaultFiles=true to include all deployment files (package.json, configuration files, etc.) or false/omitted to return only the generated source files.
|
|
254
255
|
* @link /chats/{chatId}/versions/{versionId}/download
|
|
255
256
|
*/
|
|
256
|
-
declare function chatsDownloadVersion({ pathParams, queryParams, config }?: {
|
|
257
|
+
declare function chatsDownloadVersion({ pathParams, queryParams, config, }?: {
|
|
257
258
|
pathParams: {
|
|
258
|
-
|
|
259
|
-
|
|
259
|
+
chatId: string;
|
|
260
|
+
versionId: string;
|
|
260
261
|
};
|
|
261
262
|
queryParams?: {
|
|
262
|
-
|
|
263
|
-
|
|
263
|
+
format?: "zip" | "tarball";
|
|
264
|
+
includeDefaultFiles?: "true" | "false";
|
|
264
265
|
};
|
|
265
266
|
config?: Partial<FetcherConfig> & {
|
|
266
267
|
client?: typeof client;
|
|
@@ -271,10 +272,10 @@ declare function chatsDownloadVersion({ pathParams, queryParams, config }?: {
|
|
|
271
272
|
* @description Deletes source files from a specific chat version (block). Files are removed from the version and a new source version is created.
|
|
272
273
|
* @link /chats/{chatId}/versions/{versionId}/files/delete
|
|
273
274
|
*/
|
|
274
|
-
declare function chatsDeleteVersionFiles({ pathParams, config }?: {
|
|
275
|
+
declare function chatsDeleteVersionFiles({ pathParams, config, }?: {
|
|
275
276
|
pathParams: {
|
|
276
|
-
|
|
277
|
-
|
|
277
|
+
chatId: string;
|
|
278
|
+
versionId: string;
|
|
278
279
|
};
|
|
279
280
|
config?: Partial<FetcherConfig> & {
|
|
280
281
|
client?: typeof client;
|
|
@@ -285,10 +286,10 @@ declare function chatsDeleteVersionFiles({ pathParams, config }?: {
|
|
|
285
286
|
* @description Reconnects to an active assistant message stream and returns it as Server-Sent Events. This does not restart or continue a stopped generation.
|
|
286
287
|
* @link /chats/{chatId}/messages/{messageId}/resume
|
|
287
288
|
*/
|
|
288
|
-
declare function chatsResume({ pathParams, config }?: {
|
|
289
|
+
declare function chatsResume({ pathParams, config, }?: {
|
|
289
290
|
pathParams: {
|
|
290
|
-
|
|
291
|
-
|
|
291
|
+
chatId: string;
|
|
292
|
+
messageId: string;
|
|
292
293
|
};
|
|
293
294
|
config?: Partial<FetcherConfig> & {
|
|
294
295
|
client?: typeof client;
|
|
@@ -299,10 +300,10 @@ declare function chatsResume({ pathParams, config }?: {
|
|
|
299
300
|
* @description Stops an in-flight message generation in a chat. Useful for cancelling a streaming response that is still being generated.
|
|
300
301
|
* @link /chats/{chatId}/messages/{messageId}/stop
|
|
301
302
|
*/
|
|
302
|
-
declare function chatsStop({ pathParams, config }?: {
|
|
303
|
+
declare function chatsStop({ pathParams, config, }?: {
|
|
303
304
|
pathParams: {
|
|
304
|
-
|
|
305
|
-
|
|
305
|
+
chatId: string;
|
|
306
|
+
messageId: string;
|
|
306
307
|
};
|
|
307
308
|
config?: Partial<FetcherConfig> & {
|
|
308
309
|
client?: typeof client;
|
|
@@ -313,9 +314,9 @@ declare function chatsStop({ pathParams, config }?: {
|
|
|
313
314
|
* @description Resolves a pending task in a chat, continuing the conversation. The latest message in the active chat fork must be an assistant message currently blocked on a matching task (integration setup, plan approval, question answers, or permission grants).
|
|
314
315
|
* @link /chats/{chatId}/tasks/resolve
|
|
315
316
|
*/
|
|
316
|
-
declare function chatsResolveTask({ pathParams, config }?: {
|
|
317
|
+
declare function chatsResolveTask({ pathParams, config, }?: {
|
|
317
318
|
pathParams: {
|
|
318
|
-
|
|
319
|
+
chatId: string;
|
|
319
320
|
};
|
|
320
321
|
config?: Partial<FetcherConfig> & {
|
|
321
322
|
client?: typeof client;
|
|
@@ -326,11 +327,11 @@ declare function chatsResolveTask({ pathParams, config }?: {
|
|
|
326
327
|
* @description Find deployments by project and chat IDs. This will return a list of deployments for the given project and chat IDs.
|
|
327
328
|
* @link /deployments
|
|
328
329
|
*/
|
|
329
|
-
declare function deploymentsFind({ queryParams, config }?: {
|
|
330
|
+
declare function deploymentsFind({ queryParams, config, }?: {
|
|
330
331
|
queryParams?: {
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
332
|
+
projectId?: string;
|
|
333
|
+
chatId?: string;
|
|
334
|
+
versionId?: string;
|
|
334
335
|
};
|
|
335
336
|
config?: Partial<FetcherConfig> & {
|
|
336
337
|
client?: typeof client;
|
|
@@ -351,9 +352,9 @@ declare function deploymentsCreate({ config }?: {
|
|
|
351
352
|
* @description Get a deployment by ID. This will return the details of the deployment, including the inspector URL, chat ID, project ID, version ID, API URL, and web URL.
|
|
352
353
|
* @link /deployments/{deploymentId}
|
|
353
354
|
*/
|
|
354
|
-
declare function deploymentsGetById({ pathParams, config }?: {
|
|
355
|
+
declare function deploymentsGetById({ pathParams, config, }?: {
|
|
355
356
|
pathParams: {
|
|
356
|
-
|
|
357
|
+
deploymentId: string;
|
|
357
358
|
};
|
|
358
359
|
config?: Partial<FetcherConfig> & {
|
|
359
360
|
client?: typeof client;
|
|
@@ -364,9 +365,9 @@ declare function deploymentsGetById({ pathParams, config }?: {
|
|
|
364
365
|
* @description Delete a deployment by ID. This will delete the deployment from Vercel.
|
|
365
366
|
* @link /deployments/{deploymentId}
|
|
366
367
|
*/
|
|
367
|
-
declare function deploymentsDelete({ pathParams, config }?: {
|
|
368
|
+
declare function deploymentsDelete({ pathParams, config, }?: {
|
|
368
369
|
pathParams: {
|
|
369
|
-
|
|
370
|
+
deploymentId: string;
|
|
370
371
|
};
|
|
371
372
|
config?: Partial<FetcherConfig> & {
|
|
372
373
|
client?: typeof client;
|
|
@@ -377,12 +378,12 @@ declare function deploymentsDelete({ pathParams, config }?: {
|
|
|
377
378
|
* @description Retrieves logs for a specific deployment. Supports filtering by timestamp to fetch only recent logs.
|
|
378
379
|
* @link /deployments/{deploymentId}/logs
|
|
379
380
|
*/
|
|
380
|
-
declare function deploymentsFindLogs({ pathParams, queryParams, config }?: {
|
|
381
|
+
declare function deploymentsFindLogs({ pathParams, queryParams, config, }?: {
|
|
381
382
|
pathParams: {
|
|
382
|
-
|
|
383
|
+
deploymentId: string;
|
|
383
384
|
};
|
|
384
385
|
queryParams?: {
|
|
385
|
-
|
|
386
|
+
since?: number;
|
|
386
387
|
};
|
|
387
388
|
config?: Partial<FetcherConfig> & {
|
|
388
389
|
client?: typeof client;
|
|
@@ -393,9 +394,9 @@ declare function deploymentsFindLogs({ pathParams, queryParams, config }?: {
|
|
|
393
394
|
* @description Retrieves a list of errors that occurred during a specific deployment. Useful for diagnosing and debugging deployment issues.
|
|
394
395
|
* @link /deployments/{deploymentId}/errors
|
|
395
396
|
*/
|
|
396
|
-
declare function deploymentsFindErrors({ pathParams, config }?: {
|
|
397
|
+
declare function deploymentsFindErrors({ pathParams, config, }?: {
|
|
397
398
|
pathParams: {
|
|
398
|
-
|
|
399
|
+
deploymentId: string;
|
|
399
400
|
};
|
|
400
401
|
config?: Partial<FetcherConfig> & {
|
|
401
402
|
client?: typeof client;
|
|
@@ -426,9 +427,9 @@ declare function hooksCreate({ config }?: {
|
|
|
426
427
|
* @description Retrieves the details of a specific webhook using its ID.
|
|
427
428
|
* @link /hooks/{hookId}
|
|
428
429
|
*/
|
|
429
|
-
declare function hooksGetById({ pathParams, config }?: {
|
|
430
|
+
declare function hooksGetById({ pathParams, config, }?: {
|
|
430
431
|
pathParams: {
|
|
431
|
-
|
|
432
|
+
hookId: string;
|
|
432
433
|
};
|
|
433
434
|
config?: Partial<FetcherConfig> & {
|
|
434
435
|
client?: typeof client;
|
|
@@ -439,9 +440,9 @@ declare function hooksGetById({ pathParams, config }?: {
|
|
|
439
440
|
* @description Updates the configuration of an existing webhook, including its name, event subscriptions, or target URL.
|
|
440
441
|
* @link /hooks/{hookId}
|
|
441
442
|
*/
|
|
442
|
-
declare function hooksUpdate({ pathParams, config }?: {
|
|
443
|
+
declare function hooksUpdate({ pathParams, config, }?: {
|
|
443
444
|
pathParams: {
|
|
444
|
-
|
|
445
|
+
hookId: string;
|
|
445
446
|
};
|
|
446
447
|
config?: Partial<FetcherConfig> & {
|
|
447
448
|
client?: typeof client;
|
|
@@ -452,9 +453,9 @@ declare function hooksUpdate({ pathParams, config }?: {
|
|
|
452
453
|
* @description Deletes a webhook based on its ID. This action is irreversible.
|
|
453
454
|
* @link /hooks/{hookId}
|
|
454
455
|
*/
|
|
455
|
-
declare function hooksDelete({ pathParams, config }?: {
|
|
456
|
+
declare function hooksDelete({ pathParams, config, }?: {
|
|
456
457
|
pathParams: {
|
|
457
|
-
|
|
458
|
+
hookId: string;
|
|
458
459
|
};
|
|
459
460
|
config?: Partial<FetcherConfig> & {
|
|
460
461
|
client?: typeof client;
|
|
@@ -505,9 +506,9 @@ declare function projectsCreate({ config }?: {
|
|
|
505
506
|
* @description Retrieves the details of a specific v0 project by its ID.
|
|
506
507
|
* @link /projects/{projectId}
|
|
507
508
|
*/
|
|
508
|
-
declare function projectsGetById({ pathParams, config }?: {
|
|
509
|
+
declare function projectsGetById({ pathParams, config, }?: {
|
|
509
510
|
pathParams: {
|
|
510
|
-
|
|
511
|
+
projectId: string;
|
|
511
512
|
};
|
|
512
513
|
config?: Partial<FetcherConfig> & {
|
|
513
514
|
client?: typeof client;
|
|
@@ -518,9 +519,9 @@ declare function projectsGetById({ pathParams, config }?: {
|
|
|
518
519
|
* @description Updates the metadata of an existing project using its `projectId`. Supports changes to the project name and privacy setting.
|
|
519
520
|
* @link /projects/{projectId}
|
|
520
521
|
*/
|
|
521
|
-
declare function projectsUpdate({ pathParams, config }?: {
|
|
522
|
+
declare function projectsUpdate({ pathParams, config, }?: {
|
|
522
523
|
pathParams: {
|
|
523
|
-
|
|
524
|
+
projectId: string;
|
|
524
525
|
};
|
|
525
526
|
config?: Partial<FetcherConfig> & {
|
|
526
527
|
client?: typeof client;
|
|
@@ -531,12 +532,12 @@ declare function projectsUpdate({ pathParams, config }?: {
|
|
|
531
532
|
* @description Deletes a specific project based on the provided projectId. This operation marks the project as deleted and is irreversible.
|
|
532
533
|
* @link /projects/{projectId}
|
|
533
534
|
*/
|
|
534
|
-
declare function projectsDelete({ pathParams, queryParams, config }?: {
|
|
535
|
+
declare function projectsDelete({ pathParams, queryParams, config, }?: {
|
|
535
536
|
pathParams: {
|
|
536
|
-
|
|
537
|
+
projectId: string;
|
|
537
538
|
};
|
|
538
539
|
queryParams?: {
|
|
539
|
-
|
|
540
|
+
deleteAllChats?: "true" | "false";
|
|
540
541
|
};
|
|
541
542
|
config?: Partial<FetcherConfig> & {
|
|
542
543
|
client?: typeof client;
|
|
@@ -547,9 +548,9 @@ declare function projectsDelete({ pathParams, queryParams, config }?: {
|
|
|
547
548
|
* @description Links an existing v0 project to a specific chat. Helps group conversations under a shared project context.
|
|
548
549
|
* @link /projects/{projectId}/assign
|
|
549
550
|
*/
|
|
550
|
-
declare function projectsAssign({ pathParams, config }?: {
|
|
551
|
+
declare function projectsAssign({ pathParams, config, }?: {
|
|
551
552
|
pathParams: {
|
|
552
|
-
|
|
553
|
+
projectId: string;
|
|
553
554
|
};
|
|
554
555
|
config?: Partial<FetcherConfig> & {
|
|
555
556
|
client?: typeof client;
|
|
@@ -560,12 +561,12 @@ declare function projectsAssign({ pathParams, config }?: {
|
|
|
560
561
|
* @description Retrieves all environment variables for a given project.
|
|
561
562
|
* @link /projects/{projectId}/env-vars
|
|
562
563
|
*/
|
|
563
|
-
declare function projectsFindEnvVars({ pathParams, queryParams, config }?: {
|
|
564
|
+
declare function projectsFindEnvVars({ pathParams, queryParams, config, }?: {
|
|
564
565
|
pathParams: {
|
|
565
|
-
|
|
566
|
+
projectId: string;
|
|
566
567
|
};
|
|
567
568
|
queryParams?: {
|
|
568
|
-
|
|
569
|
+
decrypted?: "true" | "false";
|
|
569
570
|
};
|
|
570
571
|
config?: Partial<FetcherConfig> & {
|
|
571
572
|
client?: typeof client;
|
|
@@ -576,12 +577,12 @@ declare function projectsFindEnvVars({ pathParams, queryParams, config }?: {
|
|
|
576
577
|
* @description Creates new environment variables for a given project. This endpoint will fail if any of the specified environment variable keys already exist, unless upsert is set to true.
|
|
577
578
|
* @link /projects/{projectId}/env-vars
|
|
578
579
|
*/
|
|
579
|
-
declare function projectsCreateEnvVars({ pathParams, queryParams, config }?: {
|
|
580
|
+
declare function projectsCreateEnvVars({ pathParams, queryParams, config, }?: {
|
|
580
581
|
pathParams: {
|
|
581
|
-
|
|
582
|
+
projectId: string;
|
|
582
583
|
};
|
|
583
584
|
queryParams?: {
|
|
584
|
-
|
|
585
|
+
decrypted?: "true" | "false";
|
|
585
586
|
};
|
|
586
587
|
config?: Partial<FetcherConfig> & {
|
|
587
588
|
client?: typeof client;
|
|
@@ -592,12 +593,12 @@ declare function projectsCreateEnvVars({ pathParams, queryParams, config }?: {
|
|
|
592
593
|
* @description Updates multiple environment variables for a given project. Only the value of each environment variable can be updated.
|
|
593
594
|
* @link /projects/{projectId}/env-vars
|
|
594
595
|
*/
|
|
595
|
-
declare function projectsUpdateEnvVars({ pathParams, queryParams, config }?: {
|
|
596
|
+
declare function projectsUpdateEnvVars({ pathParams, queryParams, config, }?: {
|
|
596
597
|
pathParams: {
|
|
597
|
-
|
|
598
|
+
projectId: string;
|
|
598
599
|
};
|
|
599
600
|
queryParams?: {
|
|
600
|
-
|
|
601
|
+
decrypted?: "true" | "false";
|
|
601
602
|
};
|
|
602
603
|
config?: Partial<FetcherConfig> & {
|
|
603
604
|
client?: typeof client;
|
|
@@ -608,9 +609,9 @@ declare function projectsUpdateEnvVars({ pathParams, queryParams, config }?: {
|
|
|
608
609
|
* @description Deletes multiple environment variables for a given project by their IDs.
|
|
609
610
|
* @link /projects/{projectId}/env-vars/delete
|
|
610
611
|
*/
|
|
611
|
-
declare function projectsDeleteEnvVars({ pathParams, config }?: {
|
|
612
|
+
declare function projectsDeleteEnvVars({ pathParams, config, }?: {
|
|
612
613
|
pathParams: {
|
|
613
|
-
|
|
614
|
+
projectId: string;
|
|
614
615
|
};
|
|
615
616
|
config?: Partial<FetcherConfig> & {
|
|
616
617
|
client?: typeof client;
|
|
@@ -621,13 +622,13 @@ declare function projectsDeleteEnvVars({ pathParams, config }?: {
|
|
|
621
622
|
* @description Retrieves a specific environment variable for a given project by its ID, including its value.
|
|
622
623
|
* @link /projects/{projectId}/env-vars/{environmentVariableId}
|
|
623
624
|
*/
|
|
624
|
-
declare function projectsGetEnvVar({ pathParams, queryParams, config }?: {
|
|
625
|
+
declare function projectsGetEnvVar({ pathParams, queryParams, config, }?: {
|
|
625
626
|
pathParams: {
|
|
626
|
-
|
|
627
|
-
|
|
627
|
+
projectId: string;
|
|
628
|
+
environmentVariableId: string;
|
|
628
629
|
};
|
|
629
630
|
queryParams?: {
|
|
630
|
-
|
|
631
|
+
decrypted?: "true" | "false";
|
|
631
632
|
};
|
|
632
633
|
config?: Partial<FetcherConfig> & {
|
|
633
634
|
client?: typeof client;
|
|
@@ -638,9 +639,9 @@ declare function projectsGetEnvVar({ pathParams, queryParams, config }?: {
|
|
|
638
639
|
* @description Retrieves rate limit information for a given scope. Useful for monitoring usage limits and avoiding throttling.
|
|
639
640
|
* @link /rate-limits
|
|
640
641
|
*/
|
|
641
|
-
declare function rateLimitsFind({ queryParams, config }?: {
|
|
642
|
+
declare function rateLimitsFind({ queryParams, config, }?: {
|
|
642
643
|
queryParams?: {
|
|
643
|
-
|
|
644
|
+
scope?: string;
|
|
644
645
|
};
|
|
645
646
|
config?: Partial<FetcherConfig> & {
|
|
646
647
|
client?: typeof client;
|
|
@@ -661,9 +662,9 @@ declare function userGet({ config }?: {
|
|
|
661
662
|
* @description Fetches billing usage and quota information for the authenticated user. Can be scoped to a specific context (e.g. project or namespace).
|
|
662
663
|
* @link /user/billing
|
|
663
664
|
*/
|
|
664
|
-
declare function userGetBilling({ queryParams, config }?: {
|
|
665
|
+
declare function userGetBilling({ queryParams, config, }?: {
|
|
665
666
|
queryParams?: {
|
|
666
|
-
|
|
667
|
+
scope?: string;
|
|
667
668
|
};
|
|
668
669
|
config?: Partial<FetcherConfig> & {
|
|
669
670
|
client?: typeof client;
|
|
@@ -694,10 +695,10 @@ declare function userGetScopes({ config }?: {
|
|
|
694
695
|
* @description Restores a block to a specific version.
|
|
695
696
|
* @link /chats/{chatId}/versions/{versionId}/restore
|
|
696
697
|
*/
|
|
697
|
-
declare function chatsRestore({ pathParams, config }?: {
|
|
698
|
+
declare function chatsRestore({ pathParams, config, }?: {
|
|
698
699
|
pathParams: {
|
|
699
|
-
|
|
700
|
-
|
|
700
|
+
chatId: string;
|
|
701
|
+
versionId: string;
|
|
701
702
|
};
|
|
702
703
|
config?: Partial<FetcherConfig> & {
|
|
703
704
|
client?: typeof client;
|
|
@@ -708,15 +709,15 @@ declare function chatsRestore({ pathParams, config }?: {
|
|
|
708
709
|
* @description Retrieves detailed usage events for the authenticated user or team, including costs, event types, models used, and metadata. Shows the same data as displayed in the usage dashboard. Can be filtered by chatId to show usage for a specific chat, or by userId to show usage for a specific user.
|
|
709
710
|
* @link /reports/usage
|
|
710
711
|
*/
|
|
711
|
-
declare function reportsGetUsage({ queryParams, config }?: {
|
|
712
|
+
declare function reportsGetUsage({ queryParams, config, }?: {
|
|
712
713
|
queryParams?: {
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
714
|
+
startDate?: string;
|
|
715
|
+
endDate?: string;
|
|
716
|
+
chatId?: string;
|
|
717
|
+
messageId?: string;
|
|
718
|
+
userId?: string;
|
|
719
|
+
limit?: number;
|
|
720
|
+
cursor?: string;
|
|
720
721
|
};
|
|
721
722
|
config?: Partial<FetcherConfig> & {
|
|
722
723
|
client?: typeof client;
|
|
@@ -727,12 +728,12 @@ declare function reportsGetUsage({ queryParams, config }?: {
|
|
|
727
728
|
* @description Retrieves v0 AI usage events for the authenticated user or active team scope.
|
|
728
729
|
* @link /reports/usage/ai
|
|
729
730
|
*/
|
|
730
|
-
declare function reportsGetAIUsage({ queryParams, config }?: {
|
|
731
|
+
declare function reportsGetAIUsage({ queryParams, config, }?: {
|
|
731
732
|
queryParams?: {
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
733
|
+
start?: string;
|
|
734
|
+
end?: string;
|
|
735
|
+
cursor?: string;
|
|
736
|
+
limit?: number;
|
|
736
737
|
};
|
|
737
738
|
config?: Partial<FetcherConfig> & {
|
|
738
739
|
client?: typeof client;
|
|
@@ -743,10 +744,10 @@ declare function reportsGetAIUsage({ queryParams, config }?: {
|
|
|
743
744
|
* @description Retrieves aggregated user activity data for team members, including chat counts, message counts, and activity timestamps. Only available for Enterprise teams with OWNER or BILLING role. Shows the same data as displayed in the Usage settings for Enterprise teams.
|
|
744
745
|
* @link /reports/user-activity
|
|
745
746
|
*/
|
|
746
|
-
declare function reportsGetUserActivity({ queryParams, config }?: {
|
|
747
|
+
declare function reportsGetUserActivity({ queryParams, config, }?: {
|
|
747
748
|
queryParams?: {
|
|
748
|
-
|
|
749
|
-
|
|
749
|
+
startDate?: string;
|
|
750
|
+
endDate?: string;
|
|
750
751
|
};
|
|
751
752
|
config?: Partial<FetcherConfig> & {
|
|
752
753
|
client?: typeof client;
|
|
@@ -777,9 +778,9 @@ declare function mcpServersCreate({ config }?: {
|
|
|
777
778
|
* @description Retrieves the details of a specific MCP server by its ID.
|
|
778
779
|
* @link /mcp-servers/{mcpServerId}
|
|
779
780
|
*/
|
|
780
|
-
declare function mcpServersGetById({ pathParams, config }?: {
|
|
781
|
+
declare function mcpServersGetById({ pathParams, config, }?: {
|
|
781
782
|
pathParams: {
|
|
782
|
-
|
|
783
|
+
mcpServerId: string;
|
|
783
784
|
};
|
|
784
785
|
config?: Partial<FetcherConfig> & {
|
|
785
786
|
client?: typeof client;
|
|
@@ -790,9 +791,9 @@ declare function mcpServersGetById({ pathParams, config }?: {
|
|
|
790
791
|
* @description Updates the configuration of an existing MCP server, including its name, URL, description, enabled status, and authentication settings.
|
|
791
792
|
* @link /mcp-servers/{mcpServerId}
|
|
792
793
|
*/
|
|
793
|
-
declare function mcpServersUpdate({ pathParams, config }?: {
|
|
794
|
+
declare function mcpServersUpdate({ pathParams, config, }?: {
|
|
794
795
|
pathParams: {
|
|
795
|
-
|
|
796
|
+
mcpServerId: string;
|
|
796
797
|
};
|
|
797
798
|
config?: Partial<FetcherConfig> & {
|
|
798
799
|
client?: typeof client;
|
|
@@ -803,9 +804,9 @@ declare function mcpServersUpdate({ pathParams, config }?: {
|
|
|
803
804
|
* @description Deletes an MCP server based on its ID. This action is irreversible and will also remove any associated OAuth tokens.
|
|
804
805
|
* @link /mcp-servers/{mcpServerId}
|
|
805
806
|
*/
|
|
806
|
-
declare function mcpServersDelete({ pathParams, config }?: {
|
|
807
|
+
declare function mcpServersDelete({ pathParams, config, }?: {
|
|
807
808
|
pathParams: {
|
|
808
|
-
|
|
809
|
+
mcpServerId: string;
|
|
809
810
|
};
|
|
810
811
|
config?: Partial<FetcherConfig> & {
|
|
811
812
|
client?: typeof client;
|
|
@@ -816,9 +817,9 @@ declare function mcpServersDelete({ pathParams, config }?: {
|
|
|
816
817
|
* @description Creates an OAuth authorization URL for an OAuth MCP server. Redirect the user to the returned URL, and the Platform API OAuth callback will store the resulting tokens before redirecting to your returnUrl.
|
|
817
818
|
* @link /mcp-servers/{mcpServerId}/oauth/authorize
|
|
818
819
|
*/
|
|
819
|
-
declare function mcpServersCreateOAuthAuthorizationUrl({ pathParams, config }?: {
|
|
820
|
+
declare function mcpServersCreateOAuthAuthorizationUrl({ pathParams, config, }?: {
|
|
820
821
|
pathParams: {
|
|
821
|
-
|
|
822
|
+
mcpServerId: string;
|
|
822
823
|
};
|
|
823
824
|
config?: Partial<FetcherConfig> & {
|
|
824
825
|
client?: typeof client;
|