v0-api 0.1.3 → 0.1.4
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 +132 -132
- package/dist/components.d.mts +132 -132
- package/dist/components.mjs +44 -44
- package/dist/effect.cjs +10 -10
- package/dist/effect.d.cts +132 -132
- package/dist/effect.d.mts +132 -132
- package/dist/effect.mjs +10 -10
- package/dist/index.cjs +699 -699
- package/dist/index.d.cts +1797 -1813
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +1797 -1813
- package/dist/index.d.mts.map +1 -1
- package/dist/index.d.ts +1797 -1813
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +699 -699
- package/dist/schemas.cjs +667 -667
- package/dist/schemas.mjs +652 -652
- package/dist/types.cjs +3 -3
- package/dist/types.d.cts +1665 -1681
- package/dist/types.d.cts.map +1 -1
- package/dist/types.d.mts +1665 -1681
- package/dist/types.d.mts.map +1 -1
- package/dist/types.mjs +3 -3
- package/package.json +4 -4
package/dist/effect.d.mts
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,13 @@ 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
66
|
};
|
|
67
67
|
config?: Partial<FetcherConfig> & {
|
|
68
68
|
client?: typeof client;
|
|
@@ -83,9 +83,9 @@ declare function chatsInit({ config }?: {
|
|
|
83
83
|
* @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
84
|
* @link /chats/{chatId}
|
|
85
85
|
*/
|
|
86
|
-
declare function chatsDelete({ pathParams, config }?: {
|
|
86
|
+
declare function chatsDelete({ pathParams, config, }?: {
|
|
87
87
|
pathParams: {
|
|
88
|
-
|
|
88
|
+
chatId: string;
|
|
89
89
|
};
|
|
90
90
|
config?: Partial<FetcherConfig> & {
|
|
91
91
|
client?: typeof client;
|
|
@@ -96,9 +96,9 @@ declare function chatsDelete({ pathParams, config }?: {
|
|
|
96
96
|
* @description Retrieves the full details of a specific chat using its `chatId`. Includes messages, metadata, and associated configuration.
|
|
97
97
|
* @link /chats/{chatId}
|
|
98
98
|
*/
|
|
99
|
-
declare function chatsGetById({ pathParams, config }?: {
|
|
99
|
+
declare function chatsGetById({ pathParams, config, }?: {
|
|
100
100
|
pathParams: {
|
|
101
|
-
|
|
101
|
+
chatId: string;
|
|
102
102
|
};
|
|
103
103
|
config?: Partial<FetcherConfig> & {
|
|
104
104
|
client?: typeof client;
|
|
@@ -109,9 +109,9 @@ declare function chatsGetById({ pathParams, config }?: {
|
|
|
109
109
|
* @description Updates the metadata of an existing chat using its `chatId`. Supports changes to the chat name and privacy setting.
|
|
110
110
|
* @link /chats/{chatId}
|
|
111
111
|
*/
|
|
112
|
-
declare function chatsUpdate({ pathParams, config }?: {
|
|
112
|
+
declare function chatsUpdate({ pathParams, config, }?: {
|
|
113
113
|
pathParams: {
|
|
114
|
-
|
|
114
|
+
chatId: string;
|
|
115
115
|
};
|
|
116
116
|
config?: Partial<FetcherConfig> & {
|
|
117
117
|
client?: typeof client;
|
|
@@ -122,9 +122,9 @@ declare function chatsUpdate({ pathParams, config }?: {
|
|
|
122
122
|
* @description Marks or unmarks a chat as a favorite using its `chatId`. This helps with organizing and quickly accessing important chats.
|
|
123
123
|
* @link /chats/{chatId}/favorite
|
|
124
124
|
*/
|
|
125
|
-
declare function chatsFavorite({ pathParams, config }?: {
|
|
125
|
+
declare function chatsFavorite({ pathParams, config, }?: {
|
|
126
126
|
pathParams: {
|
|
127
|
-
|
|
127
|
+
chatId: string;
|
|
128
128
|
};
|
|
129
129
|
config?: Partial<FetcherConfig> & {
|
|
130
130
|
client?: typeof client;
|
|
@@ -132,12 +132,12 @@ declare function chatsFavorite({ pathParams, config }?: {
|
|
|
132
132
|
}): Promise<unknown>;
|
|
133
133
|
/**
|
|
134
134
|
* @summary Fork Chat
|
|
135
|
-
* @description Creates a new chat fork (duplicate) from a specific version within
|
|
135
|
+
* @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
136
|
* @link /chats/{chatId}/fork
|
|
137
137
|
*/
|
|
138
|
-
declare function chatsFork({ pathParams, config }?: {
|
|
138
|
+
declare function chatsFork({ pathParams, config, }?: {
|
|
139
139
|
pathParams: {
|
|
140
|
-
|
|
140
|
+
chatId: string;
|
|
141
141
|
};
|
|
142
142
|
config?: Partial<FetcherConfig> & {
|
|
143
143
|
client?: typeof client;
|
|
@@ -148,9 +148,9 @@ declare function chatsFork({ pathParams, config }?: {
|
|
|
148
148
|
* @description Retrieves the v0 project associated with a given chat. Useful for determining the context or scope of a chat session.
|
|
149
149
|
* @link /chats/{chatId}/project
|
|
150
150
|
*/
|
|
151
|
-
declare function projectsGetByChatId({ pathParams, config }?: {
|
|
151
|
+
declare function projectsGetByChatId({ pathParams, config, }?: {
|
|
152
152
|
pathParams: {
|
|
153
|
-
|
|
153
|
+
chatId: string;
|
|
154
154
|
};
|
|
155
155
|
config?: Partial<FetcherConfig> & {
|
|
156
156
|
client?: typeof client;
|
|
@@ -161,13 +161,13 @@ declare function projectsGetByChatId({ pathParams, config }?: {
|
|
|
161
161
|
* @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
162
|
* @link /chats/{chatId}/messages
|
|
163
163
|
*/
|
|
164
|
-
declare function chatsFindMessages({ pathParams, queryParams, config }?: {
|
|
164
|
+
declare function chatsFindMessages({ pathParams, queryParams, config, }?: {
|
|
165
165
|
pathParams: {
|
|
166
|
-
|
|
166
|
+
chatId: string;
|
|
167
167
|
};
|
|
168
168
|
queryParams?: {
|
|
169
|
-
|
|
170
|
-
|
|
169
|
+
limit?: number;
|
|
170
|
+
cursor?: string;
|
|
171
171
|
};
|
|
172
172
|
config?: Partial<FetcherConfig> & {
|
|
173
173
|
client?: typeof client;
|
|
@@ -178,9 +178,9 @@ declare function chatsFindMessages({ pathParams, queryParams, config }?: {
|
|
|
178
178
|
* @description Creates a new message in an existing chat. Triggers a model response using the provided prompt, with optional attachments and configuration settings.
|
|
179
179
|
* @link /chats/{chatId}/messages
|
|
180
180
|
*/
|
|
181
|
-
declare function chatsSendMessage({ pathParams, config }?: {
|
|
181
|
+
declare function chatsSendMessage({ pathParams, config, }?: {
|
|
182
182
|
pathParams: {
|
|
183
|
-
|
|
183
|
+
chatId: string;
|
|
184
184
|
};
|
|
185
185
|
config?: Partial<FetcherConfig> & {
|
|
186
186
|
client?: typeof client;
|
|
@@ -191,10 +191,10 @@ declare function chatsSendMessage({ pathParams, config }?: {
|
|
|
191
191
|
* @description Retrieves detailed information about a specific message within a chat, including content, files, model configuration, and demo URLs.
|
|
192
192
|
* @link /chats/{chatId}/messages/{messageId}
|
|
193
193
|
*/
|
|
194
|
-
declare function chatsGetMessage({ pathParams, config }?: {
|
|
194
|
+
declare function chatsGetMessage({ pathParams, config, }?: {
|
|
195
195
|
pathParams: {
|
|
196
|
-
|
|
197
|
-
|
|
196
|
+
chatId: string;
|
|
197
|
+
messageId: string;
|
|
198
198
|
};
|
|
199
199
|
config?: Partial<FetcherConfig> & {
|
|
200
200
|
client?: typeof client;
|
|
@@ -205,13 +205,13 @@ declare function chatsGetMessage({ pathParams, config }?: {
|
|
|
205
205
|
* @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
206
|
* @link /chats/{chatId}/versions
|
|
207
207
|
*/
|
|
208
|
-
declare function chatsFindVersions({ pathParams, queryParams, config }?: {
|
|
208
|
+
declare function chatsFindVersions({ pathParams, queryParams, config, }?: {
|
|
209
209
|
pathParams: {
|
|
210
|
-
|
|
210
|
+
chatId: string;
|
|
211
211
|
};
|
|
212
212
|
queryParams?: {
|
|
213
|
-
|
|
214
|
-
|
|
213
|
+
limit?: number;
|
|
214
|
+
cursor?: string;
|
|
215
215
|
};
|
|
216
216
|
config?: Partial<FetcherConfig> & {
|
|
217
217
|
client?: typeof client;
|
|
@@ -222,13 +222,13 @@ declare function chatsFindVersions({ pathParams, queryParams, config }?: {
|
|
|
222
222
|
* @description Retrieves detailed information about a specific version of a chat, including all files with their content and lock status.
|
|
223
223
|
* @link /chats/{chatId}/versions/{versionId}
|
|
224
224
|
*/
|
|
225
|
-
declare function chatsGetVersion({ pathParams, queryParams, config }?: {
|
|
225
|
+
declare function chatsGetVersion({ pathParams, queryParams, config, }?: {
|
|
226
226
|
pathParams: {
|
|
227
|
-
|
|
228
|
-
|
|
227
|
+
chatId: string;
|
|
228
|
+
versionId: string;
|
|
229
229
|
};
|
|
230
230
|
queryParams?: {
|
|
231
|
-
|
|
231
|
+
includeDefaultFiles?: "true" | "false";
|
|
232
232
|
};
|
|
233
233
|
config?: Partial<FetcherConfig> & {
|
|
234
234
|
client?: typeof client;
|
|
@@ -239,10 +239,10 @@ declare function chatsGetVersion({ pathParams, queryParams, config }?: {
|
|
|
239
239
|
* @description Updates the source files of a specific chat version (block) manually. This allows editing generated files directly through the API.
|
|
240
240
|
* @link /chats/{chatId}/versions/{versionId}
|
|
241
241
|
*/
|
|
242
|
-
declare function chatsUpdateVersion({ pathParams, config }?: {
|
|
242
|
+
declare function chatsUpdateVersion({ pathParams, config, }?: {
|
|
243
243
|
pathParams: {
|
|
244
|
-
|
|
245
|
-
|
|
244
|
+
chatId: string;
|
|
245
|
+
versionId: string;
|
|
246
246
|
};
|
|
247
247
|
config?: Partial<FetcherConfig> & {
|
|
248
248
|
client?: typeof client;
|
|
@@ -253,14 +253,14 @@ declare function chatsUpdateVersion({ pathParams, config }?: {
|
|
|
253
253
|
* @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
254
|
* @link /chats/{chatId}/versions/{versionId}/download
|
|
255
255
|
*/
|
|
256
|
-
declare function chatsDownloadVersion({ pathParams, queryParams, config }?: {
|
|
256
|
+
declare function chatsDownloadVersion({ pathParams, queryParams, config, }?: {
|
|
257
257
|
pathParams: {
|
|
258
|
-
|
|
259
|
-
|
|
258
|
+
chatId: string;
|
|
259
|
+
versionId: string;
|
|
260
260
|
};
|
|
261
261
|
queryParams?: {
|
|
262
|
-
|
|
263
|
-
|
|
262
|
+
format?: "zip" | "tarball";
|
|
263
|
+
includeDefaultFiles?: "true" | "false";
|
|
264
264
|
};
|
|
265
265
|
config?: Partial<FetcherConfig> & {
|
|
266
266
|
client?: typeof client;
|
|
@@ -271,10 +271,10 @@ declare function chatsDownloadVersion({ pathParams, queryParams, config }?: {
|
|
|
271
271
|
* @description Deletes source files from a specific chat version (block). Files are removed from the version and a new source version is created.
|
|
272
272
|
* @link /chats/{chatId}/versions/{versionId}/files/delete
|
|
273
273
|
*/
|
|
274
|
-
declare function chatsDeleteVersionFiles({ pathParams, config }?: {
|
|
274
|
+
declare function chatsDeleteVersionFiles({ pathParams, config, }?: {
|
|
275
275
|
pathParams: {
|
|
276
|
-
|
|
277
|
-
|
|
276
|
+
chatId: string;
|
|
277
|
+
versionId: string;
|
|
278
278
|
};
|
|
279
279
|
config?: Partial<FetcherConfig> & {
|
|
280
280
|
client?: typeof client;
|
|
@@ -285,10 +285,10 @@ declare function chatsDeleteVersionFiles({ pathParams, config }?: {
|
|
|
285
285
|
* @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
286
|
* @link /chats/{chatId}/messages/{messageId}/resume
|
|
287
287
|
*/
|
|
288
|
-
declare function chatsResume({ pathParams, config }?: {
|
|
288
|
+
declare function chatsResume({ pathParams, config, }?: {
|
|
289
289
|
pathParams: {
|
|
290
|
-
|
|
291
|
-
|
|
290
|
+
chatId: string;
|
|
291
|
+
messageId: string;
|
|
292
292
|
};
|
|
293
293
|
config?: Partial<FetcherConfig> & {
|
|
294
294
|
client?: typeof client;
|
|
@@ -299,10 +299,10 @@ declare function chatsResume({ pathParams, config }?: {
|
|
|
299
299
|
* @description Stops an in-flight message generation in a chat. Useful for cancelling a streaming response that is still being generated.
|
|
300
300
|
* @link /chats/{chatId}/messages/{messageId}/stop
|
|
301
301
|
*/
|
|
302
|
-
declare function chatsStop({ pathParams, config }?: {
|
|
302
|
+
declare function chatsStop({ pathParams, config, }?: {
|
|
303
303
|
pathParams: {
|
|
304
|
-
|
|
305
|
-
|
|
304
|
+
chatId: string;
|
|
305
|
+
messageId: string;
|
|
306
306
|
};
|
|
307
307
|
config?: Partial<FetcherConfig> & {
|
|
308
308
|
client?: typeof client;
|
|
@@ -313,9 +313,9 @@ declare function chatsStop({ pathParams, config }?: {
|
|
|
313
313
|
* @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
314
|
* @link /chats/{chatId}/tasks/resolve
|
|
315
315
|
*/
|
|
316
|
-
declare function chatsResolveTask({ pathParams, config }?: {
|
|
316
|
+
declare function chatsResolveTask({ pathParams, config, }?: {
|
|
317
317
|
pathParams: {
|
|
318
|
-
|
|
318
|
+
chatId: string;
|
|
319
319
|
};
|
|
320
320
|
config?: Partial<FetcherConfig> & {
|
|
321
321
|
client?: typeof client;
|
|
@@ -326,11 +326,11 @@ declare function chatsResolveTask({ pathParams, config }?: {
|
|
|
326
326
|
* @description Find deployments by project and chat IDs. This will return a list of deployments for the given project and chat IDs.
|
|
327
327
|
* @link /deployments
|
|
328
328
|
*/
|
|
329
|
-
declare function deploymentsFind({ queryParams, config }?: {
|
|
329
|
+
declare function deploymentsFind({ queryParams, config, }?: {
|
|
330
330
|
queryParams?: {
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
331
|
+
projectId?: string;
|
|
332
|
+
chatId?: string;
|
|
333
|
+
versionId?: string;
|
|
334
334
|
};
|
|
335
335
|
config?: Partial<FetcherConfig> & {
|
|
336
336
|
client?: typeof client;
|
|
@@ -351,9 +351,9 @@ declare function deploymentsCreate({ config }?: {
|
|
|
351
351
|
* @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
352
|
* @link /deployments/{deploymentId}
|
|
353
353
|
*/
|
|
354
|
-
declare function deploymentsGetById({ pathParams, config }?: {
|
|
354
|
+
declare function deploymentsGetById({ pathParams, config, }?: {
|
|
355
355
|
pathParams: {
|
|
356
|
-
|
|
356
|
+
deploymentId: string;
|
|
357
357
|
};
|
|
358
358
|
config?: Partial<FetcherConfig> & {
|
|
359
359
|
client?: typeof client;
|
|
@@ -364,9 +364,9 @@ declare function deploymentsGetById({ pathParams, config }?: {
|
|
|
364
364
|
* @description Delete a deployment by ID. This will delete the deployment from Vercel.
|
|
365
365
|
* @link /deployments/{deploymentId}
|
|
366
366
|
*/
|
|
367
|
-
declare function deploymentsDelete({ pathParams, config }?: {
|
|
367
|
+
declare function deploymentsDelete({ pathParams, config, }?: {
|
|
368
368
|
pathParams: {
|
|
369
|
-
|
|
369
|
+
deploymentId: string;
|
|
370
370
|
};
|
|
371
371
|
config?: Partial<FetcherConfig> & {
|
|
372
372
|
client?: typeof client;
|
|
@@ -377,12 +377,12 @@ declare function deploymentsDelete({ pathParams, config }?: {
|
|
|
377
377
|
* @description Retrieves logs for a specific deployment. Supports filtering by timestamp to fetch only recent logs.
|
|
378
378
|
* @link /deployments/{deploymentId}/logs
|
|
379
379
|
*/
|
|
380
|
-
declare function deploymentsFindLogs({ pathParams, queryParams, config }?: {
|
|
380
|
+
declare function deploymentsFindLogs({ pathParams, queryParams, config, }?: {
|
|
381
381
|
pathParams: {
|
|
382
|
-
|
|
382
|
+
deploymentId: string;
|
|
383
383
|
};
|
|
384
384
|
queryParams?: {
|
|
385
|
-
|
|
385
|
+
since?: number;
|
|
386
386
|
};
|
|
387
387
|
config?: Partial<FetcherConfig> & {
|
|
388
388
|
client?: typeof client;
|
|
@@ -393,9 +393,9 @@ declare function deploymentsFindLogs({ pathParams, queryParams, config }?: {
|
|
|
393
393
|
* @description Retrieves a list of errors that occurred during a specific deployment. Useful for diagnosing and debugging deployment issues.
|
|
394
394
|
* @link /deployments/{deploymentId}/errors
|
|
395
395
|
*/
|
|
396
|
-
declare function deploymentsFindErrors({ pathParams, config }?: {
|
|
396
|
+
declare function deploymentsFindErrors({ pathParams, config, }?: {
|
|
397
397
|
pathParams: {
|
|
398
|
-
|
|
398
|
+
deploymentId: string;
|
|
399
399
|
};
|
|
400
400
|
config?: Partial<FetcherConfig> & {
|
|
401
401
|
client?: typeof client;
|
|
@@ -426,9 +426,9 @@ declare function hooksCreate({ config }?: {
|
|
|
426
426
|
* @description Retrieves the details of a specific webhook using its ID.
|
|
427
427
|
* @link /hooks/{hookId}
|
|
428
428
|
*/
|
|
429
|
-
declare function hooksGetById({ pathParams, config }?: {
|
|
429
|
+
declare function hooksGetById({ pathParams, config, }?: {
|
|
430
430
|
pathParams: {
|
|
431
|
-
|
|
431
|
+
hookId: string;
|
|
432
432
|
};
|
|
433
433
|
config?: Partial<FetcherConfig> & {
|
|
434
434
|
client?: typeof client;
|
|
@@ -439,9 +439,9 @@ declare function hooksGetById({ pathParams, config }?: {
|
|
|
439
439
|
* @description Updates the configuration of an existing webhook, including its name, event subscriptions, or target URL.
|
|
440
440
|
* @link /hooks/{hookId}
|
|
441
441
|
*/
|
|
442
|
-
declare function hooksUpdate({ pathParams, config }?: {
|
|
442
|
+
declare function hooksUpdate({ pathParams, config, }?: {
|
|
443
443
|
pathParams: {
|
|
444
|
-
|
|
444
|
+
hookId: string;
|
|
445
445
|
};
|
|
446
446
|
config?: Partial<FetcherConfig> & {
|
|
447
447
|
client?: typeof client;
|
|
@@ -452,9 +452,9 @@ declare function hooksUpdate({ pathParams, config }?: {
|
|
|
452
452
|
* @description Deletes a webhook based on its ID. This action is irreversible.
|
|
453
453
|
* @link /hooks/{hookId}
|
|
454
454
|
*/
|
|
455
|
-
declare function hooksDelete({ pathParams, config }?: {
|
|
455
|
+
declare function hooksDelete({ pathParams, config, }?: {
|
|
456
456
|
pathParams: {
|
|
457
|
-
|
|
457
|
+
hookId: string;
|
|
458
458
|
};
|
|
459
459
|
config?: Partial<FetcherConfig> & {
|
|
460
460
|
client?: typeof client;
|
|
@@ -505,9 +505,9 @@ declare function projectsCreate({ config }?: {
|
|
|
505
505
|
* @description Retrieves the details of a specific v0 project by its ID.
|
|
506
506
|
* @link /projects/{projectId}
|
|
507
507
|
*/
|
|
508
|
-
declare function projectsGetById({ pathParams, config }?: {
|
|
508
|
+
declare function projectsGetById({ pathParams, config, }?: {
|
|
509
509
|
pathParams: {
|
|
510
|
-
|
|
510
|
+
projectId: string;
|
|
511
511
|
};
|
|
512
512
|
config?: Partial<FetcherConfig> & {
|
|
513
513
|
client?: typeof client;
|
|
@@ -518,9 +518,9 @@ declare function projectsGetById({ pathParams, config }?: {
|
|
|
518
518
|
* @description Updates the metadata of an existing project using its `projectId`. Supports changes to the project name and privacy setting.
|
|
519
519
|
* @link /projects/{projectId}
|
|
520
520
|
*/
|
|
521
|
-
declare function projectsUpdate({ pathParams, config }?: {
|
|
521
|
+
declare function projectsUpdate({ pathParams, config, }?: {
|
|
522
522
|
pathParams: {
|
|
523
|
-
|
|
523
|
+
projectId: string;
|
|
524
524
|
};
|
|
525
525
|
config?: Partial<FetcherConfig> & {
|
|
526
526
|
client?: typeof client;
|
|
@@ -531,12 +531,12 @@ declare function projectsUpdate({ pathParams, config }?: {
|
|
|
531
531
|
* @description Deletes a specific project based on the provided projectId. This operation marks the project as deleted and is irreversible.
|
|
532
532
|
* @link /projects/{projectId}
|
|
533
533
|
*/
|
|
534
|
-
declare function projectsDelete({ pathParams, queryParams, config }?: {
|
|
534
|
+
declare function projectsDelete({ pathParams, queryParams, config, }?: {
|
|
535
535
|
pathParams: {
|
|
536
|
-
|
|
536
|
+
projectId: string;
|
|
537
537
|
};
|
|
538
538
|
queryParams?: {
|
|
539
|
-
|
|
539
|
+
deleteAllChats?: "true" | "false";
|
|
540
540
|
};
|
|
541
541
|
config?: Partial<FetcherConfig> & {
|
|
542
542
|
client?: typeof client;
|
|
@@ -547,9 +547,9 @@ declare function projectsDelete({ pathParams, queryParams, config }?: {
|
|
|
547
547
|
* @description Links an existing v0 project to a specific chat. Helps group conversations under a shared project context.
|
|
548
548
|
* @link /projects/{projectId}/assign
|
|
549
549
|
*/
|
|
550
|
-
declare function projectsAssign({ pathParams, config }?: {
|
|
550
|
+
declare function projectsAssign({ pathParams, config, }?: {
|
|
551
551
|
pathParams: {
|
|
552
|
-
|
|
552
|
+
projectId: string;
|
|
553
553
|
};
|
|
554
554
|
config?: Partial<FetcherConfig> & {
|
|
555
555
|
client?: typeof client;
|
|
@@ -560,12 +560,12 @@ declare function projectsAssign({ pathParams, config }?: {
|
|
|
560
560
|
* @description Retrieves all environment variables for a given project.
|
|
561
561
|
* @link /projects/{projectId}/env-vars
|
|
562
562
|
*/
|
|
563
|
-
declare function projectsFindEnvVars({ pathParams, queryParams, config }?: {
|
|
563
|
+
declare function projectsFindEnvVars({ pathParams, queryParams, config, }?: {
|
|
564
564
|
pathParams: {
|
|
565
|
-
|
|
565
|
+
projectId: string;
|
|
566
566
|
};
|
|
567
567
|
queryParams?: {
|
|
568
|
-
|
|
568
|
+
decrypted?: "true" | "false";
|
|
569
569
|
};
|
|
570
570
|
config?: Partial<FetcherConfig> & {
|
|
571
571
|
client?: typeof client;
|
|
@@ -576,12 +576,12 @@ declare function projectsFindEnvVars({ pathParams, queryParams, config }?: {
|
|
|
576
576
|
* @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
577
|
* @link /projects/{projectId}/env-vars
|
|
578
578
|
*/
|
|
579
|
-
declare function projectsCreateEnvVars({ pathParams, queryParams, config }?: {
|
|
579
|
+
declare function projectsCreateEnvVars({ pathParams, queryParams, config, }?: {
|
|
580
580
|
pathParams: {
|
|
581
|
-
|
|
581
|
+
projectId: string;
|
|
582
582
|
};
|
|
583
583
|
queryParams?: {
|
|
584
|
-
|
|
584
|
+
decrypted?: "true" | "false";
|
|
585
585
|
};
|
|
586
586
|
config?: Partial<FetcherConfig> & {
|
|
587
587
|
client?: typeof client;
|
|
@@ -592,12 +592,12 @@ declare function projectsCreateEnvVars({ pathParams, queryParams, config }?: {
|
|
|
592
592
|
* @description Updates multiple environment variables for a given project. Only the value of each environment variable can be updated.
|
|
593
593
|
* @link /projects/{projectId}/env-vars
|
|
594
594
|
*/
|
|
595
|
-
declare function projectsUpdateEnvVars({ pathParams, queryParams, config }?: {
|
|
595
|
+
declare function projectsUpdateEnvVars({ pathParams, queryParams, config, }?: {
|
|
596
596
|
pathParams: {
|
|
597
|
-
|
|
597
|
+
projectId: string;
|
|
598
598
|
};
|
|
599
599
|
queryParams?: {
|
|
600
|
-
|
|
600
|
+
decrypted?: "true" | "false";
|
|
601
601
|
};
|
|
602
602
|
config?: Partial<FetcherConfig> & {
|
|
603
603
|
client?: typeof client;
|
|
@@ -608,9 +608,9 @@ declare function projectsUpdateEnvVars({ pathParams, queryParams, config }?: {
|
|
|
608
608
|
* @description Deletes multiple environment variables for a given project by their IDs.
|
|
609
609
|
* @link /projects/{projectId}/env-vars/delete
|
|
610
610
|
*/
|
|
611
|
-
declare function projectsDeleteEnvVars({ pathParams, config }?: {
|
|
611
|
+
declare function projectsDeleteEnvVars({ pathParams, config, }?: {
|
|
612
612
|
pathParams: {
|
|
613
|
-
|
|
613
|
+
projectId: string;
|
|
614
614
|
};
|
|
615
615
|
config?: Partial<FetcherConfig> & {
|
|
616
616
|
client?: typeof client;
|
|
@@ -621,13 +621,13 @@ declare function projectsDeleteEnvVars({ pathParams, config }?: {
|
|
|
621
621
|
* @description Retrieves a specific environment variable for a given project by its ID, including its value.
|
|
622
622
|
* @link /projects/{projectId}/env-vars/{environmentVariableId}
|
|
623
623
|
*/
|
|
624
|
-
declare function projectsGetEnvVar({ pathParams, queryParams, config }?: {
|
|
624
|
+
declare function projectsGetEnvVar({ pathParams, queryParams, config, }?: {
|
|
625
625
|
pathParams: {
|
|
626
|
-
|
|
627
|
-
|
|
626
|
+
projectId: string;
|
|
627
|
+
environmentVariableId: string;
|
|
628
628
|
};
|
|
629
629
|
queryParams?: {
|
|
630
|
-
|
|
630
|
+
decrypted?: "true" | "false";
|
|
631
631
|
};
|
|
632
632
|
config?: Partial<FetcherConfig> & {
|
|
633
633
|
client?: typeof client;
|
|
@@ -638,9 +638,9 @@ declare function projectsGetEnvVar({ pathParams, queryParams, config }?: {
|
|
|
638
638
|
* @description Retrieves rate limit information for a given scope. Useful for monitoring usage limits and avoiding throttling.
|
|
639
639
|
* @link /rate-limits
|
|
640
640
|
*/
|
|
641
|
-
declare function rateLimitsFind({ queryParams, config }?: {
|
|
641
|
+
declare function rateLimitsFind({ queryParams, config, }?: {
|
|
642
642
|
queryParams?: {
|
|
643
|
-
|
|
643
|
+
scope?: string;
|
|
644
644
|
};
|
|
645
645
|
config?: Partial<FetcherConfig> & {
|
|
646
646
|
client?: typeof client;
|
|
@@ -661,9 +661,9 @@ declare function userGet({ config }?: {
|
|
|
661
661
|
* @description Fetches billing usage and quota information for the authenticated user. Can be scoped to a specific context (e.g. project or namespace).
|
|
662
662
|
* @link /user/billing
|
|
663
663
|
*/
|
|
664
|
-
declare function userGetBilling({ queryParams, config }?: {
|
|
664
|
+
declare function userGetBilling({ queryParams, config, }?: {
|
|
665
665
|
queryParams?: {
|
|
666
|
-
|
|
666
|
+
scope?: string;
|
|
667
667
|
};
|
|
668
668
|
config?: Partial<FetcherConfig> & {
|
|
669
669
|
client?: typeof client;
|
|
@@ -694,10 +694,10 @@ declare function userGetScopes({ config }?: {
|
|
|
694
694
|
* @description Restores a block to a specific version.
|
|
695
695
|
* @link /chats/{chatId}/versions/{versionId}/restore
|
|
696
696
|
*/
|
|
697
|
-
declare function chatsRestore({ pathParams, config }?: {
|
|
697
|
+
declare function chatsRestore({ pathParams, config, }?: {
|
|
698
698
|
pathParams: {
|
|
699
|
-
|
|
700
|
-
|
|
699
|
+
chatId: string;
|
|
700
|
+
versionId: string;
|
|
701
701
|
};
|
|
702
702
|
config?: Partial<FetcherConfig> & {
|
|
703
703
|
client?: typeof client;
|
|
@@ -708,15 +708,15 @@ declare function chatsRestore({ pathParams, config }?: {
|
|
|
708
708
|
* @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
709
|
* @link /reports/usage
|
|
710
710
|
*/
|
|
711
|
-
declare function reportsGetUsage({ queryParams, config }?: {
|
|
711
|
+
declare function reportsGetUsage({ queryParams, config, }?: {
|
|
712
712
|
queryParams?: {
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
713
|
+
startDate?: string;
|
|
714
|
+
endDate?: string;
|
|
715
|
+
chatId?: string;
|
|
716
|
+
messageId?: string;
|
|
717
|
+
userId?: string;
|
|
718
|
+
limit?: number;
|
|
719
|
+
cursor?: string;
|
|
720
720
|
};
|
|
721
721
|
config?: Partial<FetcherConfig> & {
|
|
722
722
|
client?: typeof client;
|
|
@@ -727,12 +727,12 @@ declare function reportsGetUsage({ queryParams, config }?: {
|
|
|
727
727
|
* @description Retrieves v0 AI usage events for the authenticated user or active team scope.
|
|
728
728
|
* @link /reports/usage/ai
|
|
729
729
|
*/
|
|
730
|
-
declare function reportsGetAIUsage({ queryParams, config }?: {
|
|
730
|
+
declare function reportsGetAIUsage({ queryParams, config, }?: {
|
|
731
731
|
queryParams?: {
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
732
|
+
start?: string;
|
|
733
|
+
end?: string;
|
|
734
|
+
cursor?: string;
|
|
735
|
+
limit?: number;
|
|
736
736
|
};
|
|
737
737
|
config?: Partial<FetcherConfig> & {
|
|
738
738
|
client?: typeof client;
|
|
@@ -743,10 +743,10 @@ declare function reportsGetAIUsage({ queryParams, config }?: {
|
|
|
743
743
|
* @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
744
|
* @link /reports/user-activity
|
|
745
745
|
*/
|
|
746
|
-
declare function reportsGetUserActivity({ queryParams, config }?: {
|
|
746
|
+
declare function reportsGetUserActivity({ queryParams, config, }?: {
|
|
747
747
|
queryParams?: {
|
|
748
|
-
|
|
749
|
-
|
|
748
|
+
startDate?: string;
|
|
749
|
+
endDate?: string;
|
|
750
750
|
};
|
|
751
751
|
config?: Partial<FetcherConfig> & {
|
|
752
752
|
client?: typeof client;
|
|
@@ -777,9 +777,9 @@ declare function mcpServersCreate({ config }?: {
|
|
|
777
777
|
* @description Retrieves the details of a specific MCP server by its ID.
|
|
778
778
|
* @link /mcp-servers/{mcpServerId}
|
|
779
779
|
*/
|
|
780
|
-
declare function mcpServersGetById({ pathParams, config }?: {
|
|
780
|
+
declare function mcpServersGetById({ pathParams, config, }?: {
|
|
781
781
|
pathParams: {
|
|
782
|
-
|
|
782
|
+
mcpServerId: string;
|
|
783
783
|
};
|
|
784
784
|
config?: Partial<FetcherConfig> & {
|
|
785
785
|
client?: typeof client;
|
|
@@ -790,9 +790,9 @@ declare function mcpServersGetById({ pathParams, config }?: {
|
|
|
790
790
|
* @description Updates the configuration of an existing MCP server, including its name, URL, description, enabled status, and authentication settings.
|
|
791
791
|
* @link /mcp-servers/{mcpServerId}
|
|
792
792
|
*/
|
|
793
|
-
declare function mcpServersUpdate({ pathParams, config }?: {
|
|
793
|
+
declare function mcpServersUpdate({ pathParams, config, }?: {
|
|
794
794
|
pathParams: {
|
|
795
|
-
|
|
795
|
+
mcpServerId: string;
|
|
796
796
|
};
|
|
797
797
|
config?: Partial<FetcherConfig> & {
|
|
798
798
|
client?: typeof client;
|
|
@@ -803,9 +803,9 @@ declare function mcpServersUpdate({ pathParams, config }?: {
|
|
|
803
803
|
* @description Deletes an MCP server based on its ID. This action is irreversible and will also remove any associated OAuth tokens.
|
|
804
804
|
* @link /mcp-servers/{mcpServerId}
|
|
805
805
|
*/
|
|
806
|
-
declare function mcpServersDelete({ pathParams, config }?: {
|
|
806
|
+
declare function mcpServersDelete({ pathParams, config, }?: {
|
|
807
807
|
pathParams: {
|
|
808
|
-
|
|
808
|
+
mcpServerId: string;
|
|
809
809
|
};
|
|
810
810
|
config?: Partial<FetcherConfig> & {
|
|
811
811
|
client?: typeof client;
|
|
@@ -816,9 +816,9 @@ declare function mcpServersDelete({ pathParams, config }?: {
|
|
|
816
816
|
* @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
817
|
* @link /mcp-servers/{mcpServerId}/oauth/authorize
|
|
818
818
|
*/
|
|
819
|
-
declare function mcpServersCreateOAuthAuthorizationUrl({ pathParams, config }?: {
|
|
819
|
+
declare function mcpServersCreateOAuthAuthorizationUrl({ pathParams, config, }?: {
|
|
820
820
|
pathParams: {
|
|
821
|
-
|
|
821
|
+
mcpServerId: string;
|
|
822
822
|
};
|
|
823
823
|
config?: Partial<FetcherConfig> & {
|
|
824
824
|
client?: typeof client;
|