@vercel/sdk 1.7.1 → 1.7.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 +40 -31
- package/bin/mcp-server.js +2906 -2077
- package/bin/mcp-server.js.map +41 -25
- package/docs/sdks/domains/README.md +0 -94
- package/docs/sdks/logs/README.md +92 -0
- package/docs/sdks/vercel/README.md +390 -0
- package/esm/__tests__/accessgroups.test.js +0 -144
- package/esm/__tests__/accessgroups.test.js.map +1 -1
- package/esm/__tests__/aliases.test.js +0 -43
- package/esm/__tests__/aliases.test.js.map +1 -1
- package/esm/__tests__/artifacts.test.js +0 -20
- package/esm/__tests__/artifacts.test.js.map +1 -1
- package/esm/__tests__/authentication.test.js +0 -71
- package/esm/__tests__/authentication.test.js.map +1 -1
- package/esm/__tests__/certs.test.js +0 -27
- package/esm/__tests__/certs.test.js.map +1 -1
- package/esm/__tests__/checks.test.js +0 -46
- package/esm/__tests__/checks.test.js.map +1 -1
- package/esm/__tests__/deployments.test.js +0 -209
- package/esm/__tests__/deployments.test.js.map +1 -1
- package/esm/__tests__/dns.test.js +0 -10
- package/esm/__tests__/dns.test.js.map +1 -1
- package/esm/__tests__/domains.test.js +3 -161
- package/esm/__tests__/domains.test.js.map +1 -1
- package/esm/__tests__/edgeconfig.test.js +0 -71
- package/esm/__tests__/edgeconfig.test.js.map +1 -1
- package/esm/__tests__/environment.test.js +0 -34
- package/esm/__tests__/environment.test.js.map +1 -1
- package/esm/__tests__/integrations.test.js +0 -23
- package/esm/__tests__/integrations.test.js.map +1 -1
- package/esm/__tests__/logdrains.test.js +0 -114
- package/esm/__tests__/logdrains.test.js.map +1 -1
- package/esm/__tests__/logs.test.d.ts +2 -0
- package/esm/__tests__/logs.test.d.ts.map +1 -0
- package/esm/__tests__/logs.test.js +22 -0
- package/esm/__tests__/logs.test.js.map +1 -0
- package/esm/__tests__/marketplace.test.js +0 -49
- package/esm/__tests__/marketplace.test.js.map +1 -1
- package/esm/__tests__/projectmembers.test.js +0 -6
- package/esm/__tests__/projectmembers.test.js.map +1 -1
- package/esm/__tests__/projects.test.js +0 -459
- package/esm/__tests__/projects.test.js.map +1 -1
- package/esm/__tests__/security.test.js +0 -274
- package/esm/__tests__/security.test.js.map +1 -1
- package/esm/__tests__/teams.test.js +0 -92
- package/esm/__tests__/teams.test.js.map +1 -1
- package/esm/__tests__/user.test.js +0 -8
- package/esm/__tests__/user.test.js.map +1 -1
- package/esm/__tests__/vercel.test.js +69 -1
- package/esm/__tests__/vercel.test.js.map +1 -1
- package/esm/__tests__/webhooks.test.js +0 -94
- package/esm/__tests__/webhooks.test.js.map +1 -1
- package/esm/funcs/deleteProjectsProjectIdLogsPresetsId.d.ts +12 -0
- package/esm/funcs/deleteProjectsProjectIdLogsPresetsId.d.ts.map +1 -0
- package/esm/funcs/deleteProjectsProjectIdLogsPresetsId.js +80 -0
- package/esm/funcs/deleteProjectsProjectIdLogsPresetsId.js.map +1 -0
- package/esm/funcs/deploymentsUploadFile.js +1 -0
- package/esm/funcs/deploymentsUploadFile.js.map +1 -1
- package/esm/funcs/getProjectsProjectIdLogsPresets.d.ts +13 -0
- package/esm/funcs/getProjectsProjectIdLogsPresets.d.ts.map +1 -0
- package/esm/funcs/getProjectsProjectIdLogsPresets.js +77 -0
- package/esm/funcs/getProjectsProjectIdLogsPresets.js.map +1 -0
- package/esm/funcs/logsGetRuntimeLogs.d.ts +18 -0
- package/esm/funcs/logsGetRuntimeLogs.d.ts.map +1 -0
- package/esm/funcs/{domainsCreateOrTransferDomain.js → logsGetRuntimeLogs.js} +26 -16
- package/esm/funcs/logsGetRuntimeLogs.js.map +1 -0
- package/esm/funcs/patchProjectsProjectIdLogsPresetsId.d.ts +14 -0
- package/esm/funcs/patchProjectsProjectIdLogsPresetsId.d.ts.map +1 -0
- package/esm/funcs/patchProjectsProjectIdLogsPresetsId.js +82 -0
- package/esm/funcs/patchProjectsProjectIdLogsPresetsId.js.map +1 -0
- package/esm/funcs/postDomains.d.ts +13 -0
- package/esm/funcs/postDomains.d.ts.map +1 -0
- package/esm/funcs/postDomains.js +73 -0
- package/esm/funcs/postDomains.js.map +1 -0
- package/esm/funcs/postProjectsProjectIdLogsPresets.d.ts +13 -0
- package/esm/funcs/postProjectsProjectIdLogsPresets.d.ts.map +1 -0
- package/esm/funcs/postProjectsProjectIdLogsPresets.js +77 -0
- package/esm/funcs/postProjectsProjectIdLogsPresets.js.map +1 -0
- package/esm/funcs/projectsRequestPromote.js +1 -0
- package/esm/funcs/projectsRequestPromote.js.map +1 -1
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/lib/config.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 +13 -3
- package/esm/mcp-server/server.js.map +1 -1
- package/esm/mcp-server/tools/deleteProjectsProjectIdLogsPresetsId.d.ts +7 -0
- package/esm/mcp-server/tools/deleteProjectsProjectIdLogsPresetsId.d.ts.map +1 -0
- package/esm/mcp-server/tools/deleteProjectsProjectIdLogsPresetsId.js +25 -0
- package/esm/mcp-server/tools/deleteProjectsProjectIdLogsPresetsId.js.map +1 -0
- package/esm/mcp-server/tools/getProjectsProjectIdLogsPresets.d.ts +7 -0
- package/esm/mcp-server/tools/getProjectsProjectIdLogsPresets.d.ts.map +1 -0
- package/esm/mcp-server/tools/getProjectsProjectIdLogsPresets.js +26 -0
- package/esm/mcp-server/tools/getProjectsProjectIdLogsPresets.js.map +1 -0
- package/esm/mcp-server/tools/logsGetRuntimeLogs.d.ts +7 -0
- package/esm/mcp-server/tools/logsGetRuntimeLogs.d.ts.map +1 -0
- package/esm/mcp-server/tools/logsGetRuntimeLogs.js +28 -0
- package/esm/mcp-server/tools/logsGetRuntimeLogs.js.map +1 -0
- package/esm/mcp-server/tools/patchProjectsProjectIdLogsPresetsId.d.ts +7 -0
- package/esm/mcp-server/tools/patchProjectsProjectIdLogsPresetsId.d.ts.map +1 -0
- package/esm/mcp-server/tools/patchProjectsProjectIdLogsPresetsId.js +26 -0
- package/esm/mcp-server/tools/patchProjectsProjectIdLogsPresetsId.js.map +1 -0
- package/esm/mcp-server/tools/postDomains.d.ts +7 -0
- package/esm/mcp-server/tools/postDomains.d.ts.map +1 -0
- package/esm/mcp-server/tools/postDomains.js +26 -0
- package/esm/mcp-server/tools/postDomains.js.map +1 -0
- package/esm/mcp-server/tools/postProjectsProjectIdLogsPresets.d.ts +7 -0
- package/esm/mcp-server/tools/postProjectsProjectIdLogsPresets.d.ts.map +1 -0
- package/esm/mcp-server/tools/postProjectsProjectIdLogsPresets.js +26 -0
- package/esm/mcp-server/tools/postProjectsProjectIdLogsPresets.js.map +1 -0
- package/esm/models/authuser.d.ts +0 -5
- package/esm/models/authuser.d.ts.map +1 -1
- package/esm/models/authuser.js +0 -2
- package/esm/models/authuser.js.map +1 -1
- package/esm/models/createdeploymentop.d.ts +28 -28
- package/esm/models/createdeploymentop.d.ts.map +1 -1
- package/esm/models/createdeploymentop.js +12 -12
- package/esm/models/createdeploymentop.js.map +1 -1
- package/esm/models/createprojectop.d.ts +4 -0
- package/esm/models/createprojectop.d.ts.map +1 -1
- package/esm/models/createprojectop.js +4 -0
- package/esm/models/createprojectop.js.map +1 -1
- package/esm/models/createrecordop.d.ts +43 -43
- package/esm/models/createrecordop.d.ts.map +1 -1
- package/esm/models/createrecordop.js +51 -51
- package/esm/models/createrecordop.js.map +1 -1
- package/esm/models/deleteprojectsprojectidlogspresetsidop.d.ts +37 -0
- package/esm/models/deleteprojectsprojectidlogspresetsidop.d.ts.map +1 -0
- package/esm/models/deleteprojectsprojectidlogspresetsidop.js +33 -0
- package/esm/models/deleteprojectsprojectidlogspresetsidop.js.map +1 -0
- package/esm/models/getdomainop.d.ts +8 -8
- package/esm/models/getdomainop.d.ts.map +1 -1
- package/esm/models/getdomainop.js +12 -13
- package/esm/models/getdomainop.js.map +1 -1
- package/esm/models/getprojectsop.d.ts +4 -0
- package/esm/models/getprojectsop.d.ts.map +1 -1
- package/esm/models/getprojectsop.js +4 -0
- package/esm/models/getprojectsop.js.map +1 -1
- package/esm/models/getprojectsprojectidlogspresetsop.d.ts +29 -0
- package/esm/models/getprojectsprojectidlogspresetsop.d.ts.map +1 -0
- package/esm/models/getprojectsprojectidlogspresetsop.js +31 -0
- package/esm/models/getprojectsprojectidlogspresetsop.js.map +1 -0
- package/esm/models/getruntimelogsop.d.ts +147 -0
- package/esm/models/getruntimelogsop.d.ts.map +1 -0
- package/esm/models/getruntimelogsop.js +122 -0
- package/esm/models/getruntimelogsop.js.map +1 -0
- package/esm/models/getteamsop.d.ts +5 -12
- package/esm/models/getteamsop.d.ts.map +1 -1
- package/esm/models/getteamsop.js +5 -4
- package/esm/models/getteamsop.js.map +1 -1
- package/esm/models/patchprojectsprojectidlogspresetsidop.d.ts +67 -0
- package/esm/models/patchprojectsprojectidlogspresetsidop.d.ts.map +1 -0
- package/esm/models/patchprojectsprojectidlogspresetsidop.js +69 -0
- package/esm/models/patchprojectsprojectidlogspresetsidop.js.map +1 -0
- package/esm/models/postdomainsop.d.ts +353 -0
- package/esm/models/postdomainsop.d.ts.map +1 -0
- package/esm/models/postdomainsop.js +265 -0
- package/esm/models/postdomainsop.js.map +1 -0
- package/esm/models/postprojectsprojectidlogspresetsop.d.ts +95 -0
- package/esm/models/postprojectsprojectidlogspresetsop.d.ts.map +1 -0
- package/esm/models/postprojectsprojectidlogspresetsop.js +90 -0
- package/esm/models/postprojectsprojectidlogspresetsop.js.map +1 -0
- package/esm/models/requestpromoteop.d.ts +5 -0
- package/esm/models/requestpromoteop.d.ts.map +1 -1
- package/esm/models/requestpromoteop.js +2 -0
- package/esm/models/requestpromoteop.js.map +1 -1
- package/esm/models/team.d.ts +78 -0
- package/esm/models/team.d.ts.map +1 -0
- package/esm/models/team.js +80 -0
- package/esm/models/team.js.map +1 -0
- package/esm/models/teamlimited.d.ts +13 -13
- package/esm/models/teamlimited.d.ts.map +1 -1
- package/esm/models/teamlimited.js +6 -6
- package/esm/models/teamlimited.js.map +1 -1
- package/esm/models/updateprojectdatacacheop.d.ts +4 -0
- package/esm/models/updateprojectdatacacheop.d.ts.map +1 -1
- package/esm/models/updateprojectdatacacheop.js +4 -0
- package/esm/models/updateprojectdatacacheop.js.map +1 -1
- package/esm/models/updateprojectop.d.ts +4 -0
- package/esm/models/updateprojectop.d.ts.map +1 -1
- package/esm/models/updateprojectop.js +4 -0
- package/esm/models/updateprojectop.js.map +1 -1
- package/esm/models/updateprojectprotectionbypassop.d.ts +2 -0
- package/esm/models/updateprojectprotectionbypassop.d.ts.map +1 -1
- package/esm/models/updateprojectprotectionbypassop.js +2 -0
- package/esm/models/updateprojectprotectionbypassop.js.map +1 -1
- package/esm/models/uploadfileop.d.ts +5 -0
- package/esm/models/uploadfileop.d.ts.map +1 -1
- package/esm/models/uploadfileop.js +4 -0
- package/esm/models/uploadfileop.js.map +1 -1
- package/esm/models/userevent.d.ts +1104 -983
- package/esm/models/userevent.d.ts.map +1 -1
- package/esm/models/userevent.js +1426 -1322
- package/esm/models/userevent.js.map +1 -1
- package/esm/sdk/domains.d.ts +0 -8
- package/esm/sdk/domains.d.ts.map +1 -1
- package/esm/sdk/domains.js +0 -10
- package/esm/sdk/domains.js.map +1 -1
- package/esm/sdk/logs.d.ts +12 -0
- package/esm/sdk/logs.d.ts.map +1 -0
- package/esm/sdk/logs.js +18 -0
- package/esm/sdk/logs.js.map +1 -0
- package/esm/sdk/sdk.d.ts +15 -1
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +25 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/__tests__/accessgroups.test.ts +0 -144
- package/src/__tests__/aliases.test.ts +0 -43
- package/src/__tests__/artifacts.test.ts +0 -22
- package/src/__tests__/authentication.test.ts +0 -71
- package/src/__tests__/certs.test.ts +0 -27
- package/src/__tests__/checks.test.ts +0 -46
- package/src/__tests__/deployments.test.ts +0 -211
- package/src/__tests__/dns.test.ts +0 -10
- package/src/__tests__/domains.test.ts +5 -163
- package/src/__tests__/edgeconfig.test.ts +0 -71
- package/src/__tests__/environment.test.ts +0 -34
- package/src/__tests__/integrations.test.ts +0 -23
- package/src/__tests__/logdrains.test.ts +0 -114
- package/src/__tests__/logs.test.ts +25 -0
- package/src/__tests__/marketplace.test.ts +0 -49
- package/src/__tests__/projectmembers.test.ts +0 -6
- package/src/__tests__/projects.test.ts +0 -459
- package/src/__tests__/security.test.ts +0 -274
- package/src/__tests__/teams.test.ts +0 -92
- package/src/__tests__/user.test.ts +0 -8
- package/src/__tests__/vercel.test.ts +93 -1
- package/src/__tests__/webhooks.test.ts +0 -94
- package/src/funcs/deleteProjectsProjectIdLogsPresetsId.ts +179 -0
- package/src/funcs/deploymentsUploadFile.ts +5 -0
- package/src/funcs/getProjectsProjectIdLogsPresets.ts +174 -0
- package/src/funcs/{domainsCreateOrTransferDomain.ts → logsGetRuntimeLogs.ts} +39 -33
- package/src/funcs/patchProjectsProjectIdLogsPresetsId.ts +188 -0
- package/src/funcs/postDomains.ts +177 -0
- package/src/funcs/postProjectsProjectIdLogsPresets.ts +174 -0
- package/src/funcs/projectsRequestPromote.ts +1 -0
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +13 -3
- package/src/mcp-server/tools/deleteProjectsProjectIdLogsPresetsId.ts +35 -0
- package/src/mcp-server/tools/getProjectsProjectIdLogsPresets.ts +36 -0
- package/src/mcp-server/tools/logsGetRuntimeLogs.ts +37 -0
- package/src/mcp-server/tools/patchProjectsProjectIdLogsPresetsId.ts +37 -0
- package/src/mcp-server/tools/postDomains.ts +35 -0
- package/src/mcp-server/tools/postProjectsProjectIdLogsPresets.ts +37 -0
- package/src/models/authuser.ts +0 -7
- package/src/models/createdeploymentop.ts +16 -16
- package/src/models/createprojectop.ts +8 -0
- package/src/models/createrecordop.ts +96 -84
- package/src/models/deleteprojectsprojectidlogspresetsidop.ts +89 -0
- package/src/models/getdomainop.ts +16 -14
- package/src/models/getprojectsop.ts +8 -0
- package/src/models/getprojectsprojectidlogspresetsop.ts +72 -0
- package/src/models/getruntimelogsop.ts +237 -0
- package/src/models/getteamsop.ts +14 -10
- package/src/models/patchprojectsprojectidlogspresetsidop.ts +180 -0
- package/src/models/postdomainsop.ts +637 -0
- package/src/models/postprojectsprojectidlogspresetsop.ts +217 -0
- package/src/models/requestpromoteop.ts +7 -0
- package/src/models/team.ts +156 -0
- package/src/models/teamlimited.ts +13 -13
- package/src/models/updateprojectdatacacheop.ts +8 -0
- package/src/models/updateprojectop.ts +8 -0
- package/src/models/updateprojectprotectionbypassop.ts +4 -0
- package/src/models/uploadfileop.ts +9 -0
- package/src/models/userevent.ts +2504 -2287
- package/src/sdk/domains.ts +0 -22
- package/src/sdk/logs.ts +30 -0
- package/src/sdk/sdk.ts +77 -1
- package/vercel-spec.json +874 -309
- package/esm/funcs/domainsCreateOrTransferDomain.d.ts +0 -19
- package/esm/funcs/domainsCreateOrTransferDomain.d.ts.map +0 -1
- package/esm/funcs/domainsCreateOrTransferDomain.js.map +0 -1
- package/esm/mcp-server/tools/domainsCreateOrTransferDomain.d.ts +0 -7
- package/esm/mcp-server/tools/domainsCreateOrTransferDomain.d.ts.map +0 -1
- package/esm/mcp-server/tools/domainsCreateOrTransferDomain.js +0 -28
- package/esm/mcp-server/tools/domainsCreateOrTransferDomain.js.map +0 -1
- package/esm/models/createortransferdomainop.d.ts +0 -388
- package/esm/models/createortransferdomainop.d.ts.map +0 -1
- package/esm/models/createortransferdomainop.js +0 -310
- package/esm/models/createortransferdomainop.js.map +0 -1
- package/src/mcp-server/tools/domainsCreateOrTransferDomain.ts +0 -37
- package/src/models/createortransferdomainop.ts +0 -777
|
@@ -12,7 +12,6 @@
|
|
|
12
12
|
* [getDomainConfig](#getdomainconfig) - Get a Domain's configuration
|
|
13
13
|
* [getDomain](#getdomain) - Get Information for a Single Domain
|
|
14
14
|
* [getDomains](#getdomains) - List all the domains
|
|
15
|
-
* [createOrTransferDomain](#createortransferdomain) - Register or transfer-in a new Domain
|
|
16
15
|
* [patchDomain](#patchdomain) - Update or move apex domain
|
|
17
16
|
* [deleteDomain](#deletedomain) - Remove a domain by name
|
|
18
17
|
|
|
@@ -626,99 +625,6 @@ run();
|
|
|
626
625
|
| models.VercelForbiddenError | 401 | application/json |
|
|
627
626
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
628
627
|
|
|
629
|
-
## createOrTransferDomain
|
|
630
|
-
|
|
631
|
-
This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Can also be used for initiating a domain transfer request from an external Registrar to Vercel.
|
|
632
|
-
|
|
633
|
-
### Example Usage
|
|
634
|
-
|
|
635
|
-
```typescript
|
|
636
|
-
import { Vercel } from "@vercel/sdk";
|
|
637
|
-
|
|
638
|
-
const vercel = new Vercel({
|
|
639
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
640
|
-
});
|
|
641
|
-
|
|
642
|
-
async function run() {
|
|
643
|
-
const result = await vercel.domains.createOrTransferDomain({
|
|
644
|
-
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
645
|
-
slug: "my-team-url-slug",
|
|
646
|
-
requestBody: {
|
|
647
|
-
name: "example.com",
|
|
648
|
-
method: "transfer-in",
|
|
649
|
-
authCode: "fdhfr820ad#@FAdlj$$",
|
|
650
|
-
expectedPrice: 8,
|
|
651
|
-
},
|
|
652
|
-
});
|
|
653
|
-
|
|
654
|
-
// Handle the result
|
|
655
|
-
console.log(result);
|
|
656
|
-
}
|
|
657
|
-
|
|
658
|
-
run();
|
|
659
|
-
```
|
|
660
|
-
|
|
661
|
-
### Standalone function
|
|
662
|
-
|
|
663
|
-
The standalone function version of this method:
|
|
664
|
-
|
|
665
|
-
```typescript
|
|
666
|
-
import { VercelCore } from "@vercel/sdk/core.js";
|
|
667
|
-
import { domainsCreateOrTransferDomain } from "@vercel/sdk/funcs/domainsCreateOrTransferDomain.js";
|
|
668
|
-
|
|
669
|
-
// Use `VercelCore` for best tree-shaking performance.
|
|
670
|
-
// You can create one instance of it to use across an application.
|
|
671
|
-
const vercel = new VercelCore({
|
|
672
|
-
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
673
|
-
});
|
|
674
|
-
|
|
675
|
-
async function run() {
|
|
676
|
-
const res = await domainsCreateOrTransferDomain(vercel, {
|
|
677
|
-
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
678
|
-
slug: "my-team-url-slug",
|
|
679
|
-
requestBody: {
|
|
680
|
-
name: "example.com",
|
|
681
|
-
method: "transfer-in",
|
|
682
|
-
authCode: "fdhfr820ad#@FAdlj$$",
|
|
683
|
-
expectedPrice: 8,
|
|
684
|
-
},
|
|
685
|
-
});
|
|
686
|
-
|
|
687
|
-
if (!res.ok) {
|
|
688
|
-
throw res.error;
|
|
689
|
-
}
|
|
690
|
-
|
|
691
|
-
const { value: result } = res;
|
|
692
|
-
|
|
693
|
-
// Handle the result
|
|
694
|
-
console.log(result);
|
|
695
|
-
}
|
|
696
|
-
|
|
697
|
-
run();
|
|
698
|
-
```
|
|
699
|
-
|
|
700
|
-
### Parameters
|
|
701
|
-
|
|
702
|
-
| Parameter | Type | Required | Description |
|
|
703
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
704
|
-
| `request` | [models.CreateOrTransferDomainRequest](../../models/createortransferdomainrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
705
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
706
|
-
| `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. |
|
|
707
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
708
|
-
|
|
709
|
-
### Response
|
|
710
|
-
|
|
711
|
-
**Promise\<[models.CreateOrTransferDomainResponseBody](../../models/createortransferdomainresponsebody.md)\>**
|
|
712
|
-
|
|
713
|
-
### Errors
|
|
714
|
-
|
|
715
|
-
| Error Type | Status Code | Content Type |
|
|
716
|
-
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
717
|
-
| models.VercelBadRequestError | 400 | application/json |
|
|
718
|
-
| models.VercelForbiddenError | 401 | application/json |
|
|
719
|
-
| models.VercelNotFoundError | 404 | application/json |
|
|
720
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
721
|
-
|
|
722
628
|
## patchDomain
|
|
723
629
|
|
|
724
630
|
Update or move apex domain.
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Logs
|
|
2
|
+
(*logs*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [getRuntimeLogs](#getruntimelogs) - Get logs for a deployment
|
|
9
|
+
|
|
10
|
+
## getRuntimeLogs
|
|
11
|
+
|
|
12
|
+
Returns a stream of logs for a given deployment.
|
|
13
|
+
|
|
14
|
+
### Example Usage
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { Vercel } from "@vercel/sdk";
|
|
18
|
+
|
|
19
|
+
const vercel = new Vercel({
|
|
20
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
async function run() {
|
|
24
|
+
const result = await vercel.logs.getRuntimeLogs({
|
|
25
|
+
projectId: "<id>",
|
|
26
|
+
deploymentId: "<id>",
|
|
27
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
28
|
+
slug: "my-team-url-slug",
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
// Handle the result
|
|
32
|
+
console.log(result);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
run();
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Standalone function
|
|
39
|
+
|
|
40
|
+
The standalone function version of this method:
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
44
|
+
import { logsGetRuntimeLogs } from "@vercel/sdk/funcs/logsGetRuntimeLogs.js";
|
|
45
|
+
|
|
46
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
47
|
+
// You can create one instance of it to use across an application.
|
|
48
|
+
const vercel = new VercelCore({
|
|
49
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
async function run() {
|
|
53
|
+
const res = await logsGetRuntimeLogs(vercel, {
|
|
54
|
+
projectId: "<id>",
|
|
55
|
+
deploymentId: "<id>",
|
|
56
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
57
|
+
slug: "my-team-url-slug",
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
if (!res.ok) {
|
|
61
|
+
throw res.error;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
const { value: result } = res;
|
|
65
|
+
|
|
66
|
+
// Handle the result
|
|
67
|
+
console.log(result);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
run();
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Parameters
|
|
74
|
+
|
|
75
|
+
| Parameter | Type | Required | Description |
|
|
76
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
77
|
+
| `request` | [models.GetRuntimeLogsRequest](../../models/getruntimelogsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
78
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
79
|
+
| `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. |
|
|
80
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
81
|
+
|
|
82
|
+
### Response
|
|
83
|
+
|
|
84
|
+
**Promise\<[models.GetRuntimeLogsResponseBody](../../models/getruntimelogsresponsebody.md)\>**
|
|
85
|
+
|
|
86
|
+
### Errors
|
|
87
|
+
|
|
88
|
+
| Error Type | Status Code | Content Type |
|
|
89
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
90
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
91
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
92
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -5,3 +5,393 @@
|
|
|
5
5
|
Vercel SDK: The [`@vercel/sdk`](https://www.npmjs.com/package/@vercel/sdk) is a type-safe Typescript SDK that allows you to access the resources and methods of the Vercel REST API. Learn how to [install it](https://vercel.com/docs/rest-api/sdk#installing-vercel-sdk) and [authenticate](https://vercel.com/docs/rest-api/sdk#authentication) with a Vercel access token.
|
|
6
6
|
|
|
7
7
|
### Available Operations
|
|
8
|
+
|
|
9
|
+
* [postDomains](#postdomains)
|
|
10
|
+
* [getProjectsProjectIdLogsPresets](#getprojectsprojectidlogspresets)
|
|
11
|
+
* [postProjectsProjectIdLogsPresets](#postprojectsprojectidlogspresets)
|
|
12
|
+
* [deleteProjectsProjectIdLogsPresetsId](#deleteprojectsprojectidlogspresetsid)
|
|
13
|
+
* [patchProjectsProjectIdLogsPresetsId](#patchprojectsprojectidlogspresetsid)
|
|
14
|
+
|
|
15
|
+
## postDomains
|
|
16
|
+
|
|
17
|
+
### Example Usage
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { Vercel } from "@vercel/sdk";
|
|
21
|
+
|
|
22
|
+
const vercel = new Vercel();
|
|
23
|
+
|
|
24
|
+
async function run() {
|
|
25
|
+
const result = await vercel.postDomains({
|
|
26
|
+
name: "example.com",
|
|
27
|
+
cdnEnabled: true,
|
|
28
|
+
method: "transfer-in",
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
// Handle the result
|
|
32
|
+
console.log(result);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
run();
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Standalone function
|
|
39
|
+
|
|
40
|
+
The standalone function version of this method:
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
44
|
+
import { postDomains } from "@vercel/sdk/funcs/postDomains.js";
|
|
45
|
+
|
|
46
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
47
|
+
// You can create one instance of it to use across an application.
|
|
48
|
+
const vercel = new VercelCore();
|
|
49
|
+
|
|
50
|
+
async function run() {
|
|
51
|
+
const res = await postDomains(vercel, {
|
|
52
|
+
name: "example.com",
|
|
53
|
+
cdnEnabled: true,
|
|
54
|
+
method: "transfer-in",
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
if (!res.ok) {
|
|
58
|
+
throw res.error;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
const { value: result } = res;
|
|
62
|
+
|
|
63
|
+
// Handle the result
|
|
64
|
+
console.log(result);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
run();
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Parameters
|
|
71
|
+
|
|
72
|
+
| Parameter | Type | Required | Description |
|
|
73
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
74
|
+
| `request` | [models.PostDomainsRequestBody](../../models/postdomainsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
75
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
76
|
+
| `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. |
|
|
77
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
78
|
+
|
|
79
|
+
### Response
|
|
80
|
+
|
|
81
|
+
**Promise\<[models.PostDomainsResponseBody](../../models/postdomainsresponsebody.md)\>**
|
|
82
|
+
|
|
83
|
+
### Errors
|
|
84
|
+
|
|
85
|
+
| Error Type | Status Code | Content Type |
|
|
86
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
87
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
88
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
89
|
+
| models.VercelNotFoundError | 404 | application/json |
|
|
90
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
91
|
+
|
|
92
|
+
## getProjectsProjectIdLogsPresets
|
|
93
|
+
|
|
94
|
+
### Example Usage
|
|
95
|
+
|
|
96
|
+
```typescript
|
|
97
|
+
import { Vercel } from "@vercel/sdk";
|
|
98
|
+
|
|
99
|
+
const vercel = new Vercel();
|
|
100
|
+
|
|
101
|
+
async function run() {
|
|
102
|
+
const result = await vercel.getProjectsProjectIdLogsPresets({
|
|
103
|
+
projectId: "<id>",
|
|
104
|
+
});
|
|
105
|
+
|
|
106
|
+
// Handle the result
|
|
107
|
+
console.log(result);
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
run();
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Standalone function
|
|
114
|
+
|
|
115
|
+
The standalone function version of this method:
|
|
116
|
+
|
|
117
|
+
```typescript
|
|
118
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
119
|
+
import { getProjectsProjectIdLogsPresets } from "@vercel/sdk/funcs/getProjectsProjectIdLogsPresets.js";
|
|
120
|
+
|
|
121
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
122
|
+
// You can create one instance of it to use across an application.
|
|
123
|
+
const vercel = new VercelCore();
|
|
124
|
+
|
|
125
|
+
async function run() {
|
|
126
|
+
const res = await getProjectsProjectIdLogsPresets(vercel, {
|
|
127
|
+
projectId: "<id>",
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
if (!res.ok) {
|
|
131
|
+
throw res.error;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
const { value: result } = res;
|
|
135
|
+
|
|
136
|
+
// Handle the result
|
|
137
|
+
console.log(result);
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
run();
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
|
|
145
|
+
| Parameter | Type | Required | Description |
|
|
146
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
147
|
+
| `request` | [models.GetProjectsProjectIdLogsPresetsRequest](../../models/getprojectsprojectidlogspresetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
148
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
149
|
+
| `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. |
|
|
150
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
151
|
+
|
|
152
|
+
### Response
|
|
153
|
+
|
|
154
|
+
**Promise\<[models.Team[]](../../models/.md)\>**
|
|
155
|
+
|
|
156
|
+
### Errors
|
|
157
|
+
|
|
158
|
+
| Error Type | Status Code | Content Type |
|
|
159
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
160
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
161
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
162
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
163
|
+
|
|
164
|
+
## postProjectsProjectIdLogsPresets
|
|
165
|
+
|
|
166
|
+
### Example Usage
|
|
167
|
+
|
|
168
|
+
```typescript
|
|
169
|
+
import { Vercel } from "@vercel/sdk";
|
|
170
|
+
|
|
171
|
+
const vercel = new Vercel();
|
|
172
|
+
|
|
173
|
+
async function run() {
|
|
174
|
+
const result = await vercel.postProjectsProjectIdLogsPresets({
|
|
175
|
+
projectId: "<id>",
|
|
176
|
+
requestBody: {
|
|
177
|
+
query: "timeline=past30Minutes&startDate=1690446214407&endDate=1690448014407&levels=info&domains=vercel.com",
|
|
178
|
+
title: "Request Path",
|
|
179
|
+
group: "team",
|
|
180
|
+
},
|
|
181
|
+
});
|
|
182
|
+
|
|
183
|
+
// Handle the result
|
|
184
|
+
console.log(result);
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
run();
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### Standalone function
|
|
191
|
+
|
|
192
|
+
The standalone function version of this method:
|
|
193
|
+
|
|
194
|
+
```typescript
|
|
195
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
196
|
+
import { postProjectsProjectIdLogsPresets } from "@vercel/sdk/funcs/postProjectsProjectIdLogsPresets.js";
|
|
197
|
+
|
|
198
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
199
|
+
// You can create one instance of it to use across an application.
|
|
200
|
+
const vercel = new VercelCore();
|
|
201
|
+
|
|
202
|
+
async function run() {
|
|
203
|
+
const res = await postProjectsProjectIdLogsPresets(vercel, {
|
|
204
|
+
projectId: "<id>",
|
|
205
|
+
requestBody: {
|
|
206
|
+
query: "timeline=past30Minutes&startDate=1690446214407&endDate=1690448014407&levels=info&domains=vercel.com",
|
|
207
|
+
title: "Request Path",
|
|
208
|
+
group: "team",
|
|
209
|
+
},
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
if (!res.ok) {
|
|
213
|
+
throw res.error;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
const { value: result } = res;
|
|
217
|
+
|
|
218
|
+
// Handle the result
|
|
219
|
+
console.log(result);
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
run();
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Parameters
|
|
226
|
+
|
|
227
|
+
| Parameter | Type | Required | Description |
|
|
228
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
229
|
+
| `request` | [models.PostProjectsProjectIdLogsPresetsRequest](../../models/postprojectsprojectidlogspresetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
230
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
231
|
+
| `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. |
|
|
232
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
233
|
+
|
|
234
|
+
### Response
|
|
235
|
+
|
|
236
|
+
**Promise\<[models.Team](../../models/team.md)\>**
|
|
237
|
+
|
|
238
|
+
### Errors
|
|
239
|
+
|
|
240
|
+
| Error Type | Status Code | Content Type |
|
|
241
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
242
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
243
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
244
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
245
|
+
|
|
246
|
+
## deleteProjectsProjectIdLogsPresetsId
|
|
247
|
+
|
|
248
|
+
### Example Usage
|
|
249
|
+
|
|
250
|
+
```typescript
|
|
251
|
+
import { Vercel } from "@vercel/sdk";
|
|
252
|
+
|
|
253
|
+
const vercel = new Vercel();
|
|
254
|
+
|
|
255
|
+
async function run() {
|
|
256
|
+
await vercel.deleteProjectsProjectIdLogsPresetsId({
|
|
257
|
+
projectId: "<id>",
|
|
258
|
+
id: "<id>",
|
|
259
|
+
});
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
run();
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
### Standalone function
|
|
268
|
+
|
|
269
|
+
The standalone function version of this method:
|
|
270
|
+
|
|
271
|
+
```typescript
|
|
272
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
273
|
+
import { deleteProjectsProjectIdLogsPresetsId } from "@vercel/sdk/funcs/deleteProjectsProjectIdLogsPresetsId.js";
|
|
274
|
+
|
|
275
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
276
|
+
// You can create one instance of it to use across an application.
|
|
277
|
+
const vercel = new VercelCore();
|
|
278
|
+
|
|
279
|
+
async function run() {
|
|
280
|
+
const res = await deleteProjectsProjectIdLogsPresetsId(vercel, {
|
|
281
|
+
projectId: "<id>",
|
|
282
|
+
id: "<id>",
|
|
283
|
+
});
|
|
284
|
+
|
|
285
|
+
if (!res.ok) {
|
|
286
|
+
throw res.error;
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
const { value: result } = res;
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
run();
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### Parameters
|
|
298
|
+
|
|
299
|
+
| Parameter | Type | Required | Description |
|
|
300
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
301
|
+
| `request` | [models.DeleteProjectsProjectIdLogsPresetsIdRequest](../../models/deleteprojectsprojectidlogspresetsidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
302
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
303
|
+
| `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. |
|
|
304
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
305
|
+
|
|
306
|
+
### Response
|
|
307
|
+
|
|
308
|
+
**Promise\<void\>**
|
|
309
|
+
|
|
310
|
+
### Errors
|
|
311
|
+
|
|
312
|
+
| Error Type | Status Code | Content Type |
|
|
313
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
314
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
315
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
316
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
317
|
+
|
|
318
|
+
## patchProjectsProjectIdLogsPresetsId
|
|
319
|
+
|
|
320
|
+
### Example Usage
|
|
321
|
+
|
|
322
|
+
```typescript
|
|
323
|
+
import { Vercel } from "@vercel/sdk";
|
|
324
|
+
|
|
325
|
+
const vercel = new Vercel();
|
|
326
|
+
|
|
327
|
+
async function run() {
|
|
328
|
+
const result = await vercel.patchProjectsProjectIdLogsPresetsId({
|
|
329
|
+
projectId: "<id>",
|
|
330
|
+
id: "<id>",
|
|
331
|
+
requestBody: {
|
|
332
|
+
title: "Request Path",
|
|
333
|
+
},
|
|
334
|
+
});
|
|
335
|
+
|
|
336
|
+
// Handle the result
|
|
337
|
+
console.log(result);
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
run();
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### Standalone function
|
|
344
|
+
|
|
345
|
+
The standalone function version of this method:
|
|
346
|
+
|
|
347
|
+
```typescript
|
|
348
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
349
|
+
import { patchProjectsProjectIdLogsPresetsId } from "@vercel/sdk/funcs/patchProjectsProjectIdLogsPresetsId.js";
|
|
350
|
+
|
|
351
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
352
|
+
// You can create one instance of it to use across an application.
|
|
353
|
+
const vercel = new VercelCore();
|
|
354
|
+
|
|
355
|
+
async function run() {
|
|
356
|
+
const res = await patchProjectsProjectIdLogsPresetsId(vercel, {
|
|
357
|
+
projectId: "<id>",
|
|
358
|
+
id: "<id>",
|
|
359
|
+
requestBody: {
|
|
360
|
+
title: "Request Path",
|
|
361
|
+
},
|
|
362
|
+
});
|
|
363
|
+
|
|
364
|
+
if (!res.ok) {
|
|
365
|
+
throw res.error;
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
const { value: result } = res;
|
|
369
|
+
|
|
370
|
+
// Handle the result
|
|
371
|
+
console.log(result);
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
run();
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### Parameters
|
|
378
|
+
|
|
379
|
+
| Parameter | Type | Required | Description |
|
|
380
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
381
|
+
| `request` | [models.PatchProjectsProjectIdLogsPresetsIdRequest](../../models/patchprojectsprojectidlogspresetsidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
382
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
383
|
+
| `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. |
|
|
384
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
385
|
+
|
|
386
|
+
### Response
|
|
387
|
+
|
|
388
|
+
**Promise\<[models.Team](../../models/team.md)\>**
|
|
389
|
+
|
|
390
|
+
### Errors
|
|
391
|
+
|
|
392
|
+
| Error Type | Status Code | Content Type |
|
|
393
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
394
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
395
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
396
|
+
| models.VercelNotFoundError | 404 | application/json |
|
|
397
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|