vercel-api-js 0.25.2 → 1.0.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/client.d.mts +228 -0
- package/dist/client.d.ts +228 -0
- package/dist/client.js +75 -0
- package/dist/client.mjs +68 -0
- package/dist/generated/components.d.mts +2600 -0
- package/dist/generated/components.d.ts +2600 -0
- package/dist/generated/components.js +3309 -0
- package/dist/generated/components.mjs +3125 -0
- package/dist/generated/schemas.d.mts +6536 -0
- package/dist/generated/schemas.d.ts +6536 -0
- package/dist/generated/schemas.js +7107 -0
- package/dist/generated/schemas.mjs +7077 -0
- package/dist/generated/types.d.mts +15000 -0
- package/dist/generated/types.d.ts +15000 -0
- package/dist/generated/types.js +950 -0
- package/dist/generated/types.mjs +945 -0
- package/dist/index.d.mts +1711 -30825
- package/dist/index.d.ts +1711 -30825
- package/dist/index.js +49 -0
- package/dist/index.mjs +7 -845
- package/dist/utils/fetch.d.mts +18 -0
- package/dist/utils/fetch.d.ts +18 -0
- package/dist/utils/fetch.js +8 -0
- package/dist/utils/fetch.mjs +5 -0
- package/dist/utils/fetcher.d.mts +22 -0
- package/dist/utils/fetcher.d.ts +22 -0
- package/dist/utils/fetcher.js +68 -0
- package/dist/utils/fetcher.mjs +65 -0
- package/dist/utils/lang.d.mts +1 -0
- package/dist/utils/lang.d.ts +1 -0
- package/dist/utils/lang.js +9 -0
- package/dist/utils/lang.mjs +6 -0
- package/dist/utils/types.d.mts +3 -0
- package/dist/utils/types.d.ts +3 -0
- package/dist/utils/types.js +2 -0
- package/dist/utils/types.mjs +1 -0
- package/package.json +29 -19
- package/.turbo/turbo-build.log +0 -14
- package/CHANGELOG.md +0 -756
- package/dist/index.cjs +0 -847
- package/dist/index.d.cts +0 -30832
- package/tsconfig.json +0 -19
|
@@ -0,0 +1,2600 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
*/
|
|
5
|
+
import client from "../utils/fetcher.js";
|
|
6
|
+
import type { FetcherConfig } from "../utils/fetcher.js";
|
|
7
|
+
import type { ReadAccessGroupPathParams, ReadAccessGroupQueryParams, UpdateAccessGroupPathParams, UpdateAccessGroupQueryParams, DeleteAccessGroupPathParams, DeleteAccessGroupQueryParams, ListAccessGroupMembersPathParams, ListAccessGroupMembersQueryParams, ListAccessGroupsQueryParams, CreateAccessGroupQueryParams, ListAccessGroupProjectsPathParams, ListAccessGroupProjectsQueryParams, CreateAccessGroupProjectPathParams, CreateAccessGroupProjectQueryParams, ReadAccessGroupProjectPathParams, ReadAccessGroupProjectQueryParams, UpdateAccessGroupProjectPathParams, UpdateAccessGroupProjectQueryParams, DeleteAccessGroupProjectPathParams, DeleteAccessGroupProjectQueryParams, RecordEventsQueryParams, RecordEventsHeaderParams, StatusQueryParams, UploadArtifactPathParams, UploadArtifactQueryParams, UploadArtifactHeaderParams, DownloadArtifactPathParams, DownloadArtifactQueryParams, DownloadArtifactHeaderParams, ArtifactQueryQueryParams, CreateCheckPathParams, CreateCheckQueryParams, GetAllChecksPathParams, GetAllChecksQueryParams, GetCheckPathParams, GetCheckQueryParams, UpdateCheckPathParams, UpdateCheckQueryParams, RerequestCheckPathParams, RerequestCheckQueryParams, PurgeAllDataCacheQueryParams, UpdateProjectDataCachePathParams, UpdateProjectDataCacheQueryParams, GetDeploymentEventsPathParams, GetDeploymentEventsQueryParams, UpdateIntegrationDeploymentActionPathParams, GetDeploymentPathParams, GetDeploymentQueryParams, CreateDeploymentQueryParams, CancelDeploymentPathParams, CancelDeploymentQueryParams, BuyDomainQueryParams, CheckDomainPriceQueryParams, CheckDomainStatusQueryParams, GetRecordsPathParams, GetRecordsQueryParams, CreateRecordPathParams, CreateRecordQueryParams, UpdateRecordPathParams, UpdateRecordQueryParams, RemoveRecordPathParams, RemoveRecordQueryParams, GetDomainTransferPathParams, GetDomainTransferQueryParams, GetDomainConfigPathParams, GetDomainConfigQueryParams, GetDomainPathParams, GetDomainQueryParams, GetDomainsQueryParams, CreateOrTransferDomainQueryParams, PatchDomainPathParams, PatchDomainQueryParams, DeleteDomainPathParams, DeleteDomainQueryParams, GetEdgeConfigsQueryParams, CreateEdgeConfigQueryParams, GetEdgeConfigPathParams, GetEdgeConfigQueryParams, UpdateEdgeConfigPathParams, UpdateEdgeConfigQueryParams, DeleteEdgeConfigPathParams, DeleteEdgeConfigQueryParams, GetEdgeConfigItemsPathParams, GetEdgeConfigItemsQueryParams, PatchEdgeConfigItemsPathParams, PatchEdgeConfigItemsQueryParams, GetEdgeConfigSchemaPathParams, GetEdgeConfigSchemaQueryParams, PatchEdgeConfigSchemaPathParams, PatchEdgeConfigSchemaQueryParams, DeleteEdgeConfigSchemaPathParams, DeleteEdgeConfigSchemaQueryParams, GetEdgeConfigItemPathParams, GetEdgeConfigItemQueryParams, GetEdgeConfigTokensPathParams, GetEdgeConfigTokensQueryParams, DeleteEdgeConfigTokensPathParams, DeleteEdgeConfigTokensQueryParams, GetEdgeConfigTokenPathParams, GetEdgeConfigTokenQueryParams, CreateEdgeConfigTokenPathParams, CreateEdgeConfigTokenQueryParams, GetEdgeConfigBackupPathParams, GetEdgeConfigBackupQueryParams, GetEdgeConfigBackupsPathParams, GetEdgeConfigBackupsQueryParams, ListUserEventsQueryParams, GetAccountInfoPathParams, GetMemberPathParams, CreateEventPathParams, GetIntegrationResourcesPathParams, GetIntegrationResourcePathParams, DeleteIntegrationResourcePathParams, ImportResourcePathParams, SubmitBillingDataPathParams, SubmitInvoicePathParams, GetInvoicePathParams, UpdateInvoicePathParams, SubmitPrepaymentBalancesPathParams, UpdateResourceSecretsPathParams, UpdateResourceSecretsByIdPathParams, GetConfigurationsQueryParams, GetConfigurationPathParams, GetConfigurationQueryParams, DeleteConfigurationPathParams, DeleteConfigurationQueryParams, GetIntegrationLogDrainsQueryParams, CreateLogDrainQueryParams, DeleteIntegrationLogDrainPathParams, DeleteIntegrationLogDrainQueryParams, GetRuntimeLogsPathParams, GetRuntimeLogsQueryParams, CreateExperimentationItemPathParams, UpdateExperimentationItemPathParams, DeleteExperimentationItemPathParams, UpdateExperimentationEdgeConfigPathParams, GetProjectMembersPathParams, GetProjectMembersQueryParams, AddProjectMemberPathParams, AddProjectMemberQueryParams, RemoveProjectMemberPathParams, RemoveProjectMemberQueryParams, GetProjectsQueryParams, CreateProjectQueryParams, GetProjectPathParams, GetProjectQueryParams, UpdateProjectPathParams, UpdateProjectQueryParams, DeleteProjectPathParams, DeleteProjectQueryParams, CreateCustomEnvironmentPathParams, CreateCustomEnvironmentQueryParams, ListCustomEnvironmentsPathParams, ListCustomEnvironmentsQueryParams, GetCustomEnvironmentPathParams, GetCustomEnvironmentQueryParams, UpdateCustomEnvironmentPathParams, UpdateCustomEnvironmentQueryParams, RemoveCustomEnvironmentPathParams, RemoveCustomEnvironmentQueryParams, GetProjectDomainsPathParams, GetProjectDomainsQueryParams, GetProjectDomainPathParams, GetProjectDomainQueryParams, UpdateProjectDomainPathParams, UpdateProjectDomainQueryParams, RemoveProjectDomainPathParams, RemoveProjectDomainQueryParams, AddProjectDomainPathParams, AddProjectDomainQueryParams, MoveProjectDomainPathParams, MoveProjectDomainQueryParams, VerifyProjectDomainPathParams, VerifyProjectDomainQueryParams, FilterProjectEnvsPathParams, FilterProjectEnvsQueryParams, CreateProjectEnvPathParams, CreateProjectEnvQueryParams, GetProjectEnvPathParams, GetProjectEnvQueryParams, RemoveProjectEnvPathParams, RemoveProjectEnvQueryParams, EditProjectEnvPathParams, EditProjectEnvQueryParams, GetRollingReleaseBillingStatusPathParams, GetRollingReleaseBillingStatusQueryParams, GetRollingReleaseConfigPathParams, GetRollingReleaseConfigQueryParams, DeleteRollingReleaseConfigPathParams, DeleteRollingReleaseConfigQueryParams, UpdateRollingReleaseConfigPathParams, UpdateRollingReleaseConfigQueryParams, GetRollingReleasePathParams, GetRollingReleaseQueryParams, ApproveRollingReleaseStagePathParams, ApproveRollingReleaseStageQueryParams, CompleteRollingReleasePathParams, CompleteRollingReleaseQueryParams, CreateProjectTransferRequestPathParams, CreateProjectTransferRequestQueryParams, AcceptProjectTransferRequestPathParams, AcceptProjectTransferRequestQueryParams, UpdateProjectProtectionBypassPathParams, UpdateProjectProtectionBypassQueryParams, RequestPromotePathParams, RequestPromoteQueryParams, ListPromoteAliasesPathParams, ListPromoteAliasesQueryParams, PauseProjectPathParams, PauseProjectQueryParams, UnpauseProjectPathParams, UnpauseProjectQueryParams, UpdateAttackChallengeModeQueryParams, PutFirewallConfigQueryParams, UpdateFirewallConfigQueryParams, GetFirewallConfigPathParams, GetFirewallConfigQueryParams, GetActiveAttackStatusQueryParams, GetBypassIpQueryParams, AddBypassIpQueryParams, RemoveBypassIpQueryParams, GetTeamMembersPathParams, GetTeamMembersQueryParams, InviteUserToTeamPathParams, RequestAccessToTeamPathParams, GetTeamAccessRequestPathParams, JoinTeamPathParams, UpdateTeamMemberPathParams, RemoveTeamMemberPathParams, RemoveTeamMemberQueryParams, GetTeamPathParams, GetTeamQueryParams, PatchTeamPathParams, PatchTeamQueryParams, GetTeamsQueryParams, DeleteTeamPathParams, DeleteTeamQueryParams, DeleteTeamInviteCodePathParams, UploadFileQueryParams, UploadFileHeaderParams, CreateAuthTokenQueryParams, GetAuthTokenPathParams, DeleteAuthTokenPathParams, CreateWebhookQueryParams, GetWebhooksQueryParams, GetWebhookPathParams, GetWebhookQueryParams, DeleteWebhookPathParams, DeleteWebhookQueryParams, ListDeploymentAliasesPathParams, ListDeploymentAliasesQueryParams, AssignAliasPathParams, AssignAliasQueryParams, ListAliasesQueryParams, GetAliasPathParams, GetAliasQueryParams, DeleteAliasPathParams, DeleteAliasQueryParams, PatchUrlProtectionBypassPathParams, PatchUrlProtectionBypassQueryParams, GetCertByIdPathParams, GetCertByIdQueryParams, RemoveCertPathParams, RemoveCertQueryParams, IssueCertQueryParams, UploadCertQueryParams, ListDeploymentFilesPathParams, ListDeploymentFilesQueryParams, GetDeploymentFileContentsPathParams, GetDeploymentFileContentsQueryParams, GetDeploymentsQueryParams, DeleteDeploymentPathParams, DeleteDeploymentQueryParams, GetSecretsQueryParams, CreateSecretPathParams, CreateSecretQueryParams, RenameSecretPathParams, RenameSecretQueryParams, GetSecretPathParams, GetSecretQueryParams, DeleteSecretPathParams, DeleteSecretQueryParams } from "./types.js";
|
|
8
|
+
/**
|
|
9
|
+
* @description Allows to read an access group
|
|
10
|
+
* @summary Reads an access group
|
|
11
|
+
* {@link v1AccessGroupsIdOrName}
|
|
12
|
+
*/
|
|
13
|
+
export declare function readAccessGroup({ pathParams: { idOrName }, queryParams, config, }: {
|
|
14
|
+
pathParams: ReadAccessGroupPathParams;
|
|
15
|
+
queryParams?: ReadAccessGroupQueryParams;
|
|
16
|
+
config?: Partial<FetcherConfig> & {
|
|
17
|
+
client?: typeof client;
|
|
18
|
+
};
|
|
19
|
+
}): Promise<unknown>;
|
|
20
|
+
/**
|
|
21
|
+
* @description Allows to update an access group metadata
|
|
22
|
+
* @summary Update an access group
|
|
23
|
+
* {@link v1AccessGroupsIdOrName}
|
|
24
|
+
*/
|
|
25
|
+
export declare function updateAccessGroup({ pathParams: { idOrName }, queryParams, config, }: {
|
|
26
|
+
pathParams: UpdateAccessGroupPathParams;
|
|
27
|
+
queryParams?: UpdateAccessGroupQueryParams;
|
|
28
|
+
config?: Partial<FetcherConfig> & {
|
|
29
|
+
client?: typeof client;
|
|
30
|
+
};
|
|
31
|
+
}): Promise<unknown>;
|
|
32
|
+
/**
|
|
33
|
+
* @description Allows to delete an access group
|
|
34
|
+
* @summary Deletes an access group
|
|
35
|
+
* {@link v1AccessGroupsIdOrName}
|
|
36
|
+
*/
|
|
37
|
+
export declare function deleteAccessGroup({ pathParams: { idOrName }, queryParams, config, }: {
|
|
38
|
+
pathParams: DeleteAccessGroupPathParams;
|
|
39
|
+
queryParams?: DeleteAccessGroupQueryParams;
|
|
40
|
+
config?: Partial<FetcherConfig> & {
|
|
41
|
+
client?: typeof client;
|
|
42
|
+
};
|
|
43
|
+
}): Promise<unknown>;
|
|
44
|
+
/**
|
|
45
|
+
* @description List members of an access group
|
|
46
|
+
* @summary List members of an access group
|
|
47
|
+
* {@link v1AccessGroupsIdOrNameMembers}
|
|
48
|
+
*/
|
|
49
|
+
export declare function listAccessGroupMembers({ pathParams: { idOrName }, queryParams, config, }: {
|
|
50
|
+
pathParams: ListAccessGroupMembersPathParams;
|
|
51
|
+
queryParams?: ListAccessGroupMembersQueryParams;
|
|
52
|
+
config?: Partial<FetcherConfig> & {
|
|
53
|
+
client?: typeof client;
|
|
54
|
+
};
|
|
55
|
+
}): Promise<unknown>;
|
|
56
|
+
/**
|
|
57
|
+
* @description List access groups
|
|
58
|
+
* @summary List access groups for a team, project or member
|
|
59
|
+
* {@link v1AccessGroups}
|
|
60
|
+
*/
|
|
61
|
+
export declare function listAccessGroups({ queryParams, config, }: {
|
|
62
|
+
queryParams?: ListAccessGroupsQueryParams;
|
|
63
|
+
config?: Partial<FetcherConfig> & {
|
|
64
|
+
client?: typeof client;
|
|
65
|
+
};
|
|
66
|
+
}): Promise<unknown>;
|
|
67
|
+
/**
|
|
68
|
+
* @description Allows to create an access group
|
|
69
|
+
* @summary Creates an access group
|
|
70
|
+
* {@link v1AccessGroups}
|
|
71
|
+
*/
|
|
72
|
+
export declare function createAccessGroup({ queryParams, config, }: {
|
|
73
|
+
queryParams?: CreateAccessGroupQueryParams;
|
|
74
|
+
config?: Partial<FetcherConfig> & {
|
|
75
|
+
client?: typeof client;
|
|
76
|
+
};
|
|
77
|
+
}): Promise<unknown>;
|
|
78
|
+
/**
|
|
79
|
+
* @description List projects of an access group
|
|
80
|
+
* @summary List projects of an access group
|
|
81
|
+
* {@link v1AccessGroupsIdOrNameProjects}
|
|
82
|
+
*/
|
|
83
|
+
export declare function listAccessGroupProjects({ pathParams: { idOrName }, queryParams, config, }: {
|
|
84
|
+
pathParams: ListAccessGroupProjectsPathParams;
|
|
85
|
+
queryParams?: ListAccessGroupProjectsQueryParams;
|
|
86
|
+
config?: Partial<FetcherConfig> & {
|
|
87
|
+
client?: typeof client;
|
|
88
|
+
};
|
|
89
|
+
}): Promise<unknown>;
|
|
90
|
+
/**
|
|
91
|
+
* @description Allows creation of an access group project
|
|
92
|
+
* @summary Create an access group project
|
|
93
|
+
* {@link v1AccessGroupsAccessGroupIdOrNameProjects}
|
|
94
|
+
*/
|
|
95
|
+
export declare function createAccessGroupProject({ pathParams: { accessGroupIdOrName }, queryParams, config, }: {
|
|
96
|
+
pathParams: CreateAccessGroupProjectPathParams;
|
|
97
|
+
queryParams?: CreateAccessGroupProjectQueryParams;
|
|
98
|
+
config?: Partial<FetcherConfig> & {
|
|
99
|
+
client?: typeof client;
|
|
100
|
+
};
|
|
101
|
+
}): Promise<unknown>;
|
|
102
|
+
/**
|
|
103
|
+
* @description Allows reading an access group project
|
|
104
|
+
* @summary Reads an access group project
|
|
105
|
+
* {@link v1AccessGroupsAccessGroupIdOrNameProjectsProjectId}
|
|
106
|
+
*/
|
|
107
|
+
export declare function readAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config, }: {
|
|
108
|
+
pathParams: ReadAccessGroupProjectPathParams;
|
|
109
|
+
queryParams?: ReadAccessGroupProjectQueryParams;
|
|
110
|
+
config?: Partial<FetcherConfig> & {
|
|
111
|
+
client?: typeof client;
|
|
112
|
+
};
|
|
113
|
+
}): Promise<unknown>;
|
|
114
|
+
/**
|
|
115
|
+
* @description Allows update of an access group project
|
|
116
|
+
* @summary Update an access group project
|
|
117
|
+
* {@link v1AccessGroupsAccessGroupIdOrNameProjectsProjectId}
|
|
118
|
+
*/
|
|
119
|
+
export declare function updateAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config, }: {
|
|
120
|
+
pathParams: UpdateAccessGroupProjectPathParams;
|
|
121
|
+
queryParams?: UpdateAccessGroupProjectQueryParams;
|
|
122
|
+
config?: Partial<FetcherConfig> & {
|
|
123
|
+
client?: typeof client;
|
|
124
|
+
};
|
|
125
|
+
}): Promise<unknown>;
|
|
126
|
+
/**
|
|
127
|
+
* @description Allows deletion of an access group project
|
|
128
|
+
* @summary Delete an access group project
|
|
129
|
+
* {@link v1AccessGroupsAccessGroupIdOrNameProjectsProjectId}
|
|
130
|
+
*/
|
|
131
|
+
export declare function deleteAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config, }: {
|
|
132
|
+
pathParams: DeleteAccessGroupProjectPathParams;
|
|
133
|
+
queryParams?: DeleteAccessGroupProjectQueryParams;
|
|
134
|
+
config?: Partial<FetcherConfig> & {
|
|
135
|
+
client?: typeof client;
|
|
136
|
+
};
|
|
137
|
+
}): Promise<unknown>;
|
|
138
|
+
/**
|
|
139
|
+
* @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.
|
|
140
|
+
* @summary Record an artifacts cache usage event
|
|
141
|
+
* {@link v8ArtifactsEvents}
|
|
142
|
+
*/
|
|
143
|
+
export declare function recordEvents({ queryParams, headers, config, }: {
|
|
144
|
+
queryParams?: RecordEventsQueryParams;
|
|
145
|
+
headers?: RecordEventsHeaderParams;
|
|
146
|
+
config?: Partial<FetcherConfig> & {
|
|
147
|
+
client?: typeof client;
|
|
148
|
+
};
|
|
149
|
+
}): Promise<unknown>;
|
|
150
|
+
/**
|
|
151
|
+
* @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.
|
|
152
|
+
* @summary Get status of Remote Caching for this principal
|
|
153
|
+
* {@link v8ArtifactsStatus}
|
|
154
|
+
*/
|
|
155
|
+
export declare function status({ queryParams, config }: {
|
|
156
|
+
queryParams?: StatusQueryParams;
|
|
157
|
+
config?: Partial<FetcherConfig> & {
|
|
158
|
+
client?: typeof client;
|
|
159
|
+
};
|
|
160
|
+
}): Promise<unknown>;
|
|
161
|
+
/**
|
|
162
|
+
* @description Uploads a cache artifact identified by the `hash` specified on the path. The cache artifact can then be downloaded with the provided `hash`.
|
|
163
|
+
* @summary Upload a cache artifact
|
|
164
|
+
* {@link v8ArtifactsHash}
|
|
165
|
+
*/
|
|
166
|
+
export declare function uploadArtifact({ pathParams: { hash }, headers, queryParams, config, }: {
|
|
167
|
+
pathParams: UploadArtifactPathParams;
|
|
168
|
+
headers: UploadArtifactHeaderParams;
|
|
169
|
+
queryParams?: UploadArtifactQueryParams;
|
|
170
|
+
config?: Partial<FetcherConfig> & {
|
|
171
|
+
client?: typeof client;
|
|
172
|
+
};
|
|
173
|
+
}): Promise<unknown>;
|
|
174
|
+
/**
|
|
175
|
+
* @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.
|
|
176
|
+
* @summary Download a cache artifact
|
|
177
|
+
* {@link v8ArtifactsHash}
|
|
178
|
+
*/
|
|
179
|
+
export declare function downloadArtifact({ pathParams: { hash }, queryParams, headers, config, }: {
|
|
180
|
+
pathParams: DownloadArtifactPathParams;
|
|
181
|
+
queryParams?: DownloadArtifactQueryParams;
|
|
182
|
+
headers?: DownloadArtifactHeaderParams;
|
|
183
|
+
config?: Partial<FetcherConfig> & {
|
|
184
|
+
client?: typeof client;
|
|
185
|
+
};
|
|
186
|
+
}): Promise<unknown>;
|
|
187
|
+
/**
|
|
188
|
+
* @description Query information about an array of artifacts.
|
|
189
|
+
* @summary Query information about an artifact
|
|
190
|
+
* {@link v8Artifacts}
|
|
191
|
+
*/
|
|
192
|
+
export declare function artifactQuery({ queryParams, config, }: {
|
|
193
|
+
queryParams?: ArtifactQueryQueryParams;
|
|
194
|
+
config?: Partial<FetcherConfig> & {
|
|
195
|
+
client?: typeof client;
|
|
196
|
+
};
|
|
197
|
+
}): Promise<unknown>;
|
|
198
|
+
/**
|
|
199
|
+
* @description Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
|
|
200
|
+
* @summary Creates a new Check
|
|
201
|
+
* {@link v1DeploymentsDeploymentIdChecks}
|
|
202
|
+
*/
|
|
203
|
+
export declare function createCheck({ pathParams: { deploymentId }, queryParams, config, }: {
|
|
204
|
+
pathParams: CreateCheckPathParams;
|
|
205
|
+
queryParams?: CreateCheckQueryParams;
|
|
206
|
+
config?: Partial<FetcherConfig> & {
|
|
207
|
+
client?: typeof client;
|
|
208
|
+
};
|
|
209
|
+
}): Promise<unknown>;
|
|
210
|
+
/**
|
|
211
|
+
* @description List all of the checks created for a deployment.
|
|
212
|
+
* @summary Retrieve a list of all checks
|
|
213
|
+
* {@link v1DeploymentsDeploymentIdChecks}
|
|
214
|
+
*/
|
|
215
|
+
export declare function getAllChecks({ pathParams: { deploymentId }, queryParams, config, }: {
|
|
216
|
+
pathParams: GetAllChecksPathParams;
|
|
217
|
+
queryParams?: GetAllChecksQueryParams;
|
|
218
|
+
config?: Partial<FetcherConfig> & {
|
|
219
|
+
client?: typeof client;
|
|
220
|
+
};
|
|
221
|
+
}): Promise<unknown>;
|
|
222
|
+
/**
|
|
223
|
+
* @description Return a detailed response for a single check.
|
|
224
|
+
* @summary Get a single check
|
|
225
|
+
* {@link v1DeploymentsDeploymentIdChecksCheckId}
|
|
226
|
+
*/
|
|
227
|
+
export declare function getCheck({ pathParams: { deploymentId, checkId }, queryParams, config, }: {
|
|
228
|
+
pathParams: GetCheckPathParams;
|
|
229
|
+
queryParams?: GetCheckQueryParams;
|
|
230
|
+
config?: Partial<FetcherConfig> & {
|
|
231
|
+
client?: typeof client;
|
|
232
|
+
};
|
|
233
|
+
}): Promise<unknown>;
|
|
234
|
+
/**
|
|
235
|
+
* @description Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
|
|
236
|
+
* @summary Update a check
|
|
237
|
+
* {@link v1DeploymentsDeploymentIdChecksCheckId}
|
|
238
|
+
*/
|
|
239
|
+
export declare function updateCheck({ pathParams: { deploymentId, checkId }, queryParams, config, }: {
|
|
240
|
+
pathParams: UpdateCheckPathParams;
|
|
241
|
+
queryParams?: UpdateCheckQueryParams;
|
|
242
|
+
config?: Partial<FetcherConfig> & {
|
|
243
|
+
client?: typeof client;
|
|
244
|
+
};
|
|
245
|
+
}): Promise<unknown>;
|
|
246
|
+
/**
|
|
247
|
+
* @description Rerequest a selected check that has failed.
|
|
248
|
+
* @summary Rerequest a check
|
|
249
|
+
* {@link v1DeploymentsDeploymentIdChecksCheckIdRerequest}
|
|
250
|
+
*/
|
|
251
|
+
export declare function rerequestCheck({ pathParams: { deploymentId, checkId }, queryParams, config, }: {
|
|
252
|
+
pathParams: RerequestCheckPathParams;
|
|
253
|
+
queryParams?: RerequestCheckQueryParams;
|
|
254
|
+
config?: Partial<FetcherConfig> & {
|
|
255
|
+
client?: typeof client;
|
|
256
|
+
};
|
|
257
|
+
}): Promise<unknown>;
|
|
258
|
+
/**
|
|
259
|
+
* {@link dataCachePurgeAll}
|
|
260
|
+
*/
|
|
261
|
+
export declare function purgeAllDataCache({ queryParams, config, }: {
|
|
262
|
+
queryParams: PurgeAllDataCacheQueryParams;
|
|
263
|
+
config?: Partial<FetcherConfig> & {
|
|
264
|
+
client?: typeof client;
|
|
265
|
+
};
|
|
266
|
+
}): Promise<unknown>;
|
|
267
|
+
/**
|
|
268
|
+
* {@link dataCacheBillingSettings}
|
|
269
|
+
*/
|
|
270
|
+
export declare function updateDataCacheBillingSettings({ config }: {
|
|
271
|
+
config?: Partial<FetcherConfig> & {
|
|
272
|
+
client?: typeof client;
|
|
273
|
+
};
|
|
274
|
+
}): Promise<unknown>;
|
|
275
|
+
/**
|
|
276
|
+
* @description Update the data cache feature on a project.
|
|
277
|
+
* @summary Update the data cache feature
|
|
278
|
+
* {@link v1DataCacheProjectsProjectId}
|
|
279
|
+
*/
|
|
280
|
+
export declare function updateProjectDataCache({ pathParams: { projectId }, queryParams, config, }: {
|
|
281
|
+
pathParams: UpdateProjectDataCachePathParams;
|
|
282
|
+
queryParams?: UpdateProjectDataCacheQueryParams;
|
|
283
|
+
config?: Partial<FetcherConfig> & {
|
|
284
|
+
client?: typeof client;
|
|
285
|
+
};
|
|
286
|
+
}): Promise<unknown>;
|
|
287
|
+
/**
|
|
288
|
+
* @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.
|
|
289
|
+
* @summary Get deployment events
|
|
290
|
+
* {@link v3DeploymentsIdOrUrlEvents}
|
|
291
|
+
*/
|
|
292
|
+
export declare function getDeploymentEvents({ pathParams: { idOrUrl }, queryParams, config, }: {
|
|
293
|
+
pathParams: GetDeploymentEventsPathParams;
|
|
294
|
+
queryParams?: GetDeploymentEventsQueryParams;
|
|
295
|
+
config?: Partial<FetcherConfig> & {
|
|
296
|
+
client?: typeof client;
|
|
297
|
+
};
|
|
298
|
+
}): Promise<unknown>;
|
|
299
|
+
/**
|
|
300
|
+
* @description Updates the deployment integration action for the specified integration installation
|
|
301
|
+
* @summary Update deployment integration action
|
|
302
|
+
* {@link v1DeploymentsDeploymentIdIntegrationsIntegrationConfigurationIdResourcesResourceIdActionsAction}
|
|
303
|
+
*/
|
|
304
|
+
export declare function updateIntegrationDeploymentAction({ pathParams: { deploymentId, integrationConfigurationId, resourceId, action }, config, }: {
|
|
305
|
+
pathParams: UpdateIntegrationDeploymentActionPathParams;
|
|
306
|
+
config?: Partial<FetcherConfig> & {
|
|
307
|
+
client?: typeof client;
|
|
308
|
+
};
|
|
309
|
+
}): Promise<unknown>;
|
|
310
|
+
/**
|
|
311
|
+
* @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.
|
|
312
|
+
* @summary Get a deployment by ID or URL
|
|
313
|
+
* {@link v13DeploymentsIdOrUrl}
|
|
314
|
+
*/
|
|
315
|
+
export declare function getDeployment({ pathParams: { idOrUrl }, queryParams, config, }: {
|
|
316
|
+
pathParams: GetDeploymentPathParams;
|
|
317
|
+
queryParams?: GetDeploymentQueryParams;
|
|
318
|
+
config?: Partial<FetcherConfig> & {
|
|
319
|
+
client?: typeof client;
|
|
320
|
+
};
|
|
321
|
+
}): Promise<unknown>;
|
|
322
|
+
/**
|
|
323
|
+
* @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.
|
|
324
|
+
* @summary Create a new deployment
|
|
325
|
+
* {@link v13Deployments}
|
|
326
|
+
*/
|
|
327
|
+
export declare function createDeployment({ queryParams, config, }: {
|
|
328
|
+
queryParams?: CreateDeploymentQueryParams;
|
|
329
|
+
config?: Partial<FetcherConfig> & {
|
|
330
|
+
client?: typeof client;
|
|
331
|
+
};
|
|
332
|
+
}): Promise<unknown>;
|
|
333
|
+
/**
|
|
334
|
+
* @description This endpoint allows you to cancel a deployment which is currently building, by supplying its `id` in the URL.
|
|
335
|
+
* @summary Cancel a deployment
|
|
336
|
+
* {@link v12DeploymentsIdCancel}
|
|
337
|
+
*/
|
|
338
|
+
export declare function cancelDeployment({ pathParams: { id }, queryParams, config, }: {
|
|
339
|
+
pathParams: CancelDeploymentPathParams;
|
|
340
|
+
queryParams?: CancelDeploymentQueryParams;
|
|
341
|
+
config?: Partial<FetcherConfig> & {
|
|
342
|
+
client?: typeof client;
|
|
343
|
+
};
|
|
344
|
+
}): Promise<unknown>;
|
|
345
|
+
/**
|
|
346
|
+
* @description Allows to purchase the specified domain.
|
|
347
|
+
* @summary Purchase a domain
|
|
348
|
+
* {@link v5DomainsBuy}
|
|
349
|
+
*/
|
|
350
|
+
export declare function buyDomain({ queryParams, config, }: {
|
|
351
|
+
queryParams?: BuyDomainQueryParams;
|
|
352
|
+
config?: Partial<FetcherConfig> & {
|
|
353
|
+
client?: typeof client;
|
|
354
|
+
};
|
|
355
|
+
}): Promise<unknown>;
|
|
356
|
+
/**
|
|
357
|
+
* @description Check the price to purchase a domain and how long a single purchase period is.
|
|
358
|
+
* @summary Check the price for a domain
|
|
359
|
+
* {@link v4DomainsPrice}
|
|
360
|
+
*/
|
|
361
|
+
export declare function checkDomainPrice({ queryParams, config, }: {
|
|
362
|
+
queryParams: CheckDomainPriceQueryParams;
|
|
363
|
+
config?: Partial<FetcherConfig> & {
|
|
364
|
+
client?: typeof client;
|
|
365
|
+
};
|
|
366
|
+
}): Promise<unknown>;
|
|
367
|
+
/**
|
|
368
|
+
* @description Check if a domain name is available for purchase.
|
|
369
|
+
* @summary Check a Domain Availability
|
|
370
|
+
* {@link v4DomainsStatus}
|
|
371
|
+
*/
|
|
372
|
+
export declare function checkDomainStatus({ queryParams, config, }: {
|
|
373
|
+
queryParams: CheckDomainStatusQueryParams;
|
|
374
|
+
config?: Partial<FetcherConfig> & {
|
|
375
|
+
client?: typeof client;
|
|
376
|
+
};
|
|
377
|
+
}): Promise<unknown>;
|
|
378
|
+
/**
|
|
379
|
+
* @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.
|
|
380
|
+
* @summary List existing DNS records
|
|
381
|
+
* {@link v4DomainsDomainRecords}
|
|
382
|
+
*/
|
|
383
|
+
export declare function getRecords({ pathParams: { domain }, queryParams, config, }: {
|
|
384
|
+
pathParams: GetRecordsPathParams;
|
|
385
|
+
queryParams?: GetRecordsQueryParams;
|
|
386
|
+
config?: Partial<FetcherConfig> & {
|
|
387
|
+
client?: typeof client;
|
|
388
|
+
};
|
|
389
|
+
}): Promise<unknown>;
|
|
390
|
+
/**
|
|
391
|
+
* @description Creates a DNS record for a domain.
|
|
392
|
+
* @summary Create a DNS record
|
|
393
|
+
* {@link v2DomainsDomainRecords}
|
|
394
|
+
*/
|
|
395
|
+
export declare function createRecord({ pathParams: { domain }, queryParams, config, }: {
|
|
396
|
+
pathParams: CreateRecordPathParams;
|
|
397
|
+
queryParams?: CreateRecordQueryParams;
|
|
398
|
+
config?: Partial<FetcherConfig> & {
|
|
399
|
+
client?: typeof client;
|
|
400
|
+
};
|
|
401
|
+
}): Promise<unknown>;
|
|
402
|
+
/**
|
|
403
|
+
* @description Updates an existing DNS record for a domain name.
|
|
404
|
+
* @summary Update an existing DNS record
|
|
405
|
+
* {@link v1DomainsRecordsRecordId}
|
|
406
|
+
*/
|
|
407
|
+
export declare function updateRecord({ pathParams: { recordId }, queryParams, config, }: {
|
|
408
|
+
pathParams: UpdateRecordPathParams;
|
|
409
|
+
queryParams?: UpdateRecordQueryParams;
|
|
410
|
+
config?: Partial<FetcherConfig> & {
|
|
411
|
+
client?: typeof client;
|
|
412
|
+
};
|
|
413
|
+
}): Promise<unknown>;
|
|
414
|
+
/**
|
|
415
|
+
* @description Removes an existing DNS record from a domain name.
|
|
416
|
+
* @summary Delete a DNS record
|
|
417
|
+
* {@link v2DomainsDomainRecordsRecordId}
|
|
418
|
+
*/
|
|
419
|
+
export declare function removeRecord({ pathParams: { domain, recordId }, queryParams, config, }: {
|
|
420
|
+
pathParams: RemoveRecordPathParams;
|
|
421
|
+
queryParams?: RemoveRecordQueryParams;
|
|
422
|
+
config?: Partial<FetcherConfig> & {
|
|
423
|
+
client?: typeof client;
|
|
424
|
+
};
|
|
425
|
+
}): Promise<unknown>;
|
|
426
|
+
/**
|
|
427
|
+
* @description Fetch domain transfer availability or transfer status if a transfer is in progress.
|
|
428
|
+
* @summary Get domain transfer info.
|
|
429
|
+
* {@link v1DomainsDomainRegistry}
|
|
430
|
+
*/
|
|
431
|
+
export declare function getDomainTransfer({ pathParams: { domain }, queryParams, config, }: {
|
|
432
|
+
pathParams: GetDomainTransferPathParams;
|
|
433
|
+
queryParams?: GetDomainTransferQueryParams;
|
|
434
|
+
config?: Partial<FetcherConfig> & {
|
|
435
|
+
client?: typeof client;
|
|
436
|
+
};
|
|
437
|
+
}): Promise<unknown>;
|
|
438
|
+
/**
|
|
439
|
+
* @description Get a Domain's configuration.
|
|
440
|
+
* @summary Get a Domain's configuration
|
|
441
|
+
* {@link v6DomainsDomainConfig}
|
|
442
|
+
*/
|
|
443
|
+
export declare function getDomainConfig({ pathParams: { domain }, queryParams, config, }: {
|
|
444
|
+
pathParams: GetDomainConfigPathParams;
|
|
445
|
+
queryParams?: GetDomainConfigQueryParams;
|
|
446
|
+
config?: Partial<FetcherConfig> & {
|
|
447
|
+
client?: typeof client;
|
|
448
|
+
};
|
|
449
|
+
}): Promise<unknown>;
|
|
450
|
+
/**
|
|
451
|
+
* @description Get information for a single domain in an account or team.
|
|
452
|
+
* @summary Get Information for a Single Domain
|
|
453
|
+
* {@link v5DomainsDomain}
|
|
454
|
+
*/
|
|
455
|
+
export declare function getDomain({ pathParams: { domain }, queryParams, config, }: {
|
|
456
|
+
pathParams: GetDomainPathParams;
|
|
457
|
+
queryParams?: GetDomainQueryParams;
|
|
458
|
+
config?: Partial<FetcherConfig> & {
|
|
459
|
+
client?: typeof client;
|
|
460
|
+
};
|
|
461
|
+
}): Promise<unknown>;
|
|
462
|
+
/**
|
|
463
|
+
* @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.
|
|
464
|
+
* @summary List all the domains
|
|
465
|
+
* {@link v5Domains}
|
|
466
|
+
*/
|
|
467
|
+
export declare function getDomains({ queryParams, config, }: {
|
|
468
|
+
queryParams?: GetDomainsQueryParams;
|
|
469
|
+
config?: Partial<FetcherConfig> & {
|
|
470
|
+
client?: typeof client;
|
|
471
|
+
};
|
|
472
|
+
}): Promise<unknown>;
|
|
473
|
+
/**
|
|
474
|
+
* @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.
|
|
475
|
+
* @summary Register or transfer-in a new Domain
|
|
476
|
+
* {@link v7Domains}
|
|
477
|
+
*/
|
|
478
|
+
export declare function createOrTransferDomain({ queryParams, config, }: {
|
|
479
|
+
queryParams?: CreateOrTransferDomainQueryParams;
|
|
480
|
+
config?: Partial<FetcherConfig> & {
|
|
481
|
+
client?: typeof client;
|
|
482
|
+
};
|
|
483
|
+
}): Promise<unknown>;
|
|
484
|
+
/**
|
|
485
|
+
* @description Update or move apex domain.
|
|
486
|
+
* @summary Update or move apex domain
|
|
487
|
+
* {@link v3DomainsDomain}
|
|
488
|
+
*/
|
|
489
|
+
export declare function patchDomain({ pathParams: { domain }, queryParams, config, }: {
|
|
490
|
+
pathParams: PatchDomainPathParams;
|
|
491
|
+
queryParams?: PatchDomainQueryParams;
|
|
492
|
+
config?: Partial<FetcherConfig> & {
|
|
493
|
+
client?: typeof client;
|
|
494
|
+
};
|
|
495
|
+
}): Promise<unknown>;
|
|
496
|
+
/**
|
|
497
|
+
* @description Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases.
|
|
498
|
+
* @summary Remove a domain by name
|
|
499
|
+
* {@link v6DomainsDomain}
|
|
500
|
+
*/
|
|
501
|
+
export declare function deleteDomain({ pathParams: { domain }, queryParams, config, }: {
|
|
502
|
+
pathParams: DeleteDomainPathParams;
|
|
503
|
+
queryParams?: DeleteDomainQueryParams;
|
|
504
|
+
config?: Partial<FetcherConfig> & {
|
|
505
|
+
client?: typeof client;
|
|
506
|
+
};
|
|
507
|
+
}): Promise<unknown>;
|
|
508
|
+
/**
|
|
509
|
+
* @description Returns all Edge Configs.
|
|
510
|
+
* @summary Get Edge Configs
|
|
511
|
+
* {@link v1EdgeConfig}
|
|
512
|
+
*/
|
|
513
|
+
export declare function getEdgeConfigs({ queryParams, config, }: {
|
|
514
|
+
queryParams?: GetEdgeConfigsQueryParams;
|
|
515
|
+
config?: Partial<FetcherConfig> & {
|
|
516
|
+
client?: typeof client;
|
|
517
|
+
};
|
|
518
|
+
}): Promise<unknown>;
|
|
519
|
+
/**
|
|
520
|
+
* @description Creates an Edge Config.
|
|
521
|
+
* @summary Create an Edge Config
|
|
522
|
+
* {@link v1EdgeConfig}
|
|
523
|
+
*/
|
|
524
|
+
export declare function createEdgeConfig({ queryParams, config, }: {
|
|
525
|
+
queryParams?: CreateEdgeConfigQueryParams;
|
|
526
|
+
config?: Partial<FetcherConfig> & {
|
|
527
|
+
client?: typeof client;
|
|
528
|
+
};
|
|
529
|
+
}): Promise<unknown>;
|
|
530
|
+
/**
|
|
531
|
+
* @description Returns an Edge Config.
|
|
532
|
+
* @summary Get an Edge Config
|
|
533
|
+
* {@link v1EdgeConfigEdgeConfigId}
|
|
534
|
+
*/
|
|
535
|
+
export declare function getEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
536
|
+
pathParams: GetEdgeConfigPathParams;
|
|
537
|
+
queryParams?: GetEdgeConfigQueryParams;
|
|
538
|
+
config?: Partial<FetcherConfig> & {
|
|
539
|
+
client?: typeof client;
|
|
540
|
+
};
|
|
541
|
+
}): Promise<unknown>;
|
|
542
|
+
/**
|
|
543
|
+
* @description Updates an Edge Config.
|
|
544
|
+
* @summary Update an Edge Config
|
|
545
|
+
* {@link v1EdgeConfigEdgeConfigId}
|
|
546
|
+
*/
|
|
547
|
+
export declare function updateEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
548
|
+
pathParams: UpdateEdgeConfigPathParams;
|
|
549
|
+
queryParams?: UpdateEdgeConfigQueryParams;
|
|
550
|
+
config?: Partial<FetcherConfig> & {
|
|
551
|
+
client?: typeof client;
|
|
552
|
+
};
|
|
553
|
+
}): Promise<unknown>;
|
|
554
|
+
/**
|
|
555
|
+
* @description Delete an Edge Config by id.
|
|
556
|
+
* @summary Delete an Edge Config
|
|
557
|
+
* {@link v1EdgeConfigEdgeConfigId}
|
|
558
|
+
*/
|
|
559
|
+
export declare function deleteEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
560
|
+
pathParams: DeleteEdgeConfigPathParams;
|
|
561
|
+
queryParams?: DeleteEdgeConfigQueryParams;
|
|
562
|
+
config?: Partial<FetcherConfig> & {
|
|
563
|
+
client?: typeof client;
|
|
564
|
+
};
|
|
565
|
+
}): Promise<unknown>;
|
|
566
|
+
/**
|
|
567
|
+
* @description Returns all items of an Edge Config.
|
|
568
|
+
* @summary Get Edge Config items
|
|
569
|
+
* {@link v1EdgeConfigEdgeConfigIdItems}
|
|
570
|
+
*/
|
|
571
|
+
export declare function getEdgeConfigItems({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
572
|
+
pathParams: GetEdgeConfigItemsPathParams;
|
|
573
|
+
queryParams?: GetEdgeConfigItemsQueryParams;
|
|
574
|
+
config?: Partial<FetcherConfig> & {
|
|
575
|
+
client?: typeof client;
|
|
576
|
+
};
|
|
577
|
+
}): Promise<unknown>;
|
|
578
|
+
/**
|
|
579
|
+
* @description Update multiple Edge Config Items in batch.
|
|
580
|
+
* @summary Update Edge Config items in batch
|
|
581
|
+
* {@link v1EdgeConfigEdgeConfigIdItems}
|
|
582
|
+
*/
|
|
583
|
+
export declare function patchEdgeConfigItems({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
584
|
+
pathParams: PatchEdgeConfigItemsPathParams;
|
|
585
|
+
queryParams?: PatchEdgeConfigItemsQueryParams;
|
|
586
|
+
config?: Partial<FetcherConfig> & {
|
|
587
|
+
client?: typeof client;
|
|
588
|
+
};
|
|
589
|
+
}): Promise<unknown>;
|
|
590
|
+
/**
|
|
591
|
+
* @description Returns the schema of an Edge Config.
|
|
592
|
+
* @summary Get Edge Config schema
|
|
593
|
+
* {@link v1EdgeConfigEdgeConfigIdSchema}
|
|
594
|
+
*/
|
|
595
|
+
export declare function getEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
596
|
+
pathParams: GetEdgeConfigSchemaPathParams;
|
|
597
|
+
queryParams?: GetEdgeConfigSchemaQueryParams;
|
|
598
|
+
config?: Partial<FetcherConfig> & {
|
|
599
|
+
client?: typeof client;
|
|
600
|
+
};
|
|
601
|
+
}): Promise<unknown>;
|
|
602
|
+
/**
|
|
603
|
+
* @description Update an Edge Config's schema.
|
|
604
|
+
* @summary Update Edge Config schema
|
|
605
|
+
* {@link v1EdgeConfigEdgeConfigIdSchema}
|
|
606
|
+
*/
|
|
607
|
+
export declare function patchEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
608
|
+
pathParams: PatchEdgeConfigSchemaPathParams;
|
|
609
|
+
queryParams?: PatchEdgeConfigSchemaQueryParams;
|
|
610
|
+
config?: Partial<FetcherConfig> & {
|
|
611
|
+
client?: typeof client;
|
|
612
|
+
};
|
|
613
|
+
}): Promise<unknown>;
|
|
614
|
+
/**
|
|
615
|
+
* @description Deletes the schema of existing Edge Config.
|
|
616
|
+
* @summary Delete an Edge Config's schema
|
|
617
|
+
* {@link v1EdgeConfigEdgeConfigIdSchema}
|
|
618
|
+
*/
|
|
619
|
+
export declare function deleteEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
620
|
+
pathParams: DeleteEdgeConfigSchemaPathParams;
|
|
621
|
+
queryParams?: DeleteEdgeConfigSchemaQueryParams;
|
|
622
|
+
config?: Partial<FetcherConfig> & {
|
|
623
|
+
client?: typeof client;
|
|
624
|
+
};
|
|
625
|
+
}): Promise<unknown>;
|
|
626
|
+
/**
|
|
627
|
+
* @description Returns a specific Edge Config Item.
|
|
628
|
+
* @summary Get an Edge Config item
|
|
629
|
+
* {@link v1EdgeConfigEdgeConfigIdItemEdgeConfigItemKey}
|
|
630
|
+
*/
|
|
631
|
+
export declare function getEdgeConfigItem({ pathParams: { edgeConfigId, edgeConfigItemKey }, queryParams, config, }: {
|
|
632
|
+
pathParams: GetEdgeConfigItemPathParams;
|
|
633
|
+
queryParams?: GetEdgeConfigItemQueryParams;
|
|
634
|
+
config?: Partial<FetcherConfig> & {
|
|
635
|
+
client?: typeof client;
|
|
636
|
+
};
|
|
637
|
+
}): Promise<unknown>;
|
|
638
|
+
/**
|
|
639
|
+
* @description Returns all tokens of an Edge Config.
|
|
640
|
+
* @summary Get all tokens of an Edge Config
|
|
641
|
+
* {@link v1EdgeConfigEdgeConfigIdTokens}
|
|
642
|
+
*/
|
|
643
|
+
export declare function getEdgeConfigTokens({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
644
|
+
pathParams: GetEdgeConfigTokensPathParams;
|
|
645
|
+
queryParams?: GetEdgeConfigTokensQueryParams;
|
|
646
|
+
config?: Partial<FetcherConfig> & {
|
|
647
|
+
client?: typeof client;
|
|
648
|
+
};
|
|
649
|
+
}): Promise<unknown>;
|
|
650
|
+
/**
|
|
651
|
+
* @description Deletes one or more tokens of an existing Edge Config.
|
|
652
|
+
* @summary Delete one or more Edge Config tokens
|
|
653
|
+
* {@link v1EdgeConfigEdgeConfigIdTokens}
|
|
654
|
+
*/
|
|
655
|
+
export declare function deleteEdgeConfigTokens({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
656
|
+
pathParams: DeleteEdgeConfigTokensPathParams;
|
|
657
|
+
queryParams?: DeleteEdgeConfigTokensQueryParams;
|
|
658
|
+
config?: Partial<FetcherConfig> & {
|
|
659
|
+
client?: typeof client;
|
|
660
|
+
};
|
|
661
|
+
}): Promise<unknown>;
|
|
662
|
+
/**
|
|
663
|
+
* @description Return meta data about an Edge Config token.
|
|
664
|
+
* @summary Get Edge Config token meta data
|
|
665
|
+
* {@link v1EdgeConfigEdgeConfigIdTokenToken}
|
|
666
|
+
*/
|
|
667
|
+
export declare function getEdgeConfigToken({ pathParams: { edgeConfigId, token }, queryParams, config, }: {
|
|
668
|
+
pathParams: GetEdgeConfigTokenPathParams;
|
|
669
|
+
queryParams?: GetEdgeConfigTokenQueryParams;
|
|
670
|
+
config?: Partial<FetcherConfig> & {
|
|
671
|
+
client?: typeof client;
|
|
672
|
+
};
|
|
673
|
+
}): Promise<unknown>;
|
|
674
|
+
/**
|
|
675
|
+
* @description Adds a token to an existing Edge Config.
|
|
676
|
+
* @summary Create an Edge Config token
|
|
677
|
+
* {@link v1EdgeConfigEdgeConfigIdToken}
|
|
678
|
+
*/
|
|
679
|
+
export declare function createEdgeConfigToken({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
680
|
+
pathParams: CreateEdgeConfigTokenPathParams;
|
|
681
|
+
queryParams?: CreateEdgeConfigTokenQueryParams;
|
|
682
|
+
config?: Partial<FetcherConfig> & {
|
|
683
|
+
client?: typeof client;
|
|
684
|
+
};
|
|
685
|
+
}): Promise<unknown>;
|
|
686
|
+
/**
|
|
687
|
+
* @description Retrieves a specific version of an Edge Config from backup storage.
|
|
688
|
+
* @summary Get Edge Config backup
|
|
689
|
+
* {@link v1EdgeConfigEdgeConfigIdBackupsEdgeConfigBackupVersionId}
|
|
690
|
+
*/
|
|
691
|
+
export declare function getEdgeConfigBackup({ pathParams: { edgeConfigId, edgeConfigBackupVersionId }, queryParams, config, }: {
|
|
692
|
+
pathParams: GetEdgeConfigBackupPathParams;
|
|
693
|
+
queryParams?: GetEdgeConfigBackupQueryParams;
|
|
694
|
+
config?: Partial<FetcherConfig> & {
|
|
695
|
+
client?: typeof client;
|
|
696
|
+
};
|
|
697
|
+
}): Promise<unknown>;
|
|
698
|
+
/**
|
|
699
|
+
* @description Returns backups of an Edge Config.
|
|
700
|
+
* @summary Get Edge Config backups
|
|
701
|
+
* {@link v1EdgeConfigEdgeConfigIdBackups}
|
|
702
|
+
*/
|
|
703
|
+
export declare function getEdgeConfigBackups({ pathParams: { edgeConfigId }, queryParams, config, }: {
|
|
704
|
+
pathParams: GetEdgeConfigBackupsPathParams;
|
|
705
|
+
queryParams?: GetEdgeConfigBackupsQueryParams;
|
|
706
|
+
config?: Partial<FetcherConfig> & {
|
|
707
|
+
client?: typeof client;
|
|
708
|
+
};
|
|
709
|
+
}): Promise<unknown>;
|
|
710
|
+
/**
|
|
711
|
+
* @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.
|
|
712
|
+
* @summary List User Events
|
|
713
|
+
* {@link v3Events}
|
|
714
|
+
*/
|
|
715
|
+
export declare function listUserEvents({ queryParams, config, }: {
|
|
716
|
+
queryParams?: ListUserEventsQueryParams;
|
|
717
|
+
config?: Partial<FetcherConfig> & {
|
|
718
|
+
client?: typeof client;
|
|
719
|
+
};
|
|
720
|
+
}): Promise<unknown>;
|
|
721
|
+
/**
|
|
722
|
+
* @description Fetches the best account or user’s contact info
|
|
723
|
+
* @summary Get Account Information
|
|
724
|
+
* {@link v1InstallationsIntegrationConfigurationIdAccount}
|
|
725
|
+
*/
|
|
726
|
+
export declare function getAccountInfo({ pathParams: { integrationConfigurationId }, config, }: {
|
|
727
|
+
pathParams: GetAccountInfoPathParams;
|
|
728
|
+
config?: Partial<FetcherConfig> & {
|
|
729
|
+
client?: typeof client;
|
|
730
|
+
};
|
|
731
|
+
}): Promise<unknown>;
|
|
732
|
+
/**
|
|
733
|
+
* @description Returns the member role and other information for a given member ID ("user_id" claim in the SSO OIDC token).
|
|
734
|
+
* @summary Get Member Information
|
|
735
|
+
* {@link v1InstallationsIntegrationConfigurationIdMemberMemberId}
|
|
736
|
+
*/
|
|
737
|
+
export declare function getMember({ pathParams: { integrationConfigurationId, memberId }, config, }: {
|
|
738
|
+
pathParams: GetMemberPathParams;
|
|
739
|
+
config?: Partial<FetcherConfig> & {
|
|
740
|
+
client?: typeof client;
|
|
741
|
+
};
|
|
742
|
+
}): Promise<unknown>;
|
|
743
|
+
/**
|
|
744
|
+
* @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/>
|
|
745
|
+
* @summary Create Event
|
|
746
|
+
* {@link v1InstallationsIntegrationConfigurationIdEvents}
|
|
747
|
+
*/
|
|
748
|
+
export declare function createEvent({ pathParams: { integrationConfigurationId }, config, }: {
|
|
749
|
+
pathParams: CreateEventPathParams;
|
|
750
|
+
config?: Partial<FetcherConfig> & {
|
|
751
|
+
client?: typeof client;
|
|
752
|
+
};
|
|
753
|
+
}): Promise<unknown>;
|
|
754
|
+
/**
|
|
755
|
+
* @description Get all resources for a given installation ID.
|
|
756
|
+
* @summary Get Integration Resources
|
|
757
|
+
* {@link v1InstallationsIntegrationConfigurationIdResources}
|
|
758
|
+
*/
|
|
759
|
+
export declare function getIntegrationResources({ pathParams: { integrationConfigurationId }, config, }: {
|
|
760
|
+
pathParams: GetIntegrationResourcesPathParams;
|
|
761
|
+
config?: Partial<FetcherConfig> & {
|
|
762
|
+
client?: typeof client;
|
|
763
|
+
};
|
|
764
|
+
}): Promise<unknown>;
|
|
765
|
+
/**
|
|
766
|
+
* @description Get a resource by its partner ID.
|
|
767
|
+
* @summary Get Integration Resource
|
|
768
|
+
* {@link v1InstallationsIntegrationConfigurationIdResourcesResourceId}
|
|
769
|
+
*/
|
|
770
|
+
export declare function getIntegrationResource({ pathParams: { integrationConfigurationId, resourceId }, config, }: {
|
|
771
|
+
pathParams: GetIntegrationResourcePathParams;
|
|
772
|
+
config?: Partial<FetcherConfig> & {
|
|
773
|
+
client?: typeof client;
|
|
774
|
+
};
|
|
775
|
+
}): Promise<unknown>;
|
|
776
|
+
/**
|
|
777
|
+
* @description Delete a resource owned by the selected installation ID.
|
|
778
|
+
* @summary Delete Integration Resource
|
|
779
|
+
* {@link v1InstallationsIntegrationConfigurationIdResourcesResourceId}
|
|
780
|
+
*/
|
|
781
|
+
export declare function deleteIntegrationResource({ pathParams: { integrationConfigurationId, resourceId }, config, }: {
|
|
782
|
+
pathParams: DeleteIntegrationResourcePathParams;
|
|
783
|
+
config?: Partial<FetcherConfig> & {
|
|
784
|
+
client?: typeof client;
|
|
785
|
+
};
|
|
786
|
+
}): Promise<unknown>;
|
|
787
|
+
/**
|
|
788
|
+
* @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.
|
|
789
|
+
* @summary Import Resource
|
|
790
|
+
* {@link v1InstallationsIntegrationConfigurationIdResourcesResourceId}
|
|
791
|
+
*/
|
|
792
|
+
export declare function importResource({ pathParams: { integrationConfigurationId, resourceId }, config, }: {
|
|
793
|
+
pathParams: ImportResourcePathParams;
|
|
794
|
+
config?: Partial<FetcherConfig> & {
|
|
795
|
+
client?: typeof client;
|
|
796
|
+
};
|
|
797
|
+
}): Promise<unknown>;
|
|
798
|
+
/**
|
|
799
|
+
* @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.
|
|
800
|
+
* @summary Submit Billing Data
|
|
801
|
+
* {@link v1InstallationsIntegrationConfigurationIdBilling}
|
|
802
|
+
*/
|
|
803
|
+
export declare function submitBillingData({ pathParams: { integrationConfigurationId }, config, }: {
|
|
804
|
+
pathParams: SubmitBillingDataPathParams;
|
|
805
|
+
config?: Partial<FetcherConfig> & {
|
|
806
|
+
client?: typeof client;
|
|
807
|
+
};
|
|
808
|
+
}): Promise<unknown>;
|
|
809
|
+
/**
|
|
810
|
+
* @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/>
|
|
811
|
+
* @summary Submit Invoice
|
|
812
|
+
* {@link v1InstallationsIntegrationConfigurationIdBillingInvoices}
|
|
813
|
+
*/
|
|
814
|
+
export declare function submitInvoice({ pathParams: { integrationConfigurationId }, config, }: {
|
|
815
|
+
pathParams: SubmitInvoicePathParams;
|
|
816
|
+
config?: Partial<FetcherConfig> & {
|
|
817
|
+
client?: typeof client;
|
|
818
|
+
};
|
|
819
|
+
}): Promise<unknown>;
|
|
820
|
+
/**
|
|
821
|
+
* @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.
|
|
822
|
+
* @summary Get Invoice
|
|
823
|
+
* {@link v1InstallationsIntegrationConfigurationIdBillingInvoicesInvoiceId}
|
|
824
|
+
*/
|
|
825
|
+
export declare function getInvoice({ pathParams: { integrationConfigurationId, invoiceId }, config, }: {
|
|
826
|
+
pathParams: GetInvoicePathParams;
|
|
827
|
+
config?: Partial<FetcherConfig> & {
|
|
828
|
+
client?: typeof client;
|
|
829
|
+
};
|
|
830
|
+
}): Promise<unknown>;
|
|
831
|
+
/**
|
|
832
|
+
* @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).
|
|
833
|
+
* @summary Invoice Actions
|
|
834
|
+
* {@link v1InstallationsIntegrationConfigurationIdBillingInvoicesInvoiceIdActions}
|
|
835
|
+
*/
|
|
836
|
+
export declare function updateInvoice({ pathParams: { integrationConfigurationId, invoiceId }, config, }: {
|
|
837
|
+
pathParams: UpdateInvoicePathParams;
|
|
838
|
+
config?: Partial<FetcherConfig> & {
|
|
839
|
+
client?: typeof client;
|
|
840
|
+
};
|
|
841
|
+
}): Promise<unknown>;
|
|
842
|
+
/**
|
|
843
|
+
* @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.
|
|
844
|
+
* @summary Submit Prepayment Balances
|
|
845
|
+
* {@link v1InstallationsIntegrationConfigurationIdBillingBalance}
|
|
846
|
+
*/
|
|
847
|
+
export declare function submitPrepaymentBalances({ pathParams: { integrationConfigurationId }, config, }: {
|
|
848
|
+
pathParams: SubmitPrepaymentBalancesPathParams;
|
|
849
|
+
config?: Partial<FetcherConfig> & {
|
|
850
|
+
client?: typeof client;
|
|
851
|
+
};
|
|
852
|
+
}): Promise<unknown>;
|
|
853
|
+
/**
|
|
854
|
+
* @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/>
|
|
855
|
+
* @summary Update Resource Secrets (Deprecated)
|
|
856
|
+
* {@link v1InstallationsIntegrationConfigurationIdProductsIntegrationProductIdOrSlugResourcesResourceIdSecrets}
|
|
857
|
+
*/
|
|
858
|
+
export declare function updateResourceSecrets({ pathParams: { integrationConfigurationId, integrationProductIdOrSlug, resourceId }, config, }: {
|
|
859
|
+
pathParams: UpdateResourceSecretsPathParams;
|
|
860
|
+
config?: Partial<FetcherConfig> & {
|
|
861
|
+
client?: typeof client;
|
|
862
|
+
};
|
|
863
|
+
}): Promise<unknown>;
|
|
864
|
+
/**
|
|
865
|
+
* @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/>
|
|
866
|
+
* @summary Update Resource Secrets
|
|
867
|
+
* {@link v1InstallationsIntegrationConfigurationIdResourcesResourceIdSecrets}
|
|
868
|
+
*/
|
|
869
|
+
export declare function updateResourceSecretsById({ pathParams: { integrationConfigurationId, resourceId }, config, }: {
|
|
870
|
+
pathParams: UpdateResourceSecretsByIdPathParams;
|
|
871
|
+
config?: Partial<FetcherConfig> & {
|
|
872
|
+
client?: typeof client;
|
|
873
|
+
};
|
|
874
|
+
}): Promise<unknown>;
|
|
875
|
+
/**
|
|
876
|
+
* @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.
|
|
877
|
+
* @summary Get configurations for the authenticated user or team
|
|
878
|
+
* {@link v1IntegrationsConfigurations}
|
|
879
|
+
*/
|
|
880
|
+
export declare function getConfigurations({ queryParams, config, }: {
|
|
881
|
+
queryParams: GetConfigurationsQueryParams;
|
|
882
|
+
config?: Partial<FetcherConfig> & {
|
|
883
|
+
client?: typeof client;
|
|
884
|
+
};
|
|
885
|
+
}): Promise<unknown>;
|
|
886
|
+
/**
|
|
887
|
+
* @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.
|
|
888
|
+
* @summary Retrieve an integration configuration
|
|
889
|
+
* {@link v1IntegrationsConfigurationId}
|
|
890
|
+
*/
|
|
891
|
+
export declare function getConfiguration({ pathParams: { id }, queryParams, config, }: {
|
|
892
|
+
pathParams: GetConfigurationPathParams;
|
|
893
|
+
queryParams?: GetConfigurationQueryParams;
|
|
894
|
+
config?: Partial<FetcherConfig> & {
|
|
895
|
+
client?: typeof client;
|
|
896
|
+
};
|
|
897
|
+
}): Promise<unknown>;
|
|
898
|
+
/**
|
|
899
|
+
* @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.
|
|
900
|
+
* @summary Delete an integration configuration
|
|
901
|
+
* {@link v1IntegrationsConfigurationId}
|
|
902
|
+
*/
|
|
903
|
+
export declare function deleteConfiguration({ pathParams: { id }, queryParams, config, }: {
|
|
904
|
+
pathParams: DeleteConfigurationPathParams;
|
|
905
|
+
queryParams?: DeleteConfigurationQueryParams;
|
|
906
|
+
config?: Partial<FetcherConfig> & {
|
|
907
|
+
client?: typeof client;
|
|
908
|
+
};
|
|
909
|
+
}): Promise<unknown>;
|
|
910
|
+
/**
|
|
911
|
+
* @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.
|
|
912
|
+
* @summary SSO Token Exchange
|
|
913
|
+
* {@link v1IntegrationsSsoToken}
|
|
914
|
+
*/
|
|
915
|
+
export declare function exchangeSsoToken({ config }: {
|
|
916
|
+
config?: Partial<FetcherConfig> & {
|
|
917
|
+
client?: typeof client;
|
|
918
|
+
};
|
|
919
|
+
}): Promise<unknown>;
|
|
920
|
+
/**
|
|
921
|
+
* @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.
|
|
922
|
+
* @summary Retrieves a list of Integration log drains
|
|
923
|
+
* {@link v2IntegrationsLogDrains}
|
|
924
|
+
*/
|
|
925
|
+
export declare function getIntegrationLogDrains({ queryParams, config, }: {
|
|
926
|
+
queryParams?: GetIntegrationLogDrainsQueryParams;
|
|
927
|
+
config?: Partial<FetcherConfig> & {
|
|
928
|
+
client?: typeof client;
|
|
929
|
+
};
|
|
930
|
+
}): Promise<unknown>;
|
|
931
|
+
/**
|
|
932
|
+
* @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.
|
|
933
|
+
* @summary Creates a new Integration Log Drain
|
|
934
|
+
* {@link v2IntegrationsLogDrains}
|
|
935
|
+
*/
|
|
936
|
+
export declare function createLogDrain({ queryParams, config, }: {
|
|
937
|
+
queryParams?: CreateLogDrainQueryParams;
|
|
938
|
+
config?: Partial<FetcherConfig> & {
|
|
939
|
+
client?: typeof client;
|
|
940
|
+
};
|
|
941
|
+
}): Promise<unknown>;
|
|
942
|
+
/**
|
|
943
|
+
* @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.
|
|
944
|
+
* @summary Deletes the Integration log drain with the provided `id`
|
|
945
|
+
* {@link v1IntegrationsLogDrainsId}
|
|
946
|
+
*/
|
|
947
|
+
export declare function deleteIntegrationLogDrain({ pathParams: { id }, queryParams, config, }: {
|
|
948
|
+
pathParams: DeleteIntegrationLogDrainPathParams;
|
|
949
|
+
queryParams?: DeleteIntegrationLogDrainQueryParams;
|
|
950
|
+
config?: Partial<FetcherConfig> & {
|
|
951
|
+
client?: typeof client;
|
|
952
|
+
};
|
|
953
|
+
}): Promise<unknown>;
|
|
954
|
+
/**
|
|
955
|
+
* @description Returns a stream of logs for a given deployment.
|
|
956
|
+
* @summary Get logs for a deployment
|
|
957
|
+
* {@link v1ProjectsProjectIdDeploymentsDeploymentIdRuntimeLogs}
|
|
958
|
+
*/
|
|
959
|
+
export declare function getRuntimeLogs({ pathParams: { projectId, deploymentId }, queryParams, config, }: {
|
|
960
|
+
pathParams: GetRuntimeLogsPathParams;
|
|
961
|
+
queryParams?: GetRuntimeLogsQueryParams;
|
|
962
|
+
config?: Partial<FetcherConfig> & {
|
|
963
|
+
client?: typeof client;
|
|
964
|
+
};
|
|
965
|
+
}): Promise<unknown>;
|
|
966
|
+
/**
|
|
967
|
+
* @description Create one or multiple experimentation items
|
|
968
|
+
* @summary Create one or multiple experimentation items
|
|
969
|
+
* {@link v1InstallationsIntegrationConfigurationIdResourcesResourceIdExperimentationItems}
|
|
970
|
+
*/
|
|
971
|
+
export declare function createExperimentationItem({ pathParams: { integrationConfigurationId, resourceId }, config, }: {
|
|
972
|
+
pathParams: CreateExperimentationItemPathParams;
|
|
973
|
+
config?: Partial<FetcherConfig> & {
|
|
974
|
+
client?: typeof client;
|
|
975
|
+
};
|
|
976
|
+
}): Promise<unknown>;
|
|
977
|
+
/**
|
|
978
|
+
* @description Patch an existing experimentation item
|
|
979
|
+
* @summary Patch an existing experimentation item
|
|
980
|
+
* {@link v1InstallationsIntegrationConfigurationIdResourcesResourceIdExperimentationItemsItemId}
|
|
981
|
+
*/
|
|
982
|
+
export declare function updateExperimentationItem({ pathParams: { integrationConfigurationId, resourceId, itemId }, config, }: {
|
|
983
|
+
pathParams: UpdateExperimentationItemPathParams;
|
|
984
|
+
config?: Partial<FetcherConfig> & {
|
|
985
|
+
client?: typeof client;
|
|
986
|
+
};
|
|
987
|
+
}): Promise<unknown>;
|
|
988
|
+
/**
|
|
989
|
+
* @description Delete an existing experimentation item
|
|
990
|
+
* @summary Delete an existing experimentation item
|
|
991
|
+
* {@link v1InstallationsIntegrationConfigurationIdResourcesResourceIdExperimentationItemsItemId}
|
|
992
|
+
*/
|
|
993
|
+
export declare function deleteExperimentationItem({ pathParams: { integrationConfigurationId, resourceId, itemId }, config, }: {
|
|
994
|
+
pathParams: DeleteExperimentationItemPathParams;
|
|
995
|
+
config?: Partial<FetcherConfig> & {
|
|
996
|
+
client?: typeof client;
|
|
997
|
+
};
|
|
998
|
+
}): Promise<unknown>;
|
|
999
|
+
/**
|
|
1000
|
+
* @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.
|
|
1001
|
+
* @summary Push data into a user-provided Edge Config
|
|
1002
|
+
* {@link v1InstallationsIntegrationConfigurationIdResourcesResourceIdExperimentationEdgeConfig}
|
|
1003
|
+
*/
|
|
1004
|
+
export declare function updateExperimentationEdgeConfig({ pathParams: { integrationConfigurationId, resourceId }, config, }: {
|
|
1005
|
+
pathParams: UpdateExperimentationEdgeConfigPathParams;
|
|
1006
|
+
config?: Partial<FetcherConfig> & {
|
|
1007
|
+
client?: typeof client;
|
|
1008
|
+
};
|
|
1009
|
+
}): Promise<unknown>;
|
|
1010
|
+
/**
|
|
1011
|
+
* @description Lists all members of a project.
|
|
1012
|
+
* @summary List project members
|
|
1013
|
+
* {@link v1ProjectsIdOrNameMembers}
|
|
1014
|
+
*/
|
|
1015
|
+
export declare function getProjectMembers({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1016
|
+
pathParams: GetProjectMembersPathParams;
|
|
1017
|
+
queryParams?: GetProjectMembersQueryParams;
|
|
1018
|
+
config?: Partial<FetcherConfig> & {
|
|
1019
|
+
client?: typeof client;
|
|
1020
|
+
};
|
|
1021
|
+
}): Promise<unknown>;
|
|
1022
|
+
/**
|
|
1023
|
+
* @description Adds a new member to the project.
|
|
1024
|
+
* @summary Adds a new member to a project.
|
|
1025
|
+
* {@link v1ProjectsIdOrNameMembers}
|
|
1026
|
+
*/
|
|
1027
|
+
export declare function addProjectMember({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1028
|
+
pathParams: AddProjectMemberPathParams;
|
|
1029
|
+
queryParams?: AddProjectMemberQueryParams;
|
|
1030
|
+
config?: Partial<FetcherConfig> & {
|
|
1031
|
+
client?: typeof client;
|
|
1032
|
+
};
|
|
1033
|
+
}): Promise<unknown>;
|
|
1034
|
+
/**
|
|
1035
|
+
* @description Remove a member from a specific project
|
|
1036
|
+
* @summary Remove a Project Member
|
|
1037
|
+
* {@link v1ProjectsIdOrNameMembersUid}
|
|
1038
|
+
*/
|
|
1039
|
+
export declare function removeProjectMember({ pathParams: { idOrName, uid }, queryParams, config, }: {
|
|
1040
|
+
pathParams: RemoveProjectMemberPathParams;
|
|
1041
|
+
queryParams?: RemoveProjectMemberQueryParams;
|
|
1042
|
+
config?: Partial<FetcherConfig> & {
|
|
1043
|
+
client?: typeof client;
|
|
1044
|
+
};
|
|
1045
|
+
}): Promise<unknown>;
|
|
1046
|
+
/**
|
|
1047
|
+
* @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.
|
|
1048
|
+
* @summary Retrieve a list of projects
|
|
1049
|
+
* {@link v10Projects}
|
|
1050
|
+
*/
|
|
1051
|
+
export declare function getProjects({ queryParams, config, }: {
|
|
1052
|
+
queryParams?: GetProjectsQueryParams;
|
|
1053
|
+
config?: Partial<FetcherConfig> & {
|
|
1054
|
+
client?: typeof client;
|
|
1055
|
+
};
|
|
1056
|
+
}): Promise<unknown>;
|
|
1057
|
+
/**
|
|
1058
|
+
* @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.
|
|
1059
|
+
* @summary Create a new project
|
|
1060
|
+
* {@link v11Projects}
|
|
1061
|
+
*/
|
|
1062
|
+
export declare function createProject({ queryParams, config, }: {
|
|
1063
|
+
queryParams?: CreateProjectQueryParams;
|
|
1064
|
+
config?: Partial<FetcherConfig> & {
|
|
1065
|
+
client?: typeof client;
|
|
1066
|
+
};
|
|
1067
|
+
}): Promise<unknown>;
|
|
1068
|
+
/**
|
|
1069
|
+
* @description Get the information for a specific project by passing either the project `id` or `name` in the URL.
|
|
1070
|
+
* @summary Find a project by id or name
|
|
1071
|
+
* {@link v9ProjectsIdOrName}
|
|
1072
|
+
*/
|
|
1073
|
+
export declare function getProject({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1074
|
+
pathParams: GetProjectPathParams;
|
|
1075
|
+
queryParams?: GetProjectQueryParams;
|
|
1076
|
+
config?: Partial<FetcherConfig> & {
|
|
1077
|
+
client?: typeof client;
|
|
1078
|
+
};
|
|
1079
|
+
}): Promise<unknown>;
|
|
1080
|
+
/**
|
|
1081
|
+
* @description Update the fields of a project using either its `name` or `id`.
|
|
1082
|
+
* @summary Update an existing project
|
|
1083
|
+
* {@link v9ProjectsIdOrName}
|
|
1084
|
+
*/
|
|
1085
|
+
export declare function updateProject({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1086
|
+
pathParams: UpdateProjectPathParams;
|
|
1087
|
+
queryParams?: UpdateProjectQueryParams;
|
|
1088
|
+
config?: Partial<FetcherConfig> & {
|
|
1089
|
+
client?: typeof client;
|
|
1090
|
+
};
|
|
1091
|
+
}): Promise<unknown>;
|
|
1092
|
+
/**
|
|
1093
|
+
* @description Delete a specific project by passing either the project `id` or `name` in the URL.
|
|
1094
|
+
* @summary Delete a Project
|
|
1095
|
+
* {@link v9ProjectsIdOrName}
|
|
1096
|
+
*/
|
|
1097
|
+
export declare function deleteProject({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1098
|
+
pathParams: DeleteProjectPathParams;
|
|
1099
|
+
queryParams?: DeleteProjectQueryParams;
|
|
1100
|
+
config?: Partial<FetcherConfig> & {
|
|
1101
|
+
client?: typeof client;
|
|
1102
|
+
};
|
|
1103
|
+
}): Promise<unknown>;
|
|
1104
|
+
/**
|
|
1105
|
+
* @description Creates a custom environment for the current project. Cannot be named 'Production' or 'Preview'.
|
|
1106
|
+
* @summary Create a custom environment for the current project.
|
|
1107
|
+
* {@link v9ProjectsIdOrNameCustomEnvironments}
|
|
1108
|
+
*/
|
|
1109
|
+
export declare function createCustomEnvironment({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1110
|
+
pathParams: CreateCustomEnvironmentPathParams;
|
|
1111
|
+
queryParams?: CreateCustomEnvironmentQueryParams;
|
|
1112
|
+
config?: Partial<FetcherConfig> & {
|
|
1113
|
+
client?: typeof client;
|
|
1114
|
+
};
|
|
1115
|
+
}): Promise<unknown>;
|
|
1116
|
+
/**
|
|
1117
|
+
* @description Retrieve custom environments for the project. Must not be named 'Production' or 'Preview'.
|
|
1118
|
+
* @summary Retrieve custom environments
|
|
1119
|
+
* {@link v9ProjectsIdOrNameCustomEnvironments}
|
|
1120
|
+
*/
|
|
1121
|
+
export declare function listCustomEnvironments({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1122
|
+
pathParams: ListCustomEnvironmentsPathParams;
|
|
1123
|
+
queryParams?: ListCustomEnvironmentsQueryParams;
|
|
1124
|
+
config?: Partial<FetcherConfig> & {
|
|
1125
|
+
client?: typeof client;
|
|
1126
|
+
};
|
|
1127
|
+
}): Promise<unknown>;
|
|
1128
|
+
/**
|
|
1129
|
+
* @description Retrieve a custom environment for the project. Must not be named 'Production' or 'Preview'.
|
|
1130
|
+
* @summary Retrieve a custom environment
|
|
1131
|
+
* {@link v9ProjectsIdOrNameCustomEnvironmentsEnvironmentSlugOrId}
|
|
1132
|
+
*/
|
|
1133
|
+
export declare function getCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config, }: {
|
|
1134
|
+
pathParams: GetCustomEnvironmentPathParams;
|
|
1135
|
+
queryParams?: GetCustomEnvironmentQueryParams;
|
|
1136
|
+
config?: Partial<FetcherConfig> & {
|
|
1137
|
+
client?: typeof client;
|
|
1138
|
+
};
|
|
1139
|
+
}): Promise<unknown>;
|
|
1140
|
+
/**
|
|
1141
|
+
* @description Update a custom environment for the project. Must not be named 'Production' or 'Preview'.
|
|
1142
|
+
* @summary Update a custom environment
|
|
1143
|
+
* {@link v9ProjectsIdOrNameCustomEnvironmentsEnvironmentSlugOrId}
|
|
1144
|
+
*/
|
|
1145
|
+
export declare function updateCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config, }: {
|
|
1146
|
+
pathParams: UpdateCustomEnvironmentPathParams;
|
|
1147
|
+
queryParams?: UpdateCustomEnvironmentQueryParams;
|
|
1148
|
+
config?: Partial<FetcherConfig> & {
|
|
1149
|
+
client?: typeof client;
|
|
1150
|
+
};
|
|
1151
|
+
}): Promise<unknown>;
|
|
1152
|
+
/**
|
|
1153
|
+
* @description Remove a custom environment for the project. Must not be named 'Production' or 'Preview'.
|
|
1154
|
+
* @summary Remove a custom environment
|
|
1155
|
+
* {@link v9ProjectsIdOrNameCustomEnvironmentsEnvironmentSlugOrId}
|
|
1156
|
+
*/
|
|
1157
|
+
export declare function removeCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config, }: {
|
|
1158
|
+
pathParams: RemoveCustomEnvironmentPathParams;
|
|
1159
|
+
queryParams?: RemoveCustomEnvironmentQueryParams;
|
|
1160
|
+
config?: Partial<FetcherConfig> & {
|
|
1161
|
+
client?: typeof client;
|
|
1162
|
+
};
|
|
1163
|
+
}): Promise<unknown>;
|
|
1164
|
+
/**
|
|
1165
|
+
* @description Retrieve the domains associated with a given project by passing either the project `id` or `name` in the URL.
|
|
1166
|
+
* @summary Retrieve project domains by project by id or name
|
|
1167
|
+
* {@link v9ProjectsIdOrNameDomains}
|
|
1168
|
+
*/
|
|
1169
|
+
export declare function getProjectDomains({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1170
|
+
pathParams: GetProjectDomainsPathParams;
|
|
1171
|
+
queryParams?: GetProjectDomainsQueryParams;
|
|
1172
|
+
config?: Partial<FetcherConfig> & {
|
|
1173
|
+
client?: typeof client;
|
|
1174
|
+
};
|
|
1175
|
+
}): Promise<unknown>;
|
|
1176
|
+
/**
|
|
1177
|
+
* @description Get project domain by project id/name and domain name.
|
|
1178
|
+
* @summary Get a project domain
|
|
1179
|
+
* {@link v9ProjectsIdOrNameDomainsDomain}
|
|
1180
|
+
*/
|
|
1181
|
+
export declare function getProjectDomain({ pathParams: { idOrName, domain }, queryParams, config, }: {
|
|
1182
|
+
pathParams: GetProjectDomainPathParams;
|
|
1183
|
+
queryParams?: GetProjectDomainQueryParams;
|
|
1184
|
+
config?: Partial<FetcherConfig> & {
|
|
1185
|
+
client?: typeof client;
|
|
1186
|
+
};
|
|
1187
|
+
}): Promise<unknown>;
|
|
1188
|
+
/**
|
|
1189
|
+
* @description Update a project domain's configuration, including the name, git branch and redirect of the domain.
|
|
1190
|
+
* @summary Update a project domain
|
|
1191
|
+
* {@link v9ProjectsIdOrNameDomainsDomain}
|
|
1192
|
+
*/
|
|
1193
|
+
export declare function updateProjectDomain({ pathParams: { idOrName, domain }, queryParams, config, }: {
|
|
1194
|
+
pathParams: UpdateProjectDomainPathParams;
|
|
1195
|
+
queryParams?: UpdateProjectDomainQueryParams;
|
|
1196
|
+
config?: Partial<FetcherConfig> & {
|
|
1197
|
+
client?: typeof client;
|
|
1198
|
+
};
|
|
1199
|
+
}): Promise<unknown>;
|
|
1200
|
+
/**
|
|
1201
|
+
* @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.
|
|
1202
|
+
* @summary Remove a domain from a project
|
|
1203
|
+
* {@link v9ProjectsIdOrNameDomainsDomain}
|
|
1204
|
+
*/
|
|
1205
|
+
export declare function removeProjectDomain({ pathParams: { idOrName, domain }, queryParams, config, }: {
|
|
1206
|
+
pathParams: RemoveProjectDomainPathParams;
|
|
1207
|
+
queryParams?: RemoveProjectDomainQueryParams;
|
|
1208
|
+
config?: Partial<FetcherConfig> & {
|
|
1209
|
+
client?: typeof client;
|
|
1210
|
+
};
|
|
1211
|
+
}): Promise<unknown>;
|
|
1212
|
+
/**
|
|
1213
|
+
* @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.
|
|
1214
|
+
* @summary Add a domain to a project
|
|
1215
|
+
* {@link v10ProjectsIdOrNameDomains}
|
|
1216
|
+
*/
|
|
1217
|
+
export declare function addProjectDomain({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1218
|
+
pathParams: AddProjectDomainPathParams;
|
|
1219
|
+
queryParams?: AddProjectDomainQueryParams;
|
|
1220
|
+
config?: Partial<FetcherConfig> & {
|
|
1221
|
+
client?: typeof client;
|
|
1222
|
+
};
|
|
1223
|
+
}): Promise<unknown>;
|
|
1224
|
+
/**
|
|
1225
|
+
* @description Move one project's domain to another project. Also allows the move of all redirects pointed to that domain in the same project.
|
|
1226
|
+
* @summary Move a project domain
|
|
1227
|
+
* {@link v1ProjectsIdOrNameDomainsDomainMove}
|
|
1228
|
+
*/
|
|
1229
|
+
export declare function moveProjectDomain({ pathParams: { idOrName, domain }, queryParams, config, }: {
|
|
1230
|
+
pathParams: MoveProjectDomainPathParams;
|
|
1231
|
+
queryParams?: MoveProjectDomainQueryParams;
|
|
1232
|
+
config?: Partial<FetcherConfig> & {
|
|
1233
|
+
client?: typeof client;
|
|
1234
|
+
};
|
|
1235
|
+
}): Promise<unknown>;
|
|
1236
|
+
/**
|
|
1237
|
+
* @description Attempts to verify a project domain with `verified = false` by checking the correctness of the project domain's `verification` challenge.
|
|
1238
|
+
* @summary Verify project domain
|
|
1239
|
+
* {@link v9ProjectsIdOrNameDomainsDomainVerify}
|
|
1240
|
+
*/
|
|
1241
|
+
export declare function verifyProjectDomain({ pathParams: { idOrName, domain }, queryParams, config, }: {
|
|
1242
|
+
pathParams: VerifyProjectDomainPathParams;
|
|
1243
|
+
queryParams?: VerifyProjectDomainQueryParams;
|
|
1244
|
+
config?: Partial<FetcherConfig> & {
|
|
1245
|
+
client?: typeof client;
|
|
1246
|
+
};
|
|
1247
|
+
}): Promise<unknown>;
|
|
1248
|
+
/**
|
|
1249
|
+
* @description Retrieve the environment variables for a given project by passing either the project `id` or `name` in the URL.
|
|
1250
|
+
* @summary Retrieve the environment variables of a project by id or name
|
|
1251
|
+
* {@link v10ProjectsIdOrNameEnv}
|
|
1252
|
+
*/
|
|
1253
|
+
export declare function filterProjectEnvs({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1254
|
+
pathParams: FilterProjectEnvsPathParams;
|
|
1255
|
+
queryParams?: FilterProjectEnvsQueryParams;
|
|
1256
|
+
config?: Partial<FetcherConfig> & {
|
|
1257
|
+
client?: typeof client;
|
|
1258
|
+
};
|
|
1259
|
+
}): Promise<unknown>;
|
|
1260
|
+
/**
|
|
1261
|
+
* @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.
|
|
1262
|
+
* @summary Create one or more environment variables
|
|
1263
|
+
* {@link v10ProjectsIdOrNameEnv}
|
|
1264
|
+
*/
|
|
1265
|
+
export declare function createProjectEnv({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1266
|
+
pathParams: CreateProjectEnvPathParams;
|
|
1267
|
+
queryParams?: CreateProjectEnvQueryParams;
|
|
1268
|
+
config?: Partial<FetcherConfig> & {
|
|
1269
|
+
client?: typeof client;
|
|
1270
|
+
};
|
|
1271
|
+
}): Promise<unknown>;
|
|
1272
|
+
/**
|
|
1273
|
+
* @description Retrieve the environment variable for a given project.
|
|
1274
|
+
* @summary Retrieve the decrypted value of an environment variable of a project by id
|
|
1275
|
+
* {@link v1ProjectsIdOrNameEnvId}
|
|
1276
|
+
*/
|
|
1277
|
+
export declare function getProjectEnv({ pathParams: { idOrName, id }, queryParams, config, }: {
|
|
1278
|
+
pathParams: GetProjectEnvPathParams;
|
|
1279
|
+
queryParams?: GetProjectEnvQueryParams;
|
|
1280
|
+
config?: Partial<FetcherConfig> & {
|
|
1281
|
+
client?: typeof client;
|
|
1282
|
+
};
|
|
1283
|
+
}): Promise<unknown>;
|
|
1284
|
+
/**
|
|
1285
|
+
* @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.
|
|
1286
|
+
* @summary Remove an environment variable
|
|
1287
|
+
* {@link v9ProjectsIdOrNameEnvId}
|
|
1288
|
+
*/
|
|
1289
|
+
export declare function removeProjectEnv({ pathParams: { idOrName, id }, queryParams, config, }: {
|
|
1290
|
+
pathParams: RemoveProjectEnvPathParams;
|
|
1291
|
+
queryParams?: RemoveProjectEnvQueryParams;
|
|
1292
|
+
config?: Partial<FetcherConfig> & {
|
|
1293
|
+
client?: typeof client;
|
|
1294
|
+
};
|
|
1295
|
+
}): Promise<unknown>;
|
|
1296
|
+
/**
|
|
1297
|
+
* @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.
|
|
1298
|
+
* @summary Edit an environment variable
|
|
1299
|
+
* {@link v9ProjectsIdOrNameEnvId}
|
|
1300
|
+
*/
|
|
1301
|
+
export declare function editProjectEnv({ pathParams: { idOrName, id }, queryParams, config, }: {
|
|
1302
|
+
pathParams: EditProjectEnvPathParams;
|
|
1303
|
+
queryParams?: EditProjectEnvQueryParams;
|
|
1304
|
+
config?: Partial<FetcherConfig> & {
|
|
1305
|
+
client?: typeof client;
|
|
1306
|
+
};
|
|
1307
|
+
}): Promise<unknown>;
|
|
1308
|
+
/**
|
|
1309
|
+
* @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.
|
|
1310
|
+
* @summary Get rolling release billing status
|
|
1311
|
+
* {@link v1ProjectsIdOrNameRollingReleaseBilling}
|
|
1312
|
+
*/
|
|
1313
|
+
export declare function getRollingReleaseBillingStatus({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1314
|
+
pathParams: GetRollingReleaseBillingStatusPathParams;
|
|
1315
|
+
queryParams?: GetRollingReleaseBillingStatusQueryParams;
|
|
1316
|
+
config?: Partial<FetcherConfig> & {
|
|
1317
|
+
client?: typeof client;
|
|
1318
|
+
};
|
|
1319
|
+
}): Promise<unknown>;
|
|
1320
|
+
/**
|
|
1321
|
+
* @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.
|
|
1322
|
+
* @summary Get rolling release configuration
|
|
1323
|
+
* {@link v1ProjectsIdOrNameRollingReleaseConfig}
|
|
1324
|
+
*/
|
|
1325
|
+
export declare function getRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1326
|
+
pathParams: GetRollingReleaseConfigPathParams;
|
|
1327
|
+
queryParams?: GetRollingReleaseConfigQueryParams;
|
|
1328
|
+
config?: Partial<FetcherConfig> & {
|
|
1329
|
+
client?: typeof client;
|
|
1330
|
+
};
|
|
1331
|
+
}): Promise<unknown>;
|
|
1332
|
+
/**
|
|
1333
|
+
* @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.
|
|
1334
|
+
* @summary Delete rolling release configuration
|
|
1335
|
+
* {@link v1ProjectsIdOrNameRollingReleaseConfig}
|
|
1336
|
+
*/
|
|
1337
|
+
export declare function deleteRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1338
|
+
pathParams: DeleteRollingReleaseConfigPathParams;
|
|
1339
|
+
queryParams?: DeleteRollingReleaseConfigQueryParams;
|
|
1340
|
+
config?: Partial<FetcherConfig> & {
|
|
1341
|
+
client?: typeof client;
|
|
1342
|
+
};
|
|
1343
|
+
}): Promise<unknown>;
|
|
1344
|
+
/**
|
|
1345
|
+
* @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.
|
|
1346
|
+
* @summary Update the rolling release settings for the project
|
|
1347
|
+
* {@link v1ProjectsIdOrNameRollingReleaseConfig}
|
|
1348
|
+
*/
|
|
1349
|
+
export declare function updateRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1350
|
+
pathParams: UpdateRollingReleaseConfigPathParams;
|
|
1351
|
+
queryParams?: UpdateRollingReleaseConfigQueryParams;
|
|
1352
|
+
config?: Partial<FetcherConfig> & {
|
|
1353
|
+
client?: typeof client;
|
|
1354
|
+
};
|
|
1355
|
+
}): Promise<unknown>;
|
|
1356
|
+
/**
|
|
1357
|
+
* @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.
|
|
1358
|
+
* @summary Get the active rolling release information for a project
|
|
1359
|
+
* {@link v1ProjectsIdOrNameRollingRelease}
|
|
1360
|
+
*/
|
|
1361
|
+
export declare function getRollingRelease({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1362
|
+
pathParams: GetRollingReleasePathParams;
|
|
1363
|
+
queryParams?: GetRollingReleaseQueryParams;
|
|
1364
|
+
config?: Partial<FetcherConfig> & {
|
|
1365
|
+
client?: typeof client;
|
|
1366
|
+
};
|
|
1367
|
+
}): Promise<unknown>;
|
|
1368
|
+
/**
|
|
1369
|
+
* @description Advance a rollout to the next stage. This is only needed when rolling releases is configured to require manual approval.
|
|
1370
|
+
* @summary Update the active rolling release to the next stage for a project
|
|
1371
|
+
* {@link v1ProjectsIdOrNameRollingReleaseApproveStage}
|
|
1372
|
+
*/
|
|
1373
|
+
export declare function approveRollingReleaseStage({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1374
|
+
pathParams: ApproveRollingReleaseStagePathParams;
|
|
1375
|
+
queryParams?: ApproveRollingReleaseStageQueryParams;
|
|
1376
|
+
config?: Partial<FetcherConfig> & {
|
|
1377
|
+
client?: typeof client;
|
|
1378
|
+
};
|
|
1379
|
+
}): Promise<unknown>;
|
|
1380
|
+
/**
|
|
1381
|
+
* @description Force-complete a Rolling Release. The canary deployment will begin serving 100% of the traffic.
|
|
1382
|
+
* @summary Complete the rolling release for the project
|
|
1383
|
+
* {@link v1ProjectsIdOrNameRollingReleaseComplete}
|
|
1384
|
+
*/
|
|
1385
|
+
export declare function completeRollingRelease({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1386
|
+
pathParams: CompleteRollingReleasePathParams;
|
|
1387
|
+
queryParams?: CompleteRollingReleaseQueryParams;
|
|
1388
|
+
config?: Partial<FetcherConfig> & {
|
|
1389
|
+
client?: typeof client;
|
|
1390
|
+
};
|
|
1391
|
+
}): Promise<unknown>;
|
|
1392
|
+
/**
|
|
1393
|
+
* @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.
|
|
1394
|
+
* @summary Create project transfer request
|
|
1395
|
+
* {@link projectsIdOrNameTransferRequest}
|
|
1396
|
+
*/
|
|
1397
|
+
export declare function createProjectTransferRequest({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1398
|
+
pathParams: CreateProjectTransferRequestPathParams;
|
|
1399
|
+
queryParams?: CreateProjectTransferRequestQueryParams;
|
|
1400
|
+
config?: Partial<FetcherConfig> & {
|
|
1401
|
+
client?: typeof client;
|
|
1402
|
+
};
|
|
1403
|
+
}): Promise<unknown>;
|
|
1404
|
+
/**
|
|
1405
|
+
* @description Accept a project transfer request initated by another team. <br/> The `code` is generated using the `POST /projects/:idOrName/transfer-request` endpoint.
|
|
1406
|
+
* @summary Accept project transfer request
|
|
1407
|
+
* {@link projectsTransferRequestCode}
|
|
1408
|
+
*/
|
|
1409
|
+
export declare function acceptProjectTransferRequest({ pathParams: { code }, queryParams, config, }: {
|
|
1410
|
+
pathParams: AcceptProjectTransferRequestPathParams;
|
|
1411
|
+
queryParams?: AcceptProjectTransferRequestQueryParams;
|
|
1412
|
+
config?: Partial<FetcherConfig> & {
|
|
1413
|
+
client?: typeof client;
|
|
1414
|
+
};
|
|
1415
|
+
}): Promise<unknown>;
|
|
1416
|
+
/**
|
|
1417
|
+
* @description Update the deployment protection automation bypass for a project
|
|
1418
|
+
* @summary Update Protection Bypass for Automation
|
|
1419
|
+
* {@link v1ProjectsIdOrNameProtectionBypass}
|
|
1420
|
+
*/
|
|
1421
|
+
export declare function updateProjectProtectionBypass({ pathParams: { idOrName }, queryParams, config, }: {
|
|
1422
|
+
pathParams: UpdateProjectProtectionBypassPathParams;
|
|
1423
|
+
queryParams?: UpdateProjectProtectionBypassQueryParams;
|
|
1424
|
+
config?: Partial<FetcherConfig> & {
|
|
1425
|
+
client?: typeof client;
|
|
1426
|
+
};
|
|
1427
|
+
}): Promise<unknown>;
|
|
1428
|
+
/**
|
|
1429
|
+
* @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.
|
|
1430
|
+
* @summary Points all production domains for a project to the given deploy
|
|
1431
|
+
* {@link v10ProjectsProjectIdPromoteDeploymentId}
|
|
1432
|
+
*/
|
|
1433
|
+
export declare function requestPromote({ pathParams: { projectId, deploymentId }, queryParams, config, }: {
|
|
1434
|
+
pathParams: RequestPromotePathParams;
|
|
1435
|
+
queryParams?: RequestPromoteQueryParams;
|
|
1436
|
+
config?: Partial<FetcherConfig> & {
|
|
1437
|
+
client?: typeof client;
|
|
1438
|
+
};
|
|
1439
|
+
}): Promise<unknown>;
|
|
1440
|
+
/**
|
|
1441
|
+
* @description Get a list of aliases related to the last promote request with their mapping status
|
|
1442
|
+
* @summary Gets a list of aliases with status for the current promote
|
|
1443
|
+
* {@link v1ProjectsProjectIdPromoteAliases}
|
|
1444
|
+
*/
|
|
1445
|
+
export declare function listPromoteAliases({ pathParams: { projectId }, queryParams, config, }: {
|
|
1446
|
+
pathParams: ListPromoteAliasesPathParams;
|
|
1447
|
+
queryParams?: ListPromoteAliasesQueryParams;
|
|
1448
|
+
config?: Partial<FetcherConfig> & {
|
|
1449
|
+
client?: typeof client;
|
|
1450
|
+
};
|
|
1451
|
+
}): Promise<unknown>;
|
|
1452
|
+
/**
|
|
1453
|
+
* @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.
|
|
1454
|
+
* @summary Pause a project
|
|
1455
|
+
* {@link v1ProjectsProjectIdPause}
|
|
1456
|
+
*/
|
|
1457
|
+
export declare function pauseProject({ pathParams: { projectId }, queryParams, config, }: {
|
|
1458
|
+
pathParams: PauseProjectPathParams;
|
|
1459
|
+
queryParams?: PauseProjectQueryParams;
|
|
1460
|
+
config?: Partial<FetcherConfig> & {
|
|
1461
|
+
client?: typeof client;
|
|
1462
|
+
};
|
|
1463
|
+
}): Promise<unknown>;
|
|
1464
|
+
/**
|
|
1465
|
+
* @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.
|
|
1466
|
+
* @summary Unpause a project
|
|
1467
|
+
* {@link v1ProjectsProjectIdUnpause}
|
|
1468
|
+
*/
|
|
1469
|
+
export declare function unpauseProject({ pathParams: { projectId }, queryParams, config, }: {
|
|
1470
|
+
pathParams: UnpauseProjectPathParams;
|
|
1471
|
+
queryParams?: UnpauseProjectQueryParams;
|
|
1472
|
+
config?: Partial<FetcherConfig> & {
|
|
1473
|
+
client?: typeof client;
|
|
1474
|
+
};
|
|
1475
|
+
}): Promise<unknown>;
|
|
1476
|
+
/**
|
|
1477
|
+
* @description Update the setting for determining if the project has Attack Challenge mode enabled.
|
|
1478
|
+
* @summary Update Attack Challenge mode
|
|
1479
|
+
* {@link v1SecurityAttackMode}
|
|
1480
|
+
*/
|
|
1481
|
+
export declare function updateAttackChallengeMode({ queryParams, config, }: {
|
|
1482
|
+
queryParams?: UpdateAttackChallengeModeQueryParams;
|
|
1483
|
+
config?: Partial<FetcherConfig> & {
|
|
1484
|
+
client?: typeof client;
|
|
1485
|
+
};
|
|
1486
|
+
}): Promise<unknown>;
|
|
1487
|
+
/**
|
|
1488
|
+
* @description Set the firewall configuration to provided rules and settings. Creates or overwrite the existing firewall configuration.
|
|
1489
|
+
* @summary Put Firewall Configuration
|
|
1490
|
+
* {@link v1SecurityFirewallConfig}
|
|
1491
|
+
*/
|
|
1492
|
+
export declare function putFirewallConfig({ queryParams, config, }: {
|
|
1493
|
+
queryParams: PutFirewallConfigQueryParams;
|
|
1494
|
+
config?: Partial<FetcherConfig> & {
|
|
1495
|
+
client?: typeof client;
|
|
1496
|
+
};
|
|
1497
|
+
}): Promise<unknown>;
|
|
1498
|
+
/**
|
|
1499
|
+
* @description Process updates to modify the existing firewall config for a project
|
|
1500
|
+
* @summary Update Firewall Configuration
|
|
1501
|
+
* {@link v1SecurityFirewallConfig}
|
|
1502
|
+
*/
|
|
1503
|
+
export declare function updateFirewallConfig({ queryParams, config, }: {
|
|
1504
|
+
queryParams: UpdateFirewallConfigQueryParams;
|
|
1505
|
+
config?: Partial<FetcherConfig> & {
|
|
1506
|
+
client?: typeof client;
|
|
1507
|
+
};
|
|
1508
|
+
}): Promise<unknown>;
|
|
1509
|
+
/**
|
|
1510
|
+
* @description Retrieve the specified firewall configuration for a project. The deployed configVersion will be `active`
|
|
1511
|
+
* @summary Read Firewall Configuration
|
|
1512
|
+
* {@link v1SecurityFirewallConfigConfigVersion}
|
|
1513
|
+
*/
|
|
1514
|
+
export declare function getFirewallConfig({ pathParams: { configVersion }, queryParams, config, }: {
|
|
1515
|
+
pathParams: GetFirewallConfigPathParams;
|
|
1516
|
+
queryParams: GetFirewallConfigQueryParams;
|
|
1517
|
+
config?: Partial<FetcherConfig> & {
|
|
1518
|
+
client?: typeof client;
|
|
1519
|
+
};
|
|
1520
|
+
}): Promise<unknown>;
|
|
1521
|
+
/**
|
|
1522
|
+
* @description Retrieve active attack data within the last 24h window
|
|
1523
|
+
* @summary Read active attack data
|
|
1524
|
+
* {@link v1SecurityFirewallAttackStatus}
|
|
1525
|
+
*/
|
|
1526
|
+
export declare function getActiveAttackStatus({ queryParams, config, }: {
|
|
1527
|
+
queryParams: GetActiveAttackStatusQueryParams;
|
|
1528
|
+
config?: Partial<FetcherConfig> & {
|
|
1529
|
+
client?: typeof client;
|
|
1530
|
+
};
|
|
1531
|
+
}): Promise<unknown>;
|
|
1532
|
+
/**
|
|
1533
|
+
* @description Retrieve the system bypass rules configured for the specified project
|
|
1534
|
+
* @summary Read System Bypass
|
|
1535
|
+
* {@link v1SecurityFirewallBypass}
|
|
1536
|
+
*/
|
|
1537
|
+
export declare function getBypassIp({ queryParams, config, }: {
|
|
1538
|
+
queryParams: GetBypassIpQueryParams;
|
|
1539
|
+
config?: Partial<FetcherConfig> & {
|
|
1540
|
+
client?: typeof client;
|
|
1541
|
+
};
|
|
1542
|
+
}): Promise<unknown>;
|
|
1543
|
+
/**
|
|
1544
|
+
* @description Create new system bypass rules
|
|
1545
|
+
* @summary Create System Bypass Rule
|
|
1546
|
+
* {@link v1SecurityFirewallBypass}
|
|
1547
|
+
*/
|
|
1548
|
+
export declare function addBypassIp({ queryParams, config, }: {
|
|
1549
|
+
queryParams: AddBypassIpQueryParams;
|
|
1550
|
+
config?: Partial<FetcherConfig> & {
|
|
1551
|
+
client?: typeof client;
|
|
1552
|
+
};
|
|
1553
|
+
}): Promise<unknown>;
|
|
1554
|
+
/**
|
|
1555
|
+
* @description Remove system bypass rules
|
|
1556
|
+
* @summary Remove System Bypass Rule
|
|
1557
|
+
* {@link v1SecurityFirewallBypass}
|
|
1558
|
+
*/
|
|
1559
|
+
export declare function removeBypassIp({ queryParams, config, }: {
|
|
1560
|
+
queryParams: RemoveBypassIpQueryParams;
|
|
1561
|
+
config?: Partial<FetcherConfig> & {
|
|
1562
|
+
client?: typeof client;
|
|
1563
|
+
};
|
|
1564
|
+
}): Promise<unknown>;
|
|
1565
|
+
/**
|
|
1566
|
+
* @description Get a paginated list of team members for the provided team.
|
|
1567
|
+
* @summary List team members
|
|
1568
|
+
* {@link v3TeamsTeamIdMembers}
|
|
1569
|
+
*/
|
|
1570
|
+
export declare function getTeamMembers({ pathParams: { teamId }, queryParams, config, }: {
|
|
1571
|
+
pathParams: GetTeamMembersPathParams;
|
|
1572
|
+
queryParams?: GetTeamMembersQueryParams;
|
|
1573
|
+
config?: Partial<FetcherConfig> & {
|
|
1574
|
+
client?: typeof client;
|
|
1575
|
+
};
|
|
1576
|
+
}): Promise<unknown>;
|
|
1577
|
+
/**
|
|
1578
|
+
* @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.
|
|
1579
|
+
* @summary Invite a user
|
|
1580
|
+
* {@link v1TeamsTeamIdMembers}
|
|
1581
|
+
*/
|
|
1582
|
+
export declare function inviteUserToTeam({ pathParams: { teamId }, config, }: {
|
|
1583
|
+
pathParams: InviteUserToTeamPathParams;
|
|
1584
|
+
config?: Partial<FetcherConfig> & {
|
|
1585
|
+
client?: typeof client;
|
|
1586
|
+
};
|
|
1587
|
+
}): Promise<unknown>;
|
|
1588
|
+
/**
|
|
1589
|
+
* @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.
|
|
1590
|
+
* @summary Request access to a team
|
|
1591
|
+
* {@link v1TeamsTeamIdRequest}
|
|
1592
|
+
*/
|
|
1593
|
+
export declare function requestAccessToTeam({ pathParams: { teamId }, config, }: {
|
|
1594
|
+
pathParams: RequestAccessToTeamPathParams;
|
|
1595
|
+
config?: Partial<FetcherConfig> & {
|
|
1596
|
+
client?: typeof client;
|
|
1597
|
+
};
|
|
1598
|
+
}): Promise<unknown>;
|
|
1599
|
+
/**
|
|
1600
|
+
* @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.
|
|
1601
|
+
* @summary Get access request status
|
|
1602
|
+
* {@link v1TeamsTeamIdRequestUserId}
|
|
1603
|
+
*/
|
|
1604
|
+
export declare function getTeamAccessRequest({ pathParams: { userId, teamId }, config, }: {
|
|
1605
|
+
pathParams: GetTeamAccessRequestPathParams;
|
|
1606
|
+
config?: Partial<FetcherConfig> & {
|
|
1607
|
+
client?: typeof client;
|
|
1608
|
+
};
|
|
1609
|
+
}): Promise<unknown>;
|
|
1610
|
+
/**
|
|
1611
|
+
* @description Join a team with a provided invite code or team ID.
|
|
1612
|
+
* @summary Join a team
|
|
1613
|
+
* {@link v1TeamsTeamIdMembersTeamsJoin}
|
|
1614
|
+
*/
|
|
1615
|
+
export declare function joinTeam({ pathParams: { teamId }, config, }: {
|
|
1616
|
+
pathParams: JoinTeamPathParams;
|
|
1617
|
+
config?: Partial<FetcherConfig> & {
|
|
1618
|
+
client?: typeof client;
|
|
1619
|
+
};
|
|
1620
|
+
}): Promise<unknown>;
|
|
1621
|
+
/**
|
|
1622
|
+
* @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.
|
|
1623
|
+
* @summary Update a Team Member
|
|
1624
|
+
* {@link v1TeamsTeamIdMembersUid}
|
|
1625
|
+
*/
|
|
1626
|
+
export declare function updateTeamMember({ pathParams: { uid, teamId }, config, }: {
|
|
1627
|
+
pathParams: UpdateTeamMemberPathParams;
|
|
1628
|
+
config?: Partial<FetcherConfig> & {
|
|
1629
|
+
client?: typeof client;
|
|
1630
|
+
};
|
|
1631
|
+
}): Promise<unknown>;
|
|
1632
|
+
/**
|
|
1633
|
+
* @description Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team.
|
|
1634
|
+
* @summary Remove a Team Member
|
|
1635
|
+
* {@link v1TeamsTeamIdMembersUid}
|
|
1636
|
+
*/
|
|
1637
|
+
export declare function removeTeamMember({ pathParams: { uid, teamId }, queryParams, config, }: {
|
|
1638
|
+
pathParams: RemoveTeamMemberPathParams;
|
|
1639
|
+
queryParams?: RemoveTeamMemberQueryParams;
|
|
1640
|
+
config?: Partial<FetcherConfig> & {
|
|
1641
|
+
client?: typeof client;
|
|
1642
|
+
};
|
|
1643
|
+
}): Promise<unknown>;
|
|
1644
|
+
/**
|
|
1645
|
+
* @description Get information for the Team specified by the `teamId` parameter.
|
|
1646
|
+
* @summary Get a Team
|
|
1647
|
+
* {@link v2TeamsTeamId}
|
|
1648
|
+
*/
|
|
1649
|
+
export declare function getTeam({ pathParams: { teamId }, queryParams, config, }: {
|
|
1650
|
+
pathParams: GetTeamPathParams;
|
|
1651
|
+
queryParams?: GetTeamQueryParams;
|
|
1652
|
+
config?: Partial<FetcherConfig> & {
|
|
1653
|
+
client?: typeof client;
|
|
1654
|
+
};
|
|
1655
|
+
}): Promise<unknown>;
|
|
1656
|
+
/**
|
|
1657
|
+
* @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.
|
|
1658
|
+
* @summary Update a Team
|
|
1659
|
+
* {@link v2TeamsTeamId}
|
|
1660
|
+
*/
|
|
1661
|
+
export declare function patchTeam({ pathParams: { teamId }, queryParams, config, }: {
|
|
1662
|
+
pathParams: PatchTeamPathParams;
|
|
1663
|
+
queryParams?: PatchTeamQueryParams;
|
|
1664
|
+
config?: Partial<FetcherConfig> & {
|
|
1665
|
+
client?: typeof client;
|
|
1666
|
+
};
|
|
1667
|
+
}): Promise<unknown>;
|
|
1668
|
+
/**
|
|
1669
|
+
* @description Get a paginated list of all the Teams the authenticated User is a member of.
|
|
1670
|
+
* @summary List all teams
|
|
1671
|
+
* {@link v2Teams}
|
|
1672
|
+
*/
|
|
1673
|
+
export declare function getTeams({ queryParams, config, }: {
|
|
1674
|
+
queryParams?: GetTeamsQueryParams;
|
|
1675
|
+
config?: Partial<FetcherConfig> & {
|
|
1676
|
+
client?: typeof client;
|
|
1677
|
+
};
|
|
1678
|
+
}): Promise<unknown>;
|
|
1679
|
+
/**
|
|
1680
|
+
* @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.
|
|
1681
|
+
* @summary Create a Team
|
|
1682
|
+
* {@link v1Teams}
|
|
1683
|
+
*/
|
|
1684
|
+
export declare function createTeam({ config }: {
|
|
1685
|
+
config?: Partial<FetcherConfig> & {
|
|
1686
|
+
client?: typeof client;
|
|
1687
|
+
};
|
|
1688
|
+
}): Promise<unknown>;
|
|
1689
|
+
/**
|
|
1690
|
+
* @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.
|
|
1691
|
+
* @summary Delete a Team
|
|
1692
|
+
* {@link v1TeamsTeamId}
|
|
1693
|
+
*/
|
|
1694
|
+
export declare function deleteTeam({ pathParams: { teamId }, queryParams, config, }: {
|
|
1695
|
+
pathParams: DeleteTeamPathParams;
|
|
1696
|
+
queryParams?: DeleteTeamQueryParams;
|
|
1697
|
+
config?: Partial<FetcherConfig> & {
|
|
1698
|
+
client?: typeof client;
|
|
1699
|
+
};
|
|
1700
|
+
}): Promise<unknown>;
|
|
1701
|
+
/**
|
|
1702
|
+
* @description Delete an active Team invite code.
|
|
1703
|
+
* @summary Delete a Team invite code
|
|
1704
|
+
* {@link v1TeamsTeamIdInvitesInviteId}
|
|
1705
|
+
*/
|
|
1706
|
+
export declare function deleteTeamInviteCode({ pathParams: { inviteId, teamId }, config, }: {
|
|
1707
|
+
pathParams: DeleteTeamInviteCodePathParams;
|
|
1708
|
+
config?: Partial<FetcherConfig> & {
|
|
1709
|
+
client?: typeof client;
|
|
1710
|
+
};
|
|
1711
|
+
}): Promise<unknown>;
|
|
1712
|
+
/**
|
|
1713
|
+
* @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.
|
|
1714
|
+
* @summary Upload Deployment Files
|
|
1715
|
+
* {@link v2Files}
|
|
1716
|
+
*/
|
|
1717
|
+
export declare function uploadFile({ queryParams, headers, config, }: {
|
|
1718
|
+
queryParams?: UploadFileQueryParams;
|
|
1719
|
+
headers?: UploadFileHeaderParams;
|
|
1720
|
+
config?: Partial<FetcherConfig> & {
|
|
1721
|
+
client?: typeof client;
|
|
1722
|
+
};
|
|
1723
|
+
}): Promise<unknown>;
|
|
1724
|
+
/**
|
|
1725
|
+
* @description Retrieve a list of the current User's authentication tokens.
|
|
1726
|
+
* @summary List Auth Tokens
|
|
1727
|
+
* {@link v5UserTokens}
|
|
1728
|
+
*/
|
|
1729
|
+
export declare function listAuthTokens({ config }: {
|
|
1730
|
+
config?: Partial<FetcherConfig> & {
|
|
1731
|
+
client?: typeof client;
|
|
1732
|
+
};
|
|
1733
|
+
}): Promise<unknown>;
|
|
1734
|
+
/**
|
|
1735
|
+
* @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.
|
|
1736
|
+
* @summary Create an Auth Token
|
|
1737
|
+
* {@link v3UserTokens}
|
|
1738
|
+
*/
|
|
1739
|
+
export declare function createAuthToken({ queryParams, config, }: {
|
|
1740
|
+
queryParams?: CreateAuthTokenQueryParams;
|
|
1741
|
+
config?: Partial<FetcherConfig> & {
|
|
1742
|
+
client?: typeof client;
|
|
1743
|
+
};
|
|
1744
|
+
}): Promise<unknown>;
|
|
1745
|
+
/**
|
|
1746
|
+
* @description Retrieve metadata about an authentication token belonging to the currently authenticated User.
|
|
1747
|
+
* @summary Get Auth Token Metadata
|
|
1748
|
+
* {@link v5UserTokensTokenId}
|
|
1749
|
+
*/
|
|
1750
|
+
export declare function getAuthToken({ pathParams: { tokenId }, config, }: {
|
|
1751
|
+
pathParams: GetAuthTokenPathParams;
|
|
1752
|
+
config?: Partial<FetcherConfig> & {
|
|
1753
|
+
client?: typeof client;
|
|
1754
|
+
};
|
|
1755
|
+
}): Promise<unknown>;
|
|
1756
|
+
/**
|
|
1757
|
+
* @description Invalidate an authentication token, such that it will no longer be valid for future HTTP requests.
|
|
1758
|
+
* @summary Delete an authentication token
|
|
1759
|
+
* {@link v3UserTokensTokenId}
|
|
1760
|
+
*/
|
|
1761
|
+
export declare function deleteAuthToken({ pathParams: { tokenId }, config, }: {
|
|
1762
|
+
pathParams: DeleteAuthTokenPathParams;
|
|
1763
|
+
config?: Partial<FetcherConfig> & {
|
|
1764
|
+
client?: typeof client;
|
|
1765
|
+
};
|
|
1766
|
+
}): Promise<unknown>;
|
|
1767
|
+
/**
|
|
1768
|
+
* @description Retrieves information related to the currently authenticated User.
|
|
1769
|
+
* @summary Get the User
|
|
1770
|
+
* {@link v2User}
|
|
1771
|
+
*/
|
|
1772
|
+
export declare function getAuthUser({ config }: {
|
|
1773
|
+
config?: Partial<FetcherConfig> & {
|
|
1774
|
+
client?: typeof client;
|
|
1775
|
+
};
|
|
1776
|
+
}): Promise<unknown>;
|
|
1777
|
+
/**
|
|
1778
|
+
* @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.
|
|
1779
|
+
* @summary Delete User Account
|
|
1780
|
+
* {@link v1User}
|
|
1781
|
+
*/
|
|
1782
|
+
export declare function requestDelete({ config }: {
|
|
1783
|
+
config?: Partial<FetcherConfig> & {
|
|
1784
|
+
client?: typeof client;
|
|
1785
|
+
};
|
|
1786
|
+
}): Promise<unknown>;
|
|
1787
|
+
/**
|
|
1788
|
+
* @description Creates a webhook
|
|
1789
|
+
* @summary Creates a webhook
|
|
1790
|
+
* {@link v1Webhooks}
|
|
1791
|
+
*/
|
|
1792
|
+
export declare function createWebhook({ queryParams, config, }: {
|
|
1793
|
+
queryParams?: CreateWebhookQueryParams;
|
|
1794
|
+
config?: Partial<FetcherConfig> & {
|
|
1795
|
+
client?: typeof client;
|
|
1796
|
+
};
|
|
1797
|
+
}): Promise<unknown>;
|
|
1798
|
+
/**
|
|
1799
|
+
* @description Get a list of webhooks
|
|
1800
|
+
* @summary Get a list of webhooks
|
|
1801
|
+
* {@link v1Webhooks}
|
|
1802
|
+
*/
|
|
1803
|
+
export declare function getWebhooks({ queryParams, config, }: {
|
|
1804
|
+
queryParams?: GetWebhooksQueryParams;
|
|
1805
|
+
config?: Partial<FetcherConfig> & {
|
|
1806
|
+
client?: typeof client;
|
|
1807
|
+
};
|
|
1808
|
+
}): Promise<unknown>;
|
|
1809
|
+
/**
|
|
1810
|
+
* @description Get a webhook
|
|
1811
|
+
* @summary Get a webhook
|
|
1812
|
+
* {@link v1WebhooksId}
|
|
1813
|
+
*/
|
|
1814
|
+
export declare function getWebhook({ pathParams: { id }, queryParams, config, }: {
|
|
1815
|
+
pathParams: GetWebhookPathParams;
|
|
1816
|
+
queryParams?: GetWebhookQueryParams;
|
|
1817
|
+
config?: Partial<FetcherConfig> & {
|
|
1818
|
+
client?: typeof client;
|
|
1819
|
+
};
|
|
1820
|
+
}): Promise<unknown>;
|
|
1821
|
+
/**
|
|
1822
|
+
* @description Deletes a webhook
|
|
1823
|
+
* @summary Deletes a webhook
|
|
1824
|
+
* {@link v1WebhooksId}
|
|
1825
|
+
*/
|
|
1826
|
+
export declare function deleteWebhook({ pathParams: { id }, queryParams, config, }: {
|
|
1827
|
+
pathParams: DeleteWebhookPathParams;
|
|
1828
|
+
queryParams?: DeleteWebhookQueryParams;
|
|
1829
|
+
config?: Partial<FetcherConfig> & {
|
|
1830
|
+
client?: typeof client;
|
|
1831
|
+
};
|
|
1832
|
+
}): Promise<unknown>;
|
|
1833
|
+
/**
|
|
1834
|
+
* @description Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment.
|
|
1835
|
+
* @summary List Deployment Aliases
|
|
1836
|
+
* {@link v2DeploymentsIdAliases}
|
|
1837
|
+
*/
|
|
1838
|
+
export declare function listDeploymentAliases({ pathParams: { id }, queryParams, config, }: {
|
|
1839
|
+
pathParams: ListDeploymentAliasesPathParams;
|
|
1840
|
+
queryParams?: ListDeploymentAliasesQueryParams;
|
|
1841
|
+
config?: Partial<FetcherConfig> & {
|
|
1842
|
+
client?: typeof client;
|
|
1843
|
+
};
|
|
1844
|
+
}): Promise<unknown>;
|
|
1845
|
+
/**
|
|
1846
|
+
* @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.
|
|
1847
|
+
* @summary Assign an Alias
|
|
1848
|
+
* {@link v2DeploymentsIdAliases}
|
|
1849
|
+
*/
|
|
1850
|
+
export declare function assignAlias({ pathParams: { id }, queryParams, config, }: {
|
|
1851
|
+
pathParams: AssignAliasPathParams;
|
|
1852
|
+
queryParams?: AssignAliasQueryParams;
|
|
1853
|
+
config?: Partial<FetcherConfig> & {
|
|
1854
|
+
client?: typeof client;
|
|
1855
|
+
};
|
|
1856
|
+
}): Promise<unknown>;
|
|
1857
|
+
/**
|
|
1858
|
+
* @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.
|
|
1859
|
+
* @summary List aliases
|
|
1860
|
+
* {@link v4Aliases}
|
|
1861
|
+
*/
|
|
1862
|
+
export declare function listAliases({ queryParams, config, }: {
|
|
1863
|
+
queryParams?: ListAliasesQueryParams;
|
|
1864
|
+
config?: Partial<FetcherConfig> & {
|
|
1865
|
+
client?: typeof client;
|
|
1866
|
+
};
|
|
1867
|
+
}): Promise<unknown>;
|
|
1868
|
+
/**
|
|
1869
|
+
* @description Retrieves an Alias for the given host name or alias ID.
|
|
1870
|
+
* @summary Get an Alias
|
|
1871
|
+
* {@link v4AliasesIdOrAlias}
|
|
1872
|
+
*/
|
|
1873
|
+
export declare function getAlias({ pathParams: { idOrAlias }, queryParams, config, }: {
|
|
1874
|
+
pathParams: GetAliasPathParams;
|
|
1875
|
+
queryParams?: GetAliasQueryParams;
|
|
1876
|
+
config?: Partial<FetcherConfig> & {
|
|
1877
|
+
client?: typeof client;
|
|
1878
|
+
};
|
|
1879
|
+
}): Promise<unknown>;
|
|
1880
|
+
/**
|
|
1881
|
+
* @description Delete an Alias with the specified ID.
|
|
1882
|
+
* @summary Delete an Alias
|
|
1883
|
+
* {@link v2AliasesAliasId}
|
|
1884
|
+
*/
|
|
1885
|
+
export declare function deleteAlias({ pathParams: { aliasId }, queryParams, config, }: {
|
|
1886
|
+
pathParams: DeleteAliasPathParams;
|
|
1887
|
+
queryParams?: DeleteAliasQueryParams;
|
|
1888
|
+
config?: Partial<FetcherConfig> & {
|
|
1889
|
+
client?: typeof client;
|
|
1890
|
+
};
|
|
1891
|
+
}): Promise<unknown>;
|
|
1892
|
+
/**
|
|
1893
|
+
* @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).
|
|
1894
|
+
* @summary Update the protection bypass for a URL
|
|
1895
|
+
* {@link aliasesIdProtectionBypass}
|
|
1896
|
+
*/
|
|
1897
|
+
export declare function patchUrlProtectionBypass({ pathParams: { id }, queryParams, config, }: {
|
|
1898
|
+
pathParams: PatchUrlProtectionBypassPathParams;
|
|
1899
|
+
queryParams?: PatchUrlProtectionBypassQueryParams;
|
|
1900
|
+
config?: Partial<FetcherConfig> & {
|
|
1901
|
+
client?: typeof client;
|
|
1902
|
+
};
|
|
1903
|
+
}): Promise<unknown>;
|
|
1904
|
+
/**
|
|
1905
|
+
* {@link certs}
|
|
1906
|
+
*/
|
|
1907
|
+
export declare function listCerts({ config }: {
|
|
1908
|
+
config?: Partial<FetcherConfig> & {
|
|
1909
|
+
client?: typeof client;
|
|
1910
|
+
};
|
|
1911
|
+
}): Promise<unknown>;
|
|
1912
|
+
/**
|
|
1913
|
+
* @description Get cert by id
|
|
1914
|
+
* @summary Get cert by id
|
|
1915
|
+
* {@link v8CertsId}
|
|
1916
|
+
*/
|
|
1917
|
+
export declare function getCertById({ pathParams: { id }, queryParams, config, }: {
|
|
1918
|
+
pathParams: GetCertByIdPathParams;
|
|
1919
|
+
queryParams?: GetCertByIdQueryParams;
|
|
1920
|
+
config?: Partial<FetcherConfig> & {
|
|
1921
|
+
client?: typeof client;
|
|
1922
|
+
};
|
|
1923
|
+
}): Promise<unknown>;
|
|
1924
|
+
/**
|
|
1925
|
+
* @description Remove cert
|
|
1926
|
+
* @summary Remove cert
|
|
1927
|
+
* {@link v8CertsId}
|
|
1928
|
+
*/
|
|
1929
|
+
export declare function removeCert({ pathParams: { id }, queryParams, config, }: {
|
|
1930
|
+
pathParams: RemoveCertPathParams;
|
|
1931
|
+
queryParams?: RemoveCertQueryParams;
|
|
1932
|
+
config?: Partial<FetcherConfig> & {
|
|
1933
|
+
client?: typeof client;
|
|
1934
|
+
};
|
|
1935
|
+
}): Promise<unknown>;
|
|
1936
|
+
/**
|
|
1937
|
+
* @description Issue a new cert
|
|
1938
|
+
* @summary Issue a new cert
|
|
1939
|
+
* {@link v8Certs}
|
|
1940
|
+
*/
|
|
1941
|
+
export declare function issueCert({ queryParams, config, }: {
|
|
1942
|
+
queryParams?: IssueCertQueryParams;
|
|
1943
|
+
config?: Partial<FetcherConfig> & {
|
|
1944
|
+
client?: typeof client;
|
|
1945
|
+
};
|
|
1946
|
+
}): Promise<unknown>;
|
|
1947
|
+
/**
|
|
1948
|
+
* @description Upload a cert
|
|
1949
|
+
* @summary Upload a cert
|
|
1950
|
+
* {@link v8Certs}
|
|
1951
|
+
*/
|
|
1952
|
+
export declare function uploadCert({ queryParams, config, }: {
|
|
1953
|
+
queryParams?: UploadCertQueryParams;
|
|
1954
|
+
config?: Partial<FetcherConfig> & {
|
|
1955
|
+
client?: typeof client;
|
|
1956
|
+
};
|
|
1957
|
+
}): Promise<unknown>;
|
|
1958
|
+
/**
|
|
1959
|
+
* @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.
|
|
1960
|
+
* @summary List Deployment Files
|
|
1961
|
+
* {@link v6DeploymentsIdFiles}
|
|
1962
|
+
*/
|
|
1963
|
+
export declare function listDeploymentFiles({ pathParams: { id }, queryParams, config, }: {
|
|
1964
|
+
pathParams: ListDeploymentFilesPathParams;
|
|
1965
|
+
queryParams?: ListDeploymentFilesQueryParams;
|
|
1966
|
+
config?: Partial<FetcherConfig> & {
|
|
1967
|
+
client?: typeof client;
|
|
1968
|
+
};
|
|
1969
|
+
}): Promise<unknown>;
|
|
1970
|
+
/**
|
|
1971
|
+
* @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.
|
|
1972
|
+
* @summary Get Deployment File Contents
|
|
1973
|
+
* {@link v8DeploymentsIdFilesFileId}
|
|
1974
|
+
*/
|
|
1975
|
+
export declare function getDeploymentFileContents({ pathParams: { id, fileId }, queryParams, config, }: {
|
|
1976
|
+
pathParams: GetDeploymentFileContentsPathParams;
|
|
1977
|
+
queryParams?: GetDeploymentFileContentsQueryParams;
|
|
1978
|
+
config?: Partial<FetcherConfig> & {
|
|
1979
|
+
client?: typeof client;
|
|
1980
|
+
};
|
|
1981
|
+
}): Promise<any>;
|
|
1982
|
+
/**
|
|
1983
|
+
* @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`.
|
|
1984
|
+
* @summary List deployments
|
|
1985
|
+
* {@link v6Deployments}
|
|
1986
|
+
*/
|
|
1987
|
+
export declare function getDeployments({ queryParams, config, }: {
|
|
1988
|
+
queryParams?: GetDeploymentsQueryParams;
|
|
1989
|
+
config?: Partial<FetcherConfig> & {
|
|
1990
|
+
client?: typeof client;
|
|
1991
|
+
};
|
|
1992
|
+
}): Promise<unknown>;
|
|
1993
|
+
/**
|
|
1994
|
+
* @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.
|
|
1995
|
+
* @summary Delete a Deployment
|
|
1996
|
+
* {@link v13DeploymentsId}
|
|
1997
|
+
*/
|
|
1998
|
+
export declare function deleteDeployment({ pathParams: { id }, queryParams, config, }: {
|
|
1999
|
+
pathParams: DeleteDeploymentPathParams;
|
|
2000
|
+
queryParams?: DeleteDeploymentQueryParams;
|
|
2001
|
+
config?: Partial<FetcherConfig> & {
|
|
2002
|
+
client?: typeof client;
|
|
2003
|
+
};
|
|
2004
|
+
}): Promise<unknown>;
|
|
2005
|
+
/**
|
|
2006
|
+
* @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.
|
|
2007
|
+
* @summary List secrets
|
|
2008
|
+
* {@link v3Secrets}
|
|
2009
|
+
*/
|
|
2010
|
+
export declare function getSecrets({ queryParams, config, }: {
|
|
2011
|
+
queryParams?: GetSecretsQueryParams;
|
|
2012
|
+
config?: Partial<FetcherConfig> & {
|
|
2013
|
+
client?: typeof client;
|
|
2014
|
+
};
|
|
2015
|
+
}): Promise<unknown>;
|
|
2016
|
+
/**
|
|
2017
|
+
* @description Allows to create a new secret.
|
|
2018
|
+
* @summary Create a new secret
|
|
2019
|
+
* {@link v2SecretsName}
|
|
2020
|
+
*/
|
|
2021
|
+
export declare function createSecret({ pathParams: { name }, queryParams, config, }: {
|
|
2022
|
+
pathParams: CreateSecretPathParams;
|
|
2023
|
+
queryParams?: CreateSecretQueryParams;
|
|
2024
|
+
config?: Partial<FetcherConfig> & {
|
|
2025
|
+
client?: typeof client;
|
|
2026
|
+
};
|
|
2027
|
+
}): Promise<unknown>;
|
|
2028
|
+
/**
|
|
2029
|
+
* @description Enables to edit the name of a secret. The name has to be unique to the user or team’s secrets.
|
|
2030
|
+
* @summary Change secret name
|
|
2031
|
+
* {@link v2SecretsName}
|
|
2032
|
+
*/
|
|
2033
|
+
export declare function renameSecret({ pathParams: { name }, queryParams, config, }: {
|
|
2034
|
+
pathParams: RenameSecretPathParams;
|
|
2035
|
+
queryParams?: RenameSecretQueryParams;
|
|
2036
|
+
config?: Partial<FetcherConfig> & {
|
|
2037
|
+
client?: typeof client;
|
|
2038
|
+
};
|
|
2039
|
+
}): Promise<unknown>;
|
|
2040
|
+
/**
|
|
2041
|
+
* @description Retrieves the information for a specific secret by passing either the secret id or name in the URL.
|
|
2042
|
+
* @summary Get a single secret
|
|
2043
|
+
* {@link v3SecretsIdOrName}
|
|
2044
|
+
*/
|
|
2045
|
+
export declare function getSecret({ pathParams: { idOrName }, queryParams, config, }: {
|
|
2046
|
+
pathParams: GetSecretPathParams;
|
|
2047
|
+
queryParams?: GetSecretQueryParams;
|
|
2048
|
+
config?: Partial<FetcherConfig> & {
|
|
2049
|
+
client?: typeof client;
|
|
2050
|
+
};
|
|
2051
|
+
}): Promise<unknown>;
|
|
2052
|
+
/**
|
|
2053
|
+
* @description This deletes the user or team’s secret defined in the URL.
|
|
2054
|
+
* @summary Delete a secret
|
|
2055
|
+
* {@link v2SecretsIdOrName}
|
|
2056
|
+
*/
|
|
2057
|
+
export declare function deleteSecret({ pathParams: { idOrName }, queryParams, config, }: {
|
|
2058
|
+
pathParams: DeleteSecretPathParams;
|
|
2059
|
+
queryParams?: DeleteSecretQueryParams;
|
|
2060
|
+
config?: Partial<FetcherConfig> & {
|
|
2061
|
+
client?: typeof client;
|
|
2062
|
+
};
|
|
2063
|
+
}): Promise<unknown>;
|
|
2064
|
+
export declare const operationsByPath: {
|
|
2065
|
+
'GET v1AccessGroupsIdOrName': typeof readAccessGroup;
|
|
2066
|
+
'POST v1AccessGroupsIdOrName': typeof updateAccessGroup;
|
|
2067
|
+
'DELETE v1AccessGroupsIdOrName': typeof deleteAccessGroup;
|
|
2068
|
+
'GET v1AccessGroupsIdOrNameMembers': typeof listAccessGroupMembers;
|
|
2069
|
+
'GET v1AccessGroups': typeof listAccessGroups;
|
|
2070
|
+
'POST v1AccessGroups': typeof createAccessGroup;
|
|
2071
|
+
'GET v1AccessGroupsIdOrNameProjects': typeof listAccessGroupProjects;
|
|
2072
|
+
'POST v1AccessGroupsAccessGroupIdOrNameProjects': typeof createAccessGroupProject;
|
|
2073
|
+
'GET v1AccessGroupsAccessGroupIdOrNameProjectsProjectId': typeof readAccessGroupProject;
|
|
2074
|
+
'PATCH v1AccessGroupsAccessGroupIdOrNameProjectsProjectId': typeof updateAccessGroupProject;
|
|
2075
|
+
'DELETE v1AccessGroupsAccessGroupIdOrNameProjectsProjectId': typeof deleteAccessGroupProject;
|
|
2076
|
+
'POST v8ArtifactsEvents': typeof recordEvents;
|
|
2077
|
+
'GET v8ArtifactsStatus': typeof status;
|
|
2078
|
+
'PUT v8ArtifactsHash': typeof uploadArtifact;
|
|
2079
|
+
'GET v8ArtifactsHash': typeof downloadArtifact;
|
|
2080
|
+
'POST v8Artifacts': typeof artifactQuery;
|
|
2081
|
+
'POST v1DeploymentsDeploymentIdChecks': typeof createCheck;
|
|
2082
|
+
'GET v1DeploymentsDeploymentIdChecks': typeof getAllChecks;
|
|
2083
|
+
'GET v1DeploymentsDeploymentIdChecksCheckId': typeof getCheck;
|
|
2084
|
+
'PATCH v1DeploymentsDeploymentIdChecksCheckId': typeof updateCheck;
|
|
2085
|
+
'POST v1DeploymentsDeploymentIdChecksCheckIdRerequest': typeof rerequestCheck;
|
|
2086
|
+
'DELETE dataCachePurgeAll': typeof purgeAllDataCache;
|
|
2087
|
+
'PATCH dataCacheBillingSettings': typeof updateDataCacheBillingSettings;
|
|
2088
|
+
'PATCH v1DataCacheProjectsProjectId': typeof updateProjectDataCache;
|
|
2089
|
+
'GET v3DeploymentsIdOrUrlEvents': typeof getDeploymentEvents;
|
|
2090
|
+
'PATCH v1DeploymentsDeploymentIdIntegrationsIntegrationConfigurationIdResourcesResourceIdActionsAction': typeof updateIntegrationDeploymentAction;
|
|
2091
|
+
'GET v13DeploymentsIdOrUrl': typeof getDeployment;
|
|
2092
|
+
'POST v13Deployments': typeof createDeployment;
|
|
2093
|
+
'PATCH v12DeploymentsIdCancel': typeof cancelDeployment;
|
|
2094
|
+
'POST v5DomainsBuy': typeof buyDomain;
|
|
2095
|
+
'GET v4DomainsPrice': typeof checkDomainPrice;
|
|
2096
|
+
'GET v4DomainsStatus': typeof checkDomainStatus;
|
|
2097
|
+
'GET v4DomainsDomainRecords': typeof getRecords;
|
|
2098
|
+
'POST v2DomainsDomainRecords': typeof createRecord;
|
|
2099
|
+
'PATCH v1DomainsRecordsRecordId': typeof updateRecord;
|
|
2100
|
+
'DELETE v2DomainsDomainRecordsRecordId': typeof removeRecord;
|
|
2101
|
+
'GET v1DomainsDomainRegistry': typeof getDomainTransfer;
|
|
2102
|
+
'GET v6DomainsDomainConfig': typeof getDomainConfig;
|
|
2103
|
+
'GET v5DomainsDomain': typeof getDomain;
|
|
2104
|
+
'GET v5Domains': typeof getDomains;
|
|
2105
|
+
'POST v7Domains': typeof createOrTransferDomain;
|
|
2106
|
+
'PATCH v3DomainsDomain': typeof patchDomain;
|
|
2107
|
+
'DELETE v6DomainsDomain': typeof deleteDomain;
|
|
2108
|
+
'GET v1EdgeConfig': typeof getEdgeConfigs;
|
|
2109
|
+
'POST v1EdgeConfig': typeof createEdgeConfig;
|
|
2110
|
+
'GET v1EdgeConfigEdgeConfigId': typeof getEdgeConfig;
|
|
2111
|
+
'PUT v1EdgeConfigEdgeConfigId': typeof updateEdgeConfig;
|
|
2112
|
+
'DELETE v1EdgeConfigEdgeConfigId': typeof deleteEdgeConfig;
|
|
2113
|
+
'GET v1EdgeConfigEdgeConfigIdItems': typeof getEdgeConfigItems;
|
|
2114
|
+
'PATCH v1EdgeConfigEdgeConfigIdItems': typeof patchEdgeConfigItems;
|
|
2115
|
+
'GET v1EdgeConfigEdgeConfigIdSchema': typeof getEdgeConfigSchema;
|
|
2116
|
+
'POST v1EdgeConfigEdgeConfigIdSchema': typeof patchEdgeConfigSchema;
|
|
2117
|
+
'DELETE v1EdgeConfigEdgeConfigIdSchema': typeof deleteEdgeConfigSchema;
|
|
2118
|
+
'GET v1EdgeConfigEdgeConfigIdItemEdgeConfigItemKey': typeof getEdgeConfigItem;
|
|
2119
|
+
'GET v1EdgeConfigEdgeConfigIdTokens': typeof getEdgeConfigTokens;
|
|
2120
|
+
'DELETE v1EdgeConfigEdgeConfigIdTokens': typeof deleteEdgeConfigTokens;
|
|
2121
|
+
'GET v1EdgeConfigEdgeConfigIdTokenToken': typeof getEdgeConfigToken;
|
|
2122
|
+
'POST v1EdgeConfigEdgeConfigIdToken': typeof createEdgeConfigToken;
|
|
2123
|
+
'GET v1EdgeConfigEdgeConfigIdBackupsEdgeConfigBackupVersionId': typeof getEdgeConfigBackup;
|
|
2124
|
+
'GET v1EdgeConfigEdgeConfigIdBackups': typeof getEdgeConfigBackups;
|
|
2125
|
+
'GET v3Events': typeof listUserEvents;
|
|
2126
|
+
'GET v1InstallationsIntegrationConfigurationIdAccount': typeof getAccountInfo;
|
|
2127
|
+
'GET v1InstallationsIntegrationConfigurationIdMemberMemberId': typeof getMember;
|
|
2128
|
+
'POST v1InstallationsIntegrationConfigurationIdEvents': typeof createEvent;
|
|
2129
|
+
'GET v1InstallationsIntegrationConfigurationIdResources': typeof getIntegrationResources;
|
|
2130
|
+
'GET v1InstallationsIntegrationConfigurationIdResourcesResourceId': typeof getIntegrationResource;
|
|
2131
|
+
'DELETE v1InstallationsIntegrationConfigurationIdResourcesResourceId': typeof deleteIntegrationResource;
|
|
2132
|
+
'PUT v1InstallationsIntegrationConfigurationIdResourcesResourceId': typeof importResource;
|
|
2133
|
+
'POST v1InstallationsIntegrationConfigurationIdBilling': typeof submitBillingData;
|
|
2134
|
+
'POST v1InstallationsIntegrationConfigurationIdBillingInvoices': typeof submitInvoice;
|
|
2135
|
+
'GET v1InstallationsIntegrationConfigurationIdBillingInvoicesInvoiceId': typeof getInvoice;
|
|
2136
|
+
'POST v1InstallationsIntegrationConfigurationIdBillingInvoicesInvoiceIdActions': typeof updateInvoice;
|
|
2137
|
+
'POST v1InstallationsIntegrationConfigurationIdBillingBalance': typeof submitPrepaymentBalances;
|
|
2138
|
+
'PUT v1InstallationsIntegrationConfigurationIdProductsIntegrationProductIdOrSlugResourcesResourceIdSecrets': typeof updateResourceSecrets;
|
|
2139
|
+
'PUT v1InstallationsIntegrationConfigurationIdResourcesResourceIdSecrets': typeof updateResourceSecretsById;
|
|
2140
|
+
'GET v1IntegrationsConfigurations': typeof getConfigurations;
|
|
2141
|
+
'GET v1IntegrationsConfigurationId': typeof getConfiguration;
|
|
2142
|
+
'DELETE v1IntegrationsConfigurationId': typeof deleteConfiguration;
|
|
2143
|
+
'POST v1IntegrationsSsoToken': typeof exchangeSsoToken;
|
|
2144
|
+
'GET v2IntegrationsLogDrains': typeof getIntegrationLogDrains;
|
|
2145
|
+
'POST v2IntegrationsLogDrains': typeof createLogDrain;
|
|
2146
|
+
'DELETE v1IntegrationsLogDrainsId': typeof deleteIntegrationLogDrain;
|
|
2147
|
+
'GET v1ProjectsProjectIdDeploymentsDeploymentIdRuntimeLogs': typeof getRuntimeLogs;
|
|
2148
|
+
'POST v1InstallationsIntegrationConfigurationIdResourcesResourceIdExperimentationItems': typeof createExperimentationItem;
|
|
2149
|
+
'PATCH v1InstallationsIntegrationConfigurationIdResourcesResourceIdExperimentationItemsItemId': typeof updateExperimentationItem;
|
|
2150
|
+
'DELETE v1InstallationsIntegrationConfigurationIdResourcesResourceIdExperimentationItemsItemId': typeof deleteExperimentationItem;
|
|
2151
|
+
'PUT v1InstallationsIntegrationConfigurationIdResourcesResourceIdExperimentationEdgeConfig': typeof updateExperimentationEdgeConfig;
|
|
2152
|
+
'GET v1ProjectsIdOrNameMembers': typeof getProjectMembers;
|
|
2153
|
+
'POST v1ProjectsIdOrNameMembers': typeof addProjectMember;
|
|
2154
|
+
'DELETE v1ProjectsIdOrNameMembersUid': typeof removeProjectMember;
|
|
2155
|
+
'GET v10Projects': typeof getProjects;
|
|
2156
|
+
'POST v11Projects': typeof createProject;
|
|
2157
|
+
'GET v9ProjectsIdOrName': typeof getProject;
|
|
2158
|
+
'PATCH v9ProjectsIdOrName': typeof updateProject;
|
|
2159
|
+
'DELETE v9ProjectsIdOrName': typeof deleteProject;
|
|
2160
|
+
'POST v9ProjectsIdOrNameCustomEnvironments': typeof createCustomEnvironment;
|
|
2161
|
+
'GET v9ProjectsIdOrNameCustomEnvironments': typeof listCustomEnvironments;
|
|
2162
|
+
'GET v9ProjectsIdOrNameCustomEnvironmentsEnvironmentSlugOrId': typeof getCustomEnvironment;
|
|
2163
|
+
'PATCH v9ProjectsIdOrNameCustomEnvironmentsEnvironmentSlugOrId': typeof updateCustomEnvironment;
|
|
2164
|
+
'DELETE v9ProjectsIdOrNameCustomEnvironmentsEnvironmentSlugOrId': typeof removeCustomEnvironment;
|
|
2165
|
+
'GET v9ProjectsIdOrNameDomains': typeof getProjectDomains;
|
|
2166
|
+
'GET v9ProjectsIdOrNameDomainsDomain': typeof getProjectDomain;
|
|
2167
|
+
'PATCH v9ProjectsIdOrNameDomainsDomain': typeof updateProjectDomain;
|
|
2168
|
+
'DELETE v9ProjectsIdOrNameDomainsDomain': typeof removeProjectDomain;
|
|
2169
|
+
'POST v10ProjectsIdOrNameDomains': typeof addProjectDomain;
|
|
2170
|
+
'POST v1ProjectsIdOrNameDomainsDomainMove': typeof moveProjectDomain;
|
|
2171
|
+
'POST v9ProjectsIdOrNameDomainsDomainVerify': typeof verifyProjectDomain;
|
|
2172
|
+
'GET v10ProjectsIdOrNameEnv': typeof filterProjectEnvs;
|
|
2173
|
+
'POST v10ProjectsIdOrNameEnv': typeof createProjectEnv;
|
|
2174
|
+
'GET v1ProjectsIdOrNameEnvId': typeof getProjectEnv;
|
|
2175
|
+
'DELETE v9ProjectsIdOrNameEnvId': typeof removeProjectEnv;
|
|
2176
|
+
'PATCH v9ProjectsIdOrNameEnvId': typeof editProjectEnv;
|
|
2177
|
+
'GET v1ProjectsIdOrNameRollingReleaseBilling': typeof getRollingReleaseBillingStatus;
|
|
2178
|
+
'GET v1ProjectsIdOrNameRollingReleaseConfig': typeof getRollingReleaseConfig;
|
|
2179
|
+
'DELETE v1ProjectsIdOrNameRollingReleaseConfig': typeof deleteRollingReleaseConfig;
|
|
2180
|
+
'PATCH v1ProjectsIdOrNameRollingReleaseConfig': typeof updateRollingReleaseConfig;
|
|
2181
|
+
'GET v1ProjectsIdOrNameRollingRelease': typeof getRollingRelease;
|
|
2182
|
+
'POST v1ProjectsIdOrNameRollingReleaseApproveStage': typeof approveRollingReleaseStage;
|
|
2183
|
+
'POST v1ProjectsIdOrNameRollingReleaseComplete': typeof completeRollingRelease;
|
|
2184
|
+
'POST projectsIdOrNameTransferRequest': typeof createProjectTransferRequest;
|
|
2185
|
+
'PUT projectsTransferRequestCode': typeof acceptProjectTransferRequest;
|
|
2186
|
+
'PATCH v1ProjectsIdOrNameProtectionBypass': typeof updateProjectProtectionBypass;
|
|
2187
|
+
'POST v10ProjectsProjectIdPromoteDeploymentId': typeof requestPromote;
|
|
2188
|
+
'GET v1ProjectsProjectIdPromoteAliases': typeof listPromoteAliases;
|
|
2189
|
+
'POST v1ProjectsProjectIdPause': typeof pauseProject;
|
|
2190
|
+
'POST v1ProjectsProjectIdUnpause': typeof unpauseProject;
|
|
2191
|
+
'POST v1SecurityAttackMode': typeof updateAttackChallengeMode;
|
|
2192
|
+
'PUT v1SecurityFirewallConfig': typeof putFirewallConfig;
|
|
2193
|
+
'PATCH v1SecurityFirewallConfig': typeof updateFirewallConfig;
|
|
2194
|
+
'GET v1SecurityFirewallConfigConfigVersion': typeof getFirewallConfig;
|
|
2195
|
+
'GET v1SecurityFirewallAttackStatus': typeof getActiveAttackStatus;
|
|
2196
|
+
'GET v1SecurityFirewallBypass': typeof getBypassIp;
|
|
2197
|
+
'POST v1SecurityFirewallBypass': typeof addBypassIp;
|
|
2198
|
+
'DELETE v1SecurityFirewallBypass': typeof removeBypassIp;
|
|
2199
|
+
'GET v3TeamsTeamIdMembers': typeof getTeamMembers;
|
|
2200
|
+
'POST v1TeamsTeamIdMembers': typeof inviteUserToTeam;
|
|
2201
|
+
'POST v1TeamsTeamIdRequest': typeof requestAccessToTeam;
|
|
2202
|
+
'GET v1TeamsTeamIdRequestUserId': typeof getTeamAccessRequest;
|
|
2203
|
+
'POST v1TeamsTeamIdMembersTeamsJoin': typeof joinTeam;
|
|
2204
|
+
'PATCH v1TeamsTeamIdMembersUid': typeof updateTeamMember;
|
|
2205
|
+
'DELETE v1TeamsTeamIdMembersUid': typeof removeTeamMember;
|
|
2206
|
+
'GET v2TeamsTeamId': typeof getTeam;
|
|
2207
|
+
'PATCH v2TeamsTeamId': typeof patchTeam;
|
|
2208
|
+
'GET v2Teams': typeof getTeams;
|
|
2209
|
+
'POST v1Teams': typeof createTeam;
|
|
2210
|
+
'DELETE v1TeamsTeamId': typeof deleteTeam;
|
|
2211
|
+
'DELETE v1TeamsTeamIdInvitesInviteId': typeof deleteTeamInviteCode;
|
|
2212
|
+
'POST v2Files': typeof uploadFile;
|
|
2213
|
+
'GET v5UserTokens': typeof listAuthTokens;
|
|
2214
|
+
'POST v3UserTokens': typeof createAuthToken;
|
|
2215
|
+
'GET v5UserTokensTokenId': typeof getAuthToken;
|
|
2216
|
+
'DELETE v3UserTokensTokenId': typeof deleteAuthToken;
|
|
2217
|
+
'GET v2User': typeof getAuthUser;
|
|
2218
|
+
'DELETE v1User': typeof requestDelete;
|
|
2219
|
+
'POST v1Webhooks': typeof createWebhook;
|
|
2220
|
+
'GET v1Webhooks': typeof getWebhooks;
|
|
2221
|
+
'GET v1WebhooksId': typeof getWebhook;
|
|
2222
|
+
'DELETE v1WebhooksId': typeof deleteWebhook;
|
|
2223
|
+
'GET v2DeploymentsIdAliases': typeof listDeploymentAliases;
|
|
2224
|
+
'POST v2DeploymentsIdAliases': typeof assignAlias;
|
|
2225
|
+
'GET v4Aliases': typeof listAliases;
|
|
2226
|
+
'GET v4AliasesIdOrAlias': typeof getAlias;
|
|
2227
|
+
'DELETE v2AliasesAliasId': typeof deleteAlias;
|
|
2228
|
+
'PATCH aliasesIdProtectionBypass': typeof patchUrlProtectionBypass;
|
|
2229
|
+
'GET certs': typeof listCerts;
|
|
2230
|
+
'GET v8CertsId': typeof getCertById;
|
|
2231
|
+
'DELETE v8CertsId': typeof removeCert;
|
|
2232
|
+
'POST v8Certs': typeof issueCert;
|
|
2233
|
+
'PUT v8Certs': typeof uploadCert;
|
|
2234
|
+
'GET v6DeploymentsIdFiles': typeof listDeploymentFiles;
|
|
2235
|
+
'GET v8DeploymentsIdFilesFileId': typeof getDeploymentFileContents;
|
|
2236
|
+
'GET v6Deployments': typeof getDeployments;
|
|
2237
|
+
'DELETE v13DeploymentsId': typeof deleteDeployment;
|
|
2238
|
+
'GET v3Secrets': typeof getSecrets;
|
|
2239
|
+
'POST v2SecretsName': typeof createSecret;
|
|
2240
|
+
'PATCH v2SecretsName': typeof renameSecret;
|
|
2241
|
+
'GET v3SecretsIdOrName': typeof getSecret;
|
|
2242
|
+
'DELETE v2SecretsIdOrName': typeof deleteSecret;
|
|
2243
|
+
};
|
|
2244
|
+
export declare const operationsByTag: {
|
|
2245
|
+
accessGroups: {
|
|
2246
|
+
readAccessGroup: typeof readAccessGroup;
|
|
2247
|
+
updateAccessGroup: typeof updateAccessGroup;
|
|
2248
|
+
deleteAccessGroup: typeof deleteAccessGroup;
|
|
2249
|
+
listAccessGroupMembers: typeof listAccessGroupMembers;
|
|
2250
|
+
listAccessGroups: typeof listAccessGroups;
|
|
2251
|
+
createAccessGroup: typeof createAccessGroup;
|
|
2252
|
+
listAccessGroupProjects: typeof listAccessGroupProjects;
|
|
2253
|
+
createAccessGroupProject: typeof createAccessGroupProject;
|
|
2254
|
+
readAccessGroupProject: typeof readAccessGroupProject;
|
|
2255
|
+
updateAccessGroupProject: typeof updateAccessGroupProject;
|
|
2256
|
+
deleteAccessGroupProject: typeof deleteAccessGroupProject;
|
|
2257
|
+
};
|
|
2258
|
+
artifacts: {
|
|
2259
|
+
recordEvents: typeof recordEvents;
|
|
2260
|
+
status: typeof status;
|
|
2261
|
+
uploadArtifact: typeof uploadArtifact;
|
|
2262
|
+
downloadArtifact: typeof downloadArtifact;
|
|
2263
|
+
artifactQuery: typeof artifactQuery;
|
|
2264
|
+
};
|
|
2265
|
+
checks: {
|
|
2266
|
+
createCheck: typeof createCheck;
|
|
2267
|
+
getAllChecks: typeof getAllChecks;
|
|
2268
|
+
getCheck: typeof getCheck;
|
|
2269
|
+
updateCheck: typeof updateCheck;
|
|
2270
|
+
rerequestCheck: typeof rerequestCheck;
|
|
2271
|
+
};
|
|
2272
|
+
projects: {
|
|
2273
|
+
updateProjectDataCache: typeof updateProjectDataCache;
|
|
2274
|
+
getProjects: typeof getProjects;
|
|
2275
|
+
createProject: typeof createProject;
|
|
2276
|
+
getProject: typeof getProject;
|
|
2277
|
+
updateProject: typeof updateProject;
|
|
2278
|
+
deleteProject: typeof deleteProject;
|
|
2279
|
+
getProjectDomains: typeof getProjectDomains;
|
|
2280
|
+
getProjectDomain: typeof getProjectDomain;
|
|
2281
|
+
updateProjectDomain: typeof updateProjectDomain;
|
|
2282
|
+
removeProjectDomain: typeof removeProjectDomain;
|
|
2283
|
+
addProjectDomain: typeof addProjectDomain;
|
|
2284
|
+
moveProjectDomain: typeof moveProjectDomain;
|
|
2285
|
+
verifyProjectDomain: typeof verifyProjectDomain;
|
|
2286
|
+
filterProjectEnvs: typeof filterProjectEnvs;
|
|
2287
|
+
createProjectEnv: typeof createProjectEnv;
|
|
2288
|
+
getProjectEnv: typeof getProjectEnv;
|
|
2289
|
+
removeProjectEnv: typeof removeProjectEnv;
|
|
2290
|
+
editProjectEnv: typeof editProjectEnv;
|
|
2291
|
+
createProjectTransferRequest: typeof createProjectTransferRequest;
|
|
2292
|
+
acceptProjectTransferRequest: typeof acceptProjectTransferRequest;
|
|
2293
|
+
updateProjectProtectionBypass: typeof updateProjectProtectionBypass;
|
|
2294
|
+
requestPromote: typeof requestPromote;
|
|
2295
|
+
listPromoteAliases: typeof listPromoteAliases;
|
|
2296
|
+
pauseProject: typeof pauseProject;
|
|
2297
|
+
unpauseProject: typeof unpauseProject;
|
|
2298
|
+
};
|
|
2299
|
+
deployments: {
|
|
2300
|
+
getDeploymentEvents: typeof getDeploymentEvents;
|
|
2301
|
+
updateIntegrationDeploymentAction: typeof updateIntegrationDeploymentAction;
|
|
2302
|
+
getDeployment: typeof getDeployment;
|
|
2303
|
+
createDeployment: typeof createDeployment;
|
|
2304
|
+
cancelDeployment: typeof cancelDeployment;
|
|
2305
|
+
uploadFile: typeof uploadFile;
|
|
2306
|
+
listDeploymentFiles: typeof listDeploymentFiles;
|
|
2307
|
+
getDeploymentFileContents: typeof getDeploymentFileContents;
|
|
2308
|
+
getDeployments: typeof getDeployments;
|
|
2309
|
+
deleteDeployment: typeof deleteDeployment;
|
|
2310
|
+
};
|
|
2311
|
+
integrations: {
|
|
2312
|
+
updateIntegrationDeploymentAction: typeof updateIntegrationDeploymentAction;
|
|
2313
|
+
getConfigurations: typeof getConfigurations;
|
|
2314
|
+
getConfiguration: typeof getConfiguration;
|
|
2315
|
+
deleteConfiguration: typeof deleteConfiguration;
|
|
2316
|
+
};
|
|
2317
|
+
domains: {
|
|
2318
|
+
buyDomain: typeof buyDomain;
|
|
2319
|
+
checkDomainPrice: typeof checkDomainPrice;
|
|
2320
|
+
checkDomainStatus: typeof checkDomainStatus;
|
|
2321
|
+
getDomainTransfer: typeof getDomainTransfer;
|
|
2322
|
+
getDomainConfig: typeof getDomainConfig;
|
|
2323
|
+
getDomain: typeof getDomain;
|
|
2324
|
+
getDomains: typeof getDomains;
|
|
2325
|
+
createOrTransferDomain: typeof createOrTransferDomain;
|
|
2326
|
+
patchDomain: typeof patchDomain;
|
|
2327
|
+
deleteDomain: typeof deleteDomain;
|
|
2328
|
+
};
|
|
2329
|
+
dns: {
|
|
2330
|
+
getRecords: typeof getRecords;
|
|
2331
|
+
createRecord: typeof createRecord;
|
|
2332
|
+
updateRecord: typeof updateRecord;
|
|
2333
|
+
removeRecord: typeof removeRecord;
|
|
2334
|
+
};
|
|
2335
|
+
edgeConfig: {
|
|
2336
|
+
getEdgeConfigs: typeof getEdgeConfigs;
|
|
2337
|
+
createEdgeConfig: typeof createEdgeConfig;
|
|
2338
|
+
getEdgeConfig: typeof getEdgeConfig;
|
|
2339
|
+
updateEdgeConfig: typeof updateEdgeConfig;
|
|
2340
|
+
deleteEdgeConfig: typeof deleteEdgeConfig;
|
|
2341
|
+
getEdgeConfigItems: typeof getEdgeConfigItems;
|
|
2342
|
+
patchEdgeConfigItems: typeof patchEdgeConfigItems;
|
|
2343
|
+
getEdgeConfigSchema: typeof getEdgeConfigSchema;
|
|
2344
|
+
patchEdgeConfigSchema: typeof patchEdgeConfigSchema;
|
|
2345
|
+
deleteEdgeConfigSchema: typeof deleteEdgeConfigSchema;
|
|
2346
|
+
getEdgeConfigItem: typeof getEdgeConfigItem;
|
|
2347
|
+
getEdgeConfigTokens: typeof getEdgeConfigTokens;
|
|
2348
|
+
deleteEdgeConfigTokens: typeof deleteEdgeConfigTokens;
|
|
2349
|
+
getEdgeConfigToken: typeof getEdgeConfigToken;
|
|
2350
|
+
createEdgeConfigToken: typeof createEdgeConfigToken;
|
|
2351
|
+
getEdgeConfigBackup: typeof getEdgeConfigBackup;
|
|
2352
|
+
getEdgeConfigBackups: typeof getEdgeConfigBackups;
|
|
2353
|
+
};
|
|
2354
|
+
user: {
|
|
2355
|
+
listUserEvents: typeof listUserEvents;
|
|
2356
|
+
getAuthUser: typeof getAuthUser;
|
|
2357
|
+
requestDelete: typeof requestDelete;
|
|
2358
|
+
};
|
|
2359
|
+
marketplace: {
|
|
2360
|
+
getAccountInfo: typeof getAccountInfo;
|
|
2361
|
+
getMember: typeof getMember;
|
|
2362
|
+
createEvent: typeof createEvent;
|
|
2363
|
+
getIntegrationResources: typeof getIntegrationResources;
|
|
2364
|
+
getIntegrationResource: typeof getIntegrationResource;
|
|
2365
|
+
deleteIntegrationResource: typeof deleteIntegrationResource;
|
|
2366
|
+
importResource: typeof importResource;
|
|
2367
|
+
submitBillingData: typeof submitBillingData;
|
|
2368
|
+
submitInvoice: typeof submitInvoice;
|
|
2369
|
+
getInvoice: typeof getInvoice;
|
|
2370
|
+
updateInvoice: typeof updateInvoice;
|
|
2371
|
+
submitPrepaymentBalances: typeof submitPrepaymentBalances;
|
|
2372
|
+
updateResourceSecrets: typeof updateResourceSecrets;
|
|
2373
|
+
updateResourceSecretsById: typeof updateResourceSecretsById;
|
|
2374
|
+
exchangeSsoToken: typeof exchangeSsoToken;
|
|
2375
|
+
createExperimentationItem: typeof createExperimentationItem;
|
|
2376
|
+
updateExperimentationItem: typeof updateExperimentationItem;
|
|
2377
|
+
deleteExperimentationItem: typeof deleteExperimentationItem;
|
|
2378
|
+
updateExperimentationEdgeConfig: typeof updateExperimentationEdgeConfig;
|
|
2379
|
+
};
|
|
2380
|
+
authentication: {
|
|
2381
|
+
exchangeSsoToken: typeof exchangeSsoToken;
|
|
2382
|
+
listAuthTokens: typeof listAuthTokens;
|
|
2383
|
+
createAuthToken: typeof createAuthToken;
|
|
2384
|
+
getAuthToken: typeof getAuthToken;
|
|
2385
|
+
deleteAuthToken: typeof deleteAuthToken;
|
|
2386
|
+
};
|
|
2387
|
+
logdrains: {
|
|
2388
|
+
getIntegrationLogDrains: typeof getIntegrationLogDrains;
|
|
2389
|
+
createLogDrain: typeof createLogDrain;
|
|
2390
|
+
deleteIntegrationLogDrain: typeof deleteIntegrationLogDrain;
|
|
2391
|
+
};
|
|
2392
|
+
logs: {
|
|
2393
|
+
getRuntimeLogs: typeof getRuntimeLogs;
|
|
2394
|
+
};
|
|
2395
|
+
projectmembers: {
|
|
2396
|
+
getProjectMembers: typeof getProjectMembers;
|
|
2397
|
+
addProjectMember: typeof addProjectMember;
|
|
2398
|
+
removeProjectMember: typeof removeProjectMember;
|
|
2399
|
+
};
|
|
2400
|
+
environment: {
|
|
2401
|
+
createCustomEnvironment: typeof createCustomEnvironment;
|
|
2402
|
+
listCustomEnvironments: typeof listCustomEnvironments;
|
|
2403
|
+
getCustomEnvironment: typeof getCustomEnvironment;
|
|
2404
|
+
updateCustomEnvironment: typeof updateCustomEnvironment;
|
|
2405
|
+
removeCustomEnvironment: typeof removeCustomEnvironment;
|
|
2406
|
+
};
|
|
2407
|
+
rollingRelease: {
|
|
2408
|
+
getRollingReleaseBillingStatus: typeof getRollingReleaseBillingStatus;
|
|
2409
|
+
getRollingReleaseConfig: typeof getRollingReleaseConfig;
|
|
2410
|
+
deleteRollingReleaseConfig: typeof deleteRollingReleaseConfig;
|
|
2411
|
+
updateRollingReleaseConfig: typeof updateRollingReleaseConfig;
|
|
2412
|
+
getRollingRelease: typeof getRollingRelease;
|
|
2413
|
+
approveRollingReleaseStage: typeof approveRollingReleaseStage;
|
|
2414
|
+
completeRollingRelease: typeof completeRollingRelease;
|
|
2415
|
+
};
|
|
2416
|
+
security: {
|
|
2417
|
+
updateAttackChallengeMode: typeof updateAttackChallengeMode;
|
|
2418
|
+
putFirewallConfig: typeof putFirewallConfig;
|
|
2419
|
+
updateFirewallConfig: typeof updateFirewallConfig;
|
|
2420
|
+
getFirewallConfig: typeof getFirewallConfig;
|
|
2421
|
+
getActiveAttackStatus: typeof getActiveAttackStatus;
|
|
2422
|
+
getBypassIp: typeof getBypassIp;
|
|
2423
|
+
addBypassIp: typeof addBypassIp;
|
|
2424
|
+
removeBypassIp: typeof removeBypassIp;
|
|
2425
|
+
};
|
|
2426
|
+
teams: {
|
|
2427
|
+
getTeamMembers: typeof getTeamMembers;
|
|
2428
|
+
inviteUserToTeam: typeof inviteUserToTeam;
|
|
2429
|
+
requestAccessToTeam: typeof requestAccessToTeam;
|
|
2430
|
+
getTeamAccessRequest: typeof getTeamAccessRequest;
|
|
2431
|
+
joinTeam: typeof joinTeam;
|
|
2432
|
+
updateTeamMember: typeof updateTeamMember;
|
|
2433
|
+
removeTeamMember: typeof removeTeamMember;
|
|
2434
|
+
getTeam: typeof getTeam;
|
|
2435
|
+
patchTeam: typeof patchTeam;
|
|
2436
|
+
getTeams: typeof getTeams;
|
|
2437
|
+
createTeam: typeof createTeam;
|
|
2438
|
+
deleteTeam: typeof deleteTeam;
|
|
2439
|
+
deleteTeamInviteCode: typeof deleteTeamInviteCode;
|
|
2440
|
+
};
|
|
2441
|
+
webhooks: {
|
|
2442
|
+
createWebhook: typeof createWebhook;
|
|
2443
|
+
getWebhooks: typeof getWebhooks;
|
|
2444
|
+
getWebhook: typeof getWebhook;
|
|
2445
|
+
deleteWebhook: typeof deleteWebhook;
|
|
2446
|
+
};
|
|
2447
|
+
aliases: {
|
|
2448
|
+
listDeploymentAliases: typeof listDeploymentAliases;
|
|
2449
|
+
assignAlias: typeof assignAlias;
|
|
2450
|
+
listAliases: typeof listAliases;
|
|
2451
|
+
getAlias: typeof getAlias;
|
|
2452
|
+
deleteAlias: typeof deleteAlias;
|
|
2453
|
+
patchUrlProtectionBypass: typeof patchUrlProtectionBypass;
|
|
2454
|
+
};
|
|
2455
|
+
certs: {
|
|
2456
|
+
getCertById: typeof getCertById;
|
|
2457
|
+
removeCert: typeof removeCert;
|
|
2458
|
+
issueCert: typeof issueCert;
|
|
2459
|
+
uploadCert: typeof uploadCert;
|
|
2460
|
+
};
|
|
2461
|
+
secrets: {
|
|
2462
|
+
getSecrets: typeof getSecrets;
|
|
2463
|
+
createSecret: typeof createSecret;
|
|
2464
|
+
renameSecret: typeof renameSecret;
|
|
2465
|
+
getSecret: typeof getSecret;
|
|
2466
|
+
deleteSecret: typeof deleteSecret;
|
|
2467
|
+
};
|
|
2468
|
+
};
|
|
2469
|
+
export declare const tagDictionary: {
|
|
2470
|
+
readonly accessGroups: {
|
|
2471
|
+
readonly GET: readonly ["readAccessGroup", "listAccessGroupMembers", "listAccessGroups", "listAccessGroupProjects", "readAccessGroupProject"];
|
|
2472
|
+
readonly POST: readonly ["updateAccessGroup", "createAccessGroup", "createAccessGroupProject"];
|
|
2473
|
+
readonly DELETE: readonly ["deleteAccessGroup", "deleteAccessGroupProject"];
|
|
2474
|
+
readonly PATCH: readonly ["updateAccessGroupProject"];
|
|
2475
|
+
};
|
|
2476
|
+
readonly artifacts: {
|
|
2477
|
+
readonly POST: readonly ["recordEvents", "artifactQuery"];
|
|
2478
|
+
readonly GET: readonly ["status", "downloadArtifact"];
|
|
2479
|
+
readonly PUT: readonly ["uploadArtifact"];
|
|
2480
|
+
};
|
|
2481
|
+
readonly checks: {
|
|
2482
|
+
readonly POST: readonly ["createCheck", "rerequestCheck"];
|
|
2483
|
+
readonly GET: readonly ["getAllChecks", "getCheck"];
|
|
2484
|
+
readonly PATCH: readonly ["updateCheck"];
|
|
2485
|
+
};
|
|
2486
|
+
readonly projects: {
|
|
2487
|
+
readonly PATCH: readonly ["updateProjectDataCache", "updateProject", "updateProjectDomain", "editProjectEnv", "updateProjectProtectionBypass"];
|
|
2488
|
+
readonly GET: readonly ["getProjects", "getProject", "getProjectDomains", "getProjectDomain", "filterProjectEnvs", "getProjectEnv", "listPromoteAliases"];
|
|
2489
|
+
readonly POST: readonly ["createProject", "addProjectDomain", "moveProjectDomain", "verifyProjectDomain", "createProjectEnv", "createProjectTransferRequest", "requestPromote", "pauseProject", "unpauseProject"];
|
|
2490
|
+
readonly DELETE: readonly ["deleteProject", "removeProjectDomain", "removeProjectEnv"];
|
|
2491
|
+
readonly PUT: readonly ["acceptProjectTransferRequest"];
|
|
2492
|
+
};
|
|
2493
|
+
readonly deployments: {
|
|
2494
|
+
readonly GET: readonly ["getDeploymentEvents", "getDeployment", "listDeploymentFiles", "getDeploymentFileContents", "getDeployments"];
|
|
2495
|
+
readonly PATCH: readonly ["updateIntegrationDeploymentAction", "cancelDeployment"];
|
|
2496
|
+
readonly POST: readonly ["createDeployment", "uploadFile"];
|
|
2497
|
+
readonly DELETE: readonly ["deleteDeployment"];
|
|
2498
|
+
};
|
|
2499
|
+
readonly integrations: {
|
|
2500
|
+
readonly PATCH: readonly ["updateIntegrationDeploymentAction"];
|
|
2501
|
+
readonly GET: readonly ["getConfigurations", "getConfiguration"];
|
|
2502
|
+
readonly DELETE: readonly ["deleteConfiguration"];
|
|
2503
|
+
};
|
|
2504
|
+
readonly domains: {
|
|
2505
|
+
readonly POST: readonly ["buyDomain", "createOrTransferDomain"];
|
|
2506
|
+
readonly GET: readonly ["checkDomainPrice", "checkDomainStatus", "getDomainTransfer", "getDomainConfig", "getDomain", "getDomains"];
|
|
2507
|
+
readonly PATCH: readonly ["patchDomain"];
|
|
2508
|
+
readonly DELETE: readonly ["deleteDomain"];
|
|
2509
|
+
};
|
|
2510
|
+
readonly dns: {
|
|
2511
|
+
readonly GET: readonly ["getRecords"];
|
|
2512
|
+
readonly POST: readonly ["createRecord"];
|
|
2513
|
+
readonly PATCH: readonly ["updateRecord"];
|
|
2514
|
+
readonly DELETE: readonly ["removeRecord"];
|
|
2515
|
+
};
|
|
2516
|
+
readonly edgeConfig: {
|
|
2517
|
+
readonly GET: readonly ["getEdgeConfigs", "getEdgeConfig", "getEdgeConfigItems", "getEdgeConfigSchema", "getEdgeConfigItem", "getEdgeConfigTokens", "getEdgeConfigToken", "getEdgeConfigBackup", "getEdgeConfigBackups"];
|
|
2518
|
+
readonly POST: readonly ["createEdgeConfig", "patchEdgeConfigSchema", "createEdgeConfigToken"];
|
|
2519
|
+
readonly PUT: readonly ["updateEdgeConfig"];
|
|
2520
|
+
readonly DELETE: readonly ["deleteEdgeConfig", "deleteEdgeConfigSchema", "deleteEdgeConfigTokens"];
|
|
2521
|
+
readonly PATCH: readonly ["patchEdgeConfigItems"];
|
|
2522
|
+
};
|
|
2523
|
+
readonly user: {
|
|
2524
|
+
readonly GET: readonly ["listUserEvents", "getAuthUser"];
|
|
2525
|
+
readonly DELETE: readonly ["requestDelete"];
|
|
2526
|
+
};
|
|
2527
|
+
readonly marketplace: {
|
|
2528
|
+
readonly GET: readonly ["getAccountInfo", "getMember", "getIntegrationResources", "getIntegrationResource", "getInvoice"];
|
|
2529
|
+
readonly POST: readonly ["createEvent", "submitBillingData", "submitInvoice", "updateInvoice", "submitPrepaymentBalances", "exchangeSsoToken", "createExperimentationItem"];
|
|
2530
|
+
readonly DELETE: readonly ["deleteIntegrationResource", "deleteExperimentationItem"];
|
|
2531
|
+
readonly PUT: readonly ["importResource", "updateResourceSecrets", "updateResourceSecretsById", "updateExperimentationEdgeConfig"];
|
|
2532
|
+
readonly PATCH: readonly ["updateExperimentationItem"];
|
|
2533
|
+
};
|
|
2534
|
+
readonly authentication: {
|
|
2535
|
+
readonly POST: readonly ["exchangeSsoToken", "createAuthToken"];
|
|
2536
|
+
readonly GET: readonly ["listAuthTokens", "getAuthToken"];
|
|
2537
|
+
readonly DELETE: readonly ["deleteAuthToken"];
|
|
2538
|
+
};
|
|
2539
|
+
readonly logdrains: {
|
|
2540
|
+
readonly GET: readonly ["getIntegrationLogDrains"];
|
|
2541
|
+
readonly POST: readonly ["createLogDrain"];
|
|
2542
|
+
readonly DELETE: readonly ["deleteIntegrationLogDrain"];
|
|
2543
|
+
};
|
|
2544
|
+
readonly logs: {
|
|
2545
|
+
readonly GET: readonly ["getRuntimeLogs"];
|
|
2546
|
+
};
|
|
2547
|
+
readonly projectmembers: {
|
|
2548
|
+
readonly GET: readonly ["getProjectMembers"];
|
|
2549
|
+
readonly POST: readonly ["addProjectMember"];
|
|
2550
|
+
readonly DELETE: readonly ["removeProjectMember"];
|
|
2551
|
+
};
|
|
2552
|
+
readonly environment: {
|
|
2553
|
+
readonly POST: readonly ["createCustomEnvironment"];
|
|
2554
|
+
readonly GET: readonly ["listCustomEnvironments", "getCustomEnvironment"];
|
|
2555
|
+
readonly PATCH: readonly ["updateCustomEnvironment"];
|
|
2556
|
+
readonly DELETE: readonly ["removeCustomEnvironment"];
|
|
2557
|
+
};
|
|
2558
|
+
readonly rollingRelease: {
|
|
2559
|
+
readonly GET: readonly ["getRollingReleaseBillingStatus", "getRollingReleaseConfig", "getRollingRelease"];
|
|
2560
|
+
readonly DELETE: readonly ["deleteRollingReleaseConfig"];
|
|
2561
|
+
readonly PATCH: readonly ["updateRollingReleaseConfig"];
|
|
2562
|
+
readonly POST: readonly ["approveRollingReleaseStage", "completeRollingRelease"];
|
|
2563
|
+
};
|
|
2564
|
+
readonly security: {
|
|
2565
|
+
readonly POST: readonly ["updateAttackChallengeMode", "addBypassIp"];
|
|
2566
|
+
readonly PUT: readonly ["putFirewallConfig"];
|
|
2567
|
+
readonly PATCH: readonly ["updateFirewallConfig"];
|
|
2568
|
+
readonly GET: readonly ["getFirewallConfig", "getActiveAttackStatus", "getBypassIp"];
|
|
2569
|
+
readonly DELETE: readonly ["removeBypassIp"];
|
|
2570
|
+
};
|
|
2571
|
+
readonly teams: {
|
|
2572
|
+
readonly GET: readonly ["getTeamMembers", "getTeamAccessRequest", "getTeam", "getTeams"];
|
|
2573
|
+
readonly POST: readonly ["inviteUserToTeam", "requestAccessToTeam", "joinTeam", "createTeam"];
|
|
2574
|
+
readonly PATCH: readonly ["updateTeamMember", "patchTeam"];
|
|
2575
|
+
readonly DELETE: readonly ["removeTeamMember", "deleteTeam", "deleteTeamInviteCode"];
|
|
2576
|
+
};
|
|
2577
|
+
readonly webhooks: {
|
|
2578
|
+
readonly POST: readonly ["createWebhook"];
|
|
2579
|
+
readonly GET: readonly ["getWebhooks", "getWebhook"];
|
|
2580
|
+
readonly DELETE: readonly ["deleteWebhook"];
|
|
2581
|
+
};
|
|
2582
|
+
readonly aliases: {
|
|
2583
|
+
readonly GET: readonly ["listDeploymentAliases", "listAliases", "getAlias"];
|
|
2584
|
+
readonly POST: readonly ["assignAlias"];
|
|
2585
|
+
readonly DELETE: readonly ["deleteAlias"];
|
|
2586
|
+
readonly PATCH: readonly ["patchUrlProtectionBypass"];
|
|
2587
|
+
};
|
|
2588
|
+
readonly certs: {
|
|
2589
|
+
readonly GET: readonly ["getCertById"];
|
|
2590
|
+
readonly DELETE: readonly ["removeCert"];
|
|
2591
|
+
readonly POST: readonly ["issueCert"];
|
|
2592
|
+
readonly PUT: readonly ["uploadCert"];
|
|
2593
|
+
};
|
|
2594
|
+
readonly secrets: {
|
|
2595
|
+
readonly GET: readonly ["getSecrets", "getSecret"];
|
|
2596
|
+
readonly POST: readonly ["createSecret"];
|
|
2597
|
+
readonly PATCH: readonly ["renameSecret"];
|
|
2598
|
+
readonly DELETE: readonly ["deleteSecret"];
|
|
2599
|
+
};
|
|
2600
|
+
};
|