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