@vercel/sdk 1.7.0 → 1.7.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 +28 -36
- package/bin/mcp-server.js +2767 -1898
- package/bin/mcp-server.js.map +38 -22
- package/docs/sdks/deployments/README.md +6 -4
- package/docs/sdks/logs/README.md +92 -0
- package/docs/sdks/teams/README.md +2 -2
- package/docs/sdks/vercel/README.md +312 -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 +2 -210
- 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 +0 -142
- 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 -60
- 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 +56 -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/deploymentsGetDeploymentFileContents.d.ts +2 -2
- package/esm/funcs/deploymentsGetDeploymentFileContents.d.ts.map +1 -1
- package/esm/funcs/deploymentsGetDeploymentFileContents.js +2 -3
- package/esm/funcs/deploymentsGetDeploymentFileContents.js.map +1 -1
- 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/logsGetRuntimeLogs.js +97 -0
- 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/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/teamsGetTeam.d.ts +2 -3
- package/esm/funcs/teamsGetTeam.d.ts.map +1 -1
- package/esm/funcs/teamsGetTeam.js +2 -2
- package/esm/funcs/teamsGetTeam.js.map +1 -1
- package/esm/funcs/teamsPatchTeam.d.ts +2 -3
- package/esm/funcs/teamsPatchTeam.d.ts.map +1 -1
- package/esm/funcs/teamsPatchTeam.js +2 -2
- package/esm/funcs/teamsPatchTeam.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 +11 -1
- 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/deploymentsGetDeploymentFileContents.d.ts.map +1 -1
- package/esm/mcp-server/tools/deploymentsGetDeploymentFileContents.js +2 -1
- package/esm/mcp-server/tools/deploymentsGetDeploymentFileContents.js.map +1 -1
- 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/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/createprojectop.d.ts +2 -0
- package/esm/models/createprojectop.d.ts.map +1 -1
- package/esm/models/createprojectop.js +2 -0
- package/esm/models/createprojectop.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/getdeploymentfilecontentsop.d.ts +31 -0
- package/esm/models/getdeploymentfilecontentsop.d.ts.map +1 -1
- package/esm/models/getdeploymentfilecontentsop.js +25 -0
- package/esm/models/getdeploymentfilecontentsop.js.map +1 -1
- package/esm/models/getprojectsop.d.ts +2 -0
- package/esm/models/getprojectsop.d.ts.map +1 -1
- package/esm/models/getprojectsop.js +2 -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/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/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 +14 -14
- 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 +2 -0
- package/esm/models/updateprojectdatacacheop.d.ts.map +1 -1
- package/esm/models/updateprojectdatacacheop.js +2 -0
- package/esm/models/updateprojectdatacacheop.js.map +1 -1
- package/esm/models/updateprojectop.d.ts +2 -0
- package/esm/models/updateprojectop.d.ts.map +1 -1
- package/esm/models/updateprojectop.js +2 -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 +1101 -985
- package/esm/models/userevent.d.ts.map +1 -1
- package/esm/models/userevent.js +1424 -1322
- package/esm/models/userevent.js.map +1 -1
- package/esm/sdk/deployments.d.ts +2 -2
- package/esm/sdk/deployments.d.ts.map +1 -1
- package/esm/sdk/deployments.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 +13 -1
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +21 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/teams.d.ts +3 -6
- package/esm/sdk/teams.d.ts.map +1 -1
- package/esm/sdk/teams.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 +2 -212
- package/src/__tests__/dns.test.ts +0 -10
- package/src/__tests__/domains.test.ts +0 -142
- 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 -60
- package/src/__tests__/user.test.ts +0 -8
- package/src/__tests__/vercel.test.ts +77 -1
- package/src/__tests__/webhooks.test.ts +0 -94
- package/src/funcs/deleteProjectsProjectIdLogsPresetsId.ts +179 -0
- package/src/funcs/deploymentsGetDeploymentFileContents.ts +6 -5
- package/src/funcs/deploymentsUploadFile.ts +5 -0
- package/src/funcs/getProjectsProjectIdLogsPresets.ts +174 -0
- package/src/funcs/logsGetRuntimeLogs.ts +199 -0
- package/src/funcs/patchProjectsProjectIdLogsPresetsId.ts +188 -0
- package/src/funcs/postProjectsProjectIdLogsPresets.ts +174 -0
- package/src/funcs/teamsGetTeam.ts +8 -5
- package/src/funcs/teamsPatchTeam.ts +8 -5
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +11 -1
- package/src/mcp-server/tools/deleteProjectsProjectIdLogsPresetsId.ts +35 -0
- package/src/mcp-server/tools/deploymentsGetDeploymentFileContents.ts +3 -1
- 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/postProjectsProjectIdLogsPresets.ts +37 -0
- package/src/models/authuser.ts +0 -7
- package/src/models/createprojectop.ts +4 -0
- package/src/models/deleteprojectsprojectidlogspresetsidop.ts +89 -0
- package/src/models/getdeploymentfilecontentsop.ts +69 -0
- package/src/models/getprojectsop.ts +4 -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/postprojectsprojectidlogspresetsop.ts +217 -0
- package/src/models/team.ts +156 -0
- package/src/models/teamlimited.ts +8 -8
- package/src/models/updateprojectdatacacheop.ts +4 -0
- package/src/models/updateprojectop.ts +4 -0
- package/src/models/updateprojectprotectionbypassop.ts +4 -0
- package/src/models/uploadfileop.ts +9 -0
- package/src/models/userevent.ts +2498 -2288
- package/src/sdk/deployments.ts +5 -2
- package/src/sdk/logs.ts +30 -0
- package/src/sdk/sdk.ts +61 -1
- package/src/sdk/teams.ts +3 -2
- package/vercel-spec.json +599 -29
|
@@ -691,14 +691,15 @@ const vercel = new Vercel({
|
|
|
691
691
|
});
|
|
692
692
|
|
|
693
693
|
async function run() {
|
|
694
|
-
await vercel.deployments.getDeploymentFileContents({
|
|
694
|
+
const result = await vercel.deployments.getDeploymentFileContents({
|
|
695
695
|
id: "<id>",
|
|
696
696
|
fileId: "<id>",
|
|
697
697
|
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
698
698
|
slug: "my-team-url-slug",
|
|
699
699
|
});
|
|
700
700
|
|
|
701
|
-
|
|
701
|
+
// Handle the result
|
|
702
|
+
console.log(result);
|
|
702
703
|
}
|
|
703
704
|
|
|
704
705
|
run();
|
|
@@ -732,7 +733,8 @@ async function run() {
|
|
|
732
733
|
|
|
733
734
|
const { value: result } = res;
|
|
734
735
|
|
|
735
|
-
|
|
736
|
+
// Handle the result
|
|
737
|
+
console.log(result);
|
|
736
738
|
}
|
|
737
739
|
|
|
738
740
|
run();
|
|
@@ -749,7 +751,7 @@ run();
|
|
|
749
751
|
|
|
750
752
|
### Response
|
|
751
753
|
|
|
752
|
-
**Promise\<
|
|
754
|
+
**Promise\<[models.GetDeploymentFileContentsResponseBody](../../models/getdeploymentfilecontentsresponsebody.md)\>**
|
|
753
755
|
|
|
754
756
|
### Errors
|
|
755
757
|
|
|
@@ -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 | \*/\* |
|
|
@@ -736,7 +736,7 @@ run();
|
|
|
736
736
|
|
|
737
737
|
### Response
|
|
738
738
|
|
|
739
|
-
**Promise\<[
|
|
739
|
+
**Promise\<[models.TeamLimited](../../models/teamlimited.md)\>**
|
|
740
740
|
|
|
741
741
|
### Errors
|
|
742
742
|
|
|
@@ -855,7 +855,7 @@ run();
|
|
|
855
855
|
|
|
856
856
|
### Response
|
|
857
857
|
|
|
858
|
-
**Promise\<[
|
|
858
|
+
**Promise\<[models.TeamLimited](../../models/teamlimited.md)\>**
|
|
859
859
|
|
|
860
860
|
### Errors
|
|
861
861
|
|
|
@@ -5,3 +5,315 @@
|
|
|
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
|
+
* [getProjectsProjectIdLogsPresets](#getprojectsprojectidlogspresets)
|
|
10
|
+
* [postProjectsProjectIdLogsPresets](#postprojectsprojectidlogspresets)
|
|
11
|
+
* [deleteProjectsProjectIdLogsPresetsId](#deleteprojectsprojectidlogspresetsid)
|
|
12
|
+
* [patchProjectsProjectIdLogsPresetsId](#patchprojectsprojectidlogspresetsid)
|
|
13
|
+
|
|
14
|
+
## getProjectsProjectIdLogsPresets
|
|
15
|
+
|
|
16
|
+
### Example Usage
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { Vercel } from "@vercel/sdk";
|
|
20
|
+
|
|
21
|
+
const vercel = new Vercel();
|
|
22
|
+
|
|
23
|
+
async function run() {
|
|
24
|
+
const result = await vercel.getProjectsProjectIdLogsPresets({
|
|
25
|
+
projectId: "<id>",
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
// Handle the result
|
|
29
|
+
console.log(result);
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
run();
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Standalone function
|
|
36
|
+
|
|
37
|
+
The standalone function version of this method:
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
41
|
+
import { getProjectsProjectIdLogsPresets } from "@vercel/sdk/funcs/getProjectsProjectIdLogsPresets.js";
|
|
42
|
+
|
|
43
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
44
|
+
// You can create one instance of it to use across an application.
|
|
45
|
+
const vercel = new VercelCore();
|
|
46
|
+
|
|
47
|
+
async function run() {
|
|
48
|
+
const res = await getProjectsProjectIdLogsPresets(vercel, {
|
|
49
|
+
projectId: "<id>",
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
if (!res.ok) {
|
|
53
|
+
throw res.error;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
const { value: result } = res;
|
|
57
|
+
|
|
58
|
+
// Handle the result
|
|
59
|
+
console.log(result);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
run();
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Parameters
|
|
66
|
+
|
|
67
|
+
| Parameter | Type | Required | Description |
|
|
68
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
69
|
+
| `request` | [models.GetProjectsProjectIdLogsPresetsRequest](../../models/getprojectsprojectidlogspresetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
70
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
71
|
+
| `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. |
|
|
72
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
73
|
+
|
|
74
|
+
### Response
|
|
75
|
+
|
|
76
|
+
**Promise\<[models.Team[]](../../models/.md)\>**
|
|
77
|
+
|
|
78
|
+
### Errors
|
|
79
|
+
|
|
80
|
+
| Error Type | Status Code | Content Type |
|
|
81
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
82
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
83
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
84
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
85
|
+
|
|
86
|
+
## postProjectsProjectIdLogsPresets
|
|
87
|
+
|
|
88
|
+
### Example Usage
|
|
89
|
+
|
|
90
|
+
```typescript
|
|
91
|
+
import { Vercel } from "@vercel/sdk";
|
|
92
|
+
|
|
93
|
+
const vercel = new Vercel();
|
|
94
|
+
|
|
95
|
+
async function run() {
|
|
96
|
+
const result = await vercel.postProjectsProjectIdLogsPresets({
|
|
97
|
+
projectId: "<id>",
|
|
98
|
+
requestBody: {
|
|
99
|
+
query: "timeline=past30Minutes&startDate=1690446214407&endDate=1690448014407&levels=info&domains=vercel.com",
|
|
100
|
+
title: "Request Path",
|
|
101
|
+
group: "team",
|
|
102
|
+
},
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
// Handle the result
|
|
106
|
+
console.log(result);
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
run();
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Standalone function
|
|
113
|
+
|
|
114
|
+
The standalone function version of this method:
|
|
115
|
+
|
|
116
|
+
```typescript
|
|
117
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
118
|
+
import { postProjectsProjectIdLogsPresets } from "@vercel/sdk/funcs/postProjectsProjectIdLogsPresets.js";
|
|
119
|
+
|
|
120
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
121
|
+
// You can create one instance of it to use across an application.
|
|
122
|
+
const vercel = new VercelCore();
|
|
123
|
+
|
|
124
|
+
async function run() {
|
|
125
|
+
const res = await postProjectsProjectIdLogsPresets(vercel, {
|
|
126
|
+
projectId: "<id>",
|
|
127
|
+
requestBody: {
|
|
128
|
+
query: "timeline=past30Minutes&startDate=1690446214407&endDate=1690448014407&levels=info&domains=vercel.com",
|
|
129
|
+
title: "Request Path",
|
|
130
|
+
group: "team",
|
|
131
|
+
},
|
|
132
|
+
});
|
|
133
|
+
|
|
134
|
+
if (!res.ok) {
|
|
135
|
+
throw res.error;
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
const { value: result } = res;
|
|
139
|
+
|
|
140
|
+
// Handle the result
|
|
141
|
+
console.log(result);
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
run();
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Parameters
|
|
148
|
+
|
|
149
|
+
| Parameter | Type | Required | Description |
|
|
150
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
151
|
+
| `request` | [models.PostProjectsProjectIdLogsPresetsRequest](../../models/postprojectsprojectidlogspresetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
152
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
153
|
+
| `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. |
|
|
154
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
155
|
+
|
|
156
|
+
### Response
|
|
157
|
+
|
|
158
|
+
**Promise\<[models.Team](../../models/team.md)\>**
|
|
159
|
+
|
|
160
|
+
### Errors
|
|
161
|
+
|
|
162
|
+
| Error Type | Status Code | Content Type |
|
|
163
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
164
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
165
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
166
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
167
|
+
|
|
168
|
+
## deleteProjectsProjectIdLogsPresetsId
|
|
169
|
+
|
|
170
|
+
### Example Usage
|
|
171
|
+
|
|
172
|
+
```typescript
|
|
173
|
+
import { Vercel } from "@vercel/sdk";
|
|
174
|
+
|
|
175
|
+
const vercel = new Vercel();
|
|
176
|
+
|
|
177
|
+
async function run() {
|
|
178
|
+
await vercel.deleteProjectsProjectIdLogsPresetsId({
|
|
179
|
+
projectId: "<id>",
|
|
180
|
+
id: "<id>",
|
|
181
|
+
});
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
run();
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Standalone function
|
|
190
|
+
|
|
191
|
+
The standalone function version of this method:
|
|
192
|
+
|
|
193
|
+
```typescript
|
|
194
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
195
|
+
import { deleteProjectsProjectIdLogsPresetsId } from "@vercel/sdk/funcs/deleteProjectsProjectIdLogsPresetsId.js";
|
|
196
|
+
|
|
197
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
198
|
+
// You can create one instance of it to use across an application.
|
|
199
|
+
const vercel = new VercelCore();
|
|
200
|
+
|
|
201
|
+
async function run() {
|
|
202
|
+
const res = await deleteProjectsProjectIdLogsPresetsId(vercel, {
|
|
203
|
+
projectId: "<id>",
|
|
204
|
+
id: "<id>",
|
|
205
|
+
});
|
|
206
|
+
|
|
207
|
+
if (!res.ok) {
|
|
208
|
+
throw res.error;
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
const { value: result } = res;
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
run();
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### Parameters
|
|
220
|
+
|
|
221
|
+
| Parameter | Type | Required | Description |
|
|
222
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
223
|
+
| `request` | [models.DeleteProjectsProjectIdLogsPresetsIdRequest](../../models/deleteprojectsprojectidlogspresetsidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
224
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
225
|
+
| `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. |
|
|
226
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
227
|
+
|
|
228
|
+
### Response
|
|
229
|
+
|
|
230
|
+
**Promise\<void\>**
|
|
231
|
+
|
|
232
|
+
### Errors
|
|
233
|
+
|
|
234
|
+
| Error Type | Status Code | Content Type |
|
|
235
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
236
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
237
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
238
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
239
|
+
|
|
240
|
+
## patchProjectsProjectIdLogsPresetsId
|
|
241
|
+
|
|
242
|
+
### Example Usage
|
|
243
|
+
|
|
244
|
+
```typescript
|
|
245
|
+
import { Vercel } from "@vercel/sdk";
|
|
246
|
+
|
|
247
|
+
const vercel = new Vercel();
|
|
248
|
+
|
|
249
|
+
async function run() {
|
|
250
|
+
const result = await vercel.patchProjectsProjectIdLogsPresetsId({
|
|
251
|
+
projectId: "<id>",
|
|
252
|
+
id: "<id>",
|
|
253
|
+
requestBody: {
|
|
254
|
+
title: "Request Path",
|
|
255
|
+
},
|
|
256
|
+
});
|
|
257
|
+
|
|
258
|
+
// Handle the result
|
|
259
|
+
console.log(result);
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
run();
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### Standalone function
|
|
266
|
+
|
|
267
|
+
The standalone function version of this method:
|
|
268
|
+
|
|
269
|
+
```typescript
|
|
270
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
271
|
+
import { patchProjectsProjectIdLogsPresetsId } from "@vercel/sdk/funcs/patchProjectsProjectIdLogsPresetsId.js";
|
|
272
|
+
|
|
273
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
274
|
+
// You can create one instance of it to use across an application.
|
|
275
|
+
const vercel = new VercelCore();
|
|
276
|
+
|
|
277
|
+
async function run() {
|
|
278
|
+
const res = await patchProjectsProjectIdLogsPresetsId(vercel, {
|
|
279
|
+
projectId: "<id>",
|
|
280
|
+
id: "<id>",
|
|
281
|
+
requestBody: {
|
|
282
|
+
title: "Request Path",
|
|
283
|
+
},
|
|
284
|
+
});
|
|
285
|
+
|
|
286
|
+
if (!res.ok) {
|
|
287
|
+
throw res.error;
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
const { value: result } = res;
|
|
291
|
+
|
|
292
|
+
// Handle the result
|
|
293
|
+
console.log(result);
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
run();
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
### Parameters
|
|
300
|
+
|
|
301
|
+
| Parameter | Type | Required | Description |
|
|
302
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
303
|
+
| `request` | [models.PatchProjectsProjectIdLogsPresetsIdRequest](../../models/patchprojectsprojectidlogspresetsidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
304
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
305
|
+
| `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. |
|
|
306
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
307
|
+
|
|
308
|
+
### Response
|
|
309
|
+
|
|
310
|
+
**Promise\<[models.Team](../../models/team.md)\>**
|
|
311
|
+
|
|
312
|
+
### Errors
|
|
313
|
+
|
|
314
|
+
| Error Type | Status Code | Content Type |
|
|
315
|
+
| ---------------------------- | ---------------------------- | ---------------------------- |
|
|
316
|
+
| models.VercelBadRequestError | 400 | application/json |
|
|
317
|
+
| models.VercelForbiddenError | 401 | application/json |
|
|
318
|
+
| models.VercelNotFoundError | 404 | application/json |
|
|
319
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|