vercel-api-js 1.0.0 → 1.0.1
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/dist/client.d.mts +182 -182
- package/dist/client.d.ts +182 -182
- package/dist/generated/components.d.mts +664 -664
- package/dist/generated/components.d.ts +664 -664
- package/dist/generated/components.js +1071 -801
- package/dist/generated/components.mjs +1071 -801
- package/dist/generated/mcp.d.mts +2061 -0
- package/dist/generated/mcp.d.ts +2061 -0
- package/dist/generated/mcp.js +4692 -0
- package/dist/generated/mcp.mjs +4508 -0
- package/dist/generated/schemas.d.mts +14785 -1918
- package/dist/generated/schemas.d.ts +14785 -1918
- package/dist/generated/schemas.js +1501 -989
- package/dist/generated/schemas.mjs +1501 -989
- package/dist/generated/types.d.mts +11 -2
- package/dist/generated/types.d.ts +11 -2
- package/dist/generated/types.js +133 -132
- package/dist/generated/types.mjs +133 -132
- package/dist/index.d.mts +484 -484
- package/dist/index.d.ts +484 -484
- package/dist/mcp.d.mts +1 -0
- package/dist/mcp.d.ts +1 -0
- package/dist/mcp.js +5 -0
- package/dist/mcp.mjs +1 -0
- package/dist/utils/fetcher.d.mts +2 -3
- package/dist/utils/fetcher.d.ts +2 -3
- package/dist/utils/fetcher.js +2 -1
- package/dist/utils/fetcher.mjs +2 -1
- package/dist/utils/mcp.d.mts +1 -0
- package/dist/utils/mcp.d.ts +1 -0
- package/dist/utils/mcp.js +2 -0
- package/dist/utils/mcp.mjs +1 -0
- package/package.json +14 -4
|
@@ -6,113 +6,125 @@ import client from "../utils/fetcher.mjs";
|
|
|
6
6
|
/**
|
|
7
7
|
* @description Allows to read an access group
|
|
8
8
|
* @summary Reads an access group
|
|
9
|
-
* {@link
|
|
9
|
+
* {@link /v1/access-groups/:idOrName}
|
|
10
10
|
*/
|
|
11
|
-
export async function readAccessGroup({ pathParams: { idOrName }, queryParams, config = {}
|
|
11
|
+
export async function readAccessGroup({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
12
12
|
const { client: request = client, ...requestConfig } = config;
|
|
13
13
|
if (!idOrName) {
|
|
14
14
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
15
15
|
}
|
|
16
|
-
const data = await request({ method: 'GET', url:
|
|
16
|
+
const data = await request({ method: 'GET', url: `/v1/access-groups/${idOrName}`, queryParams, ...requestConfig });
|
|
17
17
|
return data;
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
20
|
* @description Allows to update an access group metadata
|
|
21
21
|
* @summary Update an access group
|
|
22
|
-
* {@link
|
|
22
|
+
* {@link /v1/access-groups/:idOrName}
|
|
23
23
|
*/
|
|
24
|
-
export async function updateAccessGroup({ pathParams: { idOrName }, queryParams, config = {}
|
|
24
|
+
export async function updateAccessGroup({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
25
25
|
const { client: request = client, ...requestConfig } = config;
|
|
26
26
|
if (!idOrName) {
|
|
27
27
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
28
28
|
}
|
|
29
|
-
const data = await request({
|
|
29
|
+
const data = await request({
|
|
30
|
+
method: 'POST',
|
|
31
|
+
url: `/v1/access-groups/${idOrName}`,
|
|
32
|
+
queryParams,
|
|
33
|
+
...requestConfig,
|
|
34
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
35
|
+
});
|
|
30
36
|
return data;
|
|
31
37
|
}
|
|
32
38
|
/**
|
|
33
39
|
* @description Allows to delete an access group
|
|
34
40
|
* @summary Deletes an access group
|
|
35
|
-
* {@link
|
|
41
|
+
* {@link /v1/access-groups/:idOrName}
|
|
36
42
|
*/
|
|
37
|
-
export async function deleteAccessGroup({ pathParams: { idOrName }, queryParams, config = {}
|
|
43
|
+
export async function deleteAccessGroup({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
38
44
|
const { client: request = client, ...requestConfig } = config;
|
|
39
45
|
if (!idOrName) {
|
|
40
46
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
41
47
|
}
|
|
42
|
-
const data = await request({ method: 'DELETE', url:
|
|
48
|
+
const data = await request({ method: 'DELETE', url: `/v1/access-groups/${idOrName}`, queryParams, ...requestConfig });
|
|
43
49
|
return data;
|
|
44
50
|
}
|
|
45
51
|
/**
|
|
46
52
|
* @description List members of an access group
|
|
47
53
|
* @summary List members of an access group
|
|
48
|
-
* {@link
|
|
54
|
+
* {@link /v1/access-groups/:idOrName/members}
|
|
49
55
|
*/
|
|
50
|
-
export async function listAccessGroupMembers({ pathParams: { idOrName }, queryParams, config = {}
|
|
56
|
+
export async function listAccessGroupMembers({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
51
57
|
const { client: request = client, ...requestConfig } = config;
|
|
52
58
|
if (!idOrName) {
|
|
53
59
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
54
60
|
}
|
|
55
|
-
const data = await request({ method: 'GET', url:
|
|
61
|
+
const data = await request({ method: 'GET', url: `/v1/access-groups/${idOrName}/members`, queryParams, ...requestConfig });
|
|
56
62
|
return data;
|
|
57
63
|
}
|
|
58
64
|
/**
|
|
59
65
|
* @description List access groups
|
|
60
66
|
* @summary List access groups for a team, project or member
|
|
61
|
-
* {@link
|
|
67
|
+
* {@link /v1/access-groups}
|
|
62
68
|
*/
|
|
63
|
-
export async function listAccessGroups({ queryParams, config = {}
|
|
69
|
+
export async function listAccessGroups({ queryParams, config = {} }) {
|
|
64
70
|
const { client: request = client, ...requestConfig } = config;
|
|
65
|
-
const data = await request({ method: 'GET', url:
|
|
71
|
+
const data = await request({ method: 'GET', url: `/v1/access-groups`, queryParams, ...requestConfig });
|
|
66
72
|
return data;
|
|
67
73
|
}
|
|
68
74
|
/**
|
|
69
75
|
* @description Allows to create an access group
|
|
70
76
|
* @summary Creates an access group
|
|
71
|
-
* {@link
|
|
77
|
+
* {@link /v1/access-groups}
|
|
72
78
|
*/
|
|
73
|
-
export async function createAccessGroup({ queryParams, config = {}
|
|
79
|
+
export async function createAccessGroup({ queryParams, config = {} }) {
|
|
74
80
|
const { client: request = client, ...requestConfig } = config;
|
|
75
|
-
const data = await request({
|
|
81
|
+
const data = await request({
|
|
82
|
+
method: 'POST',
|
|
83
|
+
url: `/v1/access-groups`,
|
|
84
|
+
queryParams,
|
|
85
|
+
...requestConfig,
|
|
86
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
87
|
+
});
|
|
76
88
|
return data;
|
|
77
89
|
}
|
|
78
90
|
/**
|
|
79
91
|
* @description List projects of an access group
|
|
80
92
|
* @summary List projects of an access group
|
|
81
|
-
* {@link
|
|
93
|
+
* {@link /v1/access-groups/:idOrName/projects}
|
|
82
94
|
*/
|
|
83
|
-
export async function listAccessGroupProjects({ pathParams: { idOrName }, queryParams, config = {}
|
|
95
|
+
export async function listAccessGroupProjects({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
84
96
|
const { client: request = client, ...requestConfig } = config;
|
|
85
97
|
if (!idOrName) {
|
|
86
98
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
87
99
|
}
|
|
88
|
-
const data = await request({ method: 'GET', url:
|
|
100
|
+
const data = await request({ method: 'GET', url: `/v1/access-groups/${idOrName}/projects`, queryParams, ...requestConfig });
|
|
89
101
|
return data;
|
|
90
102
|
}
|
|
91
103
|
/**
|
|
92
104
|
* @description Allows creation of an access group project
|
|
93
105
|
* @summary Create an access group project
|
|
94
|
-
* {@link
|
|
106
|
+
* {@link /v1/access-groups/:accessGroupIdOrName/projects}
|
|
95
107
|
*/
|
|
96
|
-
export async function createAccessGroupProject({ pathParams: { accessGroupIdOrName }, queryParams, config = {}
|
|
108
|
+
export async function createAccessGroupProject({ pathParams: { accessGroupIdOrName }, queryParams, config = {} }) {
|
|
97
109
|
const { client: request = client, ...requestConfig } = config;
|
|
98
110
|
if (!accessGroupIdOrName) {
|
|
99
111
|
throw new Error(`Missing required path parameter: accessGroupIdOrName`);
|
|
100
112
|
}
|
|
101
113
|
const data = await request({
|
|
102
114
|
method: 'POST',
|
|
103
|
-
url:
|
|
115
|
+
url: `/v1/access-groups/${accessGroupIdOrName}/projects`,
|
|
104
116
|
queryParams,
|
|
105
117
|
...requestConfig,
|
|
106
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
118
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
107
119
|
});
|
|
108
120
|
return data;
|
|
109
121
|
}
|
|
110
122
|
/**
|
|
111
123
|
* @description Allows reading an access group project
|
|
112
124
|
* @summary Reads an access group project
|
|
113
|
-
* {@link
|
|
125
|
+
* {@link /v1/access-groups/:accessGroupIdOrName/projects/:projectId}
|
|
114
126
|
*/
|
|
115
|
-
export async function readAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config = {}
|
|
127
|
+
export async function readAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config = {} }) {
|
|
116
128
|
const { client: request = client, ...requestConfig } = config;
|
|
117
129
|
if (!accessGroupIdOrName) {
|
|
118
130
|
throw new Error(`Missing required path parameter: accessGroupIdOrName`);
|
|
@@ -120,15 +132,20 @@ export async function readAccessGroupProject({ pathParams: { accessGroupIdOrName
|
|
|
120
132
|
if (!projectId) {
|
|
121
133
|
throw new Error(`Missing required path parameter: projectId`);
|
|
122
134
|
}
|
|
123
|
-
const data = await request({
|
|
135
|
+
const data = await request({
|
|
136
|
+
method: 'GET',
|
|
137
|
+
url: `/v1/access-groups/${accessGroupIdOrName}/projects/${projectId}`,
|
|
138
|
+
queryParams,
|
|
139
|
+
...requestConfig
|
|
140
|
+
});
|
|
124
141
|
return data;
|
|
125
142
|
}
|
|
126
143
|
/**
|
|
127
144
|
* @description Allows update of an access group project
|
|
128
145
|
* @summary Update an access group project
|
|
129
|
-
* {@link
|
|
146
|
+
* {@link /v1/access-groups/:accessGroupIdOrName/projects/:projectId}
|
|
130
147
|
*/
|
|
131
|
-
export async function updateAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config = {}
|
|
148
|
+
export async function updateAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config = {} }) {
|
|
132
149
|
const { client: request = client, ...requestConfig } = config;
|
|
133
150
|
if (!accessGroupIdOrName) {
|
|
134
151
|
throw new Error(`Missing required path parameter: accessGroupIdOrName`);
|
|
@@ -138,19 +155,19 @@ export async function updateAccessGroupProject({ pathParams: { accessGroupIdOrNa
|
|
|
138
155
|
}
|
|
139
156
|
const data = await request({
|
|
140
157
|
method: 'PATCH',
|
|
141
|
-
url:
|
|
158
|
+
url: `/v1/access-groups/${accessGroupIdOrName}/projects/${projectId}`,
|
|
142
159
|
queryParams,
|
|
143
160
|
...requestConfig,
|
|
144
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
161
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
145
162
|
});
|
|
146
163
|
return data;
|
|
147
164
|
}
|
|
148
165
|
/**
|
|
149
166
|
* @description Allows deletion of an access group project
|
|
150
167
|
* @summary Delete an access group project
|
|
151
|
-
* {@link
|
|
168
|
+
* {@link /v1/access-groups/:accessGroupIdOrName/projects/:projectId}
|
|
152
169
|
*/
|
|
153
|
-
export async function deleteAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config = {}
|
|
170
|
+
export async function deleteAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config = {} }) {
|
|
154
171
|
const { client: request = client, ...requestConfig } = config;
|
|
155
172
|
if (!accessGroupIdOrName) {
|
|
156
173
|
throw new Error(`Missing required path parameter: accessGroupIdOrName`);
|
|
@@ -158,115 +175,132 @@ export async function deleteAccessGroupProject({ pathParams: { accessGroupIdOrNa
|
|
|
158
175
|
if (!projectId) {
|
|
159
176
|
throw new Error(`Missing required path parameter: projectId`);
|
|
160
177
|
}
|
|
161
|
-
const data = await request({
|
|
178
|
+
const data = await request({
|
|
179
|
+
method: 'DELETE',
|
|
180
|
+
url: `/v1/access-groups/${accessGroupIdOrName}/projects/${projectId}`,
|
|
181
|
+
queryParams,
|
|
182
|
+
...requestConfig
|
|
183
|
+
});
|
|
162
184
|
return data;
|
|
163
185
|
}
|
|
164
186
|
/**
|
|
165
187
|
* @description Records an artifacts cache usage event. The body of this request is an array of cache usage events. The supported event types are `HIT` and `MISS`. The source is either `LOCAL` the cache event was on the users filesystem cache or `REMOTE` if the cache event is for a remote cache. When the event is a `HIT` the request also accepts a number `duration` which is the time taken to generate the artifact in the cache.
|
|
166
188
|
* @summary Record an artifacts cache usage event
|
|
167
|
-
* {@link
|
|
189
|
+
* {@link /v8/artifacts/events}
|
|
168
190
|
*/
|
|
169
|
-
export async function recordEvents({ queryParams, headers, config = {}
|
|
191
|
+
export async function recordEvents({ queryParams, headers, config = {} }) {
|
|
170
192
|
const { client: request = client, ...requestConfig } = config;
|
|
171
193
|
const data = await request({
|
|
172
194
|
method: 'POST',
|
|
173
|
-
url:
|
|
195
|
+
url: `/v8/artifacts/events`,
|
|
174
196
|
queryParams,
|
|
175
197
|
...requestConfig,
|
|
176
|
-
headers: { 'Content-Type': 'applicationJson', ...headers, ...requestConfig.headers }
|
|
198
|
+
headers: { 'Content-Type': 'applicationJson', ...headers, ...requestConfig.headers }
|
|
177
199
|
});
|
|
178
200
|
return data;
|
|
179
201
|
}
|
|
180
202
|
/**
|
|
181
203
|
* @description Check the status of Remote Caching for this principal. Returns a JSON-encoded status indicating if Remote Caching is enabled, disabled, or disabled due to usage limits.
|
|
182
204
|
* @summary Get status of Remote Caching for this principal
|
|
183
|
-
* {@link
|
|
205
|
+
* {@link /v8/artifacts/status}
|
|
184
206
|
*/
|
|
185
207
|
export async function status({ queryParams, config = {} }) {
|
|
186
208
|
const { client: request = client, ...requestConfig } = config;
|
|
187
|
-
const data = await request({ method: 'GET', url:
|
|
209
|
+
const data = await request({ method: 'GET', url: `/v8/artifacts/status`, queryParams, ...requestConfig });
|
|
188
210
|
return data;
|
|
189
211
|
}
|
|
190
212
|
/**
|
|
191
213
|
* @description Uploads a cache artifact identified by the `hash` specified on the path. The cache artifact can then be downloaded with the provided `hash`.
|
|
192
214
|
* @summary Upload a cache artifact
|
|
193
|
-
* {@link
|
|
215
|
+
* {@link /v8/artifacts/:hash}
|
|
194
216
|
*/
|
|
195
|
-
export async function uploadArtifact({ pathParams: { hash }, headers, queryParams, config = {}
|
|
217
|
+
export async function uploadArtifact({ pathParams: { hash }, headers, queryParams, config = {} }) {
|
|
196
218
|
const { client: request = client, ...requestConfig } = config;
|
|
197
219
|
if (!hash) {
|
|
198
220
|
throw new Error(`Missing required path parameter: hash`);
|
|
199
221
|
}
|
|
200
222
|
const data = await request({
|
|
201
223
|
method: 'PUT',
|
|
202
|
-
url:
|
|
224
|
+
url: `/v8/artifacts/${hash}`,
|
|
203
225
|
queryParams,
|
|
204
226
|
...requestConfig,
|
|
205
|
-
headers: { 'Content-Type': 'applicationOctetStream', ...headers, ...requestConfig.headers }
|
|
227
|
+
headers: { 'Content-Type': 'applicationOctetStream', ...headers, ...requestConfig.headers }
|
|
206
228
|
});
|
|
207
229
|
return data;
|
|
208
230
|
}
|
|
209
231
|
/**
|
|
210
232
|
* @description Downloads a cache artifact indentified by its `hash` specified on the request path. The artifact is downloaded as an octet-stream. The client should verify the content-length header and response body.
|
|
211
233
|
* @summary Download a cache artifact
|
|
212
|
-
* {@link
|
|
234
|
+
* {@link /v8/artifacts/:hash}
|
|
213
235
|
*/
|
|
214
|
-
export async function downloadArtifact({ pathParams: { hash }, queryParams, headers, config = {}
|
|
236
|
+
export async function downloadArtifact({ pathParams: { hash }, queryParams, headers, config = {} }) {
|
|
215
237
|
const { client: request = client, ...requestConfig } = config;
|
|
216
238
|
if (!hash) {
|
|
217
239
|
throw new Error(`Missing required path parameter: hash`);
|
|
218
240
|
}
|
|
219
|
-
const data = await request({
|
|
241
|
+
const data = await request({
|
|
242
|
+
method: 'GET',
|
|
243
|
+
url: `/v8/artifacts/${hash}`,
|
|
244
|
+
queryParams,
|
|
245
|
+
...requestConfig,
|
|
246
|
+
headers: { ...headers, ...requestConfig.headers }
|
|
247
|
+
});
|
|
220
248
|
return data;
|
|
221
249
|
}
|
|
222
250
|
/**
|
|
223
251
|
* @description Query information about an array of artifacts.
|
|
224
252
|
* @summary Query information about an artifact
|
|
225
|
-
* {@link
|
|
253
|
+
* {@link /v8/artifacts}
|
|
226
254
|
*/
|
|
227
|
-
export async function artifactQuery({ queryParams, config = {}
|
|
255
|
+
export async function artifactQuery({ queryParams, config = {} }) {
|
|
228
256
|
const { client: request = client, ...requestConfig } = config;
|
|
229
|
-
const data = await request({
|
|
257
|
+
const data = await request({
|
|
258
|
+
method: 'POST',
|
|
259
|
+
url: `/v8/artifacts`,
|
|
260
|
+
queryParams,
|
|
261
|
+
...requestConfig,
|
|
262
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
263
|
+
});
|
|
230
264
|
return data;
|
|
231
265
|
}
|
|
232
266
|
/**
|
|
233
267
|
* @description Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
|
|
234
268
|
* @summary Creates a new Check
|
|
235
|
-
* {@link
|
|
269
|
+
* {@link /v1/deployments/:deploymentId/checks}
|
|
236
270
|
*/
|
|
237
|
-
export async function createCheck({ pathParams: { deploymentId }, queryParams, config = {}
|
|
271
|
+
export async function createCheck({ pathParams: { deploymentId }, queryParams, config = {} }) {
|
|
238
272
|
const { client: request = client, ...requestConfig } = config;
|
|
239
273
|
if (!deploymentId) {
|
|
240
274
|
throw new Error(`Missing required path parameter: deploymentId`);
|
|
241
275
|
}
|
|
242
276
|
const data = await request({
|
|
243
277
|
method: 'POST',
|
|
244
|
-
url:
|
|
278
|
+
url: `/v1/deployments/${deploymentId}/checks`,
|
|
245
279
|
queryParams,
|
|
246
280
|
...requestConfig,
|
|
247
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
281
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
248
282
|
});
|
|
249
283
|
return data;
|
|
250
284
|
}
|
|
251
285
|
/**
|
|
252
286
|
* @description List all of the checks created for a deployment.
|
|
253
287
|
* @summary Retrieve a list of all checks
|
|
254
|
-
* {@link
|
|
288
|
+
* {@link /v1/deployments/:deploymentId/checks}
|
|
255
289
|
*/
|
|
256
|
-
export async function getAllChecks({ pathParams: { deploymentId }, queryParams, config = {}
|
|
290
|
+
export async function getAllChecks({ pathParams: { deploymentId }, queryParams, config = {} }) {
|
|
257
291
|
const { client: request = client, ...requestConfig } = config;
|
|
258
292
|
if (!deploymentId) {
|
|
259
293
|
throw new Error(`Missing required path parameter: deploymentId`);
|
|
260
294
|
}
|
|
261
|
-
const data = await request({ method: 'GET', url:
|
|
295
|
+
const data = await request({ method: 'GET', url: `/v1/deployments/${deploymentId}/checks`, queryParams, ...requestConfig });
|
|
262
296
|
return data;
|
|
263
297
|
}
|
|
264
298
|
/**
|
|
265
299
|
* @description Return a detailed response for a single check.
|
|
266
300
|
* @summary Get a single check
|
|
267
|
-
* {@link
|
|
301
|
+
* {@link /v1/deployments/:deploymentId/checks/:checkId}
|
|
268
302
|
*/
|
|
269
|
-
export async function getCheck({ pathParams: { deploymentId, checkId }, queryParams, config = {}
|
|
303
|
+
export async function getCheck({ pathParams: { deploymentId, checkId }, queryParams, config = {} }) {
|
|
270
304
|
const { client: request = client, ...requestConfig } = config;
|
|
271
305
|
if (!deploymentId) {
|
|
272
306
|
throw new Error(`Missing required path parameter: deploymentId`);
|
|
@@ -274,15 +308,15 @@ export async function getCheck({ pathParams: { deploymentId, checkId }, queryPar
|
|
|
274
308
|
if (!checkId) {
|
|
275
309
|
throw new Error(`Missing required path parameter: checkId`);
|
|
276
310
|
}
|
|
277
|
-
const data = await request({ method: 'GET', url:
|
|
311
|
+
const data = await request({ method: 'GET', url: `/v1/deployments/${deploymentId}/checks/${checkId}`, queryParams, ...requestConfig });
|
|
278
312
|
return data;
|
|
279
313
|
}
|
|
280
314
|
/**
|
|
281
315
|
* @description Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
|
|
282
316
|
* @summary Update a check
|
|
283
|
-
* {@link
|
|
317
|
+
* {@link /v1/deployments/:deploymentId/checks/:checkId}
|
|
284
318
|
*/
|
|
285
|
-
export async function updateCheck({ pathParams: { deploymentId, checkId }, queryParams, config = {}
|
|
319
|
+
export async function updateCheck({ pathParams: { deploymentId, checkId }, queryParams, config = {} }) {
|
|
286
320
|
const { client: request = client, ...requestConfig } = config;
|
|
287
321
|
if (!deploymentId) {
|
|
288
322
|
throw new Error(`Missing required path parameter: deploymentId`);
|
|
@@ -292,19 +326,19 @@ export async function updateCheck({ pathParams: { deploymentId, checkId }, query
|
|
|
292
326
|
}
|
|
293
327
|
const data = await request({
|
|
294
328
|
method: 'PATCH',
|
|
295
|
-
url:
|
|
329
|
+
url: `/v1/deployments/${deploymentId}/checks/${checkId}`,
|
|
296
330
|
queryParams,
|
|
297
331
|
...requestConfig,
|
|
298
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
332
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
299
333
|
});
|
|
300
334
|
return data;
|
|
301
335
|
}
|
|
302
336
|
/**
|
|
303
337
|
* @description Rerequest a selected check that has failed.
|
|
304
338
|
* @summary Rerequest a check
|
|
305
|
-
* {@link
|
|
339
|
+
* {@link /v1/deployments/:deploymentId/checks/:checkId/rerequest}
|
|
306
340
|
*/
|
|
307
|
-
export async function rerequestCheck({ pathParams: { deploymentId, checkId }, queryParams, config = {}
|
|
341
|
+
export async function rerequestCheck({ pathParams: { deploymentId, checkId }, queryParams, config = {} }) {
|
|
308
342
|
const { client: request = client, ...requestConfig } = config;
|
|
309
343
|
if (!deploymentId) {
|
|
310
344
|
throw new Error(`Missing required path parameter: deploymentId`);
|
|
@@ -312,63 +346,73 @@ export async function rerequestCheck({ pathParams: { deploymentId, checkId }, qu
|
|
|
312
346
|
if (!checkId) {
|
|
313
347
|
throw new Error(`Missing required path parameter: checkId`);
|
|
314
348
|
}
|
|
315
|
-
const data = await request({
|
|
349
|
+
const data = await request({
|
|
350
|
+
method: 'POST',
|
|
351
|
+
url: `/v1/deployments/${deploymentId}/checks/${checkId}/rerequest`,
|
|
352
|
+
queryParams,
|
|
353
|
+
...requestConfig
|
|
354
|
+
});
|
|
316
355
|
return data;
|
|
317
356
|
}
|
|
318
357
|
/**
|
|
319
|
-
* {@link
|
|
358
|
+
* {@link /data-cache/purge-all}
|
|
320
359
|
*/
|
|
321
|
-
export async function purgeAllDataCache({ queryParams, config = {}
|
|
360
|
+
export async function purgeAllDataCache({ queryParams, config = {} }) {
|
|
322
361
|
const { client: request = client, ...requestConfig } = config;
|
|
323
|
-
const data = await request({ method: 'DELETE', url:
|
|
362
|
+
const data = await request({ method: 'DELETE', url: `/data-cache/purge-all`, queryParams, ...requestConfig });
|
|
324
363
|
return data;
|
|
325
364
|
}
|
|
326
365
|
/**
|
|
327
|
-
* {@link
|
|
366
|
+
* {@link /data-cache/billing-settings}
|
|
328
367
|
*/
|
|
329
368
|
export async function updateDataCacheBillingSettings({ config = {} }) {
|
|
330
369
|
const { client: request = client, ...requestConfig } = config;
|
|
331
|
-
const data = await request({
|
|
370
|
+
const data = await request({
|
|
371
|
+
method: 'PATCH',
|
|
372
|
+
url: `/data-cache/billing-settings`,
|
|
373
|
+
...requestConfig,
|
|
374
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
375
|
+
});
|
|
332
376
|
return data;
|
|
333
377
|
}
|
|
334
378
|
/**
|
|
335
379
|
* @description Update the data cache feature on a project.
|
|
336
380
|
* @summary Update the data cache feature
|
|
337
|
-
* {@link
|
|
381
|
+
* {@link /v1/data-cache/projects/:projectId}
|
|
338
382
|
*/
|
|
339
|
-
export async function updateProjectDataCache({ pathParams: { projectId }, queryParams, config = {}
|
|
383
|
+
export async function updateProjectDataCache({ pathParams: { projectId }, queryParams, config = {} }) {
|
|
340
384
|
const { client: request = client, ...requestConfig } = config;
|
|
341
385
|
if (!projectId) {
|
|
342
386
|
throw new Error(`Missing required path parameter: projectId`);
|
|
343
387
|
}
|
|
344
388
|
const data = await request({
|
|
345
389
|
method: 'PATCH',
|
|
346
|
-
url:
|
|
390
|
+
url: `/v1/data-cache/projects/${projectId}`,
|
|
347
391
|
queryParams,
|
|
348
392
|
...requestConfig,
|
|
349
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
393
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
350
394
|
});
|
|
351
395
|
return data;
|
|
352
396
|
}
|
|
353
397
|
/**
|
|
354
398
|
* @description Get the build logs of a deployment by deployment ID and build ID. It can work as an infinite stream of logs or as a JSON endpoint depending on the input parameters.
|
|
355
399
|
* @summary Get deployment events
|
|
356
|
-
* {@link
|
|
400
|
+
* {@link /v3/deployments/:idOrUrl/events}
|
|
357
401
|
*/
|
|
358
|
-
export async function getDeploymentEvents({ pathParams: { idOrUrl }, queryParams, config = {}
|
|
402
|
+
export async function getDeploymentEvents({ pathParams: { idOrUrl }, queryParams, config = {} }) {
|
|
359
403
|
const { client: request = client, ...requestConfig } = config;
|
|
360
404
|
if (!idOrUrl) {
|
|
361
405
|
throw new Error(`Missing required path parameter: idOrUrl`);
|
|
362
406
|
}
|
|
363
|
-
const data = await request({ method: 'GET', url:
|
|
407
|
+
const data = await request({ method: 'GET', url: `/v3/deployments/${idOrUrl}/events`, queryParams, ...requestConfig });
|
|
364
408
|
return data;
|
|
365
409
|
}
|
|
366
410
|
/**
|
|
367
411
|
* @description Updates the deployment integration action for the specified integration installation
|
|
368
412
|
* @summary Update deployment integration action
|
|
369
|
-
* {@link
|
|
413
|
+
* {@link /v1/deployments/:deploymentId/integrations/:integrationConfigurationId/resources/:resourceId/actions/:action}
|
|
370
414
|
*/
|
|
371
|
-
export async function updateIntegrationDeploymentAction({ pathParams: { deploymentId, integrationConfigurationId, resourceId, action }, config = {}
|
|
415
|
+
export async function updateIntegrationDeploymentAction({ pathParams: { deploymentId, integrationConfigurationId, resourceId, action }, config = {} }) {
|
|
372
416
|
const { client: request = client, ...requestConfig } = config;
|
|
373
417
|
if (!deploymentId) {
|
|
374
418
|
throw new Error(`Missing required path parameter: deploymentId`);
|
|
@@ -384,129 +428,147 @@ export async function updateIntegrationDeploymentAction({ pathParams: { deployme
|
|
|
384
428
|
}
|
|
385
429
|
const data = await request({
|
|
386
430
|
method: 'PATCH',
|
|
387
|
-
url:
|
|
431
|
+
url: `/v1/deployments/${deploymentId}/integrations/${integrationConfigurationId}/resources/${resourceId}/actions/${action}`,
|
|
388
432
|
...requestConfig,
|
|
389
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
433
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
390
434
|
});
|
|
391
435
|
return data;
|
|
392
436
|
}
|
|
393
437
|
/**
|
|
394
438
|
* @description Retrieves information for a deployment either by supplying its ID (`id` property) or Hostname (`url` property). Additional details will be included when the authenticated user or team is an owner of the deployment.
|
|
395
439
|
* @summary Get a deployment by ID or URL
|
|
396
|
-
* {@link
|
|
440
|
+
* {@link /v13/deployments/:idOrUrl}
|
|
397
441
|
*/
|
|
398
|
-
export async function getDeployment({ pathParams: { idOrUrl }, queryParams, config = {}
|
|
442
|
+
export async function getDeployment({ pathParams: { idOrUrl }, queryParams, config = {} }) {
|
|
399
443
|
const { client: request = client, ...requestConfig } = config;
|
|
400
444
|
if (!idOrUrl) {
|
|
401
445
|
throw new Error(`Missing required path parameter: idOrUrl`);
|
|
402
446
|
}
|
|
403
|
-
const data = await request({ method: 'GET', url:
|
|
447
|
+
const data = await request({ method: 'GET', url: `/v13/deployments/${idOrUrl}`, queryParams, ...requestConfig });
|
|
404
448
|
return data;
|
|
405
449
|
}
|
|
406
450
|
/**
|
|
407
451
|
* @description Create a new deployment with all the required and intended data. If the deployment is not a git deployment, all files must be provided with the request, either referenced or inlined. Additionally, a deployment id can be specified to redeploy a previous deployment.
|
|
408
452
|
* @summary Create a new deployment
|
|
409
|
-
* {@link
|
|
453
|
+
* {@link /v13/deployments}
|
|
410
454
|
*/
|
|
411
|
-
export async function createDeployment({ queryParams, config = {}
|
|
455
|
+
export async function createDeployment({ queryParams, config = {} }) {
|
|
412
456
|
const { client: request = client, ...requestConfig } = config;
|
|
413
|
-
const data = await request({
|
|
457
|
+
const data = await request({
|
|
458
|
+
method: 'POST',
|
|
459
|
+
url: `/v13/deployments`,
|
|
460
|
+
queryParams,
|
|
461
|
+
...requestConfig,
|
|
462
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
463
|
+
});
|
|
414
464
|
return data;
|
|
415
465
|
}
|
|
416
466
|
/**
|
|
417
467
|
* @description This endpoint allows you to cancel a deployment which is currently building, by supplying its `id` in the URL.
|
|
418
468
|
* @summary Cancel a deployment
|
|
419
|
-
* {@link
|
|
469
|
+
* {@link /v12/deployments/:id/cancel}
|
|
420
470
|
*/
|
|
421
|
-
export async function cancelDeployment({ pathParams: { id }, queryParams, config = {}
|
|
471
|
+
export async function cancelDeployment({ pathParams: { id }, queryParams, config = {} }) {
|
|
422
472
|
const { client: request = client, ...requestConfig } = config;
|
|
423
473
|
if (!id) {
|
|
424
474
|
throw new Error(`Missing required path parameter: id`);
|
|
425
475
|
}
|
|
426
|
-
const data = await request({ method: 'PATCH', url:
|
|
476
|
+
const data = await request({ method: 'PATCH', url: `/v12/deployments/${id}/cancel`, queryParams, ...requestConfig });
|
|
427
477
|
return data;
|
|
428
478
|
}
|
|
429
479
|
/**
|
|
430
480
|
* @description Allows to purchase the specified domain.
|
|
431
481
|
* @summary Purchase a domain
|
|
432
|
-
* {@link
|
|
482
|
+
* {@link /v5/domains/buy}
|
|
433
483
|
*/
|
|
434
|
-
export async function buyDomain({ queryParams, config = {}
|
|
484
|
+
export async function buyDomain({ queryParams, config = {} }) {
|
|
435
485
|
const { client: request = client, ...requestConfig } = config;
|
|
436
|
-
const data = await request({
|
|
486
|
+
const data = await request({
|
|
487
|
+
method: 'POST',
|
|
488
|
+
url: `/v5/domains/buy`,
|
|
489
|
+
queryParams,
|
|
490
|
+
...requestConfig,
|
|
491
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
492
|
+
});
|
|
437
493
|
return data;
|
|
438
494
|
}
|
|
439
495
|
/**
|
|
440
496
|
* @description Check the price to purchase a domain and how long a single purchase period is.
|
|
441
497
|
* @summary Check the price for a domain
|
|
442
|
-
* {@link
|
|
498
|
+
* {@link /v4/domains/price}
|
|
443
499
|
*/
|
|
444
|
-
export async function checkDomainPrice({ queryParams, config = {}
|
|
500
|
+
export async function checkDomainPrice({ queryParams, config = {} }) {
|
|
445
501
|
const { client: request = client, ...requestConfig } = config;
|
|
446
|
-
const data = await request({ method: 'GET', url:
|
|
502
|
+
const data = await request({ method: 'GET', url: `/v4/domains/price`, queryParams, ...requestConfig });
|
|
447
503
|
return data;
|
|
448
504
|
}
|
|
449
505
|
/**
|
|
450
506
|
* @description Check if a domain name is available for purchase.
|
|
451
507
|
* @summary Check a Domain Availability
|
|
452
|
-
* {@link
|
|
508
|
+
* {@link /v4/domains/status}
|
|
453
509
|
*/
|
|
454
|
-
export async function checkDomainStatus({ queryParams, config = {}
|
|
510
|
+
export async function checkDomainStatus({ queryParams, config = {} }) {
|
|
455
511
|
const { client: request = client, ...requestConfig } = config;
|
|
456
|
-
const data = await request({ method: 'GET', url:
|
|
512
|
+
const data = await request({ method: 'GET', url: `/v4/domains/status`, queryParams, ...requestConfig });
|
|
457
513
|
return data;
|
|
458
514
|
}
|
|
459
515
|
/**
|
|
460
516
|
* @description Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options.
|
|
461
517
|
* @summary List existing DNS records
|
|
462
|
-
* {@link
|
|
518
|
+
* {@link /v4/domains/:domain/records}
|
|
463
519
|
*/
|
|
464
|
-
export async function getRecords({ pathParams: { domain }, queryParams, config = {}
|
|
520
|
+
export async function getRecords({ pathParams: { domain }, queryParams, config = {} }) {
|
|
465
521
|
const { client: request = client, ...requestConfig } = config;
|
|
466
522
|
if (!domain) {
|
|
467
523
|
throw new Error(`Missing required path parameter: domain`);
|
|
468
524
|
}
|
|
469
|
-
const data = await request({ method: 'GET', url:
|
|
525
|
+
const data = await request({ method: 'GET', url: `/v4/domains/${domain}/records`, queryParams, ...requestConfig });
|
|
470
526
|
return data;
|
|
471
527
|
}
|
|
472
528
|
/**
|
|
473
529
|
* @description Creates a DNS record for a domain.
|
|
474
530
|
* @summary Create a DNS record
|
|
475
|
-
* {@link
|
|
531
|
+
* {@link /v2/domains/:domain/records}
|
|
476
532
|
*/
|
|
477
|
-
export async function createRecord({ pathParams: { domain }, queryParams, config = {}
|
|
533
|
+
export async function createRecord({ pathParams: { domain }, queryParams, config = {} }) {
|
|
478
534
|
const { client: request = client, ...requestConfig } = config;
|
|
479
535
|
if (!domain) {
|
|
480
536
|
throw new Error(`Missing required path parameter: domain`);
|
|
481
537
|
}
|
|
482
|
-
const data = await request({
|
|
538
|
+
const data = await request({
|
|
539
|
+
method: 'POST',
|
|
540
|
+
url: `/v2/domains/${domain}/records`,
|
|
541
|
+
queryParams,
|
|
542
|
+
...requestConfig,
|
|
543
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
544
|
+
});
|
|
483
545
|
return data;
|
|
484
546
|
}
|
|
485
547
|
/**
|
|
486
548
|
* @description Updates an existing DNS record for a domain name.
|
|
487
549
|
* @summary Update an existing DNS record
|
|
488
|
-
* {@link
|
|
550
|
+
* {@link /v1/domains/records/:recordId}
|
|
489
551
|
*/
|
|
490
|
-
export async function updateRecord({ pathParams: { recordId }, queryParams, config = {}
|
|
552
|
+
export async function updateRecord({ pathParams: { recordId }, queryParams, config = {} }) {
|
|
491
553
|
const { client: request = client, ...requestConfig } = config;
|
|
492
554
|
if (!recordId) {
|
|
493
555
|
throw new Error(`Missing required path parameter: recordId`);
|
|
494
556
|
}
|
|
495
557
|
const data = await request({
|
|
496
558
|
method: 'PATCH',
|
|
497
|
-
url:
|
|
559
|
+
url: `/v1/domains/records/${recordId}`,
|
|
498
560
|
queryParams,
|
|
499
561
|
...requestConfig,
|
|
500
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
562
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
501
563
|
});
|
|
502
564
|
return data;
|
|
503
565
|
}
|
|
504
566
|
/**
|
|
505
567
|
* @description Removes an existing DNS record from a domain name.
|
|
506
568
|
* @summary Delete a DNS record
|
|
507
|
-
* {@link
|
|
569
|
+
* {@link /v2/domains/:domain/records/:recordId}
|
|
508
570
|
*/
|
|
509
|
-
export async function removeRecord({ pathParams: { domain, recordId }, queryParams, config = {}
|
|
571
|
+
export async function removeRecord({ pathParams: { domain, recordId }, queryParams, config = {} }) {
|
|
510
572
|
const { client: request = client, ...requestConfig } = config;
|
|
511
573
|
if (!domain) {
|
|
512
574
|
throw new Error(`Missing required path parameter: domain`);
|
|
@@ -514,236 +576,260 @@ export async function removeRecord({ pathParams: { domain, recordId }, queryPara
|
|
|
514
576
|
if (!recordId) {
|
|
515
577
|
throw new Error(`Missing required path parameter: recordId`);
|
|
516
578
|
}
|
|
517
|
-
const data = await request({ method: 'DELETE', url:
|
|
579
|
+
const data = await request({ method: 'DELETE', url: `/v2/domains/${domain}/records/${recordId}`, queryParams, ...requestConfig });
|
|
518
580
|
return data;
|
|
519
581
|
}
|
|
520
582
|
/**
|
|
521
583
|
* @description Fetch domain transfer availability or transfer status if a transfer is in progress.
|
|
522
584
|
* @summary Get domain transfer info.
|
|
523
|
-
* {@link
|
|
585
|
+
* {@link /v1/domains/:domain/registry}
|
|
524
586
|
*/
|
|
525
|
-
export async function getDomainTransfer({ pathParams: { domain }, queryParams, config = {}
|
|
587
|
+
export async function getDomainTransfer({ pathParams: { domain }, queryParams, config = {} }) {
|
|
526
588
|
const { client: request = client, ...requestConfig } = config;
|
|
527
589
|
if (!domain) {
|
|
528
590
|
throw new Error(`Missing required path parameter: domain`);
|
|
529
591
|
}
|
|
530
|
-
const data = await request({ method: 'GET', url:
|
|
592
|
+
const data = await request({ method: 'GET', url: `/v1/domains/${domain}/registry`, queryParams, ...requestConfig });
|
|
531
593
|
return data;
|
|
532
594
|
}
|
|
533
595
|
/**
|
|
534
596
|
* @description Get a Domain's configuration.
|
|
535
597
|
* @summary Get a Domain's configuration
|
|
536
|
-
* {@link
|
|
598
|
+
* {@link /v6/domains/:domain/config}
|
|
537
599
|
*/
|
|
538
|
-
export async function getDomainConfig({ pathParams: { domain }, queryParams, config = {}
|
|
600
|
+
export async function getDomainConfig({ pathParams: { domain }, queryParams, config = {} }) {
|
|
539
601
|
const { client: request = client, ...requestConfig } = config;
|
|
540
602
|
if (!domain) {
|
|
541
603
|
throw new Error(`Missing required path parameter: domain`);
|
|
542
604
|
}
|
|
543
|
-
const data = await request({ method: 'GET', url:
|
|
605
|
+
const data = await request({ method: 'GET', url: `/v6/domains/${domain}/config`, queryParams, ...requestConfig });
|
|
544
606
|
return data;
|
|
545
607
|
}
|
|
546
608
|
/**
|
|
547
609
|
* @description Get information for a single domain in an account or team.
|
|
548
610
|
* @summary Get Information for a Single Domain
|
|
549
|
-
* {@link
|
|
611
|
+
* {@link /v5/domains/:domain}
|
|
550
612
|
*/
|
|
551
|
-
export async function getDomain({ pathParams: { domain }, queryParams, config = {}
|
|
613
|
+
export async function getDomain({ pathParams: { domain }, queryParams, config = {} }) {
|
|
552
614
|
const { client: request = client, ...requestConfig } = config;
|
|
553
615
|
if (!domain) {
|
|
554
616
|
throw new Error(`Missing required path parameter: domain`);
|
|
555
617
|
}
|
|
556
|
-
const data = await request({ method: 'GET', url:
|
|
618
|
+
const data = await request({ method: 'GET', url: `/v5/domains/${domain}`, queryParams, ...requestConfig });
|
|
557
619
|
return data;
|
|
558
620
|
}
|
|
559
621
|
/**
|
|
560
622
|
* @description Retrieves a list of domains registered for the authenticated user or team. By default it returns the last 20 domains if no limit is provided.
|
|
561
623
|
* @summary List all the domains
|
|
562
|
-
* {@link
|
|
624
|
+
* {@link /v5/domains}
|
|
563
625
|
*/
|
|
564
|
-
export async function getDomains({ queryParams, config = {}
|
|
626
|
+
export async function getDomains({ queryParams, config = {} }) {
|
|
565
627
|
const { client: request = client, ...requestConfig } = config;
|
|
566
|
-
const data = await request({ method: 'GET', url:
|
|
628
|
+
const data = await request({ method: 'GET', url: `/v5/domains`, queryParams, ...requestConfig });
|
|
567
629
|
return data;
|
|
568
630
|
}
|
|
569
631
|
/**
|
|
570
632
|
* @description 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.
|
|
571
633
|
* @summary Register or transfer-in a new Domain
|
|
572
|
-
* {@link
|
|
634
|
+
* {@link /v7/domains}
|
|
573
635
|
*/
|
|
574
|
-
export async function createOrTransferDomain({ queryParams, config = {}
|
|
636
|
+
export async function createOrTransferDomain({ queryParams, config = {} }) {
|
|
575
637
|
const { client: request = client, ...requestConfig } = config;
|
|
576
|
-
const data = await request({
|
|
638
|
+
const data = await request({
|
|
639
|
+
method: 'POST',
|
|
640
|
+
url: `/v7/domains`,
|
|
641
|
+
queryParams,
|
|
642
|
+
...requestConfig,
|
|
643
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
644
|
+
});
|
|
577
645
|
return data;
|
|
578
646
|
}
|
|
579
647
|
/**
|
|
580
648
|
* @description Update or move apex domain.
|
|
581
649
|
* @summary Update or move apex domain
|
|
582
|
-
* {@link
|
|
650
|
+
* {@link /v3/domains/:domain}
|
|
583
651
|
*/
|
|
584
|
-
export async function patchDomain({ pathParams: { domain }, queryParams, config = {}
|
|
652
|
+
export async function patchDomain({ pathParams: { domain }, queryParams, config = {} }) {
|
|
585
653
|
const { client: request = client, ...requestConfig } = config;
|
|
586
654
|
if (!domain) {
|
|
587
655
|
throw new Error(`Missing required path parameter: domain`);
|
|
588
656
|
}
|
|
589
|
-
const data = await request({
|
|
657
|
+
const data = await request({
|
|
658
|
+
method: 'PATCH',
|
|
659
|
+
url: `/v3/domains/${domain}`,
|
|
660
|
+
queryParams,
|
|
661
|
+
...requestConfig,
|
|
662
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
663
|
+
});
|
|
590
664
|
return data;
|
|
591
665
|
}
|
|
592
666
|
/**
|
|
593
667
|
* @description Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases.
|
|
594
668
|
* @summary Remove a domain by name
|
|
595
|
-
* {@link
|
|
669
|
+
* {@link /v6/domains/:domain}
|
|
596
670
|
*/
|
|
597
|
-
export async function deleteDomain({ pathParams: { domain }, queryParams, config = {}
|
|
671
|
+
export async function deleteDomain({ pathParams: { domain }, queryParams, config = {} }) {
|
|
598
672
|
const { client: request = client, ...requestConfig } = config;
|
|
599
673
|
if (!domain) {
|
|
600
674
|
throw new Error(`Missing required path parameter: domain`);
|
|
601
675
|
}
|
|
602
|
-
const data = await request({ method: 'DELETE', url:
|
|
676
|
+
const data = await request({ method: 'DELETE', url: `/v6/domains/${domain}`, queryParams, ...requestConfig });
|
|
603
677
|
return data;
|
|
604
678
|
}
|
|
605
679
|
/**
|
|
606
680
|
* @description Returns all Edge Configs.
|
|
607
681
|
* @summary Get Edge Configs
|
|
608
|
-
* {@link
|
|
682
|
+
* {@link /v1/edge-config}
|
|
609
683
|
*/
|
|
610
|
-
export async function getEdgeConfigs({ queryParams, config = {}
|
|
684
|
+
export async function getEdgeConfigs({ queryParams, config = {} }) {
|
|
611
685
|
const { client: request = client, ...requestConfig } = config;
|
|
612
|
-
const data = await request({ method: 'GET', url:
|
|
686
|
+
const data = await request({ method: 'GET', url: `/v1/edge-config`, queryParams, ...requestConfig });
|
|
613
687
|
return data;
|
|
614
688
|
}
|
|
615
689
|
/**
|
|
616
690
|
* @description Creates an Edge Config.
|
|
617
691
|
* @summary Create an Edge Config
|
|
618
|
-
* {@link
|
|
692
|
+
* {@link /v1/edge-config}
|
|
619
693
|
*/
|
|
620
|
-
export async function createEdgeConfig({ queryParams, config = {}
|
|
694
|
+
export async function createEdgeConfig({ queryParams, config = {} }) {
|
|
621
695
|
const { client: request = client, ...requestConfig } = config;
|
|
622
|
-
const data = await request({
|
|
696
|
+
const data = await request({
|
|
697
|
+
method: 'POST',
|
|
698
|
+
url: `/v1/edge-config`,
|
|
699
|
+
queryParams,
|
|
700
|
+
...requestConfig,
|
|
701
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
702
|
+
});
|
|
623
703
|
return data;
|
|
624
704
|
}
|
|
625
705
|
/**
|
|
626
706
|
* @description Returns an Edge Config.
|
|
627
707
|
* @summary Get an Edge Config
|
|
628
|
-
* {@link
|
|
708
|
+
* {@link /v1/edge-config/:edgeConfigId}
|
|
629
709
|
*/
|
|
630
|
-
export async function getEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
710
|
+
export async function getEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
631
711
|
const { client: request = client, ...requestConfig } = config;
|
|
632
712
|
if (!edgeConfigId) {
|
|
633
713
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
634
714
|
}
|
|
635
|
-
const data = await request({ method: 'GET', url:
|
|
715
|
+
const data = await request({ method: 'GET', url: `/v1/edge-config/${edgeConfigId}`, queryParams, ...requestConfig });
|
|
636
716
|
return data;
|
|
637
717
|
}
|
|
638
718
|
/**
|
|
639
719
|
* @description Updates an Edge Config.
|
|
640
720
|
* @summary Update an Edge Config
|
|
641
|
-
* {@link
|
|
721
|
+
* {@link /v1/edge-config/:edgeConfigId}
|
|
642
722
|
*/
|
|
643
|
-
export async function updateEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
723
|
+
export async function updateEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
644
724
|
const { client: request = client, ...requestConfig } = config;
|
|
645
725
|
if (!edgeConfigId) {
|
|
646
726
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
647
727
|
}
|
|
648
|
-
const data = await request({
|
|
728
|
+
const data = await request({
|
|
729
|
+
method: 'PUT',
|
|
730
|
+
url: `/v1/edge-config/${edgeConfigId}`,
|
|
731
|
+
queryParams,
|
|
732
|
+
...requestConfig,
|
|
733
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
734
|
+
});
|
|
649
735
|
return data;
|
|
650
736
|
}
|
|
651
737
|
/**
|
|
652
738
|
* @description Delete an Edge Config by id.
|
|
653
739
|
* @summary Delete an Edge Config
|
|
654
|
-
* {@link
|
|
740
|
+
* {@link /v1/edge-config/:edgeConfigId}
|
|
655
741
|
*/
|
|
656
|
-
export async function deleteEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
742
|
+
export async function deleteEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
657
743
|
const { client: request = client, ...requestConfig } = config;
|
|
658
744
|
if (!edgeConfigId) {
|
|
659
745
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
660
746
|
}
|
|
661
|
-
const data = await request({ method: 'DELETE', url:
|
|
747
|
+
const data = await request({ method: 'DELETE', url: `/v1/edge-config/${edgeConfigId}`, queryParams, ...requestConfig });
|
|
662
748
|
return data;
|
|
663
749
|
}
|
|
664
750
|
/**
|
|
665
751
|
* @description Returns all items of an Edge Config.
|
|
666
752
|
* @summary Get Edge Config items
|
|
667
|
-
* {@link
|
|
753
|
+
* {@link /v1/edge-config/:edgeConfigId/items}
|
|
668
754
|
*/
|
|
669
|
-
export async function getEdgeConfigItems({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
755
|
+
export async function getEdgeConfigItems({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
670
756
|
const { client: request = client, ...requestConfig } = config;
|
|
671
757
|
if (!edgeConfigId) {
|
|
672
758
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
673
759
|
}
|
|
674
|
-
const data = await request({ method: 'GET', url:
|
|
760
|
+
const data = await request({ method: 'GET', url: `/v1/edge-config/${edgeConfigId}/items`, queryParams, ...requestConfig });
|
|
675
761
|
return data;
|
|
676
762
|
}
|
|
677
763
|
/**
|
|
678
764
|
* @description Update multiple Edge Config Items in batch.
|
|
679
765
|
* @summary Update Edge Config items in batch
|
|
680
|
-
* {@link
|
|
766
|
+
* {@link /v1/edge-config/:edgeConfigId/items}
|
|
681
767
|
*/
|
|
682
|
-
export async function patchEdgeConfigItems({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
768
|
+
export async function patchEdgeConfigItems({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
683
769
|
const { client: request = client, ...requestConfig } = config;
|
|
684
770
|
if (!edgeConfigId) {
|
|
685
771
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
686
772
|
}
|
|
687
773
|
const data = await request({
|
|
688
774
|
method: 'PATCH',
|
|
689
|
-
url:
|
|
775
|
+
url: `/v1/edge-config/${edgeConfigId}/items`,
|
|
690
776
|
queryParams,
|
|
691
777
|
...requestConfig,
|
|
692
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
778
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
693
779
|
});
|
|
694
780
|
return data;
|
|
695
781
|
}
|
|
696
782
|
/**
|
|
697
783
|
* @description Returns the schema of an Edge Config.
|
|
698
784
|
* @summary Get Edge Config schema
|
|
699
|
-
* {@link
|
|
785
|
+
* {@link /v1/edge-config/:edgeConfigId/schema}
|
|
700
786
|
*/
|
|
701
|
-
export async function getEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
787
|
+
export async function getEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
702
788
|
const { client: request = client, ...requestConfig } = config;
|
|
703
789
|
if (!edgeConfigId) {
|
|
704
790
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
705
791
|
}
|
|
706
|
-
const data = await request({ method: 'GET', url:
|
|
792
|
+
const data = await request({ method: 'GET', url: `/v1/edge-config/${edgeConfigId}/schema`, queryParams, ...requestConfig });
|
|
707
793
|
return data;
|
|
708
794
|
}
|
|
709
795
|
/**
|
|
710
796
|
* @description Update an Edge Config's schema.
|
|
711
797
|
* @summary Update Edge Config schema
|
|
712
|
-
* {@link
|
|
798
|
+
* {@link /v1/edge-config/:edgeConfigId/schema}
|
|
713
799
|
*/
|
|
714
|
-
export async function patchEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
800
|
+
export async function patchEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
715
801
|
const { client: request = client, ...requestConfig } = config;
|
|
716
802
|
if (!edgeConfigId) {
|
|
717
803
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
718
804
|
}
|
|
719
805
|
const data = await request({
|
|
720
806
|
method: 'POST',
|
|
721
|
-
url:
|
|
807
|
+
url: `/v1/edge-config/${edgeConfigId}/schema`,
|
|
722
808
|
queryParams,
|
|
723
809
|
...requestConfig,
|
|
724
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
810
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
725
811
|
});
|
|
726
812
|
return data;
|
|
727
813
|
}
|
|
728
814
|
/**
|
|
729
815
|
* @description Deletes the schema of existing Edge Config.
|
|
730
816
|
* @summary Delete an Edge Config's schema
|
|
731
|
-
* {@link
|
|
817
|
+
* {@link /v1/edge-config/:edgeConfigId/schema}
|
|
732
818
|
*/
|
|
733
|
-
export async function deleteEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
819
|
+
export async function deleteEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
734
820
|
const { client: request = client, ...requestConfig } = config;
|
|
735
821
|
if (!edgeConfigId) {
|
|
736
822
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
737
823
|
}
|
|
738
|
-
const data = await request({ method: 'DELETE', url:
|
|
824
|
+
const data = await request({ method: 'DELETE', url: `/v1/edge-config/${edgeConfigId}/schema`, queryParams, ...requestConfig });
|
|
739
825
|
return data;
|
|
740
826
|
}
|
|
741
827
|
/**
|
|
742
828
|
* @description Returns a specific Edge Config Item.
|
|
743
829
|
* @summary Get an Edge Config item
|
|
744
|
-
* {@link
|
|
830
|
+
* {@link /v1/edge-config/:edgeConfigId/item/:edgeConfigItemKey}
|
|
745
831
|
*/
|
|
746
|
-
export async function getEdgeConfigItem({ pathParams: { edgeConfigId, edgeConfigItemKey }, queryParams, config = {}
|
|
832
|
+
export async function getEdgeConfigItem({ pathParams: { edgeConfigId, edgeConfigItemKey }, queryParams, config = {} }) {
|
|
747
833
|
const { client: request = client, ...requestConfig } = config;
|
|
748
834
|
if (!edgeConfigId) {
|
|
749
835
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
@@ -751,47 +837,47 @@ export async function getEdgeConfigItem({ pathParams: { edgeConfigId, edgeConfig
|
|
|
751
837
|
if (!edgeConfigItemKey) {
|
|
752
838
|
throw new Error(`Missing required path parameter: edgeConfigItemKey`);
|
|
753
839
|
}
|
|
754
|
-
const data = await request({ method: 'GET', url:
|
|
840
|
+
const data = await request({ method: 'GET', url: `/v1/edge-config/${edgeConfigId}/item/${edgeConfigItemKey}`, queryParams, ...requestConfig });
|
|
755
841
|
return data;
|
|
756
842
|
}
|
|
757
843
|
/**
|
|
758
844
|
* @description Returns all tokens of an Edge Config.
|
|
759
845
|
* @summary Get all tokens of an Edge Config
|
|
760
|
-
* {@link
|
|
846
|
+
* {@link /v1/edge-config/:edgeConfigId/tokens}
|
|
761
847
|
*/
|
|
762
|
-
export async function getEdgeConfigTokens({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
848
|
+
export async function getEdgeConfigTokens({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
763
849
|
const { client: request = client, ...requestConfig } = config;
|
|
764
850
|
if (!edgeConfigId) {
|
|
765
851
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
766
852
|
}
|
|
767
|
-
const data = await request({ method: 'GET', url:
|
|
853
|
+
const data = await request({ method: 'GET', url: `/v1/edge-config/${edgeConfigId}/tokens`, queryParams, ...requestConfig });
|
|
768
854
|
return data;
|
|
769
855
|
}
|
|
770
856
|
/**
|
|
771
857
|
* @description Deletes one or more tokens of an existing Edge Config.
|
|
772
858
|
* @summary Delete one or more Edge Config tokens
|
|
773
|
-
* {@link
|
|
859
|
+
* {@link /v1/edge-config/:edgeConfigId/tokens}
|
|
774
860
|
*/
|
|
775
|
-
export async function deleteEdgeConfigTokens({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
861
|
+
export async function deleteEdgeConfigTokens({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
776
862
|
const { client: request = client, ...requestConfig } = config;
|
|
777
863
|
if (!edgeConfigId) {
|
|
778
864
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
779
865
|
}
|
|
780
866
|
const data = await request({
|
|
781
867
|
method: 'DELETE',
|
|
782
|
-
url:
|
|
868
|
+
url: `/v1/edge-config/${edgeConfigId}/tokens`,
|
|
783
869
|
queryParams,
|
|
784
870
|
...requestConfig,
|
|
785
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
871
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
786
872
|
});
|
|
787
873
|
return data;
|
|
788
874
|
}
|
|
789
875
|
/**
|
|
790
876
|
* @description Return meta data about an Edge Config token.
|
|
791
877
|
* @summary Get Edge Config token meta data
|
|
792
|
-
* {@link
|
|
878
|
+
* {@link /v1/edge-config/:edgeConfigId/token/:token}
|
|
793
879
|
*/
|
|
794
|
-
export async function getEdgeConfigToken({ pathParams: { edgeConfigId, token }, queryParams, config = {}
|
|
880
|
+
export async function getEdgeConfigToken({ pathParams: { edgeConfigId, token }, queryParams, config = {} }) {
|
|
795
881
|
const { client: request = client, ...requestConfig } = config;
|
|
796
882
|
if (!edgeConfigId) {
|
|
797
883
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
@@ -799,34 +885,34 @@ export async function getEdgeConfigToken({ pathParams: { edgeConfigId, token },
|
|
|
799
885
|
if (!token) {
|
|
800
886
|
throw new Error(`Missing required path parameter: token`);
|
|
801
887
|
}
|
|
802
|
-
const data = await request({ method: 'GET', url:
|
|
888
|
+
const data = await request({ method: 'GET', url: `/v1/edge-config/${edgeConfigId}/token/${token}`, queryParams, ...requestConfig });
|
|
803
889
|
return data;
|
|
804
890
|
}
|
|
805
891
|
/**
|
|
806
892
|
* @description Adds a token to an existing Edge Config.
|
|
807
893
|
* @summary Create an Edge Config token
|
|
808
|
-
* {@link
|
|
894
|
+
* {@link /v1/edge-config/:edgeConfigId/token}
|
|
809
895
|
*/
|
|
810
|
-
export async function createEdgeConfigToken({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
896
|
+
export async function createEdgeConfigToken({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
811
897
|
const { client: request = client, ...requestConfig } = config;
|
|
812
898
|
if (!edgeConfigId) {
|
|
813
899
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
814
900
|
}
|
|
815
901
|
const data = await request({
|
|
816
902
|
method: 'POST',
|
|
817
|
-
url:
|
|
903
|
+
url: `/v1/edge-config/${edgeConfigId}/token`,
|
|
818
904
|
queryParams,
|
|
819
905
|
...requestConfig,
|
|
820
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
906
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
821
907
|
});
|
|
822
908
|
return data;
|
|
823
909
|
}
|
|
824
910
|
/**
|
|
825
911
|
* @description Retrieves a specific version of an Edge Config from backup storage.
|
|
826
912
|
* @summary Get Edge Config backup
|
|
827
|
-
* {@link
|
|
913
|
+
* {@link /v1/edge-config/:edgeConfigId/backups/:edgeConfigBackupVersionId}
|
|
828
914
|
*/
|
|
829
|
-
export async function getEdgeConfigBackup({ pathParams: { edgeConfigId, edgeConfigBackupVersionId }, queryParams, config = {}
|
|
915
|
+
export async function getEdgeConfigBackup({ pathParams: { edgeConfigId, edgeConfigBackupVersionId }, queryParams, config = {} }) {
|
|
830
916
|
const { client: request = client, ...requestConfig } = config;
|
|
831
917
|
if (!edgeConfigId) {
|
|
832
918
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
@@ -834,51 +920,56 @@ export async function getEdgeConfigBackup({ pathParams: { edgeConfigId, edgeConf
|
|
|
834
920
|
if (!edgeConfigBackupVersionId) {
|
|
835
921
|
throw new Error(`Missing required path parameter: edgeConfigBackupVersionId`);
|
|
836
922
|
}
|
|
837
|
-
const data = await request({
|
|
923
|
+
const data = await request({
|
|
924
|
+
method: 'GET',
|
|
925
|
+
url: `/v1/edge-config/${edgeConfigId}/backups/${edgeConfigBackupVersionId}`,
|
|
926
|
+
queryParams,
|
|
927
|
+
...requestConfig
|
|
928
|
+
});
|
|
838
929
|
return data;
|
|
839
930
|
}
|
|
840
931
|
/**
|
|
841
932
|
* @description Returns backups of an Edge Config.
|
|
842
933
|
* @summary Get Edge Config backups
|
|
843
|
-
* {@link
|
|
934
|
+
* {@link /v1/edge-config/:edgeConfigId/backups}
|
|
844
935
|
*/
|
|
845
|
-
export async function getEdgeConfigBackups({ pathParams: { edgeConfigId }, queryParams, config = {}
|
|
936
|
+
export async function getEdgeConfigBackups({ pathParams: { edgeConfigId }, queryParams, config = {} }) {
|
|
846
937
|
const { client: request = client, ...requestConfig } = config;
|
|
847
938
|
if (!edgeConfigId) {
|
|
848
939
|
throw new Error(`Missing required path parameter: edgeConfigId`);
|
|
849
940
|
}
|
|
850
|
-
const data = await request({ method: 'GET', url:
|
|
941
|
+
const data = await request({ method: 'GET', url: `/v1/edge-config/${edgeConfigId}/backups`, queryParams, ...requestConfig });
|
|
851
942
|
return data;
|
|
852
943
|
}
|
|
853
944
|
/**
|
|
854
945
|
* @description Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the `teamId` parameter is supplied, then the events that are returned will be in relation to the Team that was specified.
|
|
855
946
|
* @summary List User Events
|
|
856
|
-
* {@link
|
|
947
|
+
* {@link /v3/events}
|
|
857
948
|
*/
|
|
858
|
-
export async function listUserEvents({ queryParams, config = {}
|
|
949
|
+
export async function listUserEvents({ queryParams, config = {} }) {
|
|
859
950
|
const { client: request = client, ...requestConfig } = config;
|
|
860
|
-
const data = await request({ method: 'GET', url:
|
|
951
|
+
const data = await request({ method: 'GET', url: `/v3/events`, queryParams, ...requestConfig });
|
|
861
952
|
return data;
|
|
862
953
|
}
|
|
863
954
|
/**
|
|
864
955
|
* @description Fetches the best account or user’s contact info
|
|
865
956
|
* @summary Get Account Information
|
|
866
|
-
* {@link
|
|
957
|
+
* {@link /v1/installations/:integrationConfigurationId/account}
|
|
867
958
|
*/
|
|
868
|
-
export async function getAccountInfo({ pathParams: { integrationConfigurationId }, config = {}
|
|
959
|
+
export async function getAccountInfo({ pathParams: { integrationConfigurationId }, config = {} }) {
|
|
869
960
|
const { client: request = client, ...requestConfig } = config;
|
|
870
961
|
if (!integrationConfigurationId) {
|
|
871
962
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
872
963
|
}
|
|
873
|
-
const data = await request({ method: 'GET', url:
|
|
964
|
+
const data = await request({ method: 'GET', url: `/v1/installations/${integrationConfigurationId}/account`, ...requestConfig });
|
|
874
965
|
return data;
|
|
875
966
|
}
|
|
876
967
|
/**
|
|
877
968
|
* @description Returns the member role and other information for a given member ID ("user_id" claim in the SSO OIDC token).
|
|
878
969
|
* @summary Get Member Information
|
|
879
|
-
* {@link
|
|
970
|
+
* {@link /v1/installations/:integrationConfigurationId/member/:memberId}
|
|
880
971
|
*/
|
|
881
|
-
export async function getMember({ pathParams: { integrationConfigurationId, memberId }, config = {}
|
|
972
|
+
export async function getMember({ pathParams: { integrationConfigurationId, memberId }, config = {} }) {
|
|
882
973
|
const { client: request = client, ...requestConfig } = config;
|
|
883
974
|
if (!integrationConfigurationId) {
|
|
884
975
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -886,46 +977,46 @@ export async function getMember({ pathParams: { integrationConfigurationId, memb
|
|
|
886
977
|
if (!memberId) {
|
|
887
978
|
throw new Error(`Missing required path parameter: memberId`);
|
|
888
979
|
}
|
|
889
|
-
const data = await request({ method: 'GET', url:
|
|
980
|
+
const data = await request({ method: 'GET', url: `/v1/installations/${integrationConfigurationId}/member/${memberId}`, ...requestConfig });
|
|
890
981
|
return data;
|
|
891
982
|
}
|
|
892
983
|
/**
|
|
893
984
|
* @description Partner notifies Vercel of any changes made to an Installation or a Resource. Vercel is expected to use `list-resources` and other read APIs to get the new state.<br/> <br/> `resource.updated` event should be dispatched when any state of a resource linked to Vercel is modified by the partner.<br/> `installation.updated` event should be dispatched when an installation's billing plan is changed via the provider instead of Vercel.<br/> <br/> Resource update use cases: <br/> <br/> - The user renames a database in the partner’s application. The partner should dispatch a `resource.updated` event to notify Vercel to update the resource in Vercel’s datastores.<br/> - A resource has been suspended due to a lack of use. The partner should dispatch a `resource.updated` event to notify Vercel to update the resource's status in Vercel's datastores.<br/>
|
|
894
985
|
* @summary Create Event
|
|
895
|
-
* {@link
|
|
986
|
+
* {@link /v1/installations/:integrationConfigurationId/events}
|
|
896
987
|
*/
|
|
897
|
-
export async function createEvent({ pathParams: { integrationConfigurationId }, config = {}
|
|
988
|
+
export async function createEvent({ pathParams: { integrationConfigurationId }, config = {} }) {
|
|
898
989
|
const { client: request = client, ...requestConfig } = config;
|
|
899
990
|
if (!integrationConfigurationId) {
|
|
900
991
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
901
992
|
}
|
|
902
993
|
const data = await request({
|
|
903
994
|
method: 'POST',
|
|
904
|
-
url:
|
|
995
|
+
url: `/v1/installations/${integrationConfigurationId}/events`,
|
|
905
996
|
...requestConfig,
|
|
906
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
997
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
907
998
|
});
|
|
908
999
|
return data;
|
|
909
1000
|
}
|
|
910
1001
|
/**
|
|
911
1002
|
* @description Get all resources for a given installation ID.
|
|
912
1003
|
* @summary Get Integration Resources
|
|
913
|
-
* {@link
|
|
1004
|
+
* {@link /v1/installations/:integrationConfigurationId/resources}
|
|
914
1005
|
*/
|
|
915
|
-
export async function getIntegrationResources({ pathParams: { integrationConfigurationId }, config = {}
|
|
1006
|
+
export async function getIntegrationResources({ pathParams: { integrationConfigurationId }, config = {} }) {
|
|
916
1007
|
const { client: request = client, ...requestConfig } = config;
|
|
917
1008
|
if (!integrationConfigurationId) {
|
|
918
1009
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
919
1010
|
}
|
|
920
|
-
const data = await request({ method: 'GET', url:
|
|
1011
|
+
const data = await request({ method: 'GET', url: `/v1/installations/${integrationConfigurationId}/resources`, ...requestConfig });
|
|
921
1012
|
return data;
|
|
922
1013
|
}
|
|
923
1014
|
/**
|
|
924
1015
|
* @description Get a resource by its partner ID.
|
|
925
1016
|
* @summary Get Integration Resource
|
|
926
|
-
* {@link
|
|
1017
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId}
|
|
927
1018
|
*/
|
|
928
|
-
export async function getIntegrationResource({ pathParams: { integrationConfigurationId, resourceId }, config = {}
|
|
1019
|
+
export async function getIntegrationResource({ pathParams: { integrationConfigurationId, resourceId }, config = {} }) {
|
|
929
1020
|
const { client: request = client, ...requestConfig } = config;
|
|
930
1021
|
if (!integrationConfigurationId) {
|
|
931
1022
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -933,15 +1024,19 @@ export async function getIntegrationResource({ pathParams: { integrationConfigur
|
|
|
933
1024
|
if (!resourceId) {
|
|
934
1025
|
throw new Error(`Missing required path parameter: resourceId`);
|
|
935
1026
|
}
|
|
936
|
-
const data = await request({
|
|
1027
|
+
const data = await request({
|
|
1028
|
+
method: 'GET',
|
|
1029
|
+
url: `/v1/installations/${integrationConfigurationId}/resources/${resourceId}`,
|
|
1030
|
+
...requestConfig
|
|
1031
|
+
});
|
|
937
1032
|
return data;
|
|
938
1033
|
}
|
|
939
1034
|
/**
|
|
940
1035
|
* @description Delete a resource owned by the selected installation ID.
|
|
941
1036
|
* @summary Delete Integration Resource
|
|
942
|
-
* {@link
|
|
1037
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId}
|
|
943
1038
|
*/
|
|
944
|
-
export async function deleteIntegrationResource({ pathParams: { integrationConfigurationId, resourceId }, config = {}
|
|
1039
|
+
export async function deleteIntegrationResource({ pathParams: { integrationConfigurationId, resourceId }, config = {} }) {
|
|
945
1040
|
const { client: request = client, ...requestConfig } = config;
|
|
946
1041
|
if (!integrationConfigurationId) {
|
|
947
1042
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -949,15 +1044,19 @@ export async function deleteIntegrationResource({ pathParams: { integrationConfi
|
|
|
949
1044
|
if (!resourceId) {
|
|
950
1045
|
throw new Error(`Missing required path parameter: resourceId`);
|
|
951
1046
|
}
|
|
952
|
-
const data = await request({
|
|
1047
|
+
const data = await request({
|
|
1048
|
+
method: 'DELETE',
|
|
1049
|
+
url: `/v1/installations/${integrationConfigurationId}/resources/${resourceId}`,
|
|
1050
|
+
...requestConfig
|
|
1051
|
+
});
|
|
953
1052
|
return data;
|
|
954
1053
|
}
|
|
955
1054
|
/**
|
|
956
1055
|
* @description This endpoint imports (upserts) a resource to Vercel's installation. This may be needed if resources can be independently created on the partner's side and need to be synchronized to Vercel.
|
|
957
1056
|
* @summary Import Resource
|
|
958
|
-
* {@link
|
|
1057
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId}
|
|
959
1058
|
*/
|
|
960
|
-
export async function importResource({ pathParams: { integrationConfigurationId, resourceId }, config = {}
|
|
1059
|
+
export async function importResource({ pathParams: { integrationConfigurationId, resourceId }, config = {} }) {
|
|
961
1060
|
const { client: request = client, ...requestConfig } = config;
|
|
962
1061
|
if (!integrationConfigurationId) {
|
|
963
1062
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -967,54 +1066,54 @@ export async function importResource({ pathParams: { integrationConfigurationId,
|
|
|
967
1066
|
}
|
|
968
1067
|
const data = await request({
|
|
969
1068
|
method: 'PUT',
|
|
970
|
-
url:
|
|
1069
|
+
url: `/v1/installations/${integrationConfigurationId}/resources/${resourceId}`,
|
|
971
1070
|
...requestConfig,
|
|
972
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1071
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
973
1072
|
});
|
|
974
1073
|
return data;
|
|
975
1074
|
}
|
|
976
1075
|
/**
|
|
977
1076
|
* @description Sends the billing and usage data. The partner should do this at least once a day and ideally once per hour. <br/> Use the `credentials.access_token` we provided in the [Upsert Installation](#upsert-installation) body to authorize this request.
|
|
978
1077
|
* @summary Submit Billing Data
|
|
979
|
-
* {@link
|
|
1078
|
+
* {@link /v1/installations/:integrationConfigurationId/billing}
|
|
980
1079
|
*/
|
|
981
|
-
export async function submitBillingData({ pathParams: { integrationConfigurationId }, config = {}
|
|
1080
|
+
export async function submitBillingData({ pathParams: { integrationConfigurationId }, config = {} }) {
|
|
982
1081
|
const { client: request = client, ...requestConfig } = config;
|
|
983
1082
|
if (!integrationConfigurationId) {
|
|
984
1083
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
985
1084
|
}
|
|
986
1085
|
const data = await request({
|
|
987
1086
|
method: 'POST',
|
|
988
|
-
url:
|
|
1087
|
+
url: `/v1/installations/${integrationConfigurationId}/billing`,
|
|
989
1088
|
...requestConfig,
|
|
990
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1089
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
991
1090
|
});
|
|
992
1091
|
return data;
|
|
993
1092
|
}
|
|
994
1093
|
/**
|
|
995
1094
|
* @description This endpoint allows the partner to submit an invoice to Vercel. The invoice is created in Vercel's billing system and sent to the customer. Depending on the type of billing plan, the invoice can be sent at a time of signup, at the start of the billing period, or at the end of the billing period.<br/> <br/> Use the `credentials.access_token` we provided in the [Upsert Installation](#upsert-installation) body to authorize this request. <br/> There are several limitations to the invoice submission:<br/> <br/> 1. A resource can only be billed once per the billing period and the billing plan.<br/> 2. The billing plan used to bill the resource must have been active for this resource during the billing period.<br/> 3. The billing plan used must be a subscription plan.<br/> 4. The interim usage data must be sent hourly for all types of subscriptions. See [Send subscription billing and usage data](#send-subscription-billing-and-usage-data) API on how to send interim billing and usage data.<br/>
|
|
996
1095
|
* @summary Submit Invoice
|
|
997
|
-
* {@link
|
|
1096
|
+
* {@link /v1/installations/:integrationConfigurationId/billing/invoices}
|
|
998
1097
|
*/
|
|
999
|
-
export async function submitInvoice({ pathParams: { integrationConfigurationId }, config = {}
|
|
1098
|
+
export async function submitInvoice({ pathParams: { integrationConfigurationId }, config = {} }) {
|
|
1000
1099
|
const { client: request = client, ...requestConfig } = config;
|
|
1001
1100
|
if (!integrationConfigurationId) {
|
|
1002
1101
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
1003
1102
|
}
|
|
1004
1103
|
const data = await request({
|
|
1005
1104
|
method: 'POST',
|
|
1006
|
-
url:
|
|
1105
|
+
url: `/v1/installations/${integrationConfigurationId}/billing/invoices`,
|
|
1007
1106
|
...requestConfig,
|
|
1008
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1107
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1009
1108
|
});
|
|
1010
1109
|
return data;
|
|
1011
1110
|
}
|
|
1012
1111
|
/**
|
|
1013
1112
|
* @description Get Invoice details and status for a given invoice ID.<br/> <br/> See Billing Events with Webhooks documentation on how to receive invoice events. This endpoint is used to retrieve the invoice details.
|
|
1014
1113
|
* @summary Get Invoice
|
|
1015
|
-
* {@link
|
|
1114
|
+
* {@link /v1/installations/:integrationConfigurationId/billing/invoices/:invoiceId}
|
|
1016
1115
|
*/
|
|
1017
|
-
export async function getInvoice({ pathParams: { integrationConfigurationId, invoiceId }, config = {}
|
|
1116
|
+
export async function getInvoice({ pathParams: { integrationConfigurationId, invoiceId }, config = {} }) {
|
|
1018
1117
|
const { client: request = client, ...requestConfig } = config;
|
|
1019
1118
|
if (!integrationConfigurationId) {
|
|
1020
1119
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -1022,15 +1121,19 @@ export async function getInvoice({ pathParams: { integrationConfigurationId, inv
|
|
|
1022
1121
|
if (!invoiceId) {
|
|
1023
1122
|
throw new Error(`Missing required path parameter: invoiceId`);
|
|
1024
1123
|
}
|
|
1025
|
-
const data = await request({
|
|
1124
|
+
const data = await request({
|
|
1125
|
+
method: 'GET',
|
|
1126
|
+
url: `/v1/installations/${integrationConfigurationId}/billing/invoices/${invoiceId}`,
|
|
1127
|
+
...requestConfig
|
|
1128
|
+
});
|
|
1026
1129
|
return data;
|
|
1027
1130
|
}
|
|
1028
1131
|
/**
|
|
1029
1132
|
* @description This endpoint allows the partner to request a refund for an invoice to Vercel. The invoice is created using the [Submit Invoice API](#submit-invoice-api).
|
|
1030
1133
|
* @summary Invoice Actions
|
|
1031
|
-
* {@link
|
|
1134
|
+
* {@link /v1/installations/:integrationConfigurationId/billing/invoices/:invoiceId/actions}
|
|
1032
1135
|
*/
|
|
1033
|
-
export async function updateInvoice({ pathParams: { integrationConfigurationId, invoiceId }, config = {}
|
|
1136
|
+
export async function updateInvoice({ pathParams: { integrationConfigurationId, invoiceId }, config = {} }) {
|
|
1034
1137
|
const { client: request = client, ...requestConfig } = config;
|
|
1035
1138
|
if (!integrationConfigurationId) {
|
|
1036
1139
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -1040,36 +1143,36 @@ export async function updateInvoice({ pathParams: { integrationConfigurationId,
|
|
|
1040
1143
|
}
|
|
1041
1144
|
const data = await request({
|
|
1042
1145
|
method: 'POST',
|
|
1043
|
-
url:
|
|
1146
|
+
url: `/v1/installations/${integrationConfigurationId}/billing/invoices/${invoiceId}/actions`,
|
|
1044
1147
|
...requestConfig,
|
|
1045
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1148
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1046
1149
|
});
|
|
1047
1150
|
return data;
|
|
1048
1151
|
}
|
|
1049
1152
|
/**
|
|
1050
1153
|
* @description Sends the prepayment balances. The partner should do this at least once a day and ideally once per hour. <br/> Use the `credentials.access_token` we provided in the [Upsert Installation](#upsert-installation) body to authorize this request.
|
|
1051
1154
|
* @summary Submit Prepayment Balances
|
|
1052
|
-
* {@link
|
|
1155
|
+
* {@link /v1/installations/:integrationConfigurationId/billing/balance}
|
|
1053
1156
|
*/
|
|
1054
|
-
export async function submitPrepaymentBalances({ pathParams: { integrationConfigurationId }, config = {}
|
|
1157
|
+
export async function submitPrepaymentBalances({ pathParams: { integrationConfigurationId }, config = {} }) {
|
|
1055
1158
|
const { client: request = client, ...requestConfig } = config;
|
|
1056
1159
|
if (!integrationConfigurationId) {
|
|
1057
1160
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
1058
1161
|
}
|
|
1059
1162
|
const data = await request({
|
|
1060
1163
|
method: 'POST',
|
|
1061
|
-
url:
|
|
1164
|
+
url: `/v1/installations/${integrationConfigurationId}/billing/balance`,
|
|
1062
1165
|
...requestConfig,
|
|
1063
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1166
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1064
1167
|
});
|
|
1065
1168
|
return data;
|
|
1066
1169
|
}
|
|
1067
1170
|
/**
|
|
1068
1171
|
* @description This endpoint is deprecated and replaced with the endpoint [Update Resource Secrets](#update-resource-secrets). <br/> This endpoint updates the secrets of a resource. If a resource has projects connected, the connected secrets are updated with the new secrets. The old secrets may still be used by existing connected projects because they are not automatically redeployed. Redeployment is a manual action and must be completed by the user. All new project connections will use the new secrets.<br/> <br/> Use cases for this endpoint:<br/> <br/> - Resetting the credentials of a database in the partner. If the user requests the credentials to be updated in the partner’s application, the partner post the new set of secrets to Vercel, the user should redeploy their application and the expire the old credentials.<br/>
|
|
1069
1172
|
* @summary Update Resource Secrets (Deprecated)
|
|
1070
|
-
* {@link
|
|
1173
|
+
* {@link /v1/installations/:integrationConfigurationId/products/:integrationProductIdOrSlug/resources/:resourceId/secrets}
|
|
1071
1174
|
*/
|
|
1072
|
-
export async function updateResourceSecrets({ pathParams: { integrationConfigurationId, integrationProductIdOrSlug, resourceId }, config = {}
|
|
1175
|
+
export async function updateResourceSecrets({ pathParams: { integrationConfigurationId, integrationProductIdOrSlug, resourceId }, config = {} }) {
|
|
1073
1176
|
const { client: request = client, ...requestConfig } = config;
|
|
1074
1177
|
if (!integrationConfigurationId) {
|
|
1075
1178
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -1082,18 +1185,18 @@ export async function updateResourceSecrets({ pathParams: { integrationConfigura
|
|
|
1082
1185
|
}
|
|
1083
1186
|
const data = await request({
|
|
1084
1187
|
method: 'PUT',
|
|
1085
|
-
url:
|
|
1188
|
+
url: `/v1/installations/${integrationConfigurationId}/products/${integrationProductIdOrSlug}/resources/${resourceId}/secrets`,
|
|
1086
1189
|
...requestConfig,
|
|
1087
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1190
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1088
1191
|
});
|
|
1089
1192
|
return data;
|
|
1090
1193
|
}
|
|
1091
1194
|
/**
|
|
1092
1195
|
* @description This endpoint updates the secrets of a resource. If a resource has projects connected, the connected secrets are updated with the new secrets. The old secrets may still be used by existing connected projects because they are not automatically redeployed. Redeployment is a manual action and must be completed by the user. All new project connections will use the new secrets.<br/> <br/> Use cases for this endpoint:<br/> <br/> - Resetting the credentials of a database in the partner. If the user requests the credentials to be updated in the partner’s application, the partner post the new set of secrets to Vercel, the user should redeploy their application and the expire the old credentials.<br/>
|
|
1093
1196
|
* @summary Update Resource Secrets
|
|
1094
|
-
* {@link
|
|
1197
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId/secrets}
|
|
1095
1198
|
*/
|
|
1096
|
-
export async function updateResourceSecretsById({ pathParams: { integrationConfigurationId, resourceId }, config = {}
|
|
1199
|
+
export async function updateResourceSecretsById({ pathParams: { integrationConfigurationId, resourceId }, config = {} }) {
|
|
1097
1200
|
const { client: request = client, ...requestConfig } = config;
|
|
1098
1201
|
if (!integrationConfigurationId) {
|
|
1099
1202
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -1103,97 +1206,108 @@ export async function updateResourceSecretsById({ pathParams: { integrationConfi
|
|
|
1103
1206
|
}
|
|
1104
1207
|
const data = await request({
|
|
1105
1208
|
method: 'PUT',
|
|
1106
|
-
url:
|
|
1209
|
+
url: `/v1/installations/${integrationConfigurationId}/resources/${resourceId}/secrets`,
|
|
1107
1210
|
...requestConfig,
|
|
1108
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1211
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1109
1212
|
});
|
|
1110
1213
|
return data;
|
|
1111
1214
|
}
|
|
1112
1215
|
/**
|
|
1113
1216
|
* @description Allows to retrieve all configurations for an authenticated integration. When the `project` view is used, configurations generated for the authorization flow will be filtered out of the results.
|
|
1114
1217
|
* @summary Get configurations for the authenticated user or team
|
|
1115
|
-
* {@link
|
|
1218
|
+
* {@link /v1/integrations/configurations}
|
|
1116
1219
|
*/
|
|
1117
|
-
export async function getConfigurations({ queryParams, config = {}
|
|
1220
|
+
export async function getConfigurations({ queryParams, config = {} }) {
|
|
1118
1221
|
const { client: request = client, ...requestConfig } = config;
|
|
1119
|
-
const data = await request({ method: 'GET', url:
|
|
1222
|
+
const data = await request({ method: 'GET', url: `/v1/integrations/configurations`, queryParams, ...requestConfig });
|
|
1120
1223
|
return data;
|
|
1121
1224
|
}
|
|
1122
1225
|
/**
|
|
1123
1226
|
* @description Allows to retrieve a the configuration with the provided id in case it exists. The authenticated user or team must be the owner of the config in order to access it.
|
|
1124
1227
|
* @summary Retrieve an integration configuration
|
|
1125
|
-
* {@link
|
|
1228
|
+
* {@link /v1/integrations/configuration/:id}
|
|
1126
1229
|
*/
|
|
1127
|
-
export async function getConfiguration({ pathParams: { id }, queryParams, config = {}
|
|
1230
|
+
export async function getConfiguration({ pathParams: { id }, queryParams, config = {} }) {
|
|
1128
1231
|
const { client: request = client, ...requestConfig } = config;
|
|
1129
1232
|
if (!id) {
|
|
1130
1233
|
throw new Error(`Missing required path parameter: id`);
|
|
1131
1234
|
}
|
|
1132
|
-
const data = await request({ method: 'GET', url:
|
|
1235
|
+
const data = await request({ method: 'GET', url: `/v1/integrations/configuration/${id}`, queryParams, ...requestConfig });
|
|
1133
1236
|
return data;
|
|
1134
1237
|
}
|
|
1135
1238
|
/**
|
|
1136
1239
|
* @description Allows to remove the configuration with the `id` provided in the parameters. The configuration and all of its resources will be removed. This includes Webhooks, LogDrains and Project Env variables.
|
|
1137
1240
|
* @summary Delete an integration configuration
|
|
1138
|
-
* {@link
|
|
1241
|
+
* {@link /v1/integrations/configuration/:id}
|
|
1139
1242
|
*/
|
|
1140
|
-
export async function deleteConfiguration({ pathParams: { id }, queryParams, config = {}
|
|
1243
|
+
export async function deleteConfiguration({ pathParams: { id }, queryParams, config = {} }) {
|
|
1141
1244
|
const { client: request = client, ...requestConfig } = config;
|
|
1142
1245
|
if (!id) {
|
|
1143
1246
|
throw new Error(`Missing required path parameter: id`);
|
|
1144
1247
|
}
|
|
1145
|
-
const data = await request({ method: 'DELETE', url:
|
|
1248
|
+
const data = await request({ method: 'DELETE', url: `/v1/integrations/configuration/${id}`, queryParams, ...requestConfig });
|
|
1146
1249
|
return data;
|
|
1147
1250
|
}
|
|
1148
1251
|
/**
|
|
1149
1252
|
* @description During the autorization process, Vercel sends the user to the provider [redirectLoginUrl](https://vercel.com/docs/integrations/create-integration/submit-integration#redirect-login-url), that includes the OAuth authorization `code` parameter. The provider then calls the SSO Token Exchange endpoint with the sent code and receives the OIDC token. They log the user in based on this token and redirects the user back to the Vercel account using deep-link parameters included the redirectLoginUrl. Providers should not persist the returned `id_token` in a database since the token will expire. See [**Authentication with SSO**](https://vercel.com/docs/integrations/create-integration/marketplace-api#authentication-with-sso) for more details.
|
|
1150
1253
|
* @summary SSO Token Exchange
|
|
1151
|
-
* {@link
|
|
1254
|
+
* {@link /v1/integrations/sso/token}
|
|
1152
1255
|
*/
|
|
1153
1256
|
export async function exchangeSsoToken({ config = {} }) {
|
|
1154
1257
|
const { client: request = client, ...requestConfig } = config;
|
|
1155
|
-
const data = await request({
|
|
1258
|
+
const data = await request({
|
|
1259
|
+
method: 'POST',
|
|
1260
|
+
url: `/v1/integrations/sso/token`,
|
|
1261
|
+
...requestConfig,
|
|
1262
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1263
|
+
});
|
|
1156
1264
|
return data;
|
|
1157
1265
|
}
|
|
1158
1266
|
/**
|
|
1159
1267
|
* @description 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.
|
|
1160
1268
|
* @summary Retrieves a list of Integration log drains
|
|
1161
|
-
* {@link
|
|
1269
|
+
* {@link /v2/integrations/log-drains}
|
|
1162
1270
|
*/
|
|
1163
|
-
export async function getIntegrationLogDrains({ queryParams, config = {}
|
|
1271
|
+
export async function getIntegrationLogDrains({ queryParams, config = {} }) {
|
|
1164
1272
|
const { client: request = client, ...requestConfig } = config;
|
|
1165
|
-
const data = await request({ method: 'GET', url:
|
|
1273
|
+
const data = await request({ method: 'GET', url: `/v2/integrations/log-drains`, queryParams, ...requestConfig });
|
|
1166
1274
|
return data;
|
|
1167
1275
|
}
|
|
1168
1276
|
/**
|
|
1169
1277
|
* @description Creates an Integration log drain. This endpoint must be called with an OAuth2 client (integration), since log drains are tied to integrations. If it is called with a different token type it will produce a 400 error.
|
|
1170
1278
|
* @summary Creates a new Integration Log Drain
|
|
1171
|
-
* {@link
|
|
1279
|
+
* {@link /v2/integrations/log-drains}
|
|
1172
1280
|
*/
|
|
1173
|
-
export async function createLogDrain({ queryParams, config = {}
|
|
1281
|
+
export async function createLogDrain({ queryParams, config = {} }) {
|
|
1174
1282
|
const { client: request = client, ...requestConfig } = config;
|
|
1175
|
-
const data = await request({
|
|
1283
|
+
const data = await request({
|
|
1284
|
+
method: 'POST',
|
|
1285
|
+
url: `/v2/integrations/log-drains`,
|
|
1286
|
+
queryParams,
|
|
1287
|
+
...requestConfig,
|
|
1288
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1289
|
+
});
|
|
1176
1290
|
return data;
|
|
1177
1291
|
}
|
|
1178
1292
|
/**
|
|
1179
1293
|
* @description Deletes the Integration log drain with the provided `id`. When using an OAuth2 Token, the log drain can be deleted only if the integration owns it.
|
|
1180
1294
|
* @summary Deletes the Integration log drain with the provided `id`
|
|
1181
|
-
* {@link
|
|
1295
|
+
* {@link /v1/integrations/log-drains/:id}
|
|
1182
1296
|
*/
|
|
1183
|
-
export async function deleteIntegrationLogDrain({ pathParams: { id }, queryParams, config = {}
|
|
1297
|
+
export async function deleteIntegrationLogDrain({ pathParams: { id }, queryParams, config = {} }) {
|
|
1184
1298
|
const { client: request = client, ...requestConfig } = config;
|
|
1185
1299
|
if (!id) {
|
|
1186
1300
|
throw new Error(`Missing required path parameter: id`);
|
|
1187
1301
|
}
|
|
1188
|
-
const data = await request({ method: 'DELETE', url:
|
|
1302
|
+
const data = await request({ method: 'DELETE', url: `/v1/integrations/log-drains/${id}`, queryParams, ...requestConfig });
|
|
1189
1303
|
return data;
|
|
1190
1304
|
}
|
|
1191
1305
|
/**
|
|
1192
1306
|
* @description Returns a stream of logs for a given deployment.
|
|
1193
1307
|
* @summary Get logs for a deployment
|
|
1194
|
-
* {@link
|
|
1308
|
+
* {@link /v1/projects/:projectId/deployments/:deploymentId/runtime-logs}
|
|
1195
1309
|
*/
|
|
1196
|
-
export async function getRuntimeLogs({ pathParams: { projectId, deploymentId }, queryParams, config = {}
|
|
1310
|
+
export async function getRuntimeLogs({ pathParams: { projectId, deploymentId }, queryParams, config = {} }) {
|
|
1197
1311
|
const { client: request = client, ...requestConfig } = config;
|
|
1198
1312
|
if (!projectId) {
|
|
1199
1313
|
throw new Error(`Missing required path parameter: projectId`);
|
|
@@ -1201,15 +1315,20 @@ export async function getRuntimeLogs({ pathParams: { projectId, deploymentId },
|
|
|
1201
1315
|
if (!deploymentId) {
|
|
1202
1316
|
throw new Error(`Missing required path parameter: deploymentId`);
|
|
1203
1317
|
}
|
|
1204
|
-
const data = await request({
|
|
1318
|
+
const data = await request({
|
|
1319
|
+
method: 'GET',
|
|
1320
|
+
url: `/v1/projects/${projectId}/deployments/${deploymentId}/runtime-logs`,
|
|
1321
|
+
queryParams,
|
|
1322
|
+
...requestConfig
|
|
1323
|
+
});
|
|
1205
1324
|
return data;
|
|
1206
1325
|
}
|
|
1207
1326
|
/**
|
|
1208
1327
|
* @description Create one or multiple experimentation items
|
|
1209
1328
|
* @summary Create one or multiple experimentation items
|
|
1210
|
-
* {@link
|
|
1329
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId/experimentation/items}
|
|
1211
1330
|
*/
|
|
1212
|
-
export async function createExperimentationItem({ pathParams: { integrationConfigurationId, resourceId }, config = {}
|
|
1331
|
+
export async function createExperimentationItem({ pathParams: { integrationConfigurationId, resourceId }, config = {} }) {
|
|
1213
1332
|
const { client: request = client, ...requestConfig } = config;
|
|
1214
1333
|
if (!integrationConfigurationId) {
|
|
1215
1334
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -1219,18 +1338,18 @@ export async function createExperimentationItem({ pathParams: { integrationConfi
|
|
|
1219
1338
|
}
|
|
1220
1339
|
const data = await request({
|
|
1221
1340
|
method: 'POST',
|
|
1222
|
-
url:
|
|
1341
|
+
url: `/v1/installations/${integrationConfigurationId}/resources/${resourceId}/experimentation/items`,
|
|
1223
1342
|
...requestConfig,
|
|
1224
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1343
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1225
1344
|
});
|
|
1226
1345
|
return data;
|
|
1227
1346
|
}
|
|
1228
1347
|
/**
|
|
1229
1348
|
* @description Patch an existing experimentation item
|
|
1230
1349
|
* @summary Patch an existing experimentation item
|
|
1231
|
-
* {@link
|
|
1350
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId/experimentation/items/:itemId}
|
|
1232
1351
|
*/
|
|
1233
|
-
export async function updateExperimentationItem({ pathParams: { integrationConfigurationId, resourceId, itemId }, config = {}
|
|
1352
|
+
export async function updateExperimentationItem({ pathParams: { integrationConfigurationId, resourceId, itemId }, config = {} }) {
|
|
1234
1353
|
const { client: request = client, ...requestConfig } = config;
|
|
1235
1354
|
if (!integrationConfigurationId) {
|
|
1236
1355
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -1243,18 +1362,18 @@ export async function updateExperimentationItem({ pathParams: { integrationConfi
|
|
|
1243
1362
|
}
|
|
1244
1363
|
const data = await request({
|
|
1245
1364
|
method: 'PATCH',
|
|
1246
|
-
url:
|
|
1365
|
+
url: `/v1/installations/${integrationConfigurationId}/resources/${resourceId}/experimentation/items/${itemId}`,
|
|
1247
1366
|
...requestConfig,
|
|
1248
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1367
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1249
1368
|
});
|
|
1250
1369
|
return data;
|
|
1251
1370
|
}
|
|
1252
1371
|
/**
|
|
1253
1372
|
* @description Delete an existing experimentation item
|
|
1254
1373
|
* @summary Delete an existing experimentation item
|
|
1255
|
-
* {@link
|
|
1374
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId/experimentation/items/:itemId}
|
|
1256
1375
|
*/
|
|
1257
|
-
export async function deleteExperimentationItem({ pathParams: { integrationConfigurationId, resourceId, itemId }, config = {}
|
|
1376
|
+
export async function deleteExperimentationItem({ pathParams: { integrationConfigurationId, resourceId, itemId }, config = {} }) {
|
|
1258
1377
|
const { client: request = client, ...requestConfig } = config;
|
|
1259
1378
|
if (!integrationConfigurationId) {
|
|
1260
1379
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -1265,15 +1384,19 @@ export async function deleteExperimentationItem({ pathParams: { integrationConfi
|
|
|
1265
1384
|
if (!itemId) {
|
|
1266
1385
|
throw new Error(`Missing required path parameter: itemId`);
|
|
1267
1386
|
}
|
|
1268
|
-
const data = await request({
|
|
1387
|
+
const data = await request({
|
|
1388
|
+
method: 'DELETE',
|
|
1389
|
+
url: `/v1/installations/${integrationConfigurationId}/resources/${resourceId}/experimentation/items/${itemId}`,
|
|
1390
|
+
...requestConfig
|
|
1391
|
+
});
|
|
1269
1392
|
return data;
|
|
1270
1393
|
}
|
|
1271
1394
|
/**
|
|
1272
1395
|
* @description When the user enabled Edge Config syncing, then this endpoint can be used by the partner to push their configuration data into the relevant Edge Config.
|
|
1273
1396
|
* @summary Push data into a user-provided Edge Config
|
|
1274
|
-
* {@link
|
|
1397
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId/experimentation/edge-config}
|
|
1275
1398
|
*/
|
|
1276
|
-
export async function updateExperimentationEdgeConfig({ pathParams: { integrationConfigurationId, resourceId }, config = {}
|
|
1399
|
+
export async function updateExperimentationEdgeConfig({ pathParams: { integrationConfigurationId, resourceId }, config = {} }) {
|
|
1277
1400
|
const { client: request = client, ...requestConfig } = config;
|
|
1278
1401
|
if (!integrationConfigurationId) {
|
|
1279
1402
|
throw new Error(`Missing required path parameter: integrationConfigurationId`);
|
|
@@ -1283,50 +1406,50 @@ export async function updateExperimentationEdgeConfig({ pathParams: { integratio
|
|
|
1283
1406
|
}
|
|
1284
1407
|
const data = await request({
|
|
1285
1408
|
method: 'PUT',
|
|
1286
|
-
url:
|
|
1409
|
+
url: `/v1/installations/${integrationConfigurationId}/resources/${resourceId}/experimentation/edge-config`,
|
|
1287
1410
|
...requestConfig,
|
|
1288
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1411
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1289
1412
|
});
|
|
1290
1413
|
return data;
|
|
1291
1414
|
}
|
|
1292
1415
|
/**
|
|
1293
1416
|
* @description Lists all members of a project.
|
|
1294
1417
|
* @summary List project members
|
|
1295
|
-
* {@link
|
|
1418
|
+
* {@link /v1/projects/:idOrName/members}
|
|
1296
1419
|
*/
|
|
1297
|
-
export async function getProjectMembers({ pathParams: { idOrName }, queryParams, config = {}
|
|
1420
|
+
export async function getProjectMembers({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1298
1421
|
const { client: request = client, ...requestConfig } = config;
|
|
1299
1422
|
if (!idOrName) {
|
|
1300
1423
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1301
1424
|
}
|
|
1302
|
-
const data = await request({ method: 'GET', url:
|
|
1425
|
+
const data = await request({ method: 'GET', url: `/v1/projects/${idOrName}/members`, queryParams, ...requestConfig });
|
|
1303
1426
|
return data;
|
|
1304
1427
|
}
|
|
1305
1428
|
/**
|
|
1306
1429
|
* @description Adds a new member to the project.
|
|
1307
1430
|
* @summary Adds a new member to a project.
|
|
1308
|
-
* {@link
|
|
1431
|
+
* {@link /v1/projects/:idOrName/members}
|
|
1309
1432
|
*/
|
|
1310
|
-
export async function addProjectMember({ pathParams: { idOrName }, queryParams, config = {}
|
|
1433
|
+
export async function addProjectMember({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1311
1434
|
const { client: request = client, ...requestConfig } = config;
|
|
1312
1435
|
if (!idOrName) {
|
|
1313
1436
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1314
1437
|
}
|
|
1315
1438
|
const data = await request({
|
|
1316
1439
|
method: 'POST',
|
|
1317
|
-
url:
|
|
1440
|
+
url: `/v1/projects/${idOrName}/members`,
|
|
1318
1441
|
queryParams,
|
|
1319
1442
|
...requestConfig,
|
|
1320
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1443
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1321
1444
|
});
|
|
1322
1445
|
return data;
|
|
1323
1446
|
}
|
|
1324
1447
|
/**
|
|
1325
1448
|
* @description Remove a member from a specific project
|
|
1326
1449
|
* @summary Remove a Project Member
|
|
1327
|
-
* {@link
|
|
1450
|
+
* {@link /v1/projects/:idOrName/members/:uid}
|
|
1328
1451
|
*/
|
|
1329
|
-
export async function removeProjectMember({ pathParams: { idOrName, uid }, queryParams, config = {}
|
|
1452
|
+
export async function removeProjectMember({ pathParams: { idOrName, uid }, queryParams, config = {} }) {
|
|
1330
1453
|
const { client: request = client, ...requestConfig } = config;
|
|
1331
1454
|
if (!idOrName) {
|
|
1332
1455
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1334,106 +1457,118 @@ export async function removeProjectMember({ pathParams: { idOrName, uid }, query
|
|
|
1334
1457
|
if (!uid) {
|
|
1335
1458
|
throw new Error(`Missing required path parameter: uid`);
|
|
1336
1459
|
}
|
|
1337
|
-
const data = await request({ method: 'DELETE', url:
|
|
1460
|
+
const data = await request({ method: 'DELETE', url: `/v1/projects/${idOrName}/members/${uid}`, queryParams, ...requestConfig });
|
|
1338
1461
|
return data;
|
|
1339
1462
|
}
|
|
1340
1463
|
/**
|
|
1341
1464
|
* @description Allows to retrieve the list of projects of the authenticated user or team. The list will be paginated and the provided query parameters allow filtering the returned projects.
|
|
1342
1465
|
* @summary Retrieve a list of projects
|
|
1343
|
-
* {@link
|
|
1466
|
+
* {@link /v10/projects}
|
|
1344
1467
|
*/
|
|
1345
|
-
export async function getProjects({ queryParams, config = {}
|
|
1468
|
+
export async function getProjects({ queryParams, config = {} }) {
|
|
1346
1469
|
const { client: request = client, ...requestConfig } = config;
|
|
1347
|
-
const data = await request({ method: 'GET', url:
|
|
1470
|
+
const data = await request({ method: 'GET', url: `/v10/projects`, queryParams, ...requestConfig });
|
|
1348
1471
|
return data;
|
|
1349
1472
|
}
|
|
1350
1473
|
/**
|
|
1351
1474
|
* @description Allows to create a new project with the provided configuration. It only requires the project `name` but more configuration can be provided to override the defaults.
|
|
1352
1475
|
* @summary Create a new project
|
|
1353
|
-
* {@link
|
|
1476
|
+
* {@link /v11/projects}
|
|
1354
1477
|
*/
|
|
1355
|
-
export async function createProject({ queryParams, config = {}
|
|
1478
|
+
export async function createProject({ queryParams, config = {} }) {
|
|
1356
1479
|
const { client: request = client, ...requestConfig } = config;
|
|
1357
|
-
const data = await request({
|
|
1480
|
+
const data = await request({
|
|
1481
|
+
method: 'POST',
|
|
1482
|
+
url: `/v11/projects`,
|
|
1483
|
+
queryParams,
|
|
1484
|
+
...requestConfig,
|
|
1485
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1486
|
+
});
|
|
1358
1487
|
return data;
|
|
1359
1488
|
}
|
|
1360
1489
|
/**
|
|
1361
1490
|
* @description Get the information for a specific project by passing either the project `id` or `name` in the URL.
|
|
1362
1491
|
* @summary Find a project by id or name
|
|
1363
|
-
* {@link
|
|
1492
|
+
* {@link /v9/projects/:idOrName}
|
|
1364
1493
|
*/
|
|
1365
|
-
export async function getProject({ pathParams: { idOrName }, queryParams, config = {}
|
|
1494
|
+
export async function getProject({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1366
1495
|
const { client: request = client, ...requestConfig } = config;
|
|
1367
1496
|
if (!idOrName) {
|
|
1368
1497
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1369
1498
|
}
|
|
1370
|
-
const data = await request({ method: 'GET', url:
|
|
1499
|
+
const data = await request({ method: 'GET', url: `/v9/projects/${idOrName}`, queryParams, ...requestConfig });
|
|
1371
1500
|
return data;
|
|
1372
1501
|
}
|
|
1373
1502
|
/**
|
|
1374
1503
|
* @description Update the fields of a project using either its `name` or `id`.
|
|
1375
1504
|
* @summary Update an existing project
|
|
1376
|
-
* {@link
|
|
1505
|
+
* {@link /v9/projects/:idOrName}
|
|
1377
1506
|
*/
|
|
1378
|
-
export async function updateProject({ pathParams: { idOrName }, queryParams, config = {}
|
|
1507
|
+
export async function updateProject({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1379
1508
|
const { client: request = client, ...requestConfig } = config;
|
|
1380
1509
|
if (!idOrName) {
|
|
1381
1510
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1382
1511
|
}
|
|
1383
|
-
const data = await request({
|
|
1512
|
+
const data = await request({
|
|
1513
|
+
method: 'PATCH',
|
|
1514
|
+
url: `/v9/projects/${idOrName}`,
|
|
1515
|
+
queryParams,
|
|
1516
|
+
...requestConfig,
|
|
1517
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1518
|
+
});
|
|
1384
1519
|
return data;
|
|
1385
1520
|
}
|
|
1386
1521
|
/**
|
|
1387
1522
|
* @description Delete a specific project by passing either the project `id` or `name` in the URL.
|
|
1388
1523
|
* @summary Delete a Project
|
|
1389
|
-
* {@link
|
|
1524
|
+
* {@link /v9/projects/:idOrName}
|
|
1390
1525
|
*/
|
|
1391
|
-
export async function deleteProject({ pathParams: { idOrName }, queryParams, config = {}
|
|
1526
|
+
export async function deleteProject({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1392
1527
|
const { client: request = client, ...requestConfig } = config;
|
|
1393
1528
|
if (!idOrName) {
|
|
1394
1529
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1395
1530
|
}
|
|
1396
|
-
const data = await request({ method: 'DELETE', url:
|
|
1531
|
+
const data = await request({ method: 'DELETE', url: `/v9/projects/${idOrName}`, queryParams, ...requestConfig });
|
|
1397
1532
|
return data;
|
|
1398
1533
|
}
|
|
1399
1534
|
/**
|
|
1400
1535
|
* @description Creates a custom environment for the current project. Cannot be named 'Production' or 'Preview'.
|
|
1401
1536
|
* @summary Create a custom environment for the current project.
|
|
1402
|
-
* {@link
|
|
1537
|
+
* {@link /v9/projects/:idOrName/custom-environments}
|
|
1403
1538
|
*/
|
|
1404
|
-
export async function createCustomEnvironment({ pathParams: { idOrName }, queryParams, config = {}
|
|
1539
|
+
export async function createCustomEnvironment({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1405
1540
|
const { client: request = client, ...requestConfig } = config;
|
|
1406
1541
|
if (!idOrName) {
|
|
1407
1542
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1408
1543
|
}
|
|
1409
1544
|
const data = await request({
|
|
1410
1545
|
method: 'POST',
|
|
1411
|
-
url:
|
|
1546
|
+
url: `/v9/projects/${idOrName}/custom-environments`,
|
|
1412
1547
|
queryParams,
|
|
1413
1548
|
...requestConfig,
|
|
1414
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1549
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1415
1550
|
});
|
|
1416
1551
|
return data;
|
|
1417
1552
|
}
|
|
1418
1553
|
/**
|
|
1419
1554
|
* @description Retrieve custom environments for the project. Must not be named 'Production' or 'Preview'.
|
|
1420
1555
|
* @summary Retrieve custom environments
|
|
1421
|
-
* {@link
|
|
1556
|
+
* {@link /v9/projects/:idOrName/custom-environments}
|
|
1422
1557
|
*/
|
|
1423
|
-
export async function listCustomEnvironments({ pathParams: { idOrName }, queryParams, config = {}
|
|
1558
|
+
export async function listCustomEnvironments({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1424
1559
|
const { client: request = client, ...requestConfig } = config;
|
|
1425
1560
|
if (!idOrName) {
|
|
1426
1561
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1427
1562
|
}
|
|
1428
|
-
const data = await request({ method: 'GET', url:
|
|
1563
|
+
const data = await request({ method: 'GET', url: `/v9/projects/${idOrName}/custom-environments`, queryParams, ...requestConfig });
|
|
1429
1564
|
return data;
|
|
1430
1565
|
}
|
|
1431
1566
|
/**
|
|
1432
1567
|
* @description Retrieve a custom environment for the project. Must not be named 'Production' or 'Preview'.
|
|
1433
1568
|
* @summary Retrieve a custom environment
|
|
1434
|
-
* {@link
|
|
1569
|
+
* {@link /v9/projects/:idOrName/custom-environments/:environmentSlugOrId}
|
|
1435
1570
|
*/
|
|
1436
|
-
export async function getCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config = {}
|
|
1571
|
+
export async function getCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config = {} }) {
|
|
1437
1572
|
const { client: request = client, ...requestConfig } = config;
|
|
1438
1573
|
if (!idOrName) {
|
|
1439
1574
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1441,15 +1576,20 @@ export async function getCustomEnvironment({ pathParams: { idOrName, environment
|
|
|
1441
1576
|
if (!environmentSlugOrId) {
|
|
1442
1577
|
throw new Error(`Missing required path parameter: environmentSlugOrId`);
|
|
1443
1578
|
}
|
|
1444
|
-
const data = await request({
|
|
1579
|
+
const data = await request({
|
|
1580
|
+
method: 'GET',
|
|
1581
|
+
url: `/v9/projects/${idOrName}/custom-environments/${environmentSlugOrId}`,
|
|
1582
|
+
queryParams,
|
|
1583
|
+
...requestConfig
|
|
1584
|
+
});
|
|
1445
1585
|
return data;
|
|
1446
1586
|
}
|
|
1447
1587
|
/**
|
|
1448
1588
|
* @description Update a custom environment for the project. Must not be named 'Production' or 'Preview'.
|
|
1449
1589
|
* @summary Update a custom environment
|
|
1450
|
-
* {@link
|
|
1590
|
+
* {@link /v9/projects/:idOrName/custom-environments/:environmentSlugOrId}
|
|
1451
1591
|
*/
|
|
1452
|
-
export async function updateCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config = {}
|
|
1592
|
+
export async function updateCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config = {} }) {
|
|
1453
1593
|
const { client: request = client, ...requestConfig } = config;
|
|
1454
1594
|
if (!idOrName) {
|
|
1455
1595
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1459,19 +1599,19 @@ export async function updateCustomEnvironment({ pathParams: { idOrName, environm
|
|
|
1459
1599
|
}
|
|
1460
1600
|
const data = await request({
|
|
1461
1601
|
method: 'PATCH',
|
|
1462
|
-
url:
|
|
1602
|
+
url: `/v9/projects/${idOrName}/custom-environments/${environmentSlugOrId}`,
|
|
1463
1603
|
queryParams,
|
|
1464
1604
|
...requestConfig,
|
|
1465
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1605
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1466
1606
|
});
|
|
1467
1607
|
return data;
|
|
1468
1608
|
}
|
|
1469
1609
|
/**
|
|
1470
1610
|
* @description Remove a custom environment for the project. Must not be named 'Production' or 'Preview'.
|
|
1471
1611
|
* @summary Remove a custom environment
|
|
1472
|
-
* {@link
|
|
1612
|
+
* {@link /v9/projects/:idOrName/custom-environments/:environmentSlugOrId}
|
|
1473
1613
|
*/
|
|
1474
|
-
export async function removeCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config = {}
|
|
1614
|
+
export async function removeCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config = {} }) {
|
|
1475
1615
|
const { client: request = client, ...requestConfig } = config;
|
|
1476
1616
|
if (!idOrName) {
|
|
1477
1617
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1481,32 +1621,32 @@ export async function removeCustomEnvironment({ pathParams: { idOrName, environm
|
|
|
1481
1621
|
}
|
|
1482
1622
|
const data = await request({
|
|
1483
1623
|
method: 'DELETE',
|
|
1484
|
-
url:
|
|
1624
|
+
url: `/v9/projects/${idOrName}/custom-environments/${environmentSlugOrId}`,
|
|
1485
1625
|
queryParams,
|
|
1486
1626
|
...requestConfig,
|
|
1487
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1627
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1488
1628
|
});
|
|
1489
1629
|
return data;
|
|
1490
1630
|
}
|
|
1491
1631
|
/**
|
|
1492
1632
|
* @description Retrieve the domains associated with a given project by passing either the project `id` or `name` in the URL.
|
|
1493
1633
|
* @summary Retrieve project domains by project by id or name
|
|
1494
|
-
* {@link
|
|
1634
|
+
* {@link /v9/projects/:idOrName/domains}
|
|
1495
1635
|
*/
|
|
1496
|
-
export async function getProjectDomains({ pathParams: { idOrName }, queryParams, config = {}
|
|
1636
|
+
export async function getProjectDomains({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1497
1637
|
const { client: request = client, ...requestConfig } = config;
|
|
1498
1638
|
if (!idOrName) {
|
|
1499
1639
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1500
1640
|
}
|
|
1501
|
-
const data = await request({ method: 'GET', url:
|
|
1641
|
+
const data = await request({ method: 'GET', url: `/v9/projects/${idOrName}/domains`, queryParams, ...requestConfig });
|
|
1502
1642
|
return data;
|
|
1503
1643
|
}
|
|
1504
1644
|
/**
|
|
1505
1645
|
* @description Get project domain by project id/name and domain name.
|
|
1506
1646
|
* @summary Get a project domain
|
|
1507
|
-
* {@link
|
|
1647
|
+
* {@link /v9/projects/:idOrName/domains/:domain}
|
|
1508
1648
|
*/
|
|
1509
|
-
export async function getProjectDomain({ pathParams: { idOrName, domain }, queryParams, config = {}
|
|
1649
|
+
export async function getProjectDomain({ pathParams: { idOrName, domain }, queryParams, config = {} }) {
|
|
1510
1650
|
const { client: request = client, ...requestConfig } = config;
|
|
1511
1651
|
if (!idOrName) {
|
|
1512
1652
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1514,15 +1654,15 @@ export async function getProjectDomain({ pathParams: { idOrName, domain }, query
|
|
|
1514
1654
|
if (!domain) {
|
|
1515
1655
|
throw new Error(`Missing required path parameter: domain`);
|
|
1516
1656
|
}
|
|
1517
|
-
const data = await request({ method: 'GET', url:
|
|
1657
|
+
const data = await request({ method: 'GET', url: `/v9/projects/${idOrName}/domains/${domain}`, queryParams, ...requestConfig });
|
|
1518
1658
|
return data;
|
|
1519
1659
|
}
|
|
1520
1660
|
/**
|
|
1521
1661
|
* @description Update a project domain's configuration, including the name, git branch and redirect of the domain.
|
|
1522
1662
|
* @summary Update a project domain
|
|
1523
|
-
* {@link
|
|
1663
|
+
* {@link /v9/projects/:idOrName/domains/:domain}
|
|
1524
1664
|
*/
|
|
1525
|
-
export async function updateProjectDomain({ pathParams: { idOrName, domain }, queryParams, config = {}
|
|
1665
|
+
export async function updateProjectDomain({ pathParams: { idOrName, domain }, queryParams, config = {} }) {
|
|
1526
1666
|
const { client: request = client, ...requestConfig } = config;
|
|
1527
1667
|
if (!idOrName) {
|
|
1528
1668
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1532,19 +1672,19 @@ export async function updateProjectDomain({ pathParams: { idOrName, domain }, qu
|
|
|
1532
1672
|
}
|
|
1533
1673
|
const data = await request({
|
|
1534
1674
|
method: 'PATCH',
|
|
1535
|
-
url:
|
|
1675
|
+
url: `/v9/projects/${idOrName}/domains/${domain}`,
|
|
1536
1676
|
queryParams,
|
|
1537
1677
|
...requestConfig,
|
|
1538
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1678
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1539
1679
|
});
|
|
1540
1680
|
return data;
|
|
1541
1681
|
}
|
|
1542
1682
|
/**
|
|
1543
1683
|
* @description Remove a domain from a project by passing the domain name and by specifying the project by either passing the project `id` or `name` in the URL.
|
|
1544
1684
|
* @summary Remove a domain from a project
|
|
1545
|
-
* {@link
|
|
1685
|
+
* {@link /v9/projects/:idOrName/domains/:domain}
|
|
1546
1686
|
*/
|
|
1547
|
-
export async function removeProjectDomain({ pathParams: { idOrName, domain }, queryParams, config = {}
|
|
1687
|
+
export async function removeProjectDomain({ pathParams: { idOrName, domain }, queryParams, config = {} }) {
|
|
1548
1688
|
const { client: request = client, ...requestConfig } = config;
|
|
1549
1689
|
if (!idOrName) {
|
|
1550
1690
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1554,38 +1694,38 @@ export async function removeProjectDomain({ pathParams: { idOrName, domain }, qu
|
|
|
1554
1694
|
}
|
|
1555
1695
|
const data = await request({
|
|
1556
1696
|
method: 'DELETE',
|
|
1557
|
-
url:
|
|
1697
|
+
url: `/v9/projects/${idOrName}/domains/${domain}`,
|
|
1558
1698
|
queryParams,
|
|
1559
1699
|
...requestConfig,
|
|
1560
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1700
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1561
1701
|
});
|
|
1562
1702
|
return data;
|
|
1563
1703
|
}
|
|
1564
1704
|
/**
|
|
1565
1705
|
* @description Add a domain to the project by passing its domain name and by specifying the project by either passing the project `id` or `name` in the URL. If the domain is not yet verified to be used on this project, the request will return `verified = false`, and the domain will need to be verified according to the `verification` challenge via `POST /projects/:idOrName/domains/:domain/verify`. If the domain already exists on the project, the request will fail with a `400` status code.
|
|
1566
1706
|
* @summary Add a domain to a project
|
|
1567
|
-
* {@link
|
|
1707
|
+
* {@link /v10/projects/:idOrName/domains}
|
|
1568
1708
|
*/
|
|
1569
|
-
export async function addProjectDomain({ pathParams: { idOrName }, queryParams, config = {}
|
|
1709
|
+
export async function addProjectDomain({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1570
1710
|
const { client: request = client, ...requestConfig } = config;
|
|
1571
1711
|
if (!idOrName) {
|
|
1572
1712
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1573
1713
|
}
|
|
1574
1714
|
const data = await request({
|
|
1575
1715
|
method: 'POST',
|
|
1576
|
-
url:
|
|
1716
|
+
url: `/v10/projects/${idOrName}/domains`,
|
|
1577
1717
|
queryParams,
|
|
1578
1718
|
...requestConfig,
|
|
1579
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1719
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1580
1720
|
});
|
|
1581
1721
|
return data;
|
|
1582
1722
|
}
|
|
1583
1723
|
/**
|
|
1584
1724
|
* @description Move one project's domain to another project. Also allows the move of all redirects pointed to that domain in the same project.
|
|
1585
1725
|
* @summary Move a project domain
|
|
1586
|
-
* {@link
|
|
1726
|
+
* {@link /v1/projects/:idOrName/domains/:domain/move}
|
|
1587
1727
|
*/
|
|
1588
|
-
export async function moveProjectDomain({ pathParams: { idOrName, domain }, queryParams, config = {}
|
|
1728
|
+
export async function moveProjectDomain({ pathParams: { idOrName, domain }, queryParams, config = {} }) {
|
|
1589
1729
|
const { client: request = client, ...requestConfig } = config;
|
|
1590
1730
|
if (!idOrName) {
|
|
1591
1731
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1595,19 +1735,19 @@ export async function moveProjectDomain({ pathParams: { idOrName, domain }, quer
|
|
|
1595
1735
|
}
|
|
1596
1736
|
const data = await request({
|
|
1597
1737
|
method: 'POST',
|
|
1598
|
-
url:
|
|
1738
|
+
url: `/v1/projects/${idOrName}/domains/${domain}/move`,
|
|
1599
1739
|
queryParams,
|
|
1600
1740
|
...requestConfig,
|
|
1601
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1741
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1602
1742
|
});
|
|
1603
1743
|
return data;
|
|
1604
1744
|
}
|
|
1605
1745
|
/**
|
|
1606
1746
|
* @description Attempts to verify a project domain with `verified = false` by checking the correctness of the project domain's `verification` challenge.
|
|
1607
1747
|
* @summary Verify project domain
|
|
1608
|
-
* {@link
|
|
1748
|
+
* {@link /v9/projects/:idOrName/domains/:domain/verify}
|
|
1609
1749
|
*/
|
|
1610
|
-
export async function verifyProjectDomain({ pathParams: { idOrName, domain }, queryParams, config = {}
|
|
1750
|
+
export async function verifyProjectDomain({ pathParams: { idOrName, domain }, queryParams, config = {} }) {
|
|
1611
1751
|
const { client: request = client, ...requestConfig } = config;
|
|
1612
1752
|
if (!idOrName) {
|
|
1613
1753
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1615,41 +1755,47 @@ export async function verifyProjectDomain({ pathParams: { idOrName, domain }, qu
|
|
|
1615
1755
|
if (!domain) {
|
|
1616
1756
|
throw new Error(`Missing required path parameter: domain`);
|
|
1617
1757
|
}
|
|
1618
|
-
const data = await request({ method: 'POST', url:
|
|
1758
|
+
const data = await request({ method: 'POST', url: `/v9/projects/${idOrName}/domains/${domain}/verify`, queryParams, ...requestConfig });
|
|
1619
1759
|
return data;
|
|
1620
1760
|
}
|
|
1621
1761
|
/**
|
|
1622
1762
|
* @description Retrieve the environment variables for a given project by passing either the project `id` or `name` in the URL.
|
|
1623
1763
|
* @summary Retrieve the environment variables of a project by id or name
|
|
1624
|
-
* {@link
|
|
1764
|
+
* {@link /v10/projects/:idOrName/env}
|
|
1625
1765
|
*/
|
|
1626
|
-
export async function filterProjectEnvs({ pathParams: { idOrName }, queryParams, config = {}
|
|
1766
|
+
export async function filterProjectEnvs({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1627
1767
|
const { client: request = client, ...requestConfig } = config;
|
|
1628
1768
|
if (!idOrName) {
|
|
1629
1769
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1630
1770
|
}
|
|
1631
|
-
const data = await request({ method: 'GET', url:
|
|
1771
|
+
const data = await request({ method: 'GET', url: `/v10/projects/${idOrName}/env`, queryParams, ...requestConfig });
|
|
1632
1772
|
return data;
|
|
1633
1773
|
}
|
|
1634
1774
|
/**
|
|
1635
1775
|
* @description Create one or more environment variables for a project by passing its `key`, `value`, `type` and `target` and by specifying the project by either passing the project `id` or `name` in the URL. If you include `upsert=true` as a query parameter, a new environment variable will not be created if it already exists but, the existing variable's value will be updated.
|
|
1636
1776
|
* @summary Create one or more environment variables
|
|
1637
|
-
* {@link
|
|
1777
|
+
* {@link /v10/projects/:idOrName/env}
|
|
1638
1778
|
*/
|
|
1639
|
-
export async function createProjectEnv({ pathParams: { idOrName }, queryParams, config = {}
|
|
1779
|
+
export async function createProjectEnv({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1640
1780
|
const { client: request = client, ...requestConfig } = config;
|
|
1641
1781
|
if (!idOrName) {
|
|
1642
1782
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1643
1783
|
}
|
|
1644
|
-
const data = await request({
|
|
1784
|
+
const data = await request({
|
|
1785
|
+
method: 'POST',
|
|
1786
|
+
url: `/v10/projects/${idOrName}/env`,
|
|
1787
|
+
queryParams,
|
|
1788
|
+
...requestConfig,
|
|
1789
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1790
|
+
});
|
|
1645
1791
|
return data;
|
|
1646
1792
|
}
|
|
1647
1793
|
/**
|
|
1648
1794
|
* @description Retrieve the environment variable for a given project.
|
|
1649
1795
|
* @summary Retrieve the decrypted value of an environment variable of a project by id
|
|
1650
|
-
* {@link
|
|
1796
|
+
* {@link /v1/projects/:idOrName/env/:id}
|
|
1651
1797
|
*/
|
|
1652
|
-
export async function getProjectEnv({ pathParams: { idOrName, id }, queryParams, config = {}
|
|
1798
|
+
export async function getProjectEnv({ pathParams: { idOrName, id }, queryParams, config = {} }) {
|
|
1653
1799
|
const { client: request = client, ...requestConfig } = config;
|
|
1654
1800
|
if (!idOrName) {
|
|
1655
1801
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1657,15 +1803,15 @@ export async function getProjectEnv({ pathParams: { idOrName, id }, queryParams,
|
|
|
1657
1803
|
if (!id) {
|
|
1658
1804
|
throw new Error(`Missing required path parameter: id`);
|
|
1659
1805
|
}
|
|
1660
|
-
const data = await request({ method: 'GET', url:
|
|
1806
|
+
const data = await request({ method: 'GET', url: `/v1/projects/${idOrName}/env/${id}`, queryParams, ...requestConfig });
|
|
1661
1807
|
return data;
|
|
1662
1808
|
}
|
|
1663
1809
|
/**
|
|
1664
1810
|
* @description Delete a specific environment variable for a given project by passing the environment variable identifier and either passing the project `id` or `name` in the URL.
|
|
1665
1811
|
* @summary Remove an environment variable
|
|
1666
|
-
* {@link
|
|
1812
|
+
* {@link /v9/projects/:idOrName/env/:id}
|
|
1667
1813
|
*/
|
|
1668
|
-
export async function removeProjectEnv({ pathParams: { idOrName, id }, queryParams, config = {}
|
|
1814
|
+
export async function removeProjectEnv({ pathParams: { idOrName, id }, queryParams, config = {} }) {
|
|
1669
1815
|
const { client: request = client, ...requestConfig } = config;
|
|
1670
1816
|
if (!idOrName) {
|
|
1671
1817
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1673,15 +1819,15 @@ export async function removeProjectEnv({ pathParams: { idOrName, id }, queryPara
|
|
|
1673
1819
|
if (!id) {
|
|
1674
1820
|
throw new Error(`Missing required path parameter: id`);
|
|
1675
1821
|
}
|
|
1676
|
-
const data = await request({ method: 'DELETE', url:
|
|
1822
|
+
const data = await request({ method: 'DELETE', url: `/v9/projects/${idOrName}/env/${id}`, queryParams, ...requestConfig });
|
|
1677
1823
|
return data;
|
|
1678
1824
|
}
|
|
1679
1825
|
/**
|
|
1680
1826
|
* @description Edit a specific environment variable for a given project by passing the environment variable identifier and either passing the project `id` or `name` in the URL.
|
|
1681
1827
|
* @summary Edit an environment variable
|
|
1682
|
-
* {@link
|
|
1828
|
+
* {@link /v9/projects/:idOrName/env/:id}
|
|
1683
1829
|
*/
|
|
1684
|
-
export async function editProjectEnv({ pathParams: { idOrName, id }, queryParams, config = {}
|
|
1830
|
+
export async function editProjectEnv({ pathParams: { idOrName, id }, queryParams, config = {} }) {
|
|
1685
1831
|
const { client: request = client, ...requestConfig } = config;
|
|
1686
1832
|
if (!idOrName) {
|
|
1687
1833
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
@@ -1691,179 +1837,179 @@ export async function editProjectEnv({ pathParams: { idOrName, id }, queryParams
|
|
|
1691
1837
|
}
|
|
1692
1838
|
const data = await request({
|
|
1693
1839
|
method: 'PATCH',
|
|
1694
|
-
url:
|
|
1840
|
+
url: `/v9/projects/${idOrName}/env/${id}`,
|
|
1695
1841
|
queryParams,
|
|
1696
1842
|
...requestConfig,
|
|
1697
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1843
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1698
1844
|
});
|
|
1699
1845
|
return data;
|
|
1700
1846
|
}
|
|
1701
1847
|
/**
|
|
1702
1848
|
* @description Get the Rolling Releases billing status for a project. The team level billing status is used to determine if the project can be configured for rolling releases.
|
|
1703
1849
|
* @summary Get rolling release billing status
|
|
1704
|
-
* {@link
|
|
1850
|
+
* {@link /v1/projects/:idOrName/rolling-release/billing}
|
|
1705
1851
|
*/
|
|
1706
|
-
export async function getRollingReleaseBillingStatus({ pathParams: { idOrName }, queryParams, config = {}
|
|
1852
|
+
export async function getRollingReleaseBillingStatus({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1707
1853
|
const { client: request = client, ...requestConfig } = config;
|
|
1708
1854
|
if (!idOrName) {
|
|
1709
1855
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1710
1856
|
}
|
|
1711
|
-
const data = await request({ method: 'GET', url:
|
|
1857
|
+
const data = await request({ method: 'GET', url: `/v1/projects/${idOrName}/rolling-release/billing`, queryParams, ...requestConfig });
|
|
1712
1858
|
return data;
|
|
1713
1859
|
}
|
|
1714
1860
|
/**
|
|
1715
1861
|
* @description Get the Rolling Releases configuration for a project. The project-level config is simply a template that will be used for any future rolling release, and not the configuration for any active rolling release.
|
|
1716
1862
|
* @summary Get rolling release configuration
|
|
1717
|
-
* {@link
|
|
1863
|
+
* {@link /v1/projects/:idOrName/rolling-release/config}
|
|
1718
1864
|
*/
|
|
1719
|
-
export async function getRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config = {}
|
|
1865
|
+
export async function getRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1720
1866
|
const { client: request = client, ...requestConfig } = config;
|
|
1721
1867
|
if (!idOrName) {
|
|
1722
1868
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1723
1869
|
}
|
|
1724
|
-
const data = await request({ method: 'GET', url:
|
|
1870
|
+
const data = await request({ method: 'GET', url: `/v1/projects/${idOrName}/rolling-release/config`, queryParams, ...requestConfig });
|
|
1725
1871
|
return data;
|
|
1726
1872
|
}
|
|
1727
1873
|
/**
|
|
1728
1874
|
* @description Disable Rolling Releases for a project means that future deployments will not undergo a rolling release. Changing the config never alters a rollout that's already in-flight—it only affects the next production deployment. If you want to also stop the current rollout, call this endpoint to disable the feature, and then call either the /complete or /abort endpoint.
|
|
1729
1875
|
* @summary Delete rolling release configuration
|
|
1730
|
-
* {@link
|
|
1876
|
+
* {@link /v1/projects/:idOrName/rolling-release/config}
|
|
1731
1877
|
*/
|
|
1732
|
-
export async function deleteRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config = {}
|
|
1878
|
+
export async function deleteRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1733
1879
|
const { client: request = client, ...requestConfig } = config;
|
|
1734
1880
|
if (!idOrName) {
|
|
1735
1881
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1736
1882
|
}
|
|
1737
|
-
const data = await request({ method: 'DELETE', url:
|
|
1883
|
+
const data = await request({ method: 'DELETE', url: `/v1/projects/${idOrName}/rolling-release/config`, queryParams, ...requestConfig });
|
|
1738
1884
|
return data;
|
|
1739
1885
|
}
|
|
1740
1886
|
/**
|
|
1741
1887
|
* @description Update (or disable) Rolling Releases for a project. Changing the config never alters a rollout that's already in-flight. It only affects the next production deployment. This also applies to disabling Rolling Releases. If you want to also stop the current rollout, call this endpoint to disable the feature, and then call either the /complete or /abort endpoint. Note: Enabling Rolling Releases automatically enables skew protection on the project with the default value if it wasn't configured already.
|
|
1742
1888
|
* @summary Update the rolling release settings for the project
|
|
1743
|
-
* {@link
|
|
1889
|
+
* {@link /v1/projects/:idOrName/rolling-release/config}
|
|
1744
1890
|
*/
|
|
1745
|
-
export async function updateRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config = {}
|
|
1891
|
+
export async function updateRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1746
1892
|
const { client: request = client, ...requestConfig } = config;
|
|
1747
1893
|
if (!idOrName) {
|
|
1748
1894
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1749
1895
|
}
|
|
1750
|
-
const data = await request({ method: 'PATCH', url:
|
|
1896
|
+
const data = await request({ method: 'PATCH', url: `/v1/projects/${idOrName}/rolling-release/config`, queryParams, ...requestConfig });
|
|
1751
1897
|
return data;
|
|
1752
1898
|
}
|
|
1753
1899
|
/**
|
|
1754
1900
|
* @description Return the Rolling Release for a project, regardless of whether the rollout is active, aborted, or completed. If the feature is enabled but no deployment has occurred yet, null will be returned.
|
|
1755
1901
|
* @summary Get the active rolling release information for a project
|
|
1756
|
-
* {@link
|
|
1902
|
+
* {@link /v1/projects/:idOrName/rolling-release}
|
|
1757
1903
|
*/
|
|
1758
|
-
export async function getRollingRelease({ pathParams: { idOrName }, queryParams, config = {}
|
|
1904
|
+
export async function getRollingRelease({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1759
1905
|
const { client: request = client, ...requestConfig } = config;
|
|
1760
1906
|
if (!idOrName) {
|
|
1761
1907
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1762
1908
|
}
|
|
1763
|
-
const data = await request({ method: 'GET', url:
|
|
1909
|
+
const data = await request({ method: 'GET', url: `/v1/projects/${idOrName}/rolling-release`, queryParams, ...requestConfig });
|
|
1764
1910
|
return data;
|
|
1765
1911
|
}
|
|
1766
1912
|
/**
|
|
1767
1913
|
* @description Advance a rollout to the next stage. This is only needed when rolling releases is configured to require manual approval.
|
|
1768
1914
|
* @summary Update the active rolling release to the next stage for a project
|
|
1769
|
-
* {@link
|
|
1915
|
+
* {@link /v1/projects/:idOrName/rolling-release/approve-stage}
|
|
1770
1916
|
*/
|
|
1771
|
-
export async function approveRollingReleaseStage({ pathParams: { idOrName }, queryParams, config = {}
|
|
1917
|
+
export async function approveRollingReleaseStage({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1772
1918
|
const { client: request = client, ...requestConfig } = config;
|
|
1773
1919
|
if (!idOrName) {
|
|
1774
1920
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1775
1921
|
}
|
|
1776
1922
|
const data = await request({
|
|
1777
1923
|
method: 'POST',
|
|
1778
|
-
url:
|
|
1924
|
+
url: `/v1/projects/${idOrName}/rolling-release/approve-stage`,
|
|
1779
1925
|
queryParams,
|
|
1780
1926
|
...requestConfig,
|
|
1781
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1927
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1782
1928
|
});
|
|
1783
1929
|
return data;
|
|
1784
1930
|
}
|
|
1785
1931
|
/**
|
|
1786
1932
|
* @description Force-complete a Rolling Release. The canary deployment will begin serving 100% of the traffic.
|
|
1787
1933
|
* @summary Complete the rolling release for the project
|
|
1788
|
-
* {@link
|
|
1934
|
+
* {@link /v1/projects/:idOrName/rolling-release/complete}
|
|
1789
1935
|
*/
|
|
1790
|
-
export async function completeRollingRelease({ pathParams: { idOrName }, queryParams, config = {}
|
|
1936
|
+
export async function completeRollingRelease({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1791
1937
|
const { client: request = client, ...requestConfig } = config;
|
|
1792
1938
|
if (!idOrName) {
|
|
1793
1939
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1794
1940
|
}
|
|
1795
1941
|
const data = await request({
|
|
1796
1942
|
method: 'POST',
|
|
1797
|
-
url:
|
|
1943
|
+
url: `/v1/projects/${idOrName}/rolling-release/complete`,
|
|
1798
1944
|
queryParams,
|
|
1799
1945
|
...requestConfig,
|
|
1800
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1946
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1801
1947
|
});
|
|
1802
1948
|
return data;
|
|
1803
1949
|
}
|
|
1804
1950
|
/**
|
|
1805
1951
|
* @description Initiates a project transfer request from one team to another. <br/> Returns a `code` that remains valid for 24 hours and can be used to accept the transfer request by another team using the `PUT /projects/transfer-request/:code` endpoint. <br/> Users can also accept the project transfer request using the claim URL: `https://vercel.com/claim-deployment?code=<code>&returnUrl=<returnUrl>`. <br/> The `code` parameter specifies the project transfer request code generated using this endpoint. <br/> The `returnUrl` parameter redirects users to a specific page of the application if the claim URL is invalid or expired.
|
|
1806
1952
|
* @summary Create project transfer request
|
|
1807
|
-
* {@link
|
|
1953
|
+
* {@link /projects/:idOrName/transfer-request}
|
|
1808
1954
|
*/
|
|
1809
|
-
export async function createProjectTransferRequest({ pathParams: { idOrName }, queryParams, config = {}
|
|
1955
|
+
export async function createProjectTransferRequest({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1810
1956
|
const { client: request = client, ...requestConfig } = config;
|
|
1811
1957
|
if (!idOrName) {
|
|
1812
1958
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1813
1959
|
}
|
|
1814
1960
|
const data = await request({
|
|
1815
1961
|
method: 'POST',
|
|
1816
|
-
url:
|
|
1962
|
+
url: `/projects/${idOrName}/transfer-request`,
|
|
1817
1963
|
queryParams,
|
|
1818
1964
|
...requestConfig,
|
|
1819
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1965
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1820
1966
|
});
|
|
1821
1967
|
return data;
|
|
1822
1968
|
}
|
|
1823
1969
|
/**
|
|
1824
1970
|
* @description Accept a project transfer request initated by another team. <br/> The `code` is generated using the `POST /projects/:idOrName/transfer-request` endpoint.
|
|
1825
1971
|
* @summary Accept project transfer request
|
|
1826
|
-
* {@link
|
|
1972
|
+
* {@link /projects/transfer-request/:code}
|
|
1827
1973
|
*/
|
|
1828
|
-
export async function acceptProjectTransferRequest({ pathParams: { code }, queryParams, config = {}
|
|
1974
|
+
export async function acceptProjectTransferRequest({ pathParams: { code }, queryParams, config = {} }) {
|
|
1829
1975
|
const { client: request = client, ...requestConfig } = config;
|
|
1830
1976
|
if (!code) {
|
|
1831
1977
|
throw new Error(`Missing required path parameter: code`);
|
|
1832
1978
|
}
|
|
1833
1979
|
const data = await request({
|
|
1834
1980
|
method: 'PUT',
|
|
1835
|
-
url:
|
|
1981
|
+
url: `/projects/transfer-request/${code}`,
|
|
1836
1982
|
queryParams,
|
|
1837
1983
|
...requestConfig,
|
|
1838
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1984
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1839
1985
|
});
|
|
1840
1986
|
return data;
|
|
1841
1987
|
}
|
|
1842
1988
|
/**
|
|
1843
1989
|
* @description Update the deployment protection automation bypass for a project
|
|
1844
1990
|
* @summary Update Protection Bypass for Automation
|
|
1845
|
-
* {@link
|
|
1991
|
+
* {@link /v1/projects/:idOrName/protection-bypass}
|
|
1846
1992
|
*/
|
|
1847
|
-
export async function updateProjectProtectionBypass({ pathParams: { idOrName }, queryParams, config = {}
|
|
1993
|
+
export async function updateProjectProtectionBypass({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
1848
1994
|
const { client: request = client, ...requestConfig } = config;
|
|
1849
1995
|
if (!idOrName) {
|
|
1850
1996
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
1851
1997
|
}
|
|
1852
1998
|
const data = await request({
|
|
1853
1999
|
method: 'PATCH',
|
|
1854
|
-
url:
|
|
2000
|
+
url: `/v1/projects/${idOrName}/protection-bypass`,
|
|
1855
2001
|
queryParams,
|
|
1856
2002
|
...requestConfig,
|
|
1857
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2003
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1858
2004
|
});
|
|
1859
2005
|
return data;
|
|
1860
2006
|
}
|
|
1861
2007
|
/**
|
|
1862
2008
|
* @description Allows users to promote a deployment to production. Note: This does NOT rebuild the deployment. If you need that, then call create-deployments endpoint.
|
|
1863
2009
|
* @summary Points all production domains for a project to the given deploy
|
|
1864
|
-
* {@link
|
|
2010
|
+
* {@link /v10/projects/:projectId/promote/:deploymentId}
|
|
1865
2011
|
*/
|
|
1866
|
-
export async function requestPromote({ pathParams: { projectId, deploymentId }, queryParams, config = {}
|
|
2012
|
+
export async function requestPromote({ pathParams: { projectId, deploymentId }, queryParams, config = {} }) {
|
|
1867
2013
|
const { client: request = client, ...requestConfig } = config;
|
|
1868
2014
|
if (!projectId) {
|
|
1869
2015
|
throw new Error(`Missing required path parameter: projectId`);
|
|
@@ -1871,194 +2017,216 @@ export async function requestPromote({ pathParams: { projectId, deploymentId },
|
|
|
1871
2017
|
if (!deploymentId) {
|
|
1872
2018
|
throw new Error(`Missing required path parameter: deploymentId`);
|
|
1873
2019
|
}
|
|
1874
|
-
const data = await request({ method: 'POST', url:
|
|
2020
|
+
const data = await request({ method: 'POST', url: `/v10/projects/${projectId}/promote/${deploymentId}`, queryParams, ...requestConfig });
|
|
1875
2021
|
return data;
|
|
1876
2022
|
}
|
|
1877
2023
|
/**
|
|
1878
2024
|
* @description Get a list of aliases related to the last promote request with their mapping status
|
|
1879
2025
|
* @summary Gets a list of aliases with status for the current promote
|
|
1880
|
-
* {@link
|
|
2026
|
+
* {@link /v1/projects/:projectId/promote/aliases}
|
|
1881
2027
|
*/
|
|
1882
|
-
export async function listPromoteAliases({ pathParams: { projectId }, queryParams, config = {}
|
|
2028
|
+
export async function listPromoteAliases({ pathParams: { projectId }, queryParams, config = {} }) {
|
|
1883
2029
|
const { client: request = client, ...requestConfig } = config;
|
|
1884
2030
|
if (!projectId) {
|
|
1885
2031
|
throw new Error(`Missing required path parameter: projectId`);
|
|
1886
2032
|
}
|
|
1887
|
-
const data = await request({ method: 'GET', url:
|
|
2033
|
+
const data = await request({ method: 'GET', url: `/v1/projects/${projectId}/promote/aliases`, queryParams, ...requestConfig });
|
|
1888
2034
|
return data;
|
|
1889
2035
|
}
|
|
1890
2036
|
/**
|
|
1891
2037
|
* @description 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.
|
|
1892
2038
|
* @summary Pause a project
|
|
1893
|
-
* {@link
|
|
2039
|
+
* {@link /v1/projects/:projectId/pause}
|
|
1894
2040
|
*/
|
|
1895
|
-
export async function pauseProject({ pathParams: { projectId }, queryParams, config = {}
|
|
2041
|
+
export async function pauseProject({ pathParams: { projectId }, queryParams, config = {} }) {
|
|
1896
2042
|
const { client: request = client, ...requestConfig } = config;
|
|
1897
2043
|
if (!projectId) {
|
|
1898
2044
|
throw new Error(`Missing required path parameter: projectId`);
|
|
1899
2045
|
}
|
|
1900
|
-
const data = await request({ method: 'POST', url:
|
|
2046
|
+
const data = await request({ method: 'POST', url: `/v1/projects/${projectId}/pause`, queryParams, ...requestConfig });
|
|
1901
2047
|
return data;
|
|
1902
2048
|
}
|
|
1903
2049
|
/**
|
|
1904
2050
|
* @description 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.
|
|
1905
2051
|
* @summary Unpause a project
|
|
1906
|
-
* {@link
|
|
2052
|
+
* {@link /v1/projects/:projectId/unpause}
|
|
1907
2053
|
*/
|
|
1908
|
-
export async function unpauseProject({ pathParams: { projectId }, queryParams, config = {}
|
|
2054
|
+
export async function unpauseProject({ pathParams: { projectId }, queryParams, config = {} }) {
|
|
1909
2055
|
const { client: request = client, ...requestConfig } = config;
|
|
1910
2056
|
if (!projectId) {
|
|
1911
2057
|
throw new Error(`Missing required path parameter: projectId`);
|
|
1912
2058
|
}
|
|
1913
|
-
const data = await request({ method: 'POST', url:
|
|
2059
|
+
const data = await request({ method: 'POST', url: `/v1/projects/${projectId}/unpause`, queryParams, ...requestConfig });
|
|
1914
2060
|
return data;
|
|
1915
2061
|
}
|
|
1916
2062
|
/**
|
|
1917
2063
|
* @description Update the setting for determining if the project has Attack Challenge mode enabled.
|
|
1918
2064
|
* @summary Update Attack Challenge mode
|
|
1919
|
-
* {@link
|
|
2065
|
+
* {@link /v1/security/attack-mode}
|
|
1920
2066
|
*/
|
|
1921
|
-
export async function updateAttackChallengeMode({ queryParams, config = {}
|
|
2067
|
+
export async function updateAttackChallengeMode({ queryParams, config = {} }) {
|
|
1922
2068
|
const { client: request = client, ...requestConfig } = config;
|
|
1923
|
-
const data = await request({
|
|
2069
|
+
const data = await request({
|
|
2070
|
+
method: 'POST',
|
|
2071
|
+
url: `/v1/security/attack-mode`,
|
|
2072
|
+
queryParams,
|
|
2073
|
+
...requestConfig,
|
|
2074
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2075
|
+
});
|
|
1924
2076
|
return data;
|
|
1925
2077
|
}
|
|
1926
2078
|
/**
|
|
1927
2079
|
* @description Set the firewall configuration to provided rules and settings. Creates or overwrite the existing firewall configuration.
|
|
1928
2080
|
* @summary Put Firewall Configuration
|
|
1929
|
-
* {@link
|
|
2081
|
+
* {@link /v1/security/firewall/config}
|
|
1930
2082
|
*/
|
|
1931
|
-
export async function putFirewallConfig({ queryParams, config = {}
|
|
2083
|
+
export async function putFirewallConfig({ queryParams, config = {} }) {
|
|
1932
2084
|
const { client: request = client, ...requestConfig } = config;
|
|
1933
|
-
const data = await request({
|
|
2085
|
+
const data = await request({
|
|
2086
|
+
method: 'PUT',
|
|
2087
|
+
url: `/v1/security/firewall/config`,
|
|
2088
|
+
queryParams,
|
|
2089
|
+
...requestConfig,
|
|
2090
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2091
|
+
});
|
|
1934
2092
|
return data;
|
|
1935
2093
|
}
|
|
1936
2094
|
/**
|
|
1937
2095
|
* @description Process updates to modify the existing firewall config for a project
|
|
1938
2096
|
* @summary Update Firewall Configuration
|
|
1939
|
-
* {@link
|
|
2097
|
+
* {@link /v1/security/firewall/config}
|
|
1940
2098
|
*/
|
|
1941
|
-
export async function updateFirewallConfig({ queryParams, config = {}
|
|
2099
|
+
export async function updateFirewallConfig({ queryParams, config = {} }) {
|
|
1942
2100
|
const { client: request = client, ...requestConfig } = config;
|
|
1943
2101
|
const data = await request({
|
|
1944
2102
|
method: 'PATCH',
|
|
1945
|
-
url:
|
|
2103
|
+
url: `/v1/security/firewall/config`,
|
|
1946
2104
|
queryParams,
|
|
1947
2105
|
...requestConfig,
|
|
1948
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2106
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1949
2107
|
});
|
|
1950
2108
|
return data;
|
|
1951
2109
|
}
|
|
1952
2110
|
/**
|
|
1953
2111
|
* @description Retrieve the specified firewall configuration for a project. The deployed configVersion will be `active`
|
|
1954
2112
|
* @summary Read Firewall Configuration
|
|
1955
|
-
* {@link
|
|
2113
|
+
* {@link /v1/security/firewall/config/:configVersion}
|
|
1956
2114
|
*/
|
|
1957
|
-
export async function getFirewallConfig({ pathParams: { configVersion }, queryParams, config = {}
|
|
2115
|
+
export async function getFirewallConfig({ pathParams: { configVersion }, queryParams, config = {} }) {
|
|
1958
2116
|
const { client: request = client, ...requestConfig } = config;
|
|
1959
2117
|
if (!configVersion) {
|
|
1960
2118
|
throw new Error(`Missing required path parameter: configVersion`);
|
|
1961
2119
|
}
|
|
1962
|
-
const data = await request({ method: 'GET', url:
|
|
2120
|
+
const data = await request({ method: 'GET', url: `/v1/security/firewall/config/${configVersion}`, queryParams, ...requestConfig });
|
|
1963
2121
|
return data;
|
|
1964
2122
|
}
|
|
1965
2123
|
/**
|
|
1966
2124
|
* @description Retrieve active attack data within the last 24h window
|
|
1967
2125
|
* @summary Read active attack data
|
|
1968
|
-
* {@link
|
|
2126
|
+
* {@link /v1/security/firewall/attack-status}
|
|
1969
2127
|
*/
|
|
1970
|
-
export async function getActiveAttackStatus({ queryParams, config = {}
|
|
2128
|
+
export async function getActiveAttackStatus({ queryParams, config = {} }) {
|
|
1971
2129
|
const { client: request = client, ...requestConfig } = config;
|
|
1972
|
-
const data = await request({ method: 'GET', url:
|
|
2130
|
+
const data = await request({ method: 'GET', url: `/v1/security/firewall/attack-status`, queryParams, ...requestConfig });
|
|
1973
2131
|
return data;
|
|
1974
2132
|
}
|
|
1975
2133
|
/**
|
|
1976
2134
|
* @description Retrieve the system bypass rules configured for the specified project
|
|
1977
2135
|
* @summary Read System Bypass
|
|
1978
|
-
* {@link
|
|
2136
|
+
* {@link /v1/security/firewall/bypass}
|
|
1979
2137
|
*/
|
|
1980
|
-
export async function getBypassIp({ queryParams, config = {}
|
|
2138
|
+
export async function getBypassIp({ queryParams, config = {} }) {
|
|
1981
2139
|
const { client: request = client, ...requestConfig } = config;
|
|
1982
|
-
const data = await request({ method: 'GET', url:
|
|
2140
|
+
const data = await request({ method: 'GET', url: `/v1/security/firewall/bypass`, queryParams, ...requestConfig });
|
|
1983
2141
|
return data;
|
|
1984
2142
|
}
|
|
1985
2143
|
/**
|
|
1986
2144
|
* @description Create new system bypass rules
|
|
1987
2145
|
* @summary Create System Bypass Rule
|
|
1988
|
-
* {@link
|
|
2146
|
+
* {@link /v1/security/firewall/bypass}
|
|
1989
2147
|
*/
|
|
1990
|
-
export async function addBypassIp({ queryParams, config = {}
|
|
2148
|
+
export async function addBypassIp({ queryParams, config = {} }) {
|
|
1991
2149
|
const { client: request = client, ...requestConfig } = config;
|
|
1992
2150
|
const data = await request({
|
|
1993
2151
|
method: 'POST',
|
|
1994
|
-
url:
|
|
2152
|
+
url: `/v1/security/firewall/bypass`,
|
|
1995
2153
|
queryParams,
|
|
1996
2154
|
...requestConfig,
|
|
1997
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2155
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
1998
2156
|
});
|
|
1999
2157
|
return data;
|
|
2000
2158
|
}
|
|
2001
2159
|
/**
|
|
2002
2160
|
* @description Remove system bypass rules
|
|
2003
2161
|
* @summary Remove System Bypass Rule
|
|
2004
|
-
* {@link
|
|
2162
|
+
* {@link /v1/security/firewall/bypass}
|
|
2005
2163
|
*/
|
|
2006
|
-
export async function removeBypassIp({ queryParams, config = {}
|
|
2164
|
+
export async function removeBypassIp({ queryParams, config = {} }) {
|
|
2007
2165
|
const { client: request = client, ...requestConfig } = config;
|
|
2008
2166
|
const data = await request({
|
|
2009
2167
|
method: 'DELETE',
|
|
2010
|
-
url:
|
|
2168
|
+
url: `/v1/security/firewall/bypass`,
|
|
2011
2169
|
queryParams,
|
|
2012
2170
|
...requestConfig,
|
|
2013
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2171
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2014
2172
|
});
|
|
2015
2173
|
return data;
|
|
2016
2174
|
}
|
|
2017
2175
|
/**
|
|
2018
2176
|
* @description Get a paginated list of team members for the provided team.
|
|
2019
2177
|
* @summary List team members
|
|
2020
|
-
* {@link
|
|
2178
|
+
* {@link /v3/teams/:teamId/members}
|
|
2021
2179
|
*/
|
|
2022
|
-
export async function getTeamMembers({ pathParams: { teamId }, queryParams, config = {}
|
|
2180
|
+
export async function getTeamMembers({ pathParams: { teamId }, queryParams, config = {} }) {
|
|
2023
2181
|
const { client: request = client, ...requestConfig } = config;
|
|
2024
2182
|
if (!teamId) {
|
|
2025
2183
|
throw new Error(`Missing required path parameter: teamId`);
|
|
2026
2184
|
}
|
|
2027
|
-
const data = await request({ method: 'GET', url:
|
|
2185
|
+
const data = await request({ method: 'GET', url: `/v3/teams/${teamId}/members`, queryParams, ...requestConfig });
|
|
2028
2186
|
return data;
|
|
2029
2187
|
}
|
|
2030
2188
|
/**
|
|
2031
2189
|
* @description Invite a user to join the team specified in the URL. The authenticated user needs to be an `OWNER` in order to successfully invoke this endpoint. The user can be specified with an email or an ID. If both email and ID are provided, ID will take priority.
|
|
2032
2190
|
* @summary Invite a user
|
|
2033
|
-
* {@link
|
|
2191
|
+
* {@link /v1/teams/:teamId/members}
|
|
2034
2192
|
*/
|
|
2035
|
-
export async function inviteUserToTeam({ pathParams: { teamId }, config = {}
|
|
2193
|
+
export async function inviteUserToTeam({ pathParams: { teamId }, config = {} }) {
|
|
2036
2194
|
const { client: request = client, ...requestConfig } = config;
|
|
2037
2195
|
if (!teamId) {
|
|
2038
2196
|
throw new Error(`Missing required path parameter: teamId`);
|
|
2039
2197
|
}
|
|
2040
|
-
const data = await request({
|
|
2198
|
+
const data = await request({
|
|
2199
|
+
method: 'POST',
|
|
2200
|
+
url: `/v1/teams/${teamId}/members`,
|
|
2201
|
+
...requestConfig,
|
|
2202
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2203
|
+
});
|
|
2041
2204
|
return data;
|
|
2042
2205
|
}
|
|
2043
2206
|
/**
|
|
2044
2207
|
* @description Request access to a team as a member. An owner has to approve the request. Only 10 users can request access to a team at the same time.
|
|
2045
2208
|
* @summary Request access to a team
|
|
2046
|
-
* {@link
|
|
2209
|
+
* {@link /v1/teams/:teamId/request}
|
|
2047
2210
|
*/
|
|
2048
|
-
export async function requestAccessToTeam({ pathParams: { teamId }, config = {}
|
|
2211
|
+
export async function requestAccessToTeam({ pathParams: { teamId }, config = {} }) {
|
|
2049
2212
|
const { client: request = client, ...requestConfig } = config;
|
|
2050
2213
|
if (!teamId) {
|
|
2051
2214
|
throw new Error(`Missing required path parameter: teamId`);
|
|
2052
2215
|
}
|
|
2053
|
-
const data = await request({
|
|
2216
|
+
const data = await request({
|
|
2217
|
+
method: 'POST',
|
|
2218
|
+
url: `/v1/teams/${teamId}/request`,
|
|
2219
|
+
...requestConfig,
|
|
2220
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2221
|
+
});
|
|
2054
2222
|
return data;
|
|
2055
2223
|
}
|
|
2056
2224
|
/**
|
|
2057
2225
|
* @description Check the status of a join request. It'll respond with a 404 if the request has been declined. If no `userId` path segment was provided, this endpoint will instead return the status of the authenticated user.
|
|
2058
2226
|
* @summary Get access request status
|
|
2059
|
-
* {@link
|
|
2227
|
+
* {@link /v1/teams/:teamId/request/:userId}
|
|
2060
2228
|
*/
|
|
2061
|
-
export async function getTeamAccessRequest({ pathParams: { userId, teamId }, config = {}
|
|
2229
|
+
export async function getTeamAccessRequest({ pathParams: { userId, teamId }, config = {} }) {
|
|
2062
2230
|
const { client: request = client, ...requestConfig } = config;
|
|
2063
2231
|
if (!userId) {
|
|
2064
2232
|
throw new Error(`Missing required path parameter: userId`);
|
|
@@ -2066,28 +2234,33 @@ export async function getTeamAccessRequest({ pathParams: { userId, teamId }, con
|
|
|
2066
2234
|
if (!teamId) {
|
|
2067
2235
|
throw new Error(`Missing required path parameter: teamId`);
|
|
2068
2236
|
}
|
|
2069
|
-
const data = await request({ method: 'GET', url:
|
|
2237
|
+
const data = await request({ method: 'GET', url: `/v1/teams/${teamId}/request/${userId}`, ...requestConfig });
|
|
2070
2238
|
return data;
|
|
2071
2239
|
}
|
|
2072
2240
|
/**
|
|
2073
2241
|
* @description Join a team with a provided invite code or team ID.
|
|
2074
2242
|
* @summary Join a team
|
|
2075
|
-
* {@link
|
|
2243
|
+
* {@link /v1/teams/:teamId/members/teams/join}
|
|
2076
2244
|
*/
|
|
2077
|
-
export async function joinTeam({ pathParams: { teamId }, config = {}
|
|
2245
|
+
export async function joinTeam({ pathParams: { teamId }, config = {} }) {
|
|
2078
2246
|
const { client: request = client, ...requestConfig } = config;
|
|
2079
2247
|
if (!teamId) {
|
|
2080
2248
|
throw new Error(`Missing required path parameter: teamId`);
|
|
2081
2249
|
}
|
|
2082
|
-
const data = await request({
|
|
2250
|
+
const data = await request({
|
|
2251
|
+
method: 'POST',
|
|
2252
|
+
url: `/v1/teams/${teamId}/members/teams/join`,
|
|
2253
|
+
...requestConfig,
|
|
2254
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2255
|
+
});
|
|
2083
2256
|
return data;
|
|
2084
2257
|
}
|
|
2085
2258
|
/**
|
|
2086
2259
|
* @description Update the membership of a Team Member on the Team specified by `teamId`, such as changing the _role_ of the member, or confirming a request to join the Team for an unconfirmed member. The authenticated user must be an `OWNER` of the Team.
|
|
2087
2260
|
* @summary Update a Team Member
|
|
2088
|
-
* {@link
|
|
2261
|
+
* {@link /v1/teams/:teamId/members/:uid}
|
|
2089
2262
|
*/
|
|
2090
|
-
export async function updateTeamMember({ pathParams: { uid, teamId }, config = {}
|
|
2263
|
+
export async function updateTeamMember({ pathParams: { uid, teamId }, config = {} }) {
|
|
2091
2264
|
const { client: request = client, ...requestConfig } = config;
|
|
2092
2265
|
if (!uid) {
|
|
2093
2266
|
throw new Error(`Missing required path parameter: uid`);
|
|
@@ -2095,15 +2268,20 @@ export async function updateTeamMember({ pathParams: { uid, teamId }, config = {
|
|
|
2095
2268
|
if (!teamId) {
|
|
2096
2269
|
throw new Error(`Missing required path parameter: teamId`);
|
|
2097
2270
|
}
|
|
2098
|
-
const data = await request({
|
|
2271
|
+
const data = await request({
|
|
2272
|
+
method: 'PATCH',
|
|
2273
|
+
url: `/v1/teams/${teamId}/members/${uid}`,
|
|
2274
|
+
...requestConfig,
|
|
2275
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2276
|
+
});
|
|
2099
2277
|
return data;
|
|
2100
2278
|
}
|
|
2101
2279
|
/**
|
|
2102
2280
|
* @description Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team.
|
|
2103
2281
|
* @summary Remove a Team Member
|
|
2104
|
-
* {@link
|
|
2282
|
+
* {@link /v1/teams/:teamId/members/:uid}
|
|
2105
2283
|
*/
|
|
2106
|
-
export async function removeTeamMember({ pathParams: { uid, teamId }, queryParams, config = {}
|
|
2284
|
+
export async function removeTeamMember({ pathParams: { uid, teamId }, queryParams, config = {} }) {
|
|
2107
2285
|
const { client: request = client, ...requestConfig } = config;
|
|
2108
2286
|
if (!uid) {
|
|
2109
2287
|
throw new Error(`Missing required path parameter: uid`);
|
|
@@ -2111,74 +2289,91 @@ export async function removeTeamMember({ pathParams: { uid, teamId }, queryParam
|
|
|
2111
2289
|
if (!teamId) {
|
|
2112
2290
|
throw new Error(`Missing required path parameter: teamId`);
|
|
2113
2291
|
}
|
|
2114
|
-
const data = await request({ method: 'DELETE', url:
|
|
2292
|
+
const data = await request({ method: 'DELETE', url: `/v1/teams/${teamId}/members/${uid}`, queryParams, ...requestConfig });
|
|
2115
2293
|
return data;
|
|
2116
2294
|
}
|
|
2117
2295
|
/**
|
|
2118
2296
|
* @description Get information for the Team specified by the `teamId` parameter.
|
|
2119
2297
|
* @summary Get a Team
|
|
2120
|
-
* {@link
|
|
2298
|
+
* {@link /v2/teams/:teamId}
|
|
2121
2299
|
*/
|
|
2122
|
-
export async function getTeam({ pathParams: { teamId }, queryParams, config = {}
|
|
2300
|
+
export async function getTeam({ pathParams: { teamId }, queryParams, config = {} }) {
|
|
2123
2301
|
const { client: request = client, ...requestConfig } = config;
|
|
2124
2302
|
if (!teamId) {
|
|
2125
2303
|
throw new Error(`Missing required path parameter: teamId`);
|
|
2126
2304
|
}
|
|
2127
|
-
const data = await request({ method: 'GET', url:
|
|
2305
|
+
const data = await request({ method: 'GET', url: `/v2/teams/${teamId}`, queryParams, ...requestConfig });
|
|
2128
2306
|
return data;
|
|
2129
2307
|
}
|
|
2130
2308
|
/**
|
|
2131
2309
|
* @description Update the information of a Team specified by the `teamId` parameter. The request body should contain the information that will be updated on the Team.
|
|
2132
2310
|
* @summary Update a Team
|
|
2133
|
-
* {@link
|
|
2311
|
+
* {@link /v2/teams/:teamId}
|
|
2134
2312
|
*/
|
|
2135
|
-
export async function patchTeam({ pathParams: { teamId }, queryParams, config = {}
|
|
2313
|
+
export async function patchTeam({ pathParams: { teamId }, queryParams, config = {} }) {
|
|
2136
2314
|
const { client: request = client, ...requestConfig } = config;
|
|
2137
2315
|
if (!teamId) {
|
|
2138
2316
|
throw new Error(`Missing required path parameter: teamId`);
|
|
2139
2317
|
}
|
|
2140
|
-
const data = await request({
|
|
2318
|
+
const data = await request({
|
|
2319
|
+
method: 'PATCH',
|
|
2320
|
+
url: `/v2/teams/${teamId}`,
|
|
2321
|
+
queryParams,
|
|
2322
|
+
...requestConfig,
|
|
2323
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2324
|
+
});
|
|
2141
2325
|
return data;
|
|
2142
2326
|
}
|
|
2143
2327
|
/**
|
|
2144
2328
|
* @description Get a paginated list of all the Teams the authenticated User is a member of.
|
|
2145
2329
|
* @summary List all teams
|
|
2146
|
-
* {@link
|
|
2330
|
+
* {@link /v2/teams}
|
|
2147
2331
|
*/
|
|
2148
|
-
export async function getTeams({ queryParams, config = {}
|
|
2332
|
+
export async function getTeams({ queryParams, config = {} }) {
|
|
2149
2333
|
const { client: request = client, ...requestConfig } = config;
|
|
2150
|
-
const data = await request({ method: 'GET', url:
|
|
2334
|
+
const data = await request({ method: 'GET', url: `/v2/teams`, queryParams, ...requestConfig });
|
|
2151
2335
|
return data;
|
|
2152
2336
|
}
|
|
2153
2337
|
/**
|
|
2154
2338
|
* @description Create a new Team under your account. You need to send a POST request with the desired Team slug, and optionally the Team name.
|
|
2155
2339
|
* @summary Create a Team
|
|
2156
|
-
* {@link
|
|
2340
|
+
* {@link /v1/teams}
|
|
2157
2341
|
*/
|
|
2158
2342
|
export async function createTeam({ config = {} }) {
|
|
2159
2343
|
const { client: request = client, ...requestConfig } = config;
|
|
2160
|
-
const data = await request({
|
|
2344
|
+
const data = await request({
|
|
2345
|
+
method: 'POST',
|
|
2346
|
+
url: `/v1/teams`,
|
|
2347
|
+
...requestConfig,
|
|
2348
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2349
|
+
});
|
|
2161
2350
|
return data;
|
|
2162
2351
|
}
|
|
2163
2352
|
/**
|
|
2164
2353
|
* @description Delete a team under your account. You need to send a `DELETE` request with the desired team `id`. An optional array of reasons for deletion may also be sent.
|
|
2165
2354
|
* @summary Delete a Team
|
|
2166
|
-
* {@link
|
|
2355
|
+
* {@link /v1/teams/:teamId}
|
|
2167
2356
|
*/
|
|
2168
|
-
export async function deleteTeam({ pathParams: { teamId }, queryParams, config = {}
|
|
2357
|
+
export async function deleteTeam({ pathParams: { teamId }, queryParams, config = {} }) {
|
|
2169
2358
|
const { client: request = client, ...requestConfig } = config;
|
|
2170
2359
|
if (!teamId) {
|
|
2171
2360
|
throw new Error(`Missing required path parameter: teamId`);
|
|
2172
2361
|
}
|
|
2173
|
-
const data = await request({
|
|
2362
|
+
const data = await request({
|
|
2363
|
+
method: 'DELETE',
|
|
2364
|
+
url: `/v1/teams/${teamId}`,
|
|
2365
|
+
queryParams,
|
|
2366
|
+
...requestConfig,
|
|
2367
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2368
|
+
});
|
|
2174
2369
|
return data;
|
|
2175
2370
|
}
|
|
2176
2371
|
/**
|
|
2177
2372
|
* @description Delete an active Team invite code.
|
|
2178
2373
|
* @summary Delete a Team invite code
|
|
2179
|
-
* {@link
|
|
2374
|
+
* {@link /v1/teams/:teamId/invites/:inviteId}
|
|
2180
2375
|
*/
|
|
2181
|
-
export async function deleteTeamInviteCode({ pathParams: { inviteId, teamId }, config = {}
|
|
2376
|
+
export async function deleteTeamInviteCode({ pathParams: { inviteId, teamId }, config = {} }) {
|
|
2182
2377
|
const { client: request = client, ...requestConfig } = config;
|
|
2183
2378
|
if (!inviteId) {
|
|
2184
2379
|
throw new Error(`Missing required path parameter: inviteId`);
|
|
@@ -2186,291 +2381,326 @@ export async function deleteTeamInviteCode({ pathParams: { inviteId, teamId }, c
|
|
|
2186
2381
|
if (!teamId) {
|
|
2187
2382
|
throw new Error(`Missing required path parameter: teamId`);
|
|
2188
2383
|
}
|
|
2189
|
-
const data = await request({ method: 'DELETE', url:
|
|
2384
|
+
const data = await request({ method: 'DELETE', url: `/v1/teams/${teamId}/invites/${inviteId}`, ...requestConfig });
|
|
2190
2385
|
return data;
|
|
2191
2386
|
}
|
|
2192
2387
|
/**
|
|
2193
2388
|
* @description Before you create a deployment you need to upload the required files for that deployment. To do it, you need to first upload each file to this endpoint. Once that's completed, you can create a new deployment with the uploaded files. The file content must be placed inside the body of the request. In the case of a successful response you'll receive a status code 200 with an empty body.
|
|
2194
2389
|
* @summary Upload Deployment Files
|
|
2195
|
-
* {@link
|
|
2390
|
+
* {@link /v2/files}
|
|
2196
2391
|
*/
|
|
2197
|
-
export async function uploadFile({ queryParams, headers, config = {}
|
|
2392
|
+
export async function uploadFile({ queryParams, headers, config = {} }) {
|
|
2198
2393
|
const { client: request = client, ...requestConfig } = config;
|
|
2199
2394
|
const data = await request({
|
|
2200
2395
|
method: 'POST',
|
|
2201
|
-
url:
|
|
2396
|
+
url: `/v2/files`,
|
|
2202
2397
|
queryParams,
|
|
2203
2398
|
...requestConfig,
|
|
2204
|
-
headers: { 'Content-Type': 'applicationOctetStream', ...headers, ...requestConfig.headers }
|
|
2399
|
+
headers: { 'Content-Type': 'applicationOctetStream', ...headers, ...requestConfig.headers }
|
|
2205
2400
|
});
|
|
2206
2401
|
return data;
|
|
2207
2402
|
}
|
|
2208
2403
|
/**
|
|
2209
2404
|
* @description Retrieve a list of the current User's authentication tokens.
|
|
2210
2405
|
* @summary List Auth Tokens
|
|
2211
|
-
* {@link
|
|
2406
|
+
* {@link /v5/user/tokens}
|
|
2212
2407
|
*/
|
|
2213
2408
|
export async function listAuthTokens({ config = {} }) {
|
|
2214
2409
|
const { client: request = client, ...requestConfig } = config;
|
|
2215
|
-
const data = await request({ method: 'GET', url:
|
|
2410
|
+
const data = await request({ method: 'GET', url: `/v5/user/tokens`, ...requestConfig });
|
|
2216
2411
|
return data;
|
|
2217
2412
|
}
|
|
2218
2413
|
/**
|
|
2219
2414
|
* @description Creates and returns a new authentication token for the currently authenticated User. The `bearerToken` property is only provided once, in the response body, so be sure to save it on the client for use with API requests.
|
|
2220
2415
|
* @summary Create an Auth Token
|
|
2221
|
-
* {@link
|
|
2416
|
+
* {@link /v3/user/tokens}
|
|
2222
2417
|
*/
|
|
2223
|
-
export async function createAuthToken({ queryParams, config = {}
|
|
2418
|
+
export async function createAuthToken({ queryParams, config = {} }) {
|
|
2224
2419
|
const { client: request = client, ...requestConfig } = config;
|
|
2225
|
-
const data = await request({
|
|
2420
|
+
const data = await request({
|
|
2421
|
+
method: 'POST',
|
|
2422
|
+
url: `/v3/user/tokens`,
|
|
2423
|
+
queryParams,
|
|
2424
|
+
...requestConfig,
|
|
2425
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2426
|
+
});
|
|
2226
2427
|
return data;
|
|
2227
2428
|
}
|
|
2228
2429
|
/**
|
|
2229
2430
|
* @description Retrieve metadata about an authentication token belonging to the currently authenticated User.
|
|
2230
2431
|
* @summary Get Auth Token Metadata
|
|
2231
|
-
* {@link
|
|
2432
|
+
* {@link /v5/user/tokens/:tokenId}
|
|
2232
2433
|
*/
|
|
2233
|
-
export async function getAuthToken({ pathParams: { tokenId }, config = {}
|
|
2434
|
+
export async function getAuthToken({ pathParams: { tokenId }, config = {} }) {
|
|
2234
2435
|
const { client: request = client, ...requestConfig } = config;
|
|
2235
2436
|
if (!tokenId) {
|
|
2236
2437
|
throw new Error(`Missing required path parameter: tokenId`);
|
|
2237
2438
|
}
|
|
2238
|
-
const data = await request({ method: 'GET', url:
|
|
2439
|
+
const data = await request({ method: 'GET', url: `/v5/user/tokens/${tokenId}`, ...requestConfig });
|
|
2239
2440
|
return data;
|
|
2240
2441
|
}
|
|
2241
2442
|
/**
|
|
2242
2443
|
* @description Invalidate an authentication token, such that it will no longer be valid for future HTTP requests.
|
|
2243
2444
|
* @summary Delete an authentication token
|
|
2244
|
-
* {@link
|
|
2445
|
+
* {@link /v3/user/tokens/:tokenId}
|
|
2245
2446
|
*/
|
|
2246
|
-
export async function deleteAuthToken({ pathParams: { tokenId }, config = {}
|
|
2447
|
+
export async function deleteAuthToken({ pathParams: { tokenId }, config = {} }) {
|
|
2247
2448
|
const { client: request = client, ...requestConfig } = config;
|
|
2248
2449
|
if (!tokenId) {
|
|
2249
2450
|
throw new Error(`Missing required path parameter: tokenId`);
|
|
2250
2451
|
}
|
|
2251
|
-
const data = await request({ method: 'DELETE', url:
|
|
2452
|
+
const data = await request({ method: 'DELETE', url: `/v3/user/tokens/${tokenId}`, ...requestConfig });
|
|
2252
2453
|
return data;
|
|
2253
2454
|
}
|
|
2254
2455
|
/**
|
|
2255
2456
|
* @description Retrieves information related to the currently authenticated User.
|
|
2256
2457
|
* @summary Get the User
|
|
2257
|
-
* {@link
|
|
2458
|
+
* {@link /v2/user}
|
|
2258
2459
|
*/
|
|
2259
2460
|
export async function getAuthUser({ config = {} }) {
|
|
2260
2461
|
const { client: request = client, ...requestConfig } = config;
|
|
2261
|
-
const data = await request({ method: 'GET', url:
|
|
2462
|
+
const data = await request({ method: 'GET', url: `/v2/user`, ...requestConfig });
|
|
2262
2463
|
return data;
|
|
2263
2464
|
}
|
|
2264
2465
|
/**
|
|
2265
2466
|
* @description Initiates the deletion process for the currently authenticated User, by sending a deletion confirmation email. The email contains a link that the user needs to visit in order to proceed with the deletion process.
|
|
2266
2467
|
* @summary Delete User Account
|
|
2267
|
-
* {@link
|
|
2468
|
+
* {@link /v1/user}
|
|
2268
2469
|
*/
|
|
2269
2470
|
export async function requestDelete({ config = {} }) {
|
|
2270
2471
|
const { client: request = client, ...requestConfig } = config;
|
|
2271
|
-
const data = await request({
|
|
2472
|
+
const data = await request({
|
|
2473
|
+
method: 'DELETE',
|
|
2474
|
+
url: `/v1/user`,
|
|
2475
|
+
...requestConfig,
|
|
2476
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2477
|
+
});
|
|
2272
2478
|
return data;
|
|
2273
2479
|
}
|
|
2274
2480
|
/**
|
|
2275
2481
|
* @description Creates a webhook
|
|
2276
2482
|
* @summary Creates a webhook
|
|
2277
|
-
* {@link
|
|
2483
|
+
* {@link /v1/webhooks}
|
|
2278
2484
|
*/
|
|
2279
|
-
export async function createWebhook({ queryParams, config = {}
|
|
2485
|
+
export async function createWebhook({ queryParams, config = {} }) {
|
|
2280
2486
|
const { client: request = client, ...requestConfig } = config;
|
|
2281
|
-
const data = await request({
|
|
2487
|
+
const data = await request({
|
|
2488
|
+
method: 'POST',
|
|
2489
|
+
url: `/v1/webhooks`,
|
|
2490
|
+
queryParams,
|
|
2491
|
+
...requestConfig,
|
|
2492
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2493
|
+
});
|
|
2282
2494
|
return data;
|
|
2283
2495
|
}
|
|
2284
2496
|
/**
|
|
2285
2497
|
* @description Get a list of webhooks
|
|
2286
2498
|
* @summary Get a list of webhooks
|
|
2287
|
-
* {@link
|
|
2499
|
+
* {@link /v1/webhooks}
|
|
2288
2500
|
*/
|
|
2289
|
-
export async function getWebhooks({ queryParams, config = {}
|
|
2501
|
+
export async function getWebhooks({ queryParams, config = {} }) {
|
|
2290
2502
|
const { client: request = client, ...requestConfig } = config;
|
|
2291
|
-
const data = await request({ method: 'GET', url:
|
|
2503
|
+
const data = await request({ method: 'GET', url: `/v1/webhooks`, queryParams, ...requestConfig });
|
|
2292
2504
|
return data;
|
|
2293
2505
|
}
|
|
2294
2506
|
/**
|
|
2295
2507
|
* @description Get a webhook
|
|
2296
2508
|
* @summary Get a webhook
|
|
2297
|
-
* {@link
|
|
2509
|
+
* {@link /v1/webhooks/:id}
|
|
2298
2510
|
*/
|
|
2299
|
-
export async function getWebhook({ pathParams: { id }, queryParams, config = {}
|
|
2511
|
+
export async function getWebhook({ pathParams: { id }, queryParams, config = {} }) {
|
|
2300
2512
|
const { client: request = client, ...requestConfig } = config;
|
|
2301
2513
|
if (!id) {
|
|
2302
2514
|
throw new Error(`Missing required path parameter: id`);
|
|
2303
2515
|
}
|
|
2304
|
-
const data = await request({ method: 'GET', url:
|
|
2516
|
+
const data = await request({ method: 'GET', url: `/v1/webhooks/${id}`, queryParams, ...requestConfig });
|
|
2305
2517
|
return data;
|
|
2306
2518
|
}
|
|
2307
2519
|
/**
|
|
2308
2520
|
* @description Deletes a webhook
|
|
2309
2521
|
* @summary Deletes a webhook
|
|
2310
|
-
* {@link
|
|
2522
|
+
* {@link /v1/webhooks/:id}
|
|
2311
2523
|
*/
|
|
2312
|
-
export async function deleteWebhook({ pathParams: { id }, queryParams, config = {}
|
|
2524
|
+
export async function deleteWebhook({ pathParams: { id }, queryParams, config = {} }) {
|
|
2313
2525
|
const { client: request = client, ...requestConfig } = config;
|
|
2314
2526
|
if (!id) {
|
|
2315
2527
|
throw new Error(`Missing required path parameter: id`);
|
|
2316
2528
|
}
|
|
2317
|
-
const data = await request({ method: 'DELETE', url:
|
|
2529
|
+
const data = await request({ method: 'DELETE', url: `/v1/webhooks/${id}`, queryParams, ...requestConfig });
|
|
2318
2530
|
return data;
|
|
2319
2531
|
}
|
|
2320
2532
|
/**
|
|
2321
2533
|
* @description Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment.
|
|
2322
2534
|
* @summary List Deployment Aliases
|
|
2323
|
-
* {@link
|
|
2535
|
+
* {@link /v2/deployments/:id/aliases}
|
|
2324
2536
|
*/
|
|
2325
|
-
export async function listDeploymentAliases({ pathParams: { id }, queryParams, config = {}
|
|
2537
|
+
export async function listDeploymentAliases({ pathParams: { id }, queryParams, config = {} }) {
|
|
2326
2538
|
const { client: request = client, ...requestConfig } = config;
|
|
2327
2539
|
if (!id) {
|
|
2328
2540
|
throw new Error(`Missing required path parameter: id`);
|
|
2329
2541
|
}
|
|
2330
|
-
const data = await request({ method: 'GET', url:
|
|
2542
|
+
const data = await request({ method: 'GET', url: `/v2/deployments/${id}/aliases`, queryParams, ...requestConfig });
|
|
2331
2543
|
return data;
|
|
2332
2544
|
}
|
|
2333
2545
|
/**
|
|
2334
2546
|
* @description Creates a new alias for the deployment with the given deployment ID. The authenticated user or team must own this deployment. If the desired alias is already assigned to another deployment, then it will be removed from the old deployment and assigned to the new one.
|
|
2335
2547
|
* @summary Assign an Alias
|
|
2336
|
-
* {@link
|
|
2548
|
+
* {@link /v2/deployments/:id/aliases}
|
|
2337
2549
|
*/
|
|
2338
|
-
export async function assignAlias({ pathParams: { id }, queryParams, config = {}
|
|
2550
|
+
export async function assignAlias({ pathParams: { id }, queryParams, config = {} }) {
|
|
2339
2551
|
const { client: request = client, ...requestConfig } = config;
|
|
2340
2552
|
if (!id) {
|
|
2341
2553
|
throw new Error(`Missing required path parameter: id`);
|
|
2342
2554
|
}
|
|
2343
|
-
const data = await request({
|
|
2555
|
+
const data = await request({
|
|
2556
|
+
method: 'POST',
|
|
2557
|
+
url: `/v2/deployments/${id}/aliases`,
|
|
2558
|
+
queryParams,
|
|
2559
|
+
...requestConfig,
|
|
2560
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2561
|
+
});
|
|
2344
2562
|
return data;
|
|
2345
2563
|
}
|
|
2346
2564
|
/**
|
|
2347
2565
|
* @description Retrieves a list of aliases for the authenticated User or Team. When `domain` is provided, only aliases for that domain will be returned. When `projectId` is provided, it will only return the given project aliases.
|
|
2348
2566
|
* @summary List aliases
|
|
2349
|
-
* {@link
|
|
2567
|
+
* {@link /v4/aliases}
|
|
2350
2568
|
*/
|
|
2351
|
-
export async function listAliases({ queryParams, config = {}
|
|
2569
|
+
export async function listAliases({ queryParams, config = {} }) {
|
|
2352
2570
|
const { client: request = client, ...requestConfig } = config;
|
|
2353
|
-
const data = await request({ method: 'GET', url:
|
|
2571
|
+
const data = await request({ method: 'GET', url: `/v4/aliases`, queryParams, ...requestConfig });
|
|
2354
2572
|
return data;
|
|
2355
2573
|
}
|
|
2356
2574
|
/**
|
|
2357
2575
|
* @description Retrieves an Alias for the given host name or alias ID.
|
|
2358
2576
|
* @summary Get an Alias
|
|
2359
|
-
* {@link
|
|
2577
|
+
* {@link /v4/aliases/:idOrAlias}
|
|
2360
2578
|
*/
|
|
2361
|
-
export async function getAlias({ pathParams: { idOrAlias }, queryParams, config = {}
|
|
2579
|
+
export async function getAlias({ pathParams: { idOrAlias }, queryParams, config = {} }) {
|
|
2362
2580
|
const { client: request = client, ...requestConfig } = config;
|
|
2363
2581
|
if (!idOrAlias) {
|
|
2364
2582
|
throw new Error(`Missing required path parameter: idOrAlias`);
|
|
2365
2583
|
}
|
|
2366
|
-
const data = await request({ method: 'GET', url:
|
|
2584
|
+
const data = await request({ method: 'GET', url: `/v4/aliases/${idOrAlias}`, queryParams, ...requestConfig });
|
|
2367
2585
|
return data;
|
|
2368
2586
|
}
|
|
2369
2587
|
/**
|
|
2370
2588
|
* @description Delete an Alias with the specified ID.
|
|
2371
2589
|
* @summary Delete an Alias
|
|
2372
|
-
* {@link
|
|
2590
|
+
* {@link /v2/aliases/:aliasId}
|
|
2373
2591
|
*/
|
|
2374
|
-
export async function deleteAlias({ pathParams: { aliasId }, queryParams, config = {}
|
|
2592
|
+
export async function deleteAlias({ pathParams: { aliasId }, queryParams, config = {} }) {
|
|
2375
2593
|
const { client: request = client, ...requestConfig } = config;
|
|
2376
2594
|
if (!aliasId) {
|
|
2377
2595
|
throw new Error(`Missing required path parameter: aliasId`);
|
|
2378
2596
|
}
|
|
2379
|
-
const data = await request({ method: 'DELETE', url:
|
|
2597
|
+
const data = await request({ method: 'DELETE', url: `/v2/aliases/${aliasId}`, queryParams, ...requestConfig });
|
|
2380
2598
|
return data;
|
|
2381
2599
|
}
|
|
2382
2600
|
/**
|
|
2383
2601
|
* @description Update the protection bypass for the alias or deployment URL (used for user access & comment access for deployments). Used as shareable links and user scoped access for Vercel Authentication and also to allow external (logged in) people to comment on previews for Preview Comments (next-live-mode).
|
|
2384
2602
|
* @summary Update the protection bypass for a URL
|
|
2385
|
-
* {@link
|
|
2603
|
+
* {@link /aliases/:id/protection-bypass}
|
|
2386
2604
|
*/
|
|
2387
|
-
export async function patchUrlProtectionBypass({ pathParams: { id }, queryParams, config = {}
|
|
2605
|
+
export async function patchUrlProtectionBypass({ pathParams: { id }, queryParams, config = {} }) {
|
|
2388
2606
|
const { client: request = client, ...requestConfig } = config;
|
|
2389
2607
|
if (!id) {
|
|
2390
2608
|
throw new Error(`Missing required path parameter: id`);
|
|
2391
2609
|
}
|
|
2392
2610
|
const data = await request({
|
|
2393
2611
|
method: 'PATCH',
|
|
2394
|
-
url:
|
|
2612
|
+
url: `/aliases/${id}/protection-bypass`,
|
|
2395
2613
|
queryParams,
|
|
2396
2614
|
...requestConfig,
|
|
2397
|
-
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2615
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2398
2616
|
});
|
|
2399
2617
|
return data;
|
|
2400
2618
|
}
|
|
2401
2619
|
/**
|
|
2402
|
-
* {@link certs}
|
|
2620
|
+
* {@link /certs}
|
|
2403
2621
|
*/
|
|
2404
2622
|
export async function listCerts({ config = {} }) {
|
|
2405
2623
|
const { client: request = client, ...requestConfig } = config;
|
|
2406
|
-
const data = await request({ method: 'GET', url:
|
|
2624
|
+
const data = await request({ method: 'GET', url: `/certs`, ...requestConfig });
|
|
2407
2625
|
return data;
|
|
2408
2626
|
}
|
|
2409
2627
|
/**
|
|
2410
2628
|
* @description Get cert by id
|
|
2411
2629
|
* @summary Get cert by id
|
|
2412
|
-
* {@link
|
|
2630
|
+
* {@link /v8/certs/:id}
|
|
2413
2631
|
*/
|
|
2414
|
-
export async function getCertById({ pathParams: { id }, queryParams, config = {}
|
|
2632
|
+
export async function getCertById({ pathParams: { id }, queryParams, config = {} }) {
|
|
2415
2633
|
const { client: request = client, ...requestConfig } = config;
|
|
2416
2634
|
if (!id) {
|
|
2417
2635
|
throw new Error(`Missing required path parameter: id`);
|
|
2418
2636
|
}
|
|
2419
|
-
const data = await request({ method: 'GET', url:
|
|
2637
|
+
const data = await request({ method: 'GET', url: `/v8/certs/${id}`, queryParams, ...requestConfig });
|
|
2420
2638
|
return data;
|
|
2421
2639
|
}
|
|
2422
2640
|
/**
|
|
2423
2641
|
* @description Remove cert
|
|
2424
2642
|
* @summary Remove cert
|
|
2425
|
-
* {@link
|
|
2643
|
+
* {@link /v8/certs/:id}
|
|
2426
2644
|
*/
|
|
2427
|
-
export async function removeCert({ pathParams: { id }, queryParams, config = {}
|
|
2645
|
+
export async function removeCert({ pathParams: { id }, queryParams, config = {} }) {
|
|
2428
2646
|
const { client: request = client, ...requestConfig } = config;
|
|
2429
2647
|
if (!id) {
|
|
2430
2648
|
throw new Error(`Missing required path parameter: id`);
|
|
2431
2649
|
}
|
|
2432
|
-
const data = await request({ method: 'DELETE', url:
|
|
2650
|
+
const data = await request({ method: 'DELETE', url: `/v8/certs/${id}`, queryParams, ...requestConfig });
|
|
2433
2651
|
return data;
|
|
2434
2652
|
}
|
|
2435
2653
|
/**
|
|
2436
2654
|
* @description Issue a new cert
|
|
2437
2655
|
* @summary Issue a new cert
|
|
2438
|
-
* {@link
|
|
2656
|
+
* {@link /v8/certs}
|
|
2439
2657
|
*/
|
|
2440
|
-
export async function issueCert({ queryParams, config = {}
|
|
2658
|
+
export async function issueCert({ queryParams, config = {} }) {
|
|
2441
2659
|
const { client: request = client, ...requestConfig } = config;
|
|
2442
|
-
const data = await request({
|
|
2660
|
+
const data = await request({
|
|
2661
|
+
method: 'POST',
|
|
2662
|
+
url: `/v8/certs`,
|
|
2663
|
+
queryParams,
|
|
2664
|
+
...requestConfig,
|
|
2665
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2666
|
+
});
|
|
2443
2667
|
return data;
|
|
2444
2668
|
}
|
|
2445
2669
|
/**
|
|
2446
2670
|
* @description Upload a cert
|
|
2447
2671
|
* @summary Upload a cert
|
|
2448
|
-
* {@link
|
|
2672
|
+
* {@link /v8/certs}
|
|
2449
2673
|
*/
|
|
2450
|
-
export async function uploadCert({ queryParams, config = {}
|
|
2674
|
+
export async function uploadCert({ queryParams, config = {} }) {
|
|
2451
2675
|
const { client: request = client, ...requestConfig } = config;
|
|
2452
|
-
const data = await request({
|
|
2676
|
+
const data = await request({
|
|
2677
|
+
method: 'PUT',
|
|
2678
|
+
url: `/v8/certs`,
|
|
2679
|
+
queryParams,
|
|
2680
|
+
...requestConfig,
|
|
2681
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2682
|
+
});
|
|
2453
2683
|
return data;
|
|
2454
2684
|
}
|
|
2455
2685
|
/**
|
|
2456
2686
|
* @description Allows to retrieve the file structure of the source code of a deployment by supplying the deployment unique identifier. If the deployment was created with the Vercel CLI or the API directly with the `files` key, it will have a file tree that can be retrievable.
|
|
2457
2687
|
* @summary List Deployment Files
|
|
2458
|
-
* {@link
|
|
2688
|
+
* {@link /v6/deployments/:id/files}
|
|
2459
2689
|
*/
|
|
2460
|
-
export async function listDeploymentFiles({ pathParams: { id }, queryParams, config = {}
|
|
2690
|
+
export async function listDeploymentFiles({ pathParams: { id }, queryParams, config = {} }) {
|
|
2461
2691
|
const { client: request = client, ...requestConfig } = config;
|
|
2462
2692
|
if (!id) {
|
|
2463
2693
|
throw new Error(`Missing required path parameter: id`);
|
|
2464
2694
|
}
|
|
2465
|
-
const data = await request({ method: 'GET', url:
|
|
2695
|
+
const data = await request({ method: 'GET', url: `/v6/deployments/${id}/files`, queryParams, ...requestConfig });
|
|
2466
2696
|
return data;
|
|
2467
2697
|
}
|
|
2468
2698
|
/**
|
|
2469
2699
|
* @description Allows to retrieve the content of a file by supplying the file identifier and the deployment unique identifier. The response body will contain a JSON response containing the contents of the file encoded as base64.
|
|
2470
2700
|
* @summary Get Deployment File Contents
|
|
2471
|
-
* {@link
|
|
2701
|
+
* {@link /v8/deployments/:id/files/:fileId}
|
|
2472
2702
|
*/
|
|
2473
|
-
export async function getDeploymentFileContents({ pathParams: { id, fileId }, queryParams, config = {}
|
|
2703
|
+
export async function getDeploymentFileContents({ pathParams: { id, fileId }, queryParams, config = {} }) {
|
|
2474
2704
|
const { client: request = client, ...requestConfig } = config;
|
|
2475
2705
|
if (!id) {
|
|
2476
2706
|
throw new Error(`Missing required path parameter: id`);
|
|
@@ -2478,273 +2708,285 @@ export async function getDeploymentFileContents({ pathParams: { id, fileId }, qu
|
|
|
2478
2708
|
if (!fileId) {
|
|
2479
2709
|
throw new Error(`Missing required path parameter: fileId`);
|
|
2480
2710
|
}
|
|
2481
|
-
const data = await request({ method: 'GET', url:
|
|
2711
|
+
const data = await request({ method: 'GET', url: `/v8/deployments/${id}/files/${fileId}`, queryParams, ...requestConfig });
|
|
2482
2712
|
return data;
|
|
2483
2713
|
}
|
|
2484
2714
|
/**
|
|
2485
2715
|
* @description List deployments under the authenticated user or team. If a deployment hasn't finished uploading (is incomplete), the `url` property will have a value of `null`.
|
|
2486
2716
|
* @summary List deployments
|
|
2487
|
-
* {@link
|
|
2717
|
+
* {@link /v6/deployments}
|
|
2488
2718
|
*/
|
|
2489
|
-
export async function getDeployments({ queryParams, config = {}
|
|
2719
|
+
export async function getDeployments({ queryParams, config = {} }) {
|
|
2490
2720
|
const { client: request = client, ...requestConfig } = config;
|
|
2491
|
-
const data = await request({ method: 'GET', url:
|
|
2721
|
+
const data = await request({ method: 'GET', url: `/v6/deployments`, queryParams, ...requestConfig });
|
|
2492
2722
|
return data;
|
|
2493
2723
|
}
|
|
2494
2724
|
/**
|
|
2495
2725
|
* @description This API allows you to delete a deployment, either by supplying its `id` in the URL or the `url` of the deployment as a query parameter. You can obtain the ID, for example, by listing all deployments.
|
|
2496
2726
|
* @summary Delete a Deployment
|
|
2497
|
-
* {@link
|
|
2727
|
+
* {@link /v13/deployments/:id}
|
|
2498
2728
|
*/
|
|
2499
|
-
export async function deleteDeployment({ pathParams: { id }, queryParams, config = {}
|
|
2729
|
+
export async function deleteDeployment({ pathParams: { id }, queryParams, config = {} }) {
|
|
2500
2730
|
const { client: request = client, ...requestConfig } = config;
|
|
2501
2731
|
if (!id) {
|
|
2502
2732
|
throw new Error(`Missing required path parameter: id`);
|
|
2503
2733
|
}
|
|
2504
|
-
const data = await request({ method: 'DELETE', url:
|
|
2734
|
+
const data = await request({ method: 'DELETE', url: `/v13/deployments/${id}`, queryParams, ...requestConfig });
|
|
2505
2735
|
return data;
|
|
2506
2736
|
}
|
|
2507
2737
|
/**
|
|
2508
2738
|
* @description Retrieves the active Vercel secrets for the authenticated user or team. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret.
|
|
2509
2739
|
* @summary List secrets
|
|
2510
|
-
* {@link
|
|
2740
|
+
* {@link /v3/secrets}
|
|
2511
2741
|
*/
|
|
2512
|
-
export async function getSecrets({ queryParams, config = {}
|
|
2742
|
+
export async function getSecrets({ queryParams, config = {} }) {
|
|
2513
2743
|
const { client: request = client, ...requestConfig } = config;
|
|
2514
|
-
const data = await request({ method: 'GET', url:
|
|
2744
|
+
const data = await request({ method: 'GET', url: `/v3/secrets`, queryParams, ...requestConfig });
|
|
2515
2745
|
return data;
|
|
2516
2746
|
}
|
|
2517
2747
|
/**
|
|
2518
2748
|
* @description Allows to create a new secret.
|
|
2519
2749
|
* @summary Create a new secret
|
|
2520
|
-
* {@link
|
|
2750
|
+
* {@link /v2/secrets/:name}
|
|
2521
2751
|
*/
|
|
2522
|
-
export async function createSecret({ pathParams: { name }, queryParams, config = {}
|
|
2752
|
+
export async function createSecret({ pathParams: { name }, queryParams, config = {} }) {
|
|
2523
2753
|
const { client: request = client, ...requestConfig } = config;
|
|
2524
2754
|
if (!name) {
|
|
2525
2755
|
throw new Error(`Missing required path parameter: name`);
|
|
2526
2756
|
}
|
|
2527
|
-
const data = await request({
|
|
2757
|
+
const data = await request({
|
|
2758
|
+
method: 'POST',
|
|
2759
|
+
url: `/v2/secrets/${name}`,
|
|
2760
|
+
queryParams,
|
|
2761
|
+
...requestConfig,
|
|
2762
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2763
|
+
});
|
|
2528
2764
|
return data;
|
|
2529
2765
|
}
|
|
2530
2766
|
/**
|
|
2531
2767
|
* @description Enables to edit the name of a secret. The name has to be unique to the user or team’s secrets.
|
|
2532
2768
|
* @summary Change secret name
|
|
2533
|
-
* {@link
|
|
2769
|
+
* {@link /v2/secrets/:name}
|
|
2534
2770
|
*/
|
|
2535
|
-
export async function renameSecret({ pathParams: { name }, queryParams, config = {}
|
|
2771
|
+
export async function renameSecret({ pathParams: { name }, queryParams, config = {} }) {
|
|
2536
2772
|
const { client: request = client, ...requestConfig } = config;
|
|
2537
2773
|
if (!name) {
|
|
2538
2774
|
throw new Error(`Missing required path parameter: name`);
|
|
2539
2775
|
}
|
|
2540
|
-
const data = await request({
|
|
2776
|
+
const data = await request({
|
|
2777
|
+
method: 'PATCH',
|
|
2778
|
+
url: `/v2/secrets/${name}`,
|
|
2779
|
+
queryParams,
|
|
2780
|
+
...requestConfig,
|
|
2781
|
+
headers: { 'Content-Type': 'applicationJson', ...requestConfig.headers }
|
|
2782
|
+
});
|
|
2541
2783
|
return data;
|
|
2542
2784
|
}
|
|
2543
2785
|
/**
|
|
2544
2786
|
* @description Retrieves the information for a specific secret by passing either the secret id or name in the URL.
|
|
2545
2787
|
* @summary Get a single secret
|
|
2546
|
-
* {@link
|
|
2788
|
+
* {@link /v3/secrets/:idOrName}
|
|
2547
2789
|
*/
|
|
2548
|
-
export async function getSecret({ pathParams: { idOrName }, queryParams, config = {}
|
|
2790
|
+
export async function getSecret({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
2549
2791
|
const { client: request = client, ...requestConfig } = config;
|
|
2550
2792
|
if (!idOrName) {
|
|
2551
2793
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
2552
2794
|
}
|
|
2553
|
-
const data = await request({ method: 'GET', url:
|
|
2795
|
+
const data = await request({ method: 'GET', url: `/v3/secrets/${idOrName}`, queryParams, ...requestConfig });
|
|
2554
2796
|
return data;
|
|
2555
2797
|
}
|
|
2556
2798
|
/**
|
|
2557
2799
|
* @description This deletes the user or team’s secret defined in the URL.
|
|
2558
2800
|
* @summary Delete a secret
|
|
2559
|
-
* {@link
|
|
2801
|
+
* {@link /v2/secrets/:idOrName}
|
|
2560
2802
|
*/
|
|
2561
|
-
export async function deleteSecret({ pathParams: { idOrName }, queryParams, config = {}
|
|
2803
|
+
export async function deleteSecret({ pathParams: { idOrName }, queryParams, config = {} }) {
|
|
2562
2804
|
const { client: request = client, ...requestConfig } = config;
|
|
2563
2805
|
if (!idOrName) {
|
|
2564
2806
|
throw new Error(`Missing required path parameter: idOrName`);
|
|
2565
2807
|
}
|
|
2566
|
-
const data = await request({ method: 'DELETE', url:
|
|
2808
|
+
const data = await request({ method: 'DELETE', url: `/v2/secrets/${idOrName}`, queryParams, ...requestConfig });
|
|
2567
2809
|
return data;
|
|
2568
2810
|
}
|
|
2569
2811
|
export const operationsByPath = {
|
|
2570
|
-
'GET
|
|
2571
|
-
'POST
|
|
2572
|
-
'DELETE
|
|
2573
|
-
'GET
|
|
2574
|
-
'GET
|
|
2575
|
-
'POST
|
|
2576
|
-
'GET
|
|
2577
|
-
'POST
|
|
2578
|
-
'GET
|
|
2579
|
-
'PATCH
|
|
2580
|
-
'DELETE
|
|
2581
|
-
'POST
|
|
2582
|
-
'GET
|
|
2583
|
-
'PUT
|
|
2584
|
-
'GET
|
|
2585
|
-
'POST
|
|
2586
|
-
'POST
|
|
2587
|
-
'GET
|
|
2588
|
-
'GET
|
|
2589
|
-
'PATCH
|
|
2590
|
-
'POST
|
|
2591
|
-
'DELETE
|
|
2592
|
-
'PATCH
|
|
2593
|
-
'PATCH
|
|
2594
|
-
'GET
|
|
2595
|
-
'PATCH
|
|
2596
|
-
'GET
|
|
2597
|
-
'POST
|
|
2598
|
-
'PATCH
|
|
2599
|
-
'POST
|
|
2600
|
-
'GET
|
|
2601
|
-
'GET
|
|
2602
|
-
'GET
|
|
2603
|
-
'POST
|
|
2604
|
-
'PATCH
|
|
2605
|
-
'DELETE
|
|
2606
|
-
'GET
|
|
2607
|
-
'GET
|
|
2608
|
-
'GET
|
|
2609
|
-
'GET
|
|
2610
|
-
'POST
|
|
2611
|
-
'PATCH
|
|
2612
|
-
'DELETE
|
|
2613
|
-
'GET
|
|
2614
|
-
'POST
|
|
2615
|
-
'GET
|
|
2616
|
-
'PUT
|
|
2617
|
-
'DELETE
|
|
2618
|
-
'GET
|
|
2619
|
-
'PATCH
|
|
2620
|
-
'GET
|
|
2621
|
-
'POST
|
|
2622
|
-
'DELETE
|
|
2623
|
-
'GET
|
|
2624
|
-
'GET
|
|
2625
|
-
'DELETE
|
|
2626
|
-
'GET
|
|
2627
|
-
'POST
|
|
2628
|
-
'GET
|
|
2629
|
-
'GET
|
|
2630
|
-
'GET
|
|
2631
|
-
'GET
|
|
2632
|
-
'GET
|
|
2633
|
-
'POST
|
|
2634
|
-
'GET
|
|
2635
|
-
'GET
|
|
2636
|
-
'DELETE
|
|
2637
|
-
'PUT
|
|
2638
|
-
'POST
|
|
2639
|
-
'POST
|
|
2640
|
-
'GET
|
|
2641
|
-
'POST
|
|
2642
|
-
'POST
|
|
2643
|
-
'PUT
|
|
2644
|
-
'PUT
|
|
2645
|
-
'GET
|
|
2646
|
-
'GET
|
|
2647
|
-
'DELETE
|
|
2648
|
-
'POST
|
|
2649
|
-
'GET
|
|
2650
|
-
'POST
|
|
2651
|
-
'DELETE
|
|
2652
|
-
'GET
|
|
2653
|
-
'POST
|
|
2654
|
-
'PATCH
|
|
2655
|
-
'DELETE
|
|
2656
|
-
'PUT
|
|
2657
|
-
'GET
|
|
2658
|
-
'POST
|
|
2659
|
-
'DELETE
|
|
2660
|
-
'GET
|
|
2661
|
-
'POST
|
|
2662
|
-
'GET
|
|
2663
|
-
'PATCH
|
|
2664
|
-
'DELETE
|
|
2665
|
-
'POST
|
|
2666
|
-
'GET
|
|
2667
|
-
'GET
|
|
2668
|
-
'PATCH
|
|
2669
|
-
'DELETE
|
|
2670
|
-
'GET
|
|
2671
|
-
'GET
|
|
2672
|
-
'PATCH
|
|
2673
|
-
'DELETE
|
|
2674
|
-
'POST
|
|
2675
|
-
'POST
|
|
2676
|
-
'POST
|
|
2677
|
-
'GET
|
|
2678
|
-
'POST
|
|
2679
|
-
'GET
|
|
2680
|
-
'DELETE
|
|
2681
|
-
'PATCH
|
|
2682
|
-
'GET
|
|
2683
|
-
'GET
|
|
2684
|
-
'DELETE
|
|
2685
|
-
'PATCH
|
|
2686
|
-
'GET
|
|
2687
|
-
'POST
|
|
2688
|
-
'POST
|
|
2689
|
-
'POST
|
|
2690
|
-
'PUT
|
|
2691
|
-
'PATCH
|
|
2692
|
-
'POST
|
|
2693
|
-
'GET
|
|
2694
|
-
'POST
|
|
2695
|
-
'POST
|
|
2696
|
-
'POST
|
|
2697
|
-
'PUT
|
|
2698
|
-
'PATCH
|
|
2699
|
-
'GET
|
|
2700
|
-
'GET
|
|
2701
|
-
'GET
|
|
2702
|
-
'POST
|
|
2703
|
-
'DELETE
|
|
2704
|
-
'GET
|
|
2705
|
-
'POST
|
|
2706
|
-
'POST
|
|
2707
|
-
'GET
|
|
2708
|
-
'POST
|
|
2709
|
-
'PATCH
|
|
2710
|
-
'DELETE
|
|
2711
|
-
'GET
|
|
2712
|
-
'PATCH
|
|
2713
|
-
'GET
|
|
2714
|
-
'POST
|
|
2715
|
-
'DELETE
|
|
2716
|
-
'DELETE
|
|
2717
|
-
'POST
|
|
2718
|
-
'GET
|
|
2719
|
-
'POST
|
|
2720
|
-
'GET
|
|
2721
|
-
'DELETE
|
|
2722
|
-
'GET
|
|
2723
|
-
'DELETE
|
|
2724
|
-
'POST
|
|
2725
|
-
'GET
|
|
2726
|
-
'GET
|
|
2727
|
-
'DELETE
|
|
2728
|
-
'GET
|
|
2729
|
-
'POST
|
|
2730
|
-
'GET
|
|
2731
|
-
'GET
|
|
2732
|
-
'DELETE
|
|
2733
|
-
'PATCH
|
|
2734
|
-
'GET certs': listCerts,
|
|
2735
|
-
'GET
|
|
2736
|
-
'DELETE
|
|
2737
|
-
'POST
|
|
2738
|
-
'PUT
|
|
2739
|
-
'GET
|
|
2740
|
-
'GET
|
|
2741
|
-
'GET
|
|
2742
|
-
'DELETE
|
|
2743
|
-
'GET
|
|
2744
|
-
'POST
|
|
2745
|
-
'PATCH
|
|
2746
|
-
'GET
|
|
2747
|
-
'DELETE
|
|
2812
|
+
'GET /v1/access-groups/{idOrName}': readAccessGroup,
|
|
2813
|
+
'POST /v1/access-groups/{idOrName}': updateAccessGroup,
|
|
2814
|
+
'DELETE /v1/access-groups/{idOrName}': deleteAccessGroup,
|
|
2815
|
+
'GET /v1/access-groups/{idOrName}/members': listAccessGroupMembers,
|
|
2816
|
+
'GET /v1/access-groups': listAccessGroups,
|
|
2817
|
+
'POST /v1/access-groups': createAccessGroup,
|
|
2818
|
+
'GET /v1/access-groups/{idOrName}/projects': listAccessGroupProjects,
|
|
2819
|
+
'POST /v1/access-groups/{accessGroupIdOrName}/projects': createAccessGroupProject,
|
|
2820
|
+
'GET /v1/access-groups/{accessGroupIdOrName}/projects/{projectId}': readAccessGroupProject,
|
|
2821
|
+
'PATCH /v1/access-groups/{accessGroupIdOrName}/projects/{projectId}': updateAccessGroupProject,
|
|
2822
|
+
'DELETE /v1/access-groups/{accessGroupIdOrName}/projects/{projectId}': deleteAccessGroupProject,
|
|
2823
|
+
'POST /v8/artifacts/events': recordEvents,
|
|
2824
|
+
'GET /v8/artifacts/status': status,
|
|
2825
|
+
'PUT /v8/artifacts/{hash}': uploadArtifact,
|
|
2826
|
+
'GET /v8/artifacts/{hash}': downloadArtifact,
|
|
2827
|
+
'POST /v8/artifacts': artifactQuery,
|
|
2828
|
+
'POST /v1/deployments/{deploymentId}/checks': createCheck,
|
|
2829
|
+
'GET /v1/deployments/{deploymentId}/checks': getAllChecks,
|
|
2830
|
+
'GET /v1/deployments/{deploymentId}/checks/{checkId}': getCheck,
|
|
2831
|
+
'PATCH /v1/deployments/{deploymentId}/checks/{checkId}': updateCheck,
|
|
2832
|
+
'POST /v1/deployments/{deploymentId}/checks/{checkId}/rerequest': rerequestCheck,
|
|
2833
|
+
'DELETE /data-cache/purge-all': purgeAllDataCache,
|
|
2834
|
+
'PATCH /data-cache/billing-settings': updateDataCacheBillingSettings,
|
|
2835
|
+
'PATCH /v1/data-cache/projects/{projectId}': updateProjectDataCache,
|
|
2836
|
+
'GET /v3/deployments/{idOrUrl}/events': getDeploymentEvents,
|
|
2837
|
+
'PATCH /v1/deployments/{deploymentId}/integrations/{integrationConfigurationId}/resources/{resourceId}/actions/{action}': updateIntegrationDeploymentAction,
|
|
2838
|
+
'GET /v13/deployments/{idOrUrl}': getDeployment,
|
|
2839
|
+
'POST /v13/deployments': createDeployment,
|
|
2840
|
+
'PATCH /v12/deployments/{id}/cancel': cancelDeployment,
|
|
2841
|
+
'POST /v5/domains/buy': buyDomain,
|
|
2842
|
+
'GET /v4/domains/price': checkDomainPrice,
|
|
2843
|
+
'GET /v4/domains/status': checkDomainStatus,
|
|
2844
|
+
'GET /v4/domains/{domain}/records': getRecords,
|
|
2845
|
+
'POST /v2/domains/{domain}/records': createRecord,
|
|
2846
|
+
'PATCH /v1/domains/records/{recordId}': updateRecord,
|
|
2847
|
+
'DELETE /v2/domains/{domain}/records/{recordId}': removeRecord,
|
|
2848
|
+
'GET /v1/domains/{domain}/registry': getDomainTransfer,
|
|
2849
|
+
'GET /v6/domains/{domain}/config': getDomainConfig,
|
|
2850
|
+
'GET /v5/domains/{domain}': getDomain,
|
|
2851
|
+
'GET /v5/domains': getDomains,
|
|
2852
|
+
'POST /v7/domains': createOrTransferDomain,
|
|
2853
|
+
'PATCH /v3/domains/{domain}': patchDomain,
|
|
2854
|
+
'DELETE /v6/domains/{domain}': deleteDomain,
|
|
2855
|
+
'GET /v1/edge-config': getEdgeConfigs,
|
|
2856
|
+
'POST /v1/edge-config': createEdgeConfig,
|
|
2857
|
+
'GET /v1/edge-config/{edgeConfigId}': getEdgeConfig,
|
|
2858
|
+
'PUT /v1/edge-config/{edgeConfigId}': updateEdgeConfig,
|
|
2859
|
+
'DELETE /v1/edge-config/{edgeConfigId}': deleteEdgeConfig,
|
|
2860
|
+
'GET /v1/edge-config/{edgeConfigId}/items': getEdgeConfigItems,
|
|
2861
|
+
'PATCH /v1/edge-config/{edgeConfigId}/items': patchEdgeConfigItems,
|
|
2862
|
+
'GET /v1/edge-config/{edgeConfigId}/schema': getEdgeConfigSchema,
|
|
2863
|
+
'POST /v1/edge-config/{edgeConfigId}/schema': patchEdgeConfigSchema,
|
|
2864
|
+
'DELETE /v1/edge-config/{edgeConfigId}/schema': deleteEdgeConfigSchema,
|
|
2865
|
+
'GET /v1/edge-config/{edgeConfigId}/item/{edgeConfigItemKey}': getEdgeConfigItem,
|
|
2866
|
+
'GET /v1/edge-config/{edgeConfigId}/tokens': getEdgeConfigTokens,
|
|
2867
|
+
'DELETE /v1/edge-config/{edgeConfigId}/tokens': deleteEdgeConfigTokens,
|
|
2868
|
+
'GET /v1/edge-config/{edgeConfigId}/token/{token}': getEdgeConfigToken,
|
|
2869
|
+
'POST /v1/edge-config/{edgeConfigId}/token': createEdgeConfigToken,
|
|
2870
|
+
'GET /v1/edge-config/{edgeConfigId}/backups/{edgeConfigBackupVersionId}': getEdgeConfigBackup,
|
|
2871
|
+
'GET /v1/edge-config/{edgeConfigId}/backups': getEdgeConfigBackups,
|
|
2872
|
+
'GET /v3/events': listUserEvents,
|
|
2873
|
+
'GET /v1/installations/{integrationConfigurationId}/account': getAccountInfo,
|
|
2874
|
+
'GET /v1/installations/{integrationConfigurationId}/member/{memberId}': getMember,
|
|
2875
|
+
'POST /v1/installations/{integrationConfigurationId}/events': createEvent,
|
|
2876
|
+
'GET /v1/installations/{integrationConfigurationId}/resources': getIntegrationResources,
|
|
2877
|
+
'GET /v1/installations/{integrationConfigurationId}/resources/{resourceId}': getIntegrationResource,
|
|
2878
|
+
'DELETE /v1/installations/{integrationConfigurationId}/resources/{resourceId}': deleteIntegrationResource,
|
|
2879
|
+
'PUT /v1/installations/{integrationConfigurationId}/resources/{resourceId}': importResource,
|
|
2880
|
+
'POST /v1/installations/{integrationConfigurationId}/billing': submitBillingData,
|
|
2881
|
+
'POST /v1/installations/{integrationConfigurationId}/billing/invoices': submitInvoice,
|
|
2882
|
+
'GET /v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}': getInvoice,
|
|
2883
|
+
'POST /v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}/actions': updateInvoice,
|
|
2884
|
+
'POST /v1/installations/{integrationConfigurationId}/billing/balance': submitPrepaymentBalances,
|
|
2885
|
+
'PUT /v1/installations/{integrationConfigurationId}/products/{integrationProductIdOrSlug}/resources/{resourceId}/secrets': updateResourceSecrets,
|
|
2886
|
+
'PUT /v1/installations/{integrationConfigurationId}/resources/{resourceId}/secrets': updateResourceSecretsById,
|
|
2887
|
+
'GET /v1/integrations/configurations': getConfigurations,
|
|
2888
|
+
'GET /v1/integrations/configuration/{id}': getConfiguration,
|
|
2889
|
+
'DELETE /v1/integrations/configuration/{id}': deleteConfiguration,
|
|
2890
|
+
'POST /v1/integrations/sso/token': exchangeSsoToken,
|
|
2891
|
+
'GET /v2/integrations/log-drains': getIntegrationLogDrains,
|
|
2892
|
+
'POST /v2/integrations/log-drains': createLogDrain,
|
|
2893
|
+
'DELETE /v1/integrations/log-drains/{id}': deleteIntegrationLogDrain,
|
|
2894
|
+
'GET /v1/projects/{projectId}/deployments/{deploymentId}/runtime-logs': getRuntimeLogs,
|
|
2895
|
+
'POST /v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items': createExperimentationItem,
|
|
2896
|
+
'PATCH /v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items/{itemId}': updateExperimentationItem,
|
|
2897
|
+
'DELETE /v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items/{itemId}': deleteExperimentationItem,
|
|
2898
|
+
'PUT /v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/edge-config': updateExperimentationEdgeConfig,
|
|
2899
|
+
'GET /v1/projects/{idOrName}/members': getProjectMembers,
|
|
2900
|
+
'POST /v1/projects/{idOrName}/members': addProjectMember,
|
|
2901
|
+
'DELETE /v1/projects/{idOrName}/members/{uid}': removeProjectMember,
|
|
2902
|
+
'GET /v10/projects': getProjects,
|
|
2903
|
+
'POST /v11/projects': createProject,
|
|
2904
|
+
'GET /v9/projects/{idOrName}': getProject,
|
|
2905
|
+
'PATCH /v9/projects/{idOrName}': updateProject,
|
|
2906
|
+
'DELETE /v9/projects/{idOrName}': deleteProject,
|
|
2907
|
+
'POST /v9/projects/{idOrName}/custom-environments': createCustomEnvironment,
|
|
2908
|
+
'GET /v9/projects/{idOrName}/custom-environments': listCustomEnvironments,
|
|
2909
|
+
'GET /v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}': getCustomEnvironment,
|
|
2910
|
+
'PATCH /v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}': updateCustomEnvironment,
|
|
2911
|
+
'DELETE /v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}': removeCustomEnvironment,
|
|
2912
|
+
'GET /v9/projects/{idOrName}/domains': getProjectDomains,
|
|
2913
|
+
'GET /v9/projects/{idOrName}/domains/{domain}': getProjectDomain,
|
|
2914
|
+
'PATCH /v9/projects/{idOrName}/domains/{domain}': updateProjectDomain,
|
|
2915
|
+
'DELETE /v9/projects/{idOrName}/domains/{domain}': removeProjectDomain,
|
|
2916
|
+
'POST /v10/projects/{idOrName}/domains': addProjectDomain,
|
|
2917
|
+
'POST /v1/projects/{idOrName}/domains/{domain}/move': moveProjectDomain,
|
|
2918
|
+
'POST /v9/projects/{idOrName}/domains/{domain}/verify': verifyProjectDomain,
|
|
2919
|
+
'GET /v10/projects/{idOrName}/env': filterProjectEnvs,
|
|
2920
|
+
'POST /v10/projects/{idOrName}/env': createProjectEnv,
|
|
2921
|
+
'GET /v1/projects/{idOrName}/env/{id}': getProjectEnv,
|
|
2922
|
+
'DELETE /v9/projects/{idOrName}/env/{id}': removeProjectEnv,
|
|
2923
|
+
'PATCH /v9/projects/{idOrName}/env/{id}': editProjectEnv,
|
|
2924
|
+
'GET /v1/projects/{idOrName}/rolling-release/billing': getRollingReleaseBillingStatus,
|
|
2925
|
+
'GET /v1/projects/{idOrName}/rolling-release/config': getRollingReleaseConfig,
|
|
2926
|
+
'DELETE /v1/projects/{idOrName}/rolling-release/config': deleteRollingReleaseConfig,
|
|
2927
|
+
'PATCH /v1/projects/{idOrName}/rolling-release/config': updateRollingReleaseConfig,
|
|
2928
|
+
'GET /v1/projects/{idOrName}/rolling-release': getRollingRelease,
|
|
2929
|
+
'POST /v1/projects/{idOrName}/rolling-release/approve-stage': approveRollingReleaseStage,
|
|
2930
|
+
'POST /v1/projects/{idOrName}/rolling-release/complete': completeRollingRelease,
|
|
2931
|
+
'POST /projects/{idOrName}/transfer-request': createProjectTransferRequest,
|
|
2932
|
+
'PUT /projects/transfer-request/{code}': acceptProjectTransferRequest,
|
|
2933
|
+
'PATCH /v1/projects/{idOrName}/protection-bypass': updateProjectProtectionBypass,
|
|
2934
|
+
'POST /v10/projects/{projectId}/promote/{deploymentId}': requestPromote,
|
|
2935
|
+
'GET /v1/projects/{projectId}/promote/aliases': listPromoteAliases,
|
|
2936
|
+
'POST /v1/projects/{projectId}/pause': pauseProject,
|
|
2937
|
+
'POST /v1/projects/{projectId}/unpause': unpauseProject,
|
|
2938
|
+
'POST /v1/security/attack-mode': updateAttackChallengeMode,
|
|
2939
|
+
'PUT /v1/security/firewall/config': putFirewallConfig,
|
|
2940
|
+
'PATCH /v1/security/firewall/config': updateFirewallConfig,
|
|
2941
|
+
'GET /v1/security/firewall/config/{configVersion}': getFirewallConfig,
|
|
2942
|
+
'GET /v1/security/firewall/attack-status': getActiveAttackStatus,
|
|
2943
|
+
'GET /v1/security/firewall/bypass': getBypassIp,
|
|
2944
|
+
'POST /v1/security/firewall/bypass': addBypassIp,
|
|
2945
|
+
'DELETE /v1/security/firewall/bypass': removeBypassIp,
|
|
2946
|
+
'GET /v3/teams/{teamId}/members': getTeamMembers,
|
|
2947
|
+
'POST /v1/teams/{teamId}/members': inviteUserToTeam,
|
|
2948
|
+
'POST /v1/teams/{teamId}/request': requestAccessToTeam,
|
|
2949
|
+
'GET /v1/teams/{teamId}/request/{userId}': getTeamAccessRequest,
|
|
2950
|
+
'POST /v1/teams/{teamId}/members/teams/join': joinTeam,
|
|
2951
|
+
'PATCH /v1/teams/{teamId}/members/{uid}': updateTeamMember,
|
|
2952
|
+
'DELETE /v1/teams/{teamId}/members/{uid}': removeTeamMember,
|
|
2953
|
+
'GET /v2/teams/{teamId}': getTeam,
|
|
2954
|
+
'PATCH /v2/teams/{teamId}': patchTeam,
|
|
2955
|
+
'GET /v2/teams': getTeams,
|
|
2956
|
+
'POST /v1/teams': createTeam,
|
|
2957
|
+
'DELETE /v1/teams/{teamId}': deleteTeam,
|
|
2958
|
+
'DELETE /v1/teams/{teamId}/invites/{inviteId}': deleteTeamInviteCode,
|
|
2959
|
+
'POST /v2/files': uploadFile,
|
|
2960
|
+
'GET /v5/user/tokens': listAuthTokens,
|
|
2961
|
+
'POST /v3/user/tokens': createAuthToken,
|
|
2962
|
+
'GET /v5/user/tokens/{tokenId}': getAuthToken,
|
|
2963
|
+
'DELETE /v3/user/tokens/{tokenId}': deleteAuthToken,
|
|
2964
|
+
'GET /v2/user': getAuthUser,
|
|
2965
|
+
'DELETE /v1/user': requestDelete,
|
|
2966
|
+
'POST /v1/webhooks': createWebhook,
|
|
2967
|
+
'GET /v1/webhooks': getWebhooks,
|
|
2968
|
+
'GET /v1/webhooks/{id}': getWebhook,
|
|
2969
|
+
'DELETE /v1/webhooks/{id}': deleteWebhook,
|
|
2970
|
+
'GET /v2/deployments/{id}/aliases': listDeploymentAliases,
|
|
2971
|
+
'POST /v2/deployments/{id}/aliases': assignAlias,
|
|
2972
|
+
'GET /v4/aliases': listAliases,
|
|
2973
|
+
'GET /v4/aliases/{idOrAlias}': getAlias,
|
|
2974
|
+
'DELETE /v2/aliases/{aliasId}': deleteAlias,
|
|
2975
|
+
'PATCH /aliases/{id}/protection-bypass': patchUrlProtectionBypass,
|
|
2976
|
+
'GET /certs': listCerts,
|
|
2977
|
+
'GET /v8/certs/{id}': getCertById,
|
|
2978
|
+
'DELETE /v8/certs/{id}': removeCert,
|
|
2979
|
+
'POST /v8/certs': issueCert,
|
|
2980
|
+
'PUT /v8/certs': uploadCert,
|
|
2981
|
+
'GET /v6/deployments/{id}/files': listDeploymentFiles,
|
|
2982
|
+
'GET /v8/deployments/{id}/files/{fileId}': getDeploymentFileContents,
|
|
2983
|
+
'GET /v6/deployments': getDeployments,
|
|
2984
|
+
'DELETE /v13/deployments/{id}': deleteDeployment,
|
|
2985
|
+
'GET /v3/secrets': getSecrets,
|
|
2986
|
+
'POST /v2/secrets/{name}': createSecret,
|
|
2987
|
+
'PATCH /v2/secrets/{name}': renameSecret,
|
|
2988
|
+
'GET /v3/secrets/{idOrName}': getSecret,
|
|
2989
|
+
'DELETE /v2/secrets/{idOrName}': deleteSecret
|
|
2748
2990
|
};
|
|
2749
2991
|
export const operationsByTag = {
|
|
2750
2992
|
accessGroups: {
|
|
@@ -2758,21 +3000,21 @@ export const operationsByTag = {
|
|
|
2758
3000
|
createAccessGroupProject,
|
|
2759
3001
|
readAccessGroupProject,
|
|
2760
3002
|
updateAccessGroupProject,
|
|
2761
|
-
deleteAccessGroupProject
|
|
3003
|
+
deleteAccessGroupProject
|
|
2762
3004
|
},
|
|
2763
3005
|
artifacts: {
|
|
2764
3006
|
recordEvents,
|
|
2765
3007
|
status,
|
|
2766
3008
|
uploadArtifact,
|
|
2767
3009
|
downloadArtifact,
|
|
2768
|
-
artifactQuery
|
|
3010
|
+
artifactQuery
|
|
2769
3011
|
},
|
|
2770
3012
|
checks: {
|
|
2771
3013
|
createCheck,
|
|
2772
3014
|
getAllChecks,
|
|
2773
3015
|
getCheck,
|
|
2774
3016
|
updateCheck,
|
|
2775
|
-
rerequestCheck
|
|
3017
|
+
rerequestCheck
|
|
2776
3018
|
},
|
|
2777
3019
|
projects: {
|
|
2778
3020
|
updateProjectDataCache,
|
|
@@ -2799,7 +3041,7 @@ export const operationsByTag = {
|
|
|
2799
3041
|
requestPromote,
|
|
2800
3042
|
listPromoteAliases,
|
|
2801
3043
|
pauseProject,
|
|
2802
|
-
unpauseProject
|
|
3044
|
+
unpauseProject
|
|
2803
3045
|
},
|
|
2804
3046
|
deployments: {
|
|
2805
3047
|
getDeploymentEvents,
|
|
@@ -2811,13 +3053,13 @@ export const operationsByTag = {
|
|
|
2811
3053
|
listDeploymentFiles,
|
|
2812
3054
|
getDeploymentFileContents,
|
|
2813
3055
|
getDeployments,
|
|
2814
|
-
deleteDeployment
|
|
3056
|
+
deleteDeployment
|
|
2815
3057
|
},
|
|
2816
3058
|
integrations: {
|
|
2817
3059
|
updateIntegrationDeploymentAction,
|
|
2818
3060
|
getConfigurations,
|
|
2819
3061
|
getConfiguration,
|
|
2820
|
-
deleteConfiguration
|
|
3062
|
+
deleteConfiguration
|
|
2821
3063
|
},
|
|
2822
3064
|
domains: {
|
|
2823
3065
|
buyDomain,
|
|
@@ -2829,13 +3071,13 @@ export const operationsByTag = {
|
|
|
2829
3071
|
getDomains,
|
|
2830
3072
|
createOrTransferDomain,
|
|
2831
3073
|
patchDomain,
|
|
2832
|
-
deleteDomain
|
|
3074
|
+
deleteDomain
|
|
2833
3075
|
},
|
|
2834
3076
|
dns: {
|
|
2835
3077
|
getRecords,
|
|
2836
3078
|
createRecord,
|
|
2837
3079
|
updateRecord,
|
|
2838
|
-
removeRecord
|
|
3080
|
+
removeRecord
|
|
2839
3081
|
},
|
|
2840
3082
|
edgeConfig: {
|
|
2841
3083
|
getEdgeConfigs,
|
|
@@ -2854,12 +3096,12 @@ export const operationsByTag = {
|
|
|
2854
3096
|
getEdgeConfigToken,
|
|
2855
3097
|
createEdgeConfigToken,
|
|
2856
3098
|
getEdgeConfigBackup,
|
|
2857
|
-
getEdgeConfigBackups
|
|
3099
|
+
getEdgeConfigBackups
|
|
2858
3100
|
},
|
|
2859
3101
|
user: {
|
|
2860
3102
|
listUserEvents,
|
|
2861
3103
|
getAuthUser,
|
|
2862
|
-
requestDelete
|
|
3104
|
+
requestDelete
|
|
2863
3105
|
},
|
|
2864
3106
|
marketplace: {
|
|
2865
3107
|
getAccountInfo,
|
|
@@ -2880,34 +3122,34 @@ export const operationsByTag = {
|
|
|
2880
3122
|
createExperimentationItem,
|
|
2881
3123
|
updateExperimentationItem,
|
|
2882
3124
|
deleteExperimentationItem,
|
|
2883
|
-
updateExperimentationEdgeConfig
|
|
3125
|
+
updateExperimentationEdgeConfig
|
|
2884
3126
|
},
|
|
2885
3127
|
authentication: {
|
|
2886
3128
|
exchangeSsoToken,
|
|
2887
3129
|
listAuthTokens,
|
|
2888
3130
|
createAuthToken,
|
|
2889
3131
|
getAuthToken,
|
|
2890
|
-
deleteAuthToken
|
|
3132
|
+
deleteAuthToken
|
|
2891
3133
|
},
|
|
2892
3134
|
logdrains: {
|
|
2893
3135
|
getIntegrationLogDrains,
|
|
2894
3136
|
createLogDrain,
|
|
2895
|
-
deleteIntegrationLogDrain
|
|
3137
|
+
deleteIntegrationLogDrain
|
|
2896
3138
|
},
|
|
2897
3139
|
logs: {
|
|
2898
|
-
getRuntimeLogs
|
|
3140
|
+
getRuntimeLogs
|
|
2899
3141
|
},
|
|
2900
3142
|
projectmembers: {
|
|
2901
3143
|
getProjectMembers,
|
|
2902
3144
|
addProjectMember,
|
|
2903
|
-
removeProjectMember
|
|
3145
|
+
removeProjectMember
|
|
2904
3146
|
},
|
|
2905
3147
|
environment: {
|
|
2906
3148
|
createCustomEnvironment,
|
|
2907
3149
|
listCustomEnvironments,
|
|
2908
3150
|
getCustomEnvironment,
|
|
2909
3151
|
updateCustomEnvironment,
|
|
2910
|
-
removeCustomEnvironment
|
|
3152
|
+
removeCustomEnvironment
|
|
2911
3153
|
},
|
|
2912
3154
|
rollingRelease: {
|
|
2913
3155
|
getRollingReleaseBillingStatus,
|
|
@@ -2916,7 +3158,7 @@ export const operationsByTag = {
|
|
|
2916
3158
|
updateRollingReleaseConfig,
|
|
2917
3159
|
getRollingRelease,
|
|
2918
3160
|
approveRollingReleaseStage,
|
|
2919
|
-
completeRollingRelease
|
|
3161
|
+
completeRollingRelease
|
|
2920
3162
|
},
|
|
2921
3163
|
security: {
|
|
2922
3164
|
updateAttackChallengeMode,
|
|
@@ -2926,7 +3168,7 @@ export const operationsByTag = {
|
|
|
2926
3168
|
getActiveAttackStatus,
|
|
2927
3169
|
getBypassIp,
|
|
2928
3170
|
addBypassIp,
|
|
2929
|
-
removeBypassIp
|
|
3171
|
+
removeBypassIp
|
|
2930
3172
|
},
|
|
2931
3173
|
teams: {
|
|
2932
3174
|
getTeamMembers,
|
|
@@ -2941,13 +3183,13 @@ export const operationsByTag = {
|
|
|
2941
3183
|
getTeams,
|
|
2942
3184
|
createTeam,
|
|
2943
3185
|
deleteTeam,
|
|
2944
|
-
deleteTeamInviteCode
|
|
3186
|
+
deleteTeamInviteCode
|
|
2945
3187
|
},
|
|
2946
3188
|
webhooks: {
|
|
2947
3189
|
createWebhook,
|
|
2948
3190
|
getWebhooks,
|
|
2949
3191
|
getWebhook,
|
|
2950
|
-
deleteWebhook
|
|
3192
|
+
deleteWebhook
|
|
2951
3193
|
},
|
|
2952
3194
|
aliases: {
|
|
2953
3195
|
listDeploymentAliases,
|
|
@@ -2955,42 +3197,62 @@ export const operationsByTag = {
|
|
|
2955
3197
|
listAliases,
|
|
2956
3198
|
getAlias,
|
|
2957
3199
|
deleteAlias,
|
|
2958
|
-
patchUrlProtectionBypass
|
|
3200
|
+
patchUrlProtectionBypass
|
|
2959
3201
|
},
|
|
2960
3202
|
certs: {
|
|
2961
3203
|
getCertById,
|
|
2962
3204
|
removeCert,
|
|
2963
3205
|
issueCert,
|
|
2964
|
-
uploadCert
|
|
3206
|
+
uploadCert
|
|
2965
3207
|
},
|
|
2966
3208
|
secrets: {
|
|
2967
3209
|
getSecrets,
|
|
2968
3210
|
createSecret,
|
|
2969
3211
|
renameSecret,
|
|
2970
3212
|
getSecret,
|
|
2971
|
-
deleteSecret
|
|
2972
|
-
}
|
|
3213
|
+
deleteSecret
|
|
3214
|
+
}
|
|
2973
3215
|
};
|
|
2974
3216
|
export const tagDictionary = {
|
|
2975
3217
|
accessGroups: {
|
|
2976
|
-
GET: [
|
|
3218
|
+
GET: [
|
|
3219
|
+
'readAccessGroup',
|
|
3220
|
+
'listAccessGroupMembers',
|
|
3221
|
+
'listAccessGroups',
|
|
3222
|
+
'listAccessGroupProjects',
|
|
3223
|
+
'readAccessGroupProject'
|
|
3224
|
+
],
|
|
2977
3225
|
POST: ['updateAccessGroup', 'createAccessGroup', 'createAccessGroupProject'],
|
|
2978
3226
|
DELETE: ['deleteAccessGroup', 'deleteAccessGroupProject'],
|
|
2979
|
-
PATCH: ['updateAccessGroupProject']
|
|
3227
|
+
PATCH: ['updateAccessGroupProject']
|
|
2980
3228
|
},
|
|
2981
3229
|
artifacts: {
|
|
2982
3230
|
POST: ['recordEvents', 'artifactQuery'],
|
|
2983
3231
|
GET: ['status', 'downloadArtifact'],
|
|
2984
|
-
PUT: ['uploadArtifact']
|
|
3232
|
+
PUT: ['uploadArtifact']
|
|
2985
3233
|
},
|
|
2986
3234
|
checks: {
|
|
2987
3235
|
POST: ['createCheck', 'rerequestCheck'],
|
|
2988
3236
|
GET: ['getAllChecks', 'getCheck'],
|
|
2989
|
-
PATCH: ['updateCheck']
|
|
3237
|
+
PATCH: ['updateCheck']
|
|
2990
3238
|
},
|
|
2991
3239
|
projects: {
|
|
2992
|
-
PATCH: [
|
|
2993
|
-
|
|
3240
|
+
PATCH: [
|
|
3241
|
+
'updateProjectDataCache',
|
|
3242
|
+
'updateProject',
|
|
3243
|
+
'updateProjectDomain',
|
|
3244
|
+
'editProjectEnv',
|
|
3245
|
+
'updateProjectProtectionBypass'
|
|
3246
|
+
],
|
|
3247
|
+
GET: [
|
|
3248
|
+
'getProjects',
|
|
3249
|
+
'getProject',
|
|
3250
|
+
'getProjectDomains',
|
|
3251
|
+
'getProjectDomain',
|
|
3252
|
+
'filterProjectEnvs',
|
|
3253
|
+
'getProjectEnv',
|
|
3254
|
+
'listPromoteAliases'
|
|
3255
|
+
],
|
|
2994
3256
|
POST: [
|
|
2995
3257
|
'createProject',
|
|
2996
3258
|
'addProjectDomain',
|
|
@@ -3000,33 +3262,33 @@ export const tagDictionary = {
|
|
|
3000
3262
|
'createProjectTransferRequest',
|
|
3001
3263
|
'requestPromote',
|
|
3002
3264
|
'pauseProject',
|
|
3003
|
-
'unpauseProject'
|
|
3265
|
+
'unpauseProject'
|
|
3004
3266
|
],
|
|
3005
3267
|
DELETE: ['deleteProject', 'removeProjectDomain', 'removeProjectEnv'],
|
|
3006
|
-
PUT: ['acceptProjectTransferRequest']
|
|
3268
|
+
PUT: ['acceptProjectTransferRequest']
|
|
3007
3269
|
},
|
|
3008
3270
|
deployments: {
|
|
3009
3271
|
GET: ['getDeploymentEvents', 'getDeployment', 'listDeploymentFiles', 'getDeploymentFileContents', 'getDeployments'],
|
|
3010
3272
|
PATCH: ['updateIntegrationDeploymentAction', 'cancelDeployment'],
|
|
3011
3273
|
POST: ['createDeployment', 'uploadFile'],
|
|
3012
|
-
DELETE: ['deleteDeployment']
|
|
3274
|
+
DELETE: ['deleteDeployment']
|
|
3013
3275
|
},
|
|
3014
3276
|
integrations: {
|
|
3015
3277
|
PATCH: ['updateIntegrationDeploymentAction'],
|
|
3016
3278
|
GET: ['getConfigurations', 'getConfiguration'],
|
|
3017
|
-
DELETE: ['deleteConfiguration']
|
|
3279
|
+
DELETE: ['deleteConfiguration']
|
|
3018
3280
|
},
|
|
3019
3281
|
domains: {
|
|
3020
3282
|
POST: ['buyDomain', 'createOrTransferDomain'],
|
|
3021
3283
|
GET: ['checkDomainPrice', 'checkDomainStatus', 'getDomainTransfer', 'getDomainConfig', 'getDomain', 'getDomains'],
|
|
3022
3284
|
PATCH: ['patchDomain'],
|
|
3023
|
-
DELETE: ['deleteDomain']
|
|
3285
|
+
DELETE: ['deleteDomain']
|
|
3024
3286
|
},
|
|
3025
3287
|
dns: {
|
|
3026
3288
|
GET: ['getRecords'],
|
|
3027
3289
|
POST: ['createRecord'],
|
|
3028
3290
|
PATCH: ['updateRecord'],
|
|
3029
|
-
DELETE: ['removeRecord']
|
|
3291
|
+
DELETE: ['removeRecord']
|
|
3030
3292
|
},
|
|
3031
3293
|
edgeConfig: {
|
|
3032
3294
|
GET: [
|
|
@@ -3038,88 +3300,96 @@ export const tagDictionary = {
|
|
|
3038
3300
|
'getEdgeConfigTokens',
|
|
3039
3301
|
'getEdgeConfigToken',
|
|
3040
3302
|
'getEdgeConfigBackup',
|
|
3041
|
-
'getEdgeConfigBackups'
|
|
3303
|
+
'getEdgeConfigBackups'
|
|
3042
3304
|
],
|
|
3043
3305
|
POST: ['createEdgeConfig', 'patchEdgeConfigSchema', 'createEdgeConfigToken'],
|
|
3044
3306
|
PUT: ['updateEdgeConfig'],
|
|
3045
3307
|
DELETE: ['deleteEdgeConfig', 'deleteEdgeConfigSchema', 'deleteEdgeConfigTokens'],
|
|
3046
|
-
PATCH: ['patchEdgeConfigItems']
|
|
3308
|
+
PATCH: ['patchEdgeConfigItems']
|
|
3047
3309
|
},
|
|
3048
3310
|
user: {
|
|
3049
3311
|
GET: ['listUserEvents', 'getAuthUser'],
|
|
3050
|
-
DELETE: ['requestDelete']
|
|
3312
|
+
DELETE: ['requestDelete']
|
|
3051
3313
|
},
|
|
3052
3314
|
marketplace: {
|
|
3053
3315
|
GET: ['getAccountInfo', 'getMember', 'getIntegrationResources', 'getIntegrationResource', 'getInvoice'],
|
|
3054
|
-
POST: [
|
|
3316
|
+
POST: [
|
|
3317
|
+
'createEvent',
|
|
3318
|
+
'submitBillingData',
|
|
3319
|
+
'submitInvoice',
|
|
3320
|
+
'updateInvoice',
|
|
3321
|
+
'submitPrepaymentBalances',
|
|
3322
|
+
'exchangeSsoToken',
|
|
3323
|
+
'createExperimentationItem'
|
|
3324
|
+
],
|
|
3055
3325
|
DELETE: ['deleteIntegrationResource', 'deleteExperimentationItem'],
|
|
3056
3326
|
PUT: ['importResource', 'updateResourceSecrets', 'updateResourceSecretsById', 'updateExperimentationEdgeConfig'],
|
|
3057
|
-
PATCH: ['updateExperimentationItem']
|
|
3327
|
+
PATCH: ['updateExperimentationItem']
|
|
3058
3328
|
},
|
|
3059
3329
|
authentication: {
|
|
3060
3330
|
POST: ['exchangeSsoToken', 'createAuthToken'],
|
|
3061
3331
|
GET: ['listAuthTokens', 'getAuthToken'],
|
|
3062
|
-
DELETE: ['deleteAuthToken']
|
|
3332
|
+
DELETE: ['deleteAuthToken']
|
|
3063
3333
|
},
|
|
3064
3334
|
logdrains: {
|
|
3065
3335
|
GET: ['getIntegrationLogDrains'],
|
|
3066
3336
|
POST: ['createLogDrain'],
|
|
3067
|
-
DELETE: ['deleteIntegrationLogDrain']
|
|
3337
|
+
DELETE: ['deleteIntegrationLogDrain']
|
|
3068
3338
|
},
|
|
3069
3339
|
logs: {
|
|
3070
|
-
GET: ['getRuntimeLogs']
|
|
3340
|
+
GET: ['getRuntimeLogs']
|
|
3071
3341
|
},
|
|
3072
3342
|
projectmembers: {
|
|
3073
3343
|
GET: ['getProjectMembers'],
|
|
3074
3344
|
POST: ['addProjectMember'],
|
|
3075
|
-
DELETE: ['removeProjectMember']
|
|
3345
|
+
DELETE: ['removeProjectMember']
|
|
3076
3346
|
},
|
|
3077
3347
|
environment: {
|
|
3078
3348
|
POST: ['createCustomEnvironment'],
|
|
3079
3349
|
GET: ['listCustomEnvironments', 'getCustomEnvironment'],
|
|
3080
3350
|
PATCH: ['updateCustomEnvironment'],
|
|
3081
|
-
DELETE: ['removeCustomEnvironment']
|
|
3351
|
+
DELETE: ['removeCustomEnvironment']
|
|
3082
3352
|
},
|
|
3083
3353
|
rollingRelease: {
|
|
3084
3354
|
GET: ['getRollingReleaseBillingStatus', 'getRollingReleaseConfig', 'getRollingRelease'],
|
|
3085
3355
|
DELETE: ['deleteRollingReleaseConfig'],
|
|
3086
3356
|
PATCH: ['updateRollingReleaseConfig'],
|
|
3087
|
-
POST: ['approveRollingReleaseStage', 'completeRollingRelease']
|
|
3357
|
+
POST: ['approveRollingReleaseStage', 'completeRollingRelease']
|
|
3088
3358
|
},
|
|
3089
3359
|
security: {
|
|
3090
3360
|
POST: ['updateAttackChallengeMode', 'addBypassIp'],
|
|
3091
3361
|
PUT: ['putFirewallConfig'],
|
|
3092
3362
|
PATCH: ['updateFirewallConfig'],
|
|
3093
3363
|
GET: ['getFirewallConfig', 'getActiveAttackStatus', 'getBypassIp'],
|
|
3094
|
-
DELETE: ['removeBypassIp']
|
|
3364
|
+
DELETE: ['removeBypassIp']
|
|
3095
3365
|
},
|
|
3096
3366
|
teams: {
|
|
3097
3367
|
GET: ['getTeamMembers', 'getTeamAccessRequest', 'getTeam', 'getTeams'],
|
|
3098
3368
|
POST: ['inviteUserToTeam', 'requestAccessToTeam', 'joinTeam', 'createTeam'],
|
|
3099
3369
|
PATCH: ['updateTeamMember', 'patchTeam'],
|
|
3100
|
-
DELETE: ['removeTeamMember', 'deleteTeam', 'deleteTeamInviteCode']
|
|
3370
|
+
DELETE: ['removeTeamMember', 'deleteTeam', 'deleteTeamInviteCode']
|
|
3101
3371
|
},
|
|
3102
3372
|
webhooks: {
|
|
3103
3373
|
POST: ['createWebhook'],
|
|
3104
3374
|
GET: ['getWebhooks', 'getWebhook'],
|
|
3105
|
-
DELETE: ['deleteWebhook']
|
|
3375
|
+
DELETE: ['deleteWebhook']
|
|
3106
3376
|
},
|
|
3107
3377
|
aliases: {
|
|
3108
3378
|
GET: ['listDeploymentAliases', 'listAliases', 'getAlias'],
|
|
3109
3379
|
POST: ['assignAlias'],
|
|
3110
3380
|
DELETE: ['deleteAlias'],
|
|
3111
|
-
PATCH: ['patchUrlProtectionBypass']
|
|
3381
|
+
PATCH: ['patchUrlProtectionBypass']
|
|
3112
3382
|
},
|
|
3113
3383
|
certs: {
|
|
3114
3384
|
GET: ['getCertById'],
|
|
3115
3385
|
DELETE: ['removeCert'],
|
|
3116
3386
|
POST: ['issueCert'],
|
|
3117
|
-
PUT: ['uploadCert']
|
|
3387
|
+
PUT: ['uploadCert']
|
|
3118
3388
|
},
|
|
3119
3389
|
secrets: {
|
|
3120
3390
|
GET: ['getSecrets', 'getSecret'],
|
|
3121
3391
|
POST: ['createSecret'],
|
|
3122
3392
|
PATCH: ['renameSecret'],
|
|
3123
|
-
DELETE: ['deleteSecret']
|
|
3124
|
-
}
|
|
3393
|
+
DELETE: ['deleteSecret']
|
|
3394
|
+
}
|
|
3125
3395
|
};
|