@vercel/sdk 1.6.1 → 1.6.3
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 +4 -10
- package/bin/mcp-server.js +1579 -2527
- package/bin/mcp-server.js.map +29 -38
- package/docs/sdks/integrations/README.md +0 -161
- package/docs/sdks/logdrains/README.md +0 -260
- package/docs/sdks/projects/README.md +162 -0
- package/esm/__tests__/integrations.test.js +5 -40
- package/esm/__tests__/integrations.test.js.map +1 -1
- package/esm/__tests__/logdrains.test.js +7 -89
- package/esm/__tests__/logdrains.test.js.map +1 -1
- package/esm/__tests__/projects.test.js +41 -13
- package/esm/__tests__/projects.test.js.map +1 -1
- package/esm/funcs/projectsCreateProject.js +2 -2
- package/esm/funcs/projectsCreateProject.js.map +1 -1
- package/esm/funcs/projectsPauseProject.d.ts +18 -0
- package/esm/funcs/projectsPauseProject.d.ts.map +1 -0
- package/esm/funcs/{logDrainsGetConfigurableLogDrain.js → projectsPauseProject.js} +13 -13
- package/esm/funcs/projectsPauseProject.js.map +1 -0
- package/esm/funcs/projectsUnpauseProject.d.ts +18 -0
- package/esm/funcs/projectsUnpauseProject.d.ts.map +1 -0
- package/esm/funcs/{logDrainsGetAllLogDrains.js → projectsUnpauseProject.js} +18 -14
- package/esm/funcs/projectsUnpauseProject.js.map +1 -0
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/lib/matchers.d.ts +3 -1
- package/esm/lib/matchers.d.ts.map +1 -1
- package/esm/lib/matchers.js +10 -0
- package/esm/lib/matchers.js.map +1 -1
- package/esm/lib/sdks.js +7 -2
- package/esm/lib/sdks.js.map +1 -1
- package/esm/mcp-server/mcp-server.js +1 -1
- package/esm/mcp-server/server.d.ts.map +1 -1
- package/esm/mcp-server/server.js +5 -11
- package/esm/mcp-server/server.js.map +1 -1
- package/esm/mcp-server/tools/projectsPauseProject.d.ts +7 -0
- package/esm/mcp-server/tools/projectsPauseProject.d.ts.map +1 -0
- package/esm/mcp-server/tools/projectsPauseProject.js +27 -0
- package/esm/mcp-server/tools/projectsPauseProject.js.map +1 -0
- package/esm/mcp-server/tools/projectsUnpauseProject.d.ts +7 -0
- package/esm/mcp-server/tools/projectsUnpauseProject.d.ts.map +1 -0
- package/esm/mcp-server/tools/projectsUnpauseProject.js +27 -0
- package/esm/mcp-server/tools/projectsUnpauseProject.js.map +1 -0
- package/esm/models/authuser.d.ts +41 -0
- package/esm/models/authuser.d.ts.map +1 -1
- package/esm/models/authuser.js +29 -0
- package/esm/models/authuser.js.map +1 -1
- package/esm/models/canceldeploymentop.d.ts +3 -3
- package/esm/models/canceldeploymentop.js +1 -1
- package/esm/models/canceldeploymentop.js.map +1 -1
- package/esm/models/createlogdrainop.d.ts +51 -51
- package/esm/models/createlogdrainop.d.ts.map +1 -1
- package/esm/models/createlogdrainop.js +74 -75
- package/esm/models/createlogdrainop.js.map +1 -1
- package/esm/models/createprojectop.d.ts +46 -16
- package/esm/models/createprojectop.d.ts.map +1 -1
- package/esm/models/createprojectop.js +17 -5
- package/esm/models/createprojectop.js.map +1 -1
- package/esm/models/exchangessotokenop.d.ts +34 -0
- package/esm/models/exchangessotokenop.d.ts.map +1 -1
- package/esm/models/exchangessotokenop.js +25 -0
- package/esm/models/exchangessotokenop.js.map +1 -1
- package/esm/models/getconfigurationsop.d.ts +19 -16
- package/esm/models/getconfigurationsop.d.ts.map +1 -1
- package/esm/models/getconfigurationsop.js +25 -27
- package/esm/models/getconfigurationsop.js.map +1 -1
- package/esm/models/getcustomenvironmentop.d.ts +3 -0
- package/esm/models/getcustomenvironmentop.d.ts.map +1 -1
- package/esm/models/getcustomenvironmentop.js.map +1 -1
- package/esm/models/getintegrationlogdrainsop.d.ts +11 -11
- package/esm/models/getintegrationlogdrainsop.d.ts.map +1 -1
- package/esm/models/getintegrationlogdrainsop.js +14 -13
- package/esm/models/getintegrationlogdrainsop.js.map +1 -1
- package/esm/models/getprojectsop.d.ts +46 -16
- package/esm/models/getprojectsop.d.ts.map +1 -1
- package/esm/models/getprojectsop.js +17 -5
- package/esm/models/getprojectsop.js.map +1 -1
- package/esm/models/getteammembersop.d.ts +9 -9
- package/esm/models/getteammembersop.js +3 -3
- package/esm/models/getteammembersop.js.map +1 -1
- package/esm/models/getv9projectsidornamecustomenvironmentsop.d.ts +3 -0
- package/esm/models/getv9projectsidornamecustomenvironmentsop.d.ts.map +1 -1
- package/esm/models/getv9projectsidornamecustomenvironmentsop.js.map +1 -1
- package/esm/models/pauseprojectop.d.ts +42 -0
- package/esm/models/pauseprojectop.d.ts.map +1 -0
- package/esm/models/pauseprojectop.js +35 -0
- package/esm/models/pauseprojectop.js.map +1 -0
- package/esm/models/unpauseprojectop.d.ts +42 -0
- package/esm/models/unpauseprojectop.d.ts.map +1 -0
- package/esm/models/unpauseprojectop.js +35 -0
- package/esm/models/unpauseprojectop.js.map +1 -0
- package/esm/models/updateprojectdatacacheop.d.ts +46 -16
- package/esm/models/updateprojectdatacacheop.d.ts.map +1 -1
- package/esm/models/updateprojectdatacacheop.js +17 -5
- package/esm/models/updateprojectdatacacheop.js.map +1 -1
- package/esm/models/updateprojectop.d.ts +46 -16
- package/esm/models/updateprojectop.d.ts.map +1 -1
- package/esm/models/updateprojectop.js +17 -5
- package/esm/models/updateprojectop.js.map +1 -1
- package/esm/models/userevent.d.ts +569 -512
- package/esm/models/userevent.d.ts.map +1 -1
- package/esm/models/userevent.js +703 -645
- package/esm/models/userevent.js.map +1 -1
- package/esm/sdk/integrations.d.ts +0 -16
- package/esm/sdk/integrations.d.ts.map +1 -1
- package/esm/sdk/integrations.js +0 -20
- package/esm/sdk/integrations.js.map +1 -1
- package/esm/sdk/logdrains.d.ts +0 -24
- package/esm/sdk/logdrains.d.ts.map +1 -1
- package/esm/sdk/logdrains.js +0 -30
- package/esm/sdk/logdrains.js.map +1 -1
- package/esm/sdk/projects.d.ts +16 -0
- package/esm/sdk/projects.d.ts.map +1 -1
- package/esm/sdk/projects.js +20 -0
- package/esm/sdk/projects.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/__tests__/integrations.test.ts +9 -44
- package/src/__tests__/logdrains.test.ts +13 -95
- package/src/__tests__/projects.test.ts +47 -13
- package/src/funcs/projectsCreateProject.ts +2 -2
- package/src/funcs/{integrationsGitNamespaces.ts → projectsPauseProject.ts} +30 -25
- package/src/funcs/{logDrainsGetAllLogDrains.ts → projectsUnpauseProject.ts} +27 -24
- package/src/lib/config.ts +3 -3
- package/src/lib/matchers.ts +20 -0
- package/src/lib/sdks.ts +8 -2
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +5 -11
- package/src/mcp-server/tools/projectsPauseProject.ts +35 -0
- package/src/mcp-server/tools/projectsUnpauseProject.ts +35 -0
- package/src/models/authuser.ts +74 -0
- package/src/models/canceldeploymentop.ts +1 -1
- package/src/models/createlogdrainop.ts +95 -112
- package/src/models/createprojectop.ts +42 -6
- package/src/models/exchangessotokenop.ts +44 -0
- package/src/models/getconfigurationsop.ts +34 -39
- package/src/models/getcustomenvironmentop.ts +3 -0
- package/src/models/getintegrationlogdrainsop.ts +15 -20
- package/src/models/getprojectsop.ts +42 -6
- package/src/models/getteammembersop.ts +3 -3
- package/src/models/getv9projectsidornamecustomenvironmentsop.ts +3 -0
- package/src/models/pauseprojectop.ts +83 -0
- package/src/models/unpauseprojectop.ts +83 -0
- package/src/models/updateprojectdatacacheop.ts +42 -6
- package/src/models/updateprojectop.ts +42 -6
- package/src/models/userevent.ts +1328 -1193
- package/src/sdk/integrations.ts +0 -44
- package/src/sdk/logdrains.ts +0 -66
- package/src/sdk/projects.ts +38 -0
- package/vercel-spec.json +616 -1392
- package/esm/funcs/integrationsGitNamespaces.d.ts +0 -18
- package/esm/funcs/integrationsGitNamespaces.d.ts.map +0 -1
- package/esm/funcs/integrationsGitNamespaces.js +0 -86
- package/esm/funcs/integrationsGitNamespaces.js.map +0 -1
- package/esm/funcs/integrationsSearchRepo.d.ts +0 -17
- package/esm/funcs/integrationsSearchRepo.d.ts.map +0 -1
- package/esm/funcs/integrationsSearchRepo.js +0 -89
- package/esm/funcs/integrationsSearchRepo.js.map +0 -1
- package/esm/funcs/logDrainsCreateConfigurableLogDrain.d.ts +0 -18
- package/esm/funcs/logDrainsCreateConfigurableLogDrain.d.ts.map +0 -1
- package/esm/funcs/logDrainsCreateConfigurableLogDrain.js +0 -86
- package/esm/funcs/logDrainsCreateConfigurableLogDrain.js.map +0 -1
- package/esm/funcs/logDrainsGetAllLogDrains.d.ts +0 -18
- package/esm/funcs/logDrainsGetAllLogDrains.d.ts.map +0 -1
- package/esm/funcs/logDrainsGetAllLogDrains.js.map +0 -1
- package/esm/funcs/logDrainsGetConfigurableLogDrain.d.ts +0 -19
- package/esm/funcs/logDrainsGetConfigurableLogDrain.d.ts.map +0 -1
- package/esm/funcs/logDrainsGetConfigurableLogDrain.js.map +0 -1
- package/esm/mcp-server/tools/integrationsGitNamespaces.d.ts +0 -7
- package/esm/mcp-server/tools/integrationsGitNamespaces.d.ts.map +0 -1
- package/esm/mcp-server/tools/integrationsGitNamespaces.js +0 -28
- package/esm/mcp-server/tools/integrationsGitNamespaces.js.map +0 -1
- package/esm/mcp-server/tools/integrationsSearchRepo.d.ts +0 -7
- package/esm/mcp-server/tools/integrationsSearchRepo.d.ts.map +0 -1
- package/esm/mcp-server/tools/integrationsSearchRepo.js +0 -28
- package/esm/mcp-server/tools/integrationsSearchRepo.js.map +0 -1
- package/esm/mcp-server/tools/logDrainsCreateConfigurableLogDrain.d.ts +0 -7
- package/esm/mcp-server/tools/logDrainsCreateConfigurableLogDrain.d.ts.map +0 -1
- package/esm/mcp-server/tools/logDrainsCreateConfigurableLogDrain.js +0 -28
- package/esm/mcp-server/tools/logDrainsCreateConfigurableLogDrain.js.map +0 -1
- package/esm/mcp-server/tools/logDrainsGetAllLogDrains.d.ts +0 -7
- package/esm/mcp-server/tools/logDrainsGetAllLogDrains.d.ts.map +0 -1
- package/esm/mcp-server/tools/logDrainsGetAllLogDrains.js +0 -28
- package/esm/mcp-server/tools/logDrainsGetAllLogDrains.js.map +0 -1
- package/esm/mcp-server/tools/logDrainsGetConfigurableLogDrain.d.ts +0 -7
- package/esm/mcp-server/tools/logDrainsGetConfigurableLogDrain.d.ts.map +0 -1
- package/esm/mcp-server/tools/logDrainsGetConfigurableLogDrain.js +0 -28
- package/esm/mcp-server/tools/logDrainsGetConfigurableLogDrain.js.map +0 -1
- package/esm/models/createconfigurablelogdrainop.d.ts +0 -451
- package/esm/models/createconfigurablelogdrainop.d.ts.map +0 -1
- package/esm/models/createconfigurablelogdrainop.js +0 -348
- package/esm/models/createconfigurablelogdrainop.js.map +0 -1
- package/esm/models/getalllogdrainsop.d.ts +0 -294
- package/esm/models/getalllogdrainsop.d.ts.map +0 -1
- package/esm/models/getalllogdrainsop.js +0 -231
- package/esm/models/getalllogdrainsop.js.map +0 -1
- package/esm/models/getconfigurablelogdrainop.d.ts +0 -292
- package/esm/models/getconfigurablelogdrainop.d.ts.map +0 -1
- package/esm/models/getconfigurablelogdrainop.js +0 -230
- package/esm/models/getconfigurablelogdrainop.js.map +0 -1
- package/esm/models/gitnamespacesop.d.ts +0 -126
- package/esm/models/gitnamespacesop.d.ts.map +0 -1
- package/esm/models/gitnamespacesop.js +0 -115
- package/esm/models/gitnamespacesop.js.map +0 -1
- package/esm/models/searchrepoop.d.ts +0 -421
- package/esm/models/searchrepoop.d.ts.map +0 -1
- package/esm/models/searchrepoop.js +0 -385
- package/esm/models/searchrepoop.js.map +0 -1
- package/src/funcs/integrationsSearchRepo.ts +0 -181
- package/src/funcs/logDrainsCreateConfigurableLogDrain.ts +0 -185
- package/src/funcs/logDrainsGetConfigurableLogDrain.ts +0 -199
- package/src/mcp-server/tools/integrationsGitNamespaces.ts +0 -37
- package/src/mcp-server/tools/integrationsSearchRepo.ts +0 -37
- package/src/mcp-server/tools/logDrainsCreateConfigurableLogDrain.ts +0 -39
- package/src/mcp-server/tools/logDrainsGetAllLogDrains.ts +0 -37
- package/src/mcp-server/tools/logDrainsGetConfigurableLogDrain.ts +0 -39
- package/src/models/createconfigurablelogdrainop.ts +0 -652
- package/src/models/getalllogdrainsop.ts +0 -416
- package/src/models/getconfigurablelogdrainop.ts +0 -420
- package/src/models/gitnamespacesop.ts +0 -235
- package/src/models/searchrepoop.ts +0 -784
|
@@ -9,8 +9,6 @@
|
|
|
9
9
|
* [getConfigurations](#getconfigurations) - Get configurations for the authenticated user or team
|
|
10
10
|
* [getConfiguration](#getconfiguration) - Retrieve an integration configuration
|
|
11
11
|
* [deleteConfiguration](#deleteconfiguration) - Delete an integration configuration
|
|
12
|
-
* [gitNamespaces](#gitnamespaces) - List git namespaces by provider
|
|
13
|
-
* [searchRepo](#searchrepo) - List git repositories linked to namespace by provider
|
|
14
12
|
|
|
15
13
|
## updateIntegrationDeploymentAction
|
|
16
14
|
|
|
@@ -338,163 +336,4 @@ run();
|
|
|
338
336
|
| models.VercelBadRequestError | 400 | application/json |
|
|
339
337
|
| models.VercelForbiddenError | 401 | application/json |
|
|
340
338
|
| models.VercelNotFoundError | 404 | application/json |
|
|
341
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
342
|
-
|
|
343
|
-
## gitNamespaces
|
|
344
|
-
|
|
345
|
-
Lists git namespaces for a supported provider. Supported providers are `github`, `gitlab` and `bitbucket`. If the provider is not provided, it will try to obtain it from the user that authenticated the request.
|
|
346
|
-
|
|
347
|
-
### Example Usage
|
|
348
|
-
|
|
349
|
-
```typescript
|
|
350
|
-
import { Vercel } from "@vercel/sdk";
|
|
351
|
-
|
|
352
|
-
const vercel = new Vercel({
|
|
353
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
354
|
-
});
|
|
355
|
-
|
|
356
|
-
async function run() {
|
|
357
|
-
const result = await vercel.integrations.gitNamespaces({
|
|
358
|
-
host: "ghes-test.now.systems",
|
|
359
|
-
});
|
|
360
|
-
|
|
361
|
-
// Handle the result
|
|
362
|
-
console.log(result);
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
run();
|
|
366
|
-
```
|
|
367
|
-
|
|
368
|
-
### Standalone function
|
|
369
|
-
|
|
370
|
-
The standalone function version of this method:
|
|
371
|
-
|
|
372
|
-
```typescript
|
|
373
|
-
import { VercelCore } from "@vercel/sdk/core.js";
|
|
374
|
-
import { integrationsGitNamespaces } from "@vercel/sdk/funcs/integrationsGitNamespaces.js";
|
|
375
|
-
|
|
376
|
-
// Use `VercelCore` for best tree-shaking performance.
|
|
377
|
-
// You can create one instance of it to use across an application.
|
|
378
|
-
const vercel = new VercelCore({
|
|
379
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
380
|
-
});
|
|
381
|
-
|
|
382
|
-
async function run() {
|
|
383
|
-
const res = await integrationsGitNamespaces(vercel, {
|
|
384
|
-
host: "ghes-test.now.systems",
|
|
385
|
-
});
|
|
386
|
-
|
|
387
|
-
if (!res.ok) {
|
|
388
|
-
throw res.error;
|
|
389
|
-
}
|
|
390
|
-
|
|
391
|
-
const { value: result } = res;
|
|
392
|
-
|
|
393
|
-
// Handle the result
|
|
394
|
-
console.log(result);
|
|
395
|
-
}
|
|
396
|
-
|
|
397
|
-
run();
|
|
398
|
-
```
|
|
399
|
-
|
|
400
|
-
### Parameters
|
|
401
|
-
|
|
402
|
-
| Parameter | Type | Required | Description |
|
|
403
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
404
|
-
| `request` | [models.GitNamespacesRequest](../../models/gitnamespacesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
405
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
406
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
407
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
408
|
-
|
|
409
|
-
### Response
|
|
410
|
-
|
|
411
|
-
**Promise\<[models.GitNamespacesResponseBody[]](../../models/.md)\>**
|
|
412
|
-
|
|
413
|
-
### Errors
|
|
414
|
-
|
|
415
|
-
| Error Type | Status Code | Content Type |
|
|
416
|
-
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
417
|
-
| models.VercelBadRequestError | 400 | application/json |
|
|
418
|
-
| models.VercelForbiddenError | 401 | application/json |
|
|
419
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
420
|
-
|
|
421
|
-
## searchRepo
|
|
422
|
-
|
|
423
|
-
Lists git repositories linked to a namespace `id` for a supported provider. A specific namespace `id` can be obtained via the `git-namespaces` endpoint. Supported providers are `github`, `gitlab` and `bitbucket`. If the provider or namespace is not provided, it will try to obtain it from the user that authenticated the request.
|
|
424
|
-
|
|
425
|
-
### Example Usage
|
|
426
|
-
|
|
427
|
-
```typescript
|
|
428
|
-
import { Vercel } from "@vercel/sdk";
|
|
429
|
-
|
|
430
|
-
const vercel = new Vercel({
|
|
431
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
432
|
-
});
|
|
433
|
-
|
|
434
|
-
async function run() {
|
|
435
|
-
const result = await vercel.integrations.searchRepo({
|
|
436
|
-
host: "ghes-test.now.systems",
|
|
437
|
-
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
438
|
-
slug: "my-team-url-slug",
|
|
439
|
-
});
|
|
440
|
-
|
|
441
|
-
// Handle the result
|
|
442
|
-
console.log(result);
|
|
443
|
-
}
|
|
444
|
-
|
|
445
|
-
run();
|
|
446
|
-
```
|
|
447
|
-
|
|
448
|
-
### Standalone function
|
|
449
|
-
|
|
450
|
-
The standalone function version of this method:
|
|
451
|
-
|
|
452
|
-
```typescript
|
|
453
|
-
import { VercelCore } from "@vercel/sdk/core.js";
|
|
454
|
-
import { integrationsSearchRepo } from "@vercel/sdk/funcs/integrationsSearchRepo.js";
|
|
455
|
-
|
|
456
|
-
// Use `VercelCore` for best tree-shaking performance.
|
|
457
|
-
// You can create one instance of it to use across an application.
|
|
458
|
-
const vercel = new VercelCore({
|
|
459
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
460
|
-
});
|
|
461
|
-
|
|
462
|
-
async function run() {
|
|
463
|
-
const res = await integrationsSearchRepo(vercel, {
|
|
464
|
-
host: "ghes-test.now.systems",
|
|
465
|
-
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
466
|
-
slug: "my-team-url-slug",
|
|
467
|
-
});
|
|
468
|
-
|
|
469
|
-
if (!res.ok) {
|
|
470
|
-
throw res.error;
|
|
471
|
-
}
|
|
472
|
-
|
|
473
|
-
const { value: result } = res;
|
|
474
|
-
|
|
475
|
-
// Handle the result
|
|
476
|
-
console.log(result);
|
|
477
|
-
}
|
|
478
|
-
|
|
479
|
-
run();
|
|
480
|
-
```
|
|
481
|
-
|
|
482
|
-
### Parameters
|
|
483
|
-
|
|
484
|
-
| Parameter | Type | Required | Description |
|
|
485
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
486
|
-
| `request` | [models.SearchRepoRequest](../../models/searchreporequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
487
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
488
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
489
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
490
|
-
|
|
491
|
-
### Response
|
|
492
|
-
|
|
493
|
-
**Promise\<[models.SearchRepoResponseBody](../../models/searchreporesponsebody.md)\>**
|
|
494
|
-
|
|
495
|
-
### Errors
|
|
496
|
-
|
|
497
|
-
| Error Type | Status Code | Content Type |
|
|
498
|
-
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
499
|
-
| models.VercelBadRequestError | 400 | application/json |
|
|
500
339
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -5,97 +5,11 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [getConfigurableLogDrain](#getconfigurablelogdrain) - Retrieves a Configurable Log Drain
|
|
9
8
|
* [deleteConfigurableLogDrain](#deleteconfigurablelogdrain) - Deletes a Configurable Log Drain
|
|
10
|
-
* [getAllLogDrains](#getalllogdrains) - Retrieves a list of all the Log Drains
|
|
11
|
-
* [createConfigurableLogDrain](#createconfigurablelogdrain) - Creates a Configurable Log Drain
|
|
12
9
|
* [getIntegrationLogDrains](#getintegrationlogdrains) - Retrieves a list of Integration log drains
|
|
13
10
|
* [createLogDrain](#createlogdrain) - Creates a new Integration Log Drain
|
|
14
11
|
* [deleteIntegrationLogDrain](#deleteintegrationlogdrain) - Deletes the Integration log drain with the provided `id`
|
|
15
12
|
|
|
16
|
-
## getConfigurableLogDrain
|
|
17
|
-
|
|
18
|
-
Retrieves a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be accessed.
|
|
19
|
-
|
|
20
|
-
### Example Usage
|
|
21
|
-
|
|
22
|
-
```typescript
|
|
23
|
-
import { Vercel } from "@vercel/sdk";
|
|
24
|
-
|
|
25
|
-
const vercel = new Vercel({
|
|
26
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
27
|
-
});
|
|
28
|
-
|
|
29
|
-
async function run() {
|
|
30
|
-
const result = await vercel.logDrains.getConfigurableLogDrain({
|
|
31
|
-
id: "<id>",
|
|
32
|
-
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
33
|
-
slug: "my-team-url-slug",
|
|
34
|
-
});
|
|
35
|
-
|
|
36
|
-
// Handle the result
|
|
37
|
-
console.log(result);
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
run();
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### Standalone function
|
|
44
|
-
|
|
45
|
-
The standalone function version of this method:
|
|
46
|
-
|
|
47
|
-
```typescript
|
|
48
|
-
import { VercelCore } from "@vercel/sdk/core.js";
|
|
49
|
-
import { logDrainsGetConfigurableLogDrain } from "@vercel/sdk/funcs/logDrainsGetConfigurableLogDrain.js";
|
|
50
|
-
|
|
51
|
-
// Use `VercelCore` for best tree-shaking performance.
|
|
52
|
-
// You can create one instance of it to use across an application.
|
|
53
|
-
const vercel = new VercelCore({
|
|
54
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
55
|
-
});
|
|
56
|
-
|
|
57
|
-
async function run() {
|
|
58
|
-
const res = await logDrainsGetConfigurableLogDrain(vercel, {
|
|
59
|
-
id: "<id>",
|
|
60
|
-
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
61
|
-
slug: "my-team-url-slug",
|
|
62
|
-
});
|
|
63
|
-
|
|
64
|
-
if (!res.ok) {
|
|
65
|
-
throw res.error;
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
const { value: result } = res;
|
|
69
|
-
|
|
70
|
-
// Handle the result
|
|
71
|
-
console.log(result);
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
run();
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### Parameters
|
|
78
|
-
|
|
79
|
-
| Parameter | Type | Required | Description |
|
|
80
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
81
|
-
| `request` | [models.GetConfigurableLogDrainRequest](../../models/getconfigurablelogdrainrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
82
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
83
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
84
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
85
|
-
|
|
86
|
-
### Response
|
|
87
|
-
|
|
88
|
-
**Promise\<[models.GetConfigurableLogDrainResponseBody](../../models/getconfigurablelogdrainresponsebody.md)\>**
|
|
89
|
-
|
|
90
|
-
### Errors
|
|
91
|
-
|
|
92
|
-
| Error Type | Status Code | Content Type |
|
|
93
|
-
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
94
|
-
| models.VercelBadRequestError | 400 | application/json |
|
|
95
|
-
| models.VercelForbiddenError | 401 | application/json |
|
|
96
|
-
| models.VercelNotFoundError | 404 | application/json |
|
|
97
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
98
|
-
|
|
99
13
|
## deleteConfigurableLogDrain
|
|
100
14
|
|
|
101
15
|
Deletes a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be deleted.
|
|
@@ -177,180 +91,6 @@ run();
|
|
|
177
91
|
| models.VercelNotFoundError | 404 | application/json |
|
|
178
92
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
179
93
|
|
|
180
|
-
## getAllLogDrains
|
|
181
|
-
|
|
182
|
-
Retrieves a list of all the Log Drains owned by the account. This endpoint must be called with an account AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated account can be accessed.
|
|
183
|
-
|
|
184
|
-
### Example Usage
|
|
185
|
-
|
|
186
|
-
```typescript
|
|
187
|
-
import { Vercel } from "@vercel/sdk";
|
|
188
|
-
|
|
189
|
-
const vercel = new Vercel({
|
|
190
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
191
|
-
});
|
|
192
|
-
|
|
193
|
-
async function run() {
|
|
194
|
-
const result = await vercel.logDrains.getAllLogDrains({
|
|
195
|
-
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
196
|
-
slug: "my-team-url-slug",
|
|
197
|
-
});
|
|
198
|
-
|
|
199
|
-
// Handle the result
|
|
200
|
-
console.log(result);
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
run();
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
### Standalone function
|
|
207
|
-
|
|
208
|
-
The standalone function version of this method:
|
|
209
|
-
|
|
210
|
-
```typescript
|
|
211
|
-
import { VercelCore } from "@vercel/sdk/core.js";
|
|
212
|
-
import { logDrainsGetAllLogDrains } from "@vercel/sdk/funcs/logDrainsGetAllLogDrains.js";
|
|
213
|
-
|
|
214
|
-
// Use `VercelCore` for best tree-shaking performance.
|
|
215
|
-
// You can create one instance of it to use across an application.
|
|
216
|
-
const vercel = new VercelCore({
|
|
217
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
218
|
-
});
|
|
219
|
-
|
|
220
|
-
async function run() {
|
|
221
|
-
const res = await logDrainsGetAllLogDrains(vercel, {
|
|
222
|
-
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
223
|
-
slug: "my-team-url-slug",
|
|
224
|
-
});
|
|
225
|
-
|
|
226
|
-
if (!res.ok) {
|
|
227
|
-
throw res.error;
|
|
228
|
-
}
|
|
229
|
-
|
|
230
|
-
const { value: result } = res;
|
|
231
|
-
|
|
232
|
-
// Handle the result
|
|
233
|
-
console.log(result);
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
run();
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
### Parameters
|
|
240
|
-
|
|
241
|
-
| Parameter | Type | Required | Description |
|
|
242
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
243
|
-
| `request` | [models.GetAllLogDrainsRequest](../../models/getalllogdrainsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
244
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
245
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
246
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
247
|
-
|
|
248
|
-
### Response
|
|
249
|
-
|
|
250
|
-
**Promise\<[models.GetAllLogDrainsResponseBody[]](../../models/.md)\>**
|
|
251
|
-
|
|
252
|
-
### Errors
|
|
253
|
-
|
|
254
|
-
| Error Type | Status Code | Content Type |
|
|
255
|
-
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
256
|
-
| models.VercelBadRequestError | 400 | application/json |
|
|
257
|
-
| models.VercelForbiddenError | 401 | application/json |
|
|
258
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
259
|
-
|
|
260
|
-
## createConfigurableLogDrain
|
|
261
|
-
|
|
262
|
-
Creates a configurable log drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed)
|
|
263
|
-
|
|
264
|
-
### Example Usage
|
|
265
|
-
|
|
266
|
-
```typescript
|
|
267
|
-
import { Vercel } from "@vercel/sdk";
|
|
268
|
-
|
|
269
|
-
const vercel = new Vercel({
|
|
270
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
271
|
-
});
|
|
272
|
-
|
|
273
|
-
async function run() {
|
|
274
|
-
const result = await vercel.logDrains.createConfigurableLogDrain({
|
|
275
|
-
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
276
|
-
slug: "my-team-url-slug",
|
|
277
|
-
requestBody: {
|
|
278
|
-
deliveryFormat: "json",
|
|
279
|
-
url: "https://sugary-technician.name",
|
|
280
|
-
sources: [
|
|
281
|
-
"external",
|
|
282
|
-
],
|
|
283
|
-
},
|
|
284
|
-
});
|
|
285
|
-
|
|
286
|
-
// Handle the result
|
|
287
|
-
console.log(result);
|
|
288
|
-
}
|
|
289
|
-
|
|
290
|
-
run();
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
### Standalone function
|
|
294
|
-
|
|
295
|
-
The standalone function version of this method:
|
|
296
|
-
|
|
297
|
-
```typescript
|
|
298
|
-
import { VercelCore } from "@vercel/sdk/core.js";
|
|
299
|
-
import { logDrainsCreateConfigurableLogDrain } from "@vercel/sdk/funcs/logDrainsCreateConfigurableLogDrain.js";
|
|
300
|
-
|
|
301
|
-
// Use `VercelCore` for best tree-shaking performance.
|
|
302
|
-
// You can create one instance of it to use across an application.
|
|
303
|
-
const vercel = new VercelCore({
|
|
304
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
305
|
-
});
|
|
306
|
-
|
|
307
|
-
async function run() {
|
|
308
|
-
const res = await logDrainsCreateConfigurableLogDrain(vercel, {
|
|
309
|
-
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
310
|
-
slug: "my-team-url-slug",
|
|
311
|
-
requestBody: {
|
|
312
|
-
deliveryFormat: "json",
|
|
313
|
-
url: "https://sugary-technician.name",
|
|
314
|
-
sources: [
|
|
315
|
-
"external",
|
|
316
|
-
],
|
|
317
|
-
},
|
|
318
|
-
});
|
|
319
|
-
|
|
320
|
-
if (!res.ok) {
|
|
321
|
-
throw res.error;
|
|
322
|
-
}
|
|
323
|
-
|
|
324
|
-
const { value: result } = res;
|
|
325
|
-
|
|
326
|
-
// Handle the result
|
|
327
|
-
console.log(result);
|
|
328
|
-
}
|
|
329
|
-
|
|
330
|
-
run();
|
|
331
|
-
```
|
|
332
|
-
|
|
333
|
-
### Parameters
|
|
334
|
-
|
|
335
|
-
| Parameter | Type | Required | Description |
|
|
336
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
337
|
-
| `request` | [models.CreateConfigurableLogDrainRequest](../../models/createconfigurablelogdrainrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
338
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
339
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
340
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
341
|
-
|
|
342
|
-
### Response
|
|
343
|
-
|
|
344
|
-
**Promise\<[models.CreateConfigurableLogDrainResponseBody](../../models/createconfigurablelogdrainresponsebody.md)\>**
|
|
345
|
-
|
|
346
|
-
### Errors
|
|
347
|
-
|
|
348
|
-
| Error Type | Status Code | Content Type |
|
|
349
|
-
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
350
|
-
| models.VercelBadRequestError | 400 | application/json |
|
|
351
|
-
| models.VercelForbiddenError | 401 | application/json |
|
|
352
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
353
|
-
|
|
354
94
|
## getIntegrationLogDrains
|
|
355
95
|
|
|
356
96
|
Retrieves a list of all Integration log drains that are defined for the authenticated user or team. When using an OAuth2 token, the list is limited to log drains created by the authenticated integration.
|
|
@@ -26,6 +26,8 @@
|
|
|
26
26
|
* [updateProjectProtectionBypass](#updateprojectprotectionbypass) - Update Protection Bypass for Automation
|
|
27
27
|
* [requestPromote](#requestpromote) - Points all production domains for a project to the given deploy
|
|
28
28
|
* [listPromoteAliases](#listpromotealiases) - Gets a list of aliases with status for the current promote
|
|
29
|
+
* [pauseProject](#pauseproject) - Pause a project
|
|
30
|
+
* [unpauseProject](#unpauseproject) - Unpause a project
|
|
29
31
|
|
|
30
32
|
## updateProjectDataCache
|
|
31
33
|
|
|
@@ -1896,4 +1898,164 @@ run();
|
|
|
1896
1898
|
| models.VercelBadRequestError | 400 | application/json |
|
|
1897
1899
|
| models.VercelForbiddenError | 401 | application/json |
|
|
1898
1900
|
| models.VercelNotFoundError | 404 | application/json |
|
|
1901
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1902
|
+
|
|
1903
|
+
## pauseProject
|
|
1904
|
+
|
|
1905
|
+
Pause a project by passing its project `id` in the URL. If the project does not exist given the id then the request will fail with 400 status code. If the project disables auto assigning custom production domains and blocks the active Production Deployment then the request will return with 200 status code.
|
|
1906
|
+
|
|
1907
|
+
### Example Usage
|
|
1908
|
+
|
|
1909
|
+
```typescript
|
|
1910
|
+
import { Vercel } from "@vercel/sdk";
|
|
1911
|
+
|
|
1912
|
+
const vercel = new Vercel({
|
|
1913
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1914
|
+
});
|
|
1915
|
+
|
|
1916
|
+
async function run() {
|
|
1917
|
+
await vercel.projects.pauseProject({
|
|
1918
|
+
projectId: "<id>",
|
|
1919
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
1920
|
+
slug: "my-team-url-slug",
|
|
1921
|
+
});
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
}
|
|
1925
|
+
|
|
1926
|
+
run();
|
|
1927
|
+
```
|
|
1928
|
+
|
|
1929
|
+
### Standalone function
|
|
1930
|
+
|
|
1931
|
+
The standalone function version of this method:
|
|
1932
|
+
|
|
1933
|
+
```typescript
|
|
1934
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
1935
|
+
import { projectsPauseProject } from "@vercel/sdk/funcs/projectsPauseProject.js";
|
|
1936
|
+
|
|
1937
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
1938
|
+
// You can create one instance of it to use across an application.
|
|
1939
|
+
const vercel = new VercelCore({
|
|
1940
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1941
|
+
});
|
|
1942
|
+
|
|
1943
|
+
async function run() {
|
|
1944
|
+
const res = await projectsPauseProject(vercel, {
|
|
1945
|
+
projectId: "<id>",
|
|
1946
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
1947
|
+
slug: "my-team-url-slug",
|
|
1948
|
+
});
|
|
1949
|
+
|
|
1950
|
+
if (!res.ok) {
|
|
1951
|
+
throw res.error;
|
|
1952
|
+
}
|
|
1953
|
+
|
|
1954
|
+
const { value: result } = res;
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
}
|
|
1958
|
+
|
|
1959
|
+
run();
|
|
1960
|
+
```
|
|
1961
|
+
|
|
1962
|
+
### Parameters
|
|
1963
|
+
|
|
1964
|
+
| Parameter | Type | Required | Description |
|
|
1965
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1966
|
+
| `request` | [models.PauseProjectRequest](../../models/pauseprojectrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1967
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1968
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1969
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1970
|
+
|
|
1971
|
+
### Response
|
|
1972
|
+
|
|
1973
|
+
**Promise\<void\>**
|
|
1974
|
+
|
|
1975
|
+
### Errors
|
|
1976
|
+
|
|
1977
|
+
| Error Type | Status Code | Content Type |
|
|
1978
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
1979
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
1980
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
1981
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1982
|
+
|
|
1983
|
+
## unpauseProject
|
|
1984
|
+
|
|
1985
|
+
Unpause a project by passing its project `id` in the URL. If the project does not exist given the id then the request will fail with 400 status code. If the project enables auto assigning custom production domains and unblocks the active Production Deployment then the request will return with 200 status code.
|
|
1986
|
+
|
|
1987
|
+
### Example Usage
|
|
1988
|
+
|
|
1989
|
+
```typescript
|
|
1990
|
+
import { Vercel } from "@vercel/sdk";
|
|
1991
|
+
|
|
1992
|
+
const vercel = new Vercel({
|
|
1993
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1994
|
+
});
|
|
1995
|
+
|
|
1996
|
+
async function run() {
|
|
1997
|
+
await vercel.projects.unpauseProject({
|
|
1998
|
+
projectId: "<id>",
|
|
1999
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
2000
|
+
slug: "my-team-url-slug",
|
|
2001
|
+
});
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
}
|
|
2005
|
+
|
|
2006
|
+
run();
|
|
2007
|
+
```
|
|
2008
|
+
|
|
2009
|
+
### Standalone function
|
|
2010
|
+
|
|
2011
|
+
The standalone function version of this method:
|
|
2012
|
+
|
|
2013
|
+
```typescript
|
|
2014
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
2015
|
+
import { projectsUnpauseProject } from "@vercel/sdk/funcs/projectsUnpauseProject.js";
|
|
2016
|
+
|
|
2017
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
2018
|
+
// You can create one instance of it to use across an application.
|
|
2019
|
+
const vercel = new VercelCore({
|
|
2020
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
2021
|
+
});
|
|
2022
|
+
|
|
2023
|
+
async function run() {
|
|
2024
|
+
const res = await projectsUnpauseProject(vercel, {
|
|
2025
|
+
projectId: "<id>",
|
|
2026
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
2027
|
+
slug: "my-team-url-slug",
|
|
2028
|
+
});
|
|
2029
|
+
|
|
2030
|
+
if (!res.ok) {
|
|
2031
|
+
throw res.error;
|
|
2032
|
+
}
|
|
2033
|
+
|
|
2034
|
+
const { value: result } = res;
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
}
|
|
2038
|
+
|
|
2039
|
+
run();
|
|
2040
|
+
```
|
|
2041
|
+
|
|
2042
|
+
### Parameters
|
|
2043
|
+
|
|
2044
|
+
| Parameter | Type | Required | Description |
|
|
2045
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2046
|
+
| `request` | [models.UnpauseProjectRequest](../../models/unpauseprojectrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2047
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2048
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2049
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2050
|
+
|
|
2051
|
+
### Response
|
|
2052
|
+
|
|
2053
|
+
**Promise\<void\>**
|
|
2054
|
+
|
|
2055
|
+
### Errors
|
|
2056
|
+
|
|
2057
|
+
| Error Type | Status Code | Content Type |
|
|
2058
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
2059
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
2060
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
1899
2061
|
| models.SDKError | 4XX, 5XX | \*/\* |
|