vercel-api-js 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.mts +182 -182
- package/dist/client.d.ts +182 -182
- package/dist/generated/components.d.mts +664 -664
- package/dist/generated/components.d.ts +664 -664
- package/dist/generated/components.js +1071 -801
- package/dist/generated/components.mjs +1071 -801
- package/dist/generated/mcp.d.mts +2061 -0
- package/dist/generated/mcp.d.ts +2061 -0
- package/dist/generated/mcp.js +4692 -0
- package/dist/generated/mcp.mjs +4508 -0
- package/dist/generated/schemas.d.mts +14785 -1918
- package/dist/generated/schemas.d.ts +14785 -1918
- package/dist/generated/schemas.js +1501 -989
- package/dist/generated/schemas.mjs +1501 -989
- package/dist/generated/types.d.mts +11 -2
- package/dist/generated/types.d.ts +11 -2
- package/dist/generated/types.js +133 -132
- package/dist/generated/types.mjs +133 -132
- package/dist/index.d.mts +484 -484
- package/dist/index.d.ts +484 -484
- package/dist/mcp.d.mts +1 -0
- package/dist/mcp.d.ts +1 -0
- package/dist/mcp.js +5 -0
- package/dist/mcp.mjs +1 -0
- package/dist/utils/fetcher.d.mts +2 -3
- package/dist/utils/fetcher.d.ts +2 -3
- package/dist/utils/fetcher.js +2 -1
- package/dist/utils/fetcher.mjs +2 -1
- package/dist/utils/mcp.d.mts +1 -0
- package/dist/utils/mcp.d.ts +1 -0
- package/dist/utils/mcp.js +2 -0
- package/dist/utils/mcp.mjs +1 -0
- package/package.json +14 -4
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
* Generated by Kubb (https://kubb.dev/).
|
|
3
3
|
* Do not edit manually.
|
|
4
4
|
*/
|
|
5
|
-
import client from "../utils/fetcher.js";
|
|
6
5
|
import type { FetcherConfig } from "../utils/fetcher.js";
|
|
7
|
-
import
|
|
6
|
+
import client from "../utils/fetcher.js";
|
|
7
|
+
import type { AcceptProjectTransferRequestPathParams, AcceptProjectTransferRequestQueryParams, AddBypassIpQueryParams, AddProjectDomainPathParams, AddProjectDomainQueryParams, AddProjectMemberPathParams, AddProjectMemberQueryParams, ApproveRollingReleaseStagePathParams, ApproveRollingReleaseStageQueryParams, ArtifactQueryQueryParams, AssignAliasPathParams, AssignAliasQueryParams, BuyDomainQueryParams, CancelDeploymentPathParams, CancelDeploymentQueryParams, CheckDomainPriceQueryParams, CheckDomainStatusQueryParams, CompleteRollingReleasePathParams, CompleteRollingReleaseQueryParams, CreateAccessGroupProjectPathParams, CreateAccessGroupProjectQueryParams, CreateAccessGroupQueryParams, CreateAuthTokenQueryParams, CreateCheckPathParams, CreateCheckQueryParams, CreateCustomEnvironmentPathParams, CreateCustomEnvironmentQueryParams, CreateDeploymentQueryParams, CreateEdgeConfigQueryParams, CreateEdgeConfigTokenPathParams, CreateEdgeConfigTokenQueryParams, CreateEventPathParams, CreateExperimentationItemPathParams, CreateLogDrainQueryParams, CreateOrTransferDomainQueryParams, CreateProjectEnvPathParams, CreateProjectEnvQueryParams, CreateProjectQueryParams, CreateProjectTransferRequestPathParams, CreateProjectTransferRequestQueryParams, CreateRecordPathParams, CreateRecordQueryParams, CreateSecretPathParams, CreateSecretQueryParams, CreateWebhookQueryParams, DeleteAccessGroupPathParams, DeleteAccessGroupProjectPathParams, DeleteAccessGroupProjectQueryParams, DeleteAccessGroupQueryParams, DeleteAliasPathParams, DeleteAliasQueryParams, DeleteAuthTokenPathParams, DeleteConfigurationPathParams, DeleteConfigurationQueryParams, DeleteDeploymentPathParams, DeleteDeploymentQueryParams, DeleteDomainPathParams, DeleteDomainQueryParams, DeleteEdgeConfigPathParams, DeleteEdgeConfigQueryParams, DeleteEdgeConfigSchemaPathParams, DeleteEdgeConfigSchemaQueryParams, DeleteEdgeConfigTokensPathParams, DeleteEdgeConfigTokensQueryParams, DeleteExperimentationItemPathParams, DeleteIntegrationLogDrainPathParams, DeleteIntegrationLogDrainQueryParams, DeleteIntegrationResourcePathParams, DeleteProjectPathParams, DeleteProjectQueryParams, DeleteRollingReleaseConfigPathParams, DeleteRollingReleaseConfigQueryParams, DeleteSecretPathParams, DeleteSecretQueryParams, DeleteTeamInviteCodePathParams, DeleteTeamPathParams, DeleteTeamQueryParams, DeleteWebhookPathParams, DeleteWebhookQueryParams, DownloadArtifactHeaderParams, DownloadArtifactPathParams, DownloadArtifactQueryParams, EditProjectEnvPathParams, EditProjectEnvQueryParams, FilterProjectEnvsPathParams, FilterProjectEnvsQueryParams, GetAccountInfoPathParams, GetActiveAttackStatusQueryParams, GetAliasPathParams, GetAliasQueryParams, GetAllChecksPathParams, GetAllChecksQueryParams, GetAuthTokenPathParams, GetBypassIpQueryParams, GetCertByIdPathParams, GetCertByIdQueryParams, GetCheckPathParams, GetCheckQueryParams, GetConfigurationPathParams, GetConfigurationQueryParams, GetConfigurationsQueryParams, GetCustomEnvironmentPathParams, GetCustomEnvironmentQueryParams, GetDeploymentEventsPathParams, GetDeploymentEventsQueryParams, GetDeploymentFileContentsPathParams, GetDeploymentFileContentsQueryParams, GetDeploymentPathParams, GetDeploymentQueryParams, GetDeploymentsQueryParams, GetDomainConfigPathParams, GetDomainConfigQueryParams, GetDomainPathParams, GetDomainQueryParams, GetDomainsQueryParams, GetDomainTransferPathParams, GetDomainTransferQueryParams, GetEdgeConfigBackupPathParams, GetEdgeConfigBackupQueryParams, GetEdgeConfigBackupsPathParams, GetEdgeConfigBackupsQueryParams, GetEdgeConfigItemPathParams, GetEdgeConfigItemQueryParams, GetEdgeConfigItemsPathParams, GetEdgeConfigItemsQueryParams, GetEdgeConfigPathParams, GetEdgeConfigQueryParams, GetEdgeConfigSchemaPathParams, GetEdgeConfigSchemaQueryParams, GetEdgeConfigsQueryParams, GetEdgeConfigTokenPathParams, GetEdgeConfigTokenQueryParams, GetEdgeConfigTokensPathParams, GetEdgeConfigTokensQueryParams, GetFirewallConfigPathParams, GetFirewallConfigQueryParams, GetIntegrationLogDrainsQueryParams, GetIntegrationResourcePathParams, GetIntegrationResourcesPathParams, GetInvoicePathParams, GetMemberPathParams, GetProjectDomainPathParams, GetProjectDomainQueryParams, GetProjectDomainsPathParams, GetProjectDomainsQueryParams, GetProjectEnvPathParams, GetProjectEnvQueryParams, GetProjectMembersPathParams, GetProjectMembersQueryParams, GetProjectPathParams, GetProjectQueryParams, GetProjectsQueryParams, GetRecordsPathParams, GetRecordsQueryParams, GetRollingReleaseBillingStatusPathParams, GetRollingReleaseBillingStatusQueryParams, GetRollingReleaseConfigPathParams, GetRollingReleaseConfigQueryParams, GetRollingReleasePathParams, GetRollingReleaseQueryParams, GetRuntimeLogsPathParams, GetRuntimeLogsQueryParams, GetSecretPathParams, GetSecretQueryParams, GetSecretsQueryParams, GetTeamAccessRequestPathParams, GetTeamMembersPathParams, GetTeamMembersQueryParams, GetTeamPathParams, GetTeamQueryParams, GetTeamsQueryParams, GetWebhookPathParams, GetWebhookQueryParams, GetWebhooksQueryParams, ImportResourcePathParams, InviteUserToTeamPathParams, IssueCertQueryParams, JoinTeamPathParams, ListAccessGroupMembersPathParams, ListAccessGroupMembersQueryParams, ListAccessGroupProjectsPathParams, ListAccessGroupProjectsQueryParams, ListAccessGroupsQueryParams, ListAliasesQueryParams, ListCustomEnvironmentsPathParams, ListCustomEnvironmentsQueryParams, ListDeploymentAliasesPathParams, ListDeploymentAliasesQueryParams, ListDeploymentFilesPathParams, ListDeploymentFilesQueryParams, ListPromoteAliasesPathParams, ListPromoteAliasesQueryParams, ListUserEventsQueryParams, MoveProjectDomainPathParams, MoveProjectDomainQueryParams, PatchDomainPathParams, PatchDomainQueryParams, PatchEdgeConfigItemsPathParams, PatchEdgeConfigItemsQueryParams, PatchEdgeConfigSchemaPathParams, PatchEdgeConfigSchemaQueryParams, PatchTeamPathParams, PatchTeamQueryParams, PatchUrlProtectionBypassPathParams, PatchUrlProtectionBypassQueryParams, PauseProjectPathParams, PauseProjectQueryParams, PurgeAllDataCacheQueryParams, PutFirewallConfigQueryParams, ReadAccessGroupPathParams, ReadAccessGroupProjectPathParams, ReadAccessGroupProjectQueryParams, ReadAccessGroupQueryParams, RecordEventsHeaderParams, RecordEventsQueryParams, RemoveBypassIpQueryParams, RemoveCertPathParams, RemoveCertQueryParams, RemoveCustomEnvironmentPathParams, RemoveCustomEnvironmentQueryParams, RemoveProjectDomainPathParams, RemoveProjectDomainQueryParams, RemoveProjectEnvPathParams, RemoveProjectEnvQueryParams, RemoveProjectMemberPathParams, RemoveProjectMemberQueryParams, RemoveRecordPathParams, RemoveRecordQueryParams, RemoveTeamMemberPathParams, RemoveTeamMemberQueryParams, RenameSecretPathParams, RenameSecretQueryParams, RequestAccessToTeamPathParams, RequestPromotePathParams, RequestPromoteQueryParams, RerequestCheckPathParams, RerequestCheckQueryParams, StatusQueryParams, SubmitBillingDataPathParams, SubmitInvoicePathParams, SubmitPrepaymentBalancesPathParams, UnpauseProjectPathParams, UnpauseProjectQueryParams, UpdateAccessGroupPathParams, UpdateAccessGroupProjectPathParams, UpdateAccessGroupProjectQueryParams, UpdateAccessGroupQueryParams, UpdateAttackChallengeModeQueryParams, UpdateCheckPathParams, UpdateCheckQueryParams, UpdateCustomEnvironmentPathParams, UpdateCustomEnvironmentQueryParams, UpdateEdgeConfigPathParams, UpdateEdgeConfigQueryParams, UpdateExperimentationEdgeConfigPathParams, UpdateExperimentationItemPathParams, UpdateFirewallConfigQueryParams, UpdateIntegrationDeploymentActionPathParams, UpdateInvoicePathParams, UpdateProjectDataCachePathParams, UpdateProjectDataCacheQueryParams, UpdateProjectDomainPathParams, UpdateProjectDomainQueryParams, UpdateProjectPathParams, UpdateProjectProtectionBypassPathParams, UpdateProjectProtectionBypassQueryParams, UpdateProjectQueryParams, UpdateRecordPathParams, UpdateRecordQueryParams, UpdateResourceSecretsByIdPathParams, UpdateResourceSecretsPathParams, UpdateRollingReleaseConfigPathParams, UpdateRollingReleaseConfigQueryParams, UpdateTeamMemberPathParams, UploadArtifactHeaderParams, UploadArtifactPathParams, UploadArtifactQueryParams, UploadCertQueryParams, UploadFileHeaderParams, UploadFileQueryParams, VerifyProjectDomainPathParams, VerifyProjectDomainQueryParams } from "./types.js";
|
|
8
8
|
/**
|
|
9
9
|
* @description Allows to read an access group
|
|
10
10
|
* @summary Reads an access group
|
|
11
|
-
* {@link
|
|
11
|
+
* {@link /v1/access-groups/:idOrName}
|
|
12
12
|
*/
|
|
13
|
-
export declare function readAccessGroup({ pathParams: { idOrName }, queryParams, config
|
|
13
|
+
export declare function readAccessGroup({ pathParams: { idOrName }, queryParams, config }: {
|
|
14
14
|
pathParams: ReadAccessGroupPathParams;
|
|
15
|
-
queryParams?: ReadAccessGroupQueryParams;
|
|
15
|
+
queryParams?: ReadAccessGroupQueryParams | undefined;
|
|
16
16
|
config?: Partial<FetcherConfig> & {
|
|
17
17
|
client?: typeof client;
|
|
18
18
|
};
|
|
@@ -20,11 +20,11 @@ export declare function readAccessGroup({ pathParams: { idOrName }, queryParams,
|
|
|
20
20
|
/**
|
|
21
21
|
* @description Allows to update an access group metadata
|
|
22
22
|
* @summary Update an access group
|
|
23
|
-
* {@link
|
|
23
|
+
* {@link /v1/access-groups/:idOrName}
|
|
24
24
|
*/
|
|
25
|
-
export declare function updateAccessGroup({ pathParams: { idOrName }, queryParams, config
|
|
25
|
+
export declare function updateAccessGroup({ pathParams: { idOrName }, queryParams, config }: {
|
|
26
26
|
pathParams: UpdateAccessGroupPathParams;
|
|
27
|
-
queryParams?: UpdateAccessGroupQueryParams;
|
|
27
|
+
queryParams?: UpdateAccessGroupQueryParams | undefined;
|
|
28
28
|
config?: Partial<FetcherConfig> & {
|
|
29
29
|
client?: typeof client;
|
|
30
30
|
};
|
|
@@ -32,11 +32,11 @@ export declare function updateAccessGroup({ pathParams: { idOrName }, queryParam
|
|
|
32
32
|
/**
|
|
33
33
|
* @description Allows to delete an access group
|
|
34
34
|
* @summary Deletes an access group
|
|
35
|
-
* {@link
|
|
35
|
+
* {@link /v1/access-groups/:idOrName}
|
|
36
36
|
*/
|
|
37
|
-
export declare function deleteAccessGroup({ pathParams: { idOrName }, queryParams, config
|
|
37
|
+
export declare function deleteAccessGroup({ pathParams: { idOrName }, queryParams, config }: {
|
|
38
38
|
pathParams: DeleteAccessGroupPathParams;
|
|
39
|
-
queryParams?: DeleteAccessGroupQueryParams;
|
|
39
|
+
queryParams?: DeleteAccessGroupQueryParams | undefined;
|
|
40
40
|
config?: Partial<FetcherConfig> & {
|
|
41
41
|
client?: typeof client;
|
|
42
42
|
};
|
|
@@ -44,11 +44,11 @@ export declare function deleteAccessGroup({ pathParams: { idOrName }, queryParam
|
|
|
44
44
|
/**
|
|
45
45
|
* @description List members of an access group
|
|
46
46
|
* @summary List members of an access group
|
|
47
|
-
* {@link
|
|
47
|
+
* {@link /v1/access-groups/:idOrName/members}
|
|
48
48
|
*/
|
|
49
|
-
export declare function listAccessGroupMembers({ pathParams: { idOrName }, queryParams, config
|
|
49
|
+
export declare function listAccessGroupMembers({ pathParams: { idOrName }, queryParams, config }: {
|
|
50
50
|
pathParams: ListAccessGroupMembersPathParams;
|
|
51
|
-
queryParams?: ListAccessGroupMembersQueryParams;
|
|
51
|
+
queryParams?: ListAccessGroupMembersQueryParams | undefined;
|
|
52
52
|
config?: Partial<FetcherConfig> & {
|
|
53
53
|
client?: typeof client;
|
|
54
54
|
};
|
|
@@ -56,10 +56,10 @@ export declare function listAccessGroupMembers({ pathParams: { idOrName }, query
|
|
|
56
56
|
/**
|
|
57
57
|
* @description List access groups
|
|
58
58
|
* @summary List access groups for a team, project or member
|
|
59
|
-
* {@link
|
|
59
|
+
* {@link /v1/access-groups}
|
|
60
60
|
*/
|
|
61
|
-
export declare function listAccessGroups({ queryParams, config
|
|
62
|
-
queryParams?: ListAccessGroupsQueryParams;
|
|
61
|
+
export declare function listAccessGroups({ queryParams, config }: {
|
|
62
|
+
queryParams?: ListAccessGroupsQueryParams | undefined;
|
|
63
63
|
config?: Partial<FetcherConfig> & {
|
|
64
64
|
client?: typeof client;
|
|
65
65
|
};
|
|
@@ -67,10 +67,10 @@ export declare function listAccessGroups({ queryParams, config, }: {
|
|
|
67
67
|
/**
|
|
68
68
|
* @description Allows to create an access group
|
|
69
69
|
* @summary Creates an access group
|
|
70
|
-
* {@link
|
|
70
|
+
* {@link /v1/access-groups}
|
|
71
71
|
*/
|
|
72
|
-
export declare function createAccessGroup({ queryParams, config
|
|
73
|
-
queryParams?: CreateAccessGroupQueryParams;
|
|
72
|
+
export declare function createAccessGroup({ queryParams, config }: {
|
|
73
|
+
queryParams?: CreateAccessGroupQueryParams | undefined;
|
|
74
74
|
config?: Partial<FetcherConfig> & {
|
|
75
75
|
client?: typeof client;
|
|
76
76
|
};
|
|
@@ -78,11 +78,11 @@ export declare function createAccessGroup({ queryParams, config, }: {
|
|
|
78
78
|
/**
|
|
79
79
|
* @description List projects of an access group
|
|
80
80
|
* @summary List projects of an access group
|
|
81
|
-
* {@link
|
|
81
|
+
* {@link /v1/access-groups/:idOrName/projects}
|
|
82
82
|
*/
|
|
83
|
-
export declare function listAccessGroupProjects({ pathParams: { idOrName }, queryParams, config
|
|
83
|
+
export declare function listAccessGroupProjects({ pathParams: { idOrName }, queryParams, config }: {
|
|
84
84
|
pathParams: ListAccessGroupProjectsPathParams;
|
|
85
|
-
queryParams?: ListAccessGroupProjectsQueryParams;
|
|
85
|
+
queryParams?: ListAccessGroupProjectsQueryParams | undefined;
|
|
86
86
|
config?: Partial<FetcherConfig> & {
|
|
87
87
|
client?: typeof client;
|
|
88
88
|
};
|
|
@@ -90,11 +90,11 @@ export declare function listAccessGroupProjects({ pathParams: { idOrName }, quer
|
|
|
90
90
|
/**
|
|
91
91
|
* @description Allows creation of an access group project
|
|
92
92
|
* @summary Create an access group project
|
|
93
|
-
* {@link
|
|
93
|
+
* {@link /v1/access-groups/:accessGroupIdOrName/projects}
|
|
94
94
|
*/
|
|
95
|
-
export declare function createAccessGroupProject({ pathParams: { accessGroupIdOrName }, queryParams, config
|
|
95
|
+
export declare function createAccessGroupProject({ pathParams: { accessGroupIdOrName }, queryParams, config }: {
|
|
96
96
|
pathParams: CreateAccessGroupProjectPathParams;
|
|
97
|
-
queryParams?: CreateAccessGroupProjectQueryParams;
|
|
97
|
+
queryParams?: CreateAccessGroupProjectQueryParams | undefined;
|
|
98
98
|
config?: Partial<FetcherConfig> & {
|
|
99
99
|
client?: typeof client;
|
|
100
100
|
};
|
|
@@ -102,11 +102,11 @@ export declare function createAccessGroupProject({ pathParams: { accessGroupIdOr
|
|
|
102
102
|
/**
|
|
103
103
|
* @description Allows reading an access group project
|
|
104
104
|
* @summary Reads an access group project
|
|
105
|
-
* {@link
|
|
105
|
+
* {@link /v1/access-groups/:accessGroupIdOrName/projects/:projectId}
|
|
106
106
|
*/
|
|
107
|
-
export declare function readAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config
|
|
107
|
+
export declare function readAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config }: {
|
|
108
108
|
pathParams: ReadAccessGroupProjectPathParams;
|
|
109
|
-
queryParams?: ReadAccessGroupProjectQueryParams;
|
|
109
|
+
queryParams?: ReadAccessGroupProjectQueryParams | undefined;
|
|
110
110
|
config?: Partial<FetcherConfig> & {
|
|
111
111
|
client?: typeof client;
|
|
112
112
|
};
|
|
@@ -114,11 +114,11 @@ export declare function readAccessGroupProject({ pathParams: { accessGroupIdOrNa
|
|
|
114
114
|
/**
|
|
115
115
|
* @description Allows update of an access group project
|
|
116
116
|
* @summary Update an access group project
|
|
117
|
-
* {@link
|
|
117
|
+
* {@link /v1/access-groups/:accessGroupIdOrName/projects/:projectId}
|
|
118
118
|
*/
|
|
119
|
-
export declare function updateAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config
|
|
119
|
+
export declare function updateAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config }: {
|
|
120
120
|
pathParams: UpdateAccessGroupProjectPathParams;
|
|
121
|
-
queryParams?: UpdateAccessGroupProjectQueryParams;
|
|
121
|
+
queryParams?: UpdateAccessGroupProjectQueryParams | undefined;
|
|
122
122
|
config?: Partial<FetcherConfig> & {
|
|
123
123
|
client?: typeof client;
|
|
124
124
|
};
|
|
@@ -126,11 +126,11 @@ export declare function updateAccessGroupProject({ pathParams: { accessGroupIdOr
|
|
|
126
126
|
/**
|
|
127
127
|
* @description Allows deletion of an access group project
|
|
128
128
|
* @summary Delete an access group project
|
|
129
|
-
* {@link
|
|
129
|
+
* {@link /v1/access-groups/:accessGroupIdOrName/projects/:projectId}
|
|
130
130
|
*/
|
|
131
|
-
export declare function deleteAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config
|
|
131
|
+
export declare function deleteAccessGroupProject({ pathParams: { accessGroupIdOrName, projectId }, queryParams, config }: {
|
|
132
132
|
pathParams: DeleteAccessGroupProjectPathParams;
|
|
133
|
-
queryParams?: DeleteAccessGroupProjectQueryParams;
|
|
133
|
+
queryParams?: DeleteAccessGroupProjectQueryParams | undefined;
|
|
134
134
|
config?: Partial<FetcherConfig> & {
|
|
135
135
|
client?: typeof client;
|
|
136
136
|
};
|
|
@@ -138,11 +138,11 @@ export declare function deleteAccessGroupProject({ pathParams: { accessGroupIdOr
|
|
|
138
138
|
/**
|
|
139
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
140
|
* @summary Record an artifacts cache usage event
|
|
141
|
-
* {@link
|
|
141
|
+
* {@link /v8/artifacts/events}
|
|
142
142
|
*/
|
|
143
|
-
export declare function recordEvents({ queryParams, headers, config
|
|
144
|
-
queryParams?: RecordEventsQueryParams;
|
|
145
|
-
headers?: RecordEventsHeaderParams;
|
|
143
|
+
export declare function recordEvents({ queryParams, headers, config }: {
|
|
144
|
+
queryParams?: RecordEventsQueryParams | undefined;
|
|
145
|
+
headers?: RecordEventsHeaderParams | undefined;
|
|
146
146
|
config?: Partial<FetcherConfig> & {
|
|
147
147
|
client?: typeof client;
|
|
148
148
|
};
|
|
@@ -150,10 +150,10 @@ export declare function recordEvents({ queryParams, headers, config, }: {
|
|
|
150
150
|
/**
|
|
151
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
152
|
* @summary Get status of Remote Caching for this principal
|
|
153
|
-
* {@link
|
|
153
|
+
* {@link /v8/artifacts/status}
|
|
154
154
|
*/
|
|
155
155
|
export declare function status({ queryParams, config }: {
|
|
156
|
-
queryParams?: StatusQueryParams;
|
|
156
|
+
queryParams?: StatusQueryParams | undefined;
|
|
157
157
|
config?: Partial<FetcherConfig> & {
|
|
158
158
|
client?: typeof client;
|
|
159
159
|
};
|
|
@@ -161,12 +161,12 @@ export declare function status({ queryParams, config }: {
|
|
|
161
161
|
/**
|
|
162
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
163
|
* @summary Upload a cache artifact
|
|
164
|
-
* {@link
|
|
164
|
+
* {@link /v8/artifacts/:hash}
|
|
165
165
|
*/
|
|
166
|
-
export declare function uploadArtifact({ pathParams: { hash }, headers, queryParams, config
|
|
166
|
+
export declare function uploadArtifact({ pathParams: { hash }, headers, queryParams, config }: {
|
|
167
167
|
pathParams: UploadArtifactPathParams;
|
|
168
168
|
headers: UploadArtifactHeaderParams;
|
|
169
|
-
queryParams?: UploadArtifactQueryParams;
|
|
169
|
+
queryParams?: UploadArtifactQueryParams | undefined;
|
|
170
170
|
config?: Partial<FetcherConfig> & {
|
|
171
171
|
client?: typeof client;
|
|
172
172
|
};
|
|
@@ -174,12 +174,12 @@ export declare function uploadArtifact({ pathParams: { hash }, headers, queryPar
|
|
|
174
174
|
/**
|
|
175
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
176
|
* @summary Download a cache artifact
|
|
177
|
-
* {@link
|
|
177
|
+
* {@link /v8/artifacts/:hash}
|
|
178
178
|
*/
|
|
179
|
-
export declare function downloadArtifact({ pathParams: { hash }, queryParams, headers, config
|
|
179
|
+
export declare function downloadArtifact({ pathParams: { hash }, queryParams, headers, config }: {
|
|
180
180
|
pathParams: DownloadArtifactPathParams;
|
|
181
|
-
queryParams?: DownloadArtifactQueryParams;
|
|
182
|
-
headers?: DownloadArtifactHeaderParams;
|
|
181
|
+
queryParams?: DownloadArtifactQueryParams | undefined;
|
|
182
|
+
headers?: DownloadArtifactHeaderParams | undefined;
|
|
183
183
|
config?: Partial<FetcherConfig> & {
|
|
184
184
|
client?: typeof client;
|
|
185
185
|
};
|
|
@@ -187,10 +187,10 @@ export declare function downloadArtifact({ pathParams: { hash }, queryParams, he
|
|
|
187
187
|
/**
|
|
188
188
|
* @description Query information about an array of artifacts.
|
|
189
189
|
* @summary Query information about an artifact
|
|
190
|
-
* {@link
|
|
190
|
+
* {@link /v8/artifacts}
|
|
191
191
|
*/
|
|
192
|
-
export declare function artifactQuery({ queryParams, config
|
|
193
|
-
queryParams?: ArtifactQueryQueryParams;
|
|
192
|
+
export declare function artifactQuery({ queryParams, config }: {
|
|
193
|
+
queryParams?: ArtifactQueryQueryParams | undefined;
|
|
194
194
|
config?: Partial<FetcherConfig> & {
|
|
195
195
|
client?: typeof client;
|
|
196
196
|
};
|
|
@@ -198,11 +198,11 @@ export declare function artifactQuery({ queryParams, config, }: {
|
|
|
198
198
|
/**
|
|
199
199
|
* @description Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
|
|
200
200
|
* @summary Creates a new Check
|
|
201
|
-
* {@link
|
|
201
|
+
* {@link /v1/deployments/:deploymentId/checks}
|
|
202
202
|
*/
|
|
203
|
-
export declare function createCheck({ pathParams: { deploymentId }, queryParams, config
|
|
203
|
+
export declare function createCheck({ pathParams: { deploymentId }, queryParams, config }: {
|
|
204
204
|
pathParams: CreateCheckPathParams;
|
|
205
|
-
queryParams?: CreateCheckQueryParams;
|
|
205
|
+
queryParams?: CreateCheckQueryParams | undefined;
|
|
206
206
|
config?: Partial<FetcherConfig> & {
|
|
207
207
|
client?: typeof client;
|
|
208
208
|
};
|
|
@@ -210,11 +210,11 @@ export declare function createCheck({ pathParams: { deploymentId }, queryParams,
|
|
|
210
210
|
/**
|
|
211
211
|
* @description List all of the checks created for a deployment.
|
|
212
212
|
* @summary Retrieve a list of all checks
|
|
213
|
-
* {@link
|
|
213
|
+
* {@link /v1/deployments/:deploymentId/checks}
|
|
214
214
|
*/
|
|
215
|
-
export declare function getAllChecks({ pathParams: { deploymentId }, queryParams, config
|
|
215
|
+
export declare function getAllChecks({ pathParams: { deploymentId }, queryParams, config }: {
|
|
216
216
|
pathParams: GetAllChecksPathParams;
|
|
217
|
-
queryParams?: GetAllChecksQueryParams;
|
|
217
|
+
queryParams?: GetAllChecksQueryParams | undefined;
|
|
218
218
|
config?: Partial<FetcherConfig> & {
|
|
219
219
|
client?: typeof client;
|
|
220
220
|
};
|
|
@@ -222,11 +222,11 @@ export declare function getAllChecks({ pathParams: { deploymentId }, queryParams
|
|
|
222
222
|
/**
|
|
223
223
|
* @description Return a detailed response for a single check.
|
|
224
224
|
* @summary Get a single check
|
|
225
|
-
* {@link
|
|
225
|
+
* {@link /v1/deployments/:deploymentId/checks/:checkId}
|
|
226
226
|
*/
|
|
227
|
-
export declare function getCheck({ pathParams: { deploymentId, checkId }, queryParams, config
|
|
227
|
+
export declare function getCheck({ pathParams: { deploymentId, checkId }, queryParams, config }: {
|
|
228
228
|
pathParams: GetCheckPathParams;
|
|
229
|
-
queryParams?: GetCheckQueryParams;
|
|
229
|
+
queryParams?: GetCheckQueryParams | undefined;
|
|
230
230
|
config?: Partial<FetcherConfig> & {
|
|
231
231
|
client?: typeof client;
|
|
232
232
|
};
|
|
@@ -234,11 +234,11 @@ export declare function getCheck({ pathParams: { deploymentId, checkId }, queryP
|
|
|
234
234
|
/**
|
|
235
235
|
* @description Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
|
|
236
236
|
* @summary Update a check
|
|
237
|
-
* {@link
|
|
237
|
+
* {@link /v1/deployments/:deploymentId/checks/:checkId}
|
|
238
238
|
*/
|
|
239
|
-
export declare function updateCheck({ pathParams: { deploymentId, checkId }, queryParams, config
|
|
239
|
+
export declare function updateCheck({ pathParams: { deploymentId, checkId }, queryParams, config }: {
|
|
240
240
|
pathParams: UpdateCheckPathParams;
|
|
241
|
-
queryParams?: UpdateCheckQueryParams;
|
|
241
|
+
queryParams?: UpdateCheckQueryParams | undefined;
|
|
242
242
|
config?: Partial<FetcherConfig> & {
|
|
243
243
|
client?: typeof client;
|
|
244
244
|
};
|
|
@@ -246,26 +246,26 @@ export declare function updateCheck({ pathParams: { deploymentId, checkId }, que
|
|
|
246
246
|
/**
|
|
247
247
|
* @description Rerequest a selected check that has failed.
|
|
248
248
|
* @summary Rerequest a check
|
|
249
|
-
* {@link
|
|
249
|
+
* {@link /v1/deployments/:deploymentId/checks/:checkId/rerequest}
|
|
250
250
|
*/
|
|
251
|
-
export declare function rerequestCheck({ pathParams: { deploymentId, checkId }, queryParams, config
|
|
251
|
+
export declare function rerequestCheck({ pathParams: { deploymentId, checkId }, queryParams, config }: {
|
|
252
252
|
pathParams: RerequestCheckPathParams;
|
|
253
|
-
queryParams?: RerequestCheckQueryParams;
|
|
253
|
+
queryParams?: RerequestCheckQueryParams | undefined;
|
|
254
254
|
config?: Partial<FetcherConfig> & {
|
|
255
255
|
client?: typeof client;
|
|
256
256
|
};
|
|
257
257
|
}): Promise<unknown>;
|
|
258
258
|
/**
|
|
259
|
-
* {@link
|
|
259
|
+
* {@link /data-cache/purge-all}
|
|
260
260
|
*/
|
|
261
|
-
export declare function purgeAllDataCache({ queryParams, config
|
|
261
|
+
export declare function purgeAllDataCache({ queryParams, config }: {
|
|
262
262
|
queryParams: PurgeAllDataCacheQueryParams;
|
|
263
263
|
config?: Partial<FetcherConfig> & {
|
|
264
264
|
client?: typeof client;
|
|
265
265
|
};
|
|
266
266
|
}): Promise<unknown>;
|
|
267
267
|
/**
|
|
268
|
-
* {@link
|
|
268
|
+
* {@link /data-cache/billing-settings}
|
|
269
269
|
*/
|
|
270
270
|
export declare function updateDataCacheBillingSettings({ config }: {
|
|
271
271
|
config?: Partial<FetcherConfig> & {
|
|
@@ -275,11 +275,11 @@ export declare function updateDataCacheBillingSettings({ config }: {
|
|
|
275
275
|
/**
|
|
276
276
|
* @description Update the data cache feature on a project.
|
|
277
277
|
* @summary Update the data cache feature
|
|
278
|
-
* {@link
|
|
278
|
+
* {@link /v1/data-cache/projects/:projectId}
|
|
279
279
|
*/
|
|
280
|
-
export declare function updateProjectDataCache({ pathParams: { projectId }, queryParams, config
|
|
280
|
+
export declare function updateProjectDataCache({ pathParams: { projectId }, queryParams, config }: {
|
|
281
281
|
pathParams: UpdateProjectDataCachePathParams;
|
|
282
|
-
queryParams?: UpdateProjectDataCacheQueryParams;
|
|
282
|
+
queryParams?: UpdateProjectDataCacheQueryParams | undefined;
|
|
283
283
|
config?: Partial<FetcherConfig> & {
|
|
284
284
|
client?: typeof client;
|
|
285
285
|
};
|
|
@@ -287,11 +287,11 @@ export declare function updateProjectDataCache({ pathParams: { projectId }, quer
|
|
|
287
287
|
/**
|
|
288
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
289
|
* @summary Get deployment events
|
|
290
|
-
* {@link
|
|
290
|
+
* {@link /v3/deployments/:idOrUrl/events}
|
|
291
291
|
*/
|
|
292
|
-
export declare function getDeploymentEvents({ pathParams: { idOrUrl }, queryParams, config
|
|
292
|
+
export declare function getDeploymentEvents({ pathParams: { idOrUrl }, queryParams, config }: {
|
|
293
293
|
pathParams: GetDeploymentEventsPathParams;
|
|
294
|
-
queryParams?: GetDeploymentEventsQueryParams;
|
|
294
|
+
queryParams?: GetDeploymentEventsQueryParams | undefined;
|
|
295
295
|
config?: Partial<FetcherConfig> & {
|
|
296
296
|
client?: typeof client;
|
|
297
297
|
};
|
|
@@ -299,9 +299,9 @@ export declare function getDeploymentEvents({ pathParams: { idOrUrl }, queryPara
|
|
|
299
299
|
/**
|
|
300
300
|
* @description Updates the deployment integration action for the specified integration installation
|
|
301
301
|
* @summary Update deployment integration action
|
|
302
|
-
* {@link
|
|
302
|
+
* {@link /v1/deployments/:deploymentId/integrations/:integrationConfigurationId/resources/:resourceId/actions/:action}
|
|
303
303
|
*/
|
|
304
|
-
export declare function updateIntegrationDeploymentAction({ pathParams: { deploymentId, integrationConfigurationId, resourceId, action }, config
|
|
304
|
+
export declare function updateIntegrationDeploymentAction({ pathParams: { deploymentId, integrationConfigurationId, resourceId, action }, config }: {
|
|
305
305
|
pathParams: UpdateIntegrationDeploymentActionPathParams;
|
|
306
306
|
config?: Partial<FetcherConfig> & {
|
|
307
307
|
client?: typeof client;
|
|
@@ -310,11 +310,11 @@ export declare function updateIntegrationDeploymentAction({ pathParams: { deploy
|
|
|
310
310
|
/**
|
|
311
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
312
|
* @summary Get a deployment by ID or URL
|
|
313
|
-
* {@link
|
|
313
|
+
* {@link /v13/deployments/:idOrUrl}
|
|
314
314
|
*/
|
|
315
|
-
export declare function getDeployment({ pathParams: { idOrUrl }, queryParams, config
|
|
315
|
+
export declare function getDeployment({ pathParams: { idOrUrl }, queryParams, config }: {
|
|
316
316
|
pathParams: GetDeploymentPathParams;
|
|
317
|
-
queryParams?: GetDeploymentQueryParams;
|
|
317
|
+
queryParams?: GetDeploymentQueryParams | undefined;
|
|
318
318
|
config?: Partial<FetcherConfig> & {
|
|
319
319
|
client?: typeof client;
|
|
320
320
|
};
|
|
@@ -322,10 +322,10 @@ export declare function getDeployment({ pathParams: { idOrUrl }, queryParams, co
|
|
|
322
322
|
/**
|
|
323
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
324
|
* @summary Create a new deployment
|
|
325
|
-
* {@link
|
|
325
|
+
* {@link /v13/deployments}
|
|
326
326
|
*/
|
|
327
|
-
export declare function createDeployment({ queryParams, config
|
|
328
|
-
queryParams?: CreateDeploymentQueryParams;
|
|
327
|
+
export declare function createDeployment({ queryParams, config }: {
|
|
328
|
+
queryParams?: CreateDeploymentQueryParams | undefined;
|
|
329
329
|
config?: Partial<FetcherConfig> & {
|
|
330
330
|
client?: typeof client;
|
|
331
331
|
};
|
|
@@ -333,11 +333,11 @@ export declare function createDeployment({ queryParams, config, }: {
|
|
|
333
333
|
/**
|
|
334
334
|
* @description This endpoint allows you to cancel a deployment which is currently building, by supplying its `id` in the URL.
|
|
335
335
|
* @summary Cancel a deployment
|
|
336
|
-
* {@link
|
|
336
|
+
* {@link /v12/deployments/:id/cancel}
|
|
337
337
|
*/
|
|
338
|
-
export declare function cancelDeployment({ pathParams: { id }, queryParams, config
|
|
338
|
+
export declare function cancelDeployment({ pathParams: { id }, queryParams, config }: {
|
|
339
339
|
pathParams: CancelDeploymentPathParams;
|
|
340
|
-
queryParams?: CancelDeploymentQueryParams;
|
|
340
|
+
queryParams?: CancelDeploymentQueryParams | undefined;
|
|
341
341
|
config?: Partial<FetcherConfig> & {
|
|
342
342
|
client?: typeof client;
|
|
343
343
|
};
|
|
@@ -345,10 +345,10 @@ export declare function cancelDeployment({ pathParams: { id }, queryParams, conf
|
|
|
345
345
|
/**
|
|
346
346
|
* @description Allows to purchase the specified domain.
|
|
347
347
|
* @summary Purchase a domain
|
|
348
|
-
* {@link
|
|
348
|
+
* {@link /v5/domains/buy}
|
|
349
349
|
*/
|
|
350
|
-
export declare function buyDomain({ queryParams, config
|
|
351
|
-
queryParams?: BuyDomainQueryParams;
|
|
350
|
+
export declare function buyDomain({ queryParams, config }: {
|
|
351
|
+
queryParams?: BuyDomainQueryParams | undefined;
|
|
352
352
|
config?: Partial<FetcherConfig> & {
|
|
353
353
|
client?: typeof client;
|
|
354
354
|
};
|
|
@@ -356,9 +356,9 @@ export declare function buyDomain({ queryParams, config, }: {
|
|
|
356
356
|
/**
|
|
357
357
|
* @description Check the price to purchase a domain and how long a single purchase period is.
|
|
358
358
|
* @summary Check the price for a domain
|
|
359
|
-
* {@link
|
|
359
|
+
* {@link /v4/domains/price}
|
|
360
360
|
*/
|
|
361
|
-
export declare function checkDomainPrice({ queryParams, config
|
|
361
|
+
export declare function checkDomainPrice({ queryParams, config }: {
|
|
362
362
|
queryParams: CheckDomainPriceQueryParams;
|
|
363
363
|
config?: Partial<FetcherConfig> & {
|
|
364
364
|
client?: typeof client;
|
|
@@ -367,9 +367,9 @@ export declare function checkDomainPrice({ queryParams, config, }: {
|
|
|
367
367
|
/**
|
|
368
368
|
* @description Check if a domain name is available for purchase.
|
|
369
369
|
* @summary Check a Domain Availability
|
|
370
|
-
* {@link
|
|
370
|
+
* {@link /v4/domains/status}
|
|
371
371
|
*/
|
|
372
|
-
export declare function checkDomainStatus({ queryParams, config
|
|
372
|
+
export declare function checkDomainStatus({ queryParams, config }: {
|
|
373
373
|
queryParams: CheckDomainStatusQueryParams;
|
|
374
374
|
config?: Partial<FetcherConfig> & {
|
|
375
375
|
client?: typeof client;
|
|
@@ -378,11 +378,11 @@ export declare function checkDomainStatus({ queryParams, config, }: {
|
|
|
378
378
|
/**
|
|
379
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
380
|
* @summary List existing DNS records
|
|
381
|
-
* {@link
|
|
381
|
+
* {@link /v4/domains/:domain/records}
|
|
382
382
|
*/
|
|
383
|
-
export declare function getRecords({ pathParams: { domain }, queryParams, config
|
|
383
|
+
export declare function getRecords({ pathParams: { domain }, queryParams, config }: {
|
|
384
384
|
pathParams: GetRecordsPathParams;
|
|
385
|
-
queryParams?: GetRecordsQueryParams;
|
|
385
|
+
queryParams?: GetRecordsQueryParams | undefined;
|
|
386
386
|
config?: Partial<FetcherConfig> & {
|
|
387
387
|
client?: typeof client;
|
|
388
388
|
};
|
|
@@ -390,11 +390,11 @@ export declare function getRecords({ pathParams: { domain }, queryParams, config
|
|
|
390
390
|
/**
|
|
391
391
|
* @description Creates a DNS record for a domain.
|
|
392
392
|
* @summary Create a DNS record
|
|
393
|
-
* {@link
|
|
393
|
+
* {@link /v2/domains/:domain/records}
|
|
394
394
|
*/
|
|
395
|
-
export declare function createRecord({ pathParams: { domain }, queryParams, config
|
|
395
|
+
export declare function createRecord({ pathParams: { domain }, queryParams, config }: {
|
|
396
396
|
pathParams: CreateRecordPathParams;
|
|
397
|
-
queryParams?: CreateRecordQueryParams;
|
|
397
|
+
queryParams?: CreateRecordQueryParams | undefined;
|
|
398
398
|
config?: Partial<FetcherConfig> & {
|
|
399
399
|
client?: typeof client;
|
|
400
400
|
};
|
|
@@ -402,11 +402,11 @@ export declare function createRecord({ pathParams: { domain }, queryParams, conf
|
|
|
402
402
|
/**
|
|
403
403
|
* @description Updates an existing DNS record for a domain name.
|
|
404
404
|
* @summary Update an existing DNS record
|
|
405
|
-
* {@link
|
|
405
|
+
* {@link /v1/domains/records/:recordId}
|
|
406
406
|
*/
|
|
407
|
-
export declare function updateRecord({ pathParams: { recordId }, queryParams, config
|
|
407
|
+
export declare function updateRecord({ pathParams: { recordId }, queryParams, config }: {
|
|
408
408
|
pathParams: UpdateRecordPathParams;
|
|
409
|
-
queryParams?: UpdateRecordQueryParams;
|
|
409
|
+
queryParams?: UpdateRecordQueryParams | undefined;
|
|
410
410
|
config?: Partial<FetcherConfig> & {
|
|
411
411
|
client?: typeof client;
|
|
412
412
|
};
|
|
@@ -414,11 +414,11 @@ export declare function updateRecord({ pathParams: { recordId }, queryParams, co
|
|
|
414
414
|
/**
|
|
415
415
|
* @description Removes an existing DNS record from a domain name.
|
|
416
416
|
* @summary Delete a DNS record
|
|
417
|
-
* {@link
|
|
417
|
+
* {@link /v2/domains/:domain/records/:recordId}
|
|
418
418
|
*/
|
|
419
|
-
export declare function removeRecord({ pathParams: { domain, recordId }, queryParams, config
|
|
419
|
+
export declare function removeRecord({ pathParams: { domain, recordId }, queryParams, config }: {
|
|
420
420
|
pathParams: RemoveRecordPathParams;
|
|
421
|
-
queryParams?: RemoveRecordQueryParams;
|
|
421
|
+
queryParams?: RemoveRecordQueryParams | undefined;
|
|
422
422
|
config?: Partial<FetcherConfig> & {
|
|
423
423
|
client?: typeof client;
|
|
424
424
|
};
|
|
@@ -426,11 +426,11 @@ export declare function removeRecord({ pathParams: { domain, recordId }, queryPa
|
|
|
426
426
|
/**
|
|
427
427
|
* @description Fetch domain transfer availability or transfer status if a transfer is in progress.
|
|
428
428
|
* @summary Get domain transfer info.
|
|
429
|
-
* {@link
|
|
429
|
+
* {@link /v1/domains/:domain/registry}
|
|
430
430
|
*/
|
|
431
|
-
export declare function getDomainTransfer({ pathParams: { domain }, queryParams, config
|
|
431
|
+
export declare function getDomainTransfer({ pathParams: { domain }, queryParams, config }: {
|
|
432
432
|
pathParams: GetDomainTransferPathParams;
|
|
433
|
-
queryParams?: GetDomainTransferQueryParams;
|
|
433
|
+
queryParams?: GetDomainTransferQueryParams | undefined;
|
|
434
434
|
config?: Partial<FetcherConfig> & {
|
|
435
435
|
client?: typeof client;
|
|
436
436
|
};
|
|
@@ -438,11 +438,11 @@ export declare function getDomainTransfer({ pathParams: { domain }, queryParams,
|
|
|
438
438
|
/**
|
|
439
439
|
* @description Get a Domain's configuration.
|
|
440
440
|
* @summary Get a Domain's configuration
|
|
441
|
-
* {@link
|
|
441
|
+
* {@link /v6/domains/:domain/config}
|
|
442
442
|
*/
|
|
443
|
-
export declare function getDomainConfig({ pathParams: { domain }, queryParams, config
|
|
443
|
+
export declare function getDomainConfig({ pathParams: { domain }, queryParams, config }: {
|
|
444
444
|
pathParams: GetDomainConfigPathParams;
|
|
445
|
-
queryParams?: GetDomainConfigQueryParams;
|
|
445
|
+
queryParams?: GetDomainConfigQueryParams | undefined;
|
|
446
446
|
config?: Partial<FetcherConfig> & {
|
|
447
447
|
client?: typeof client;
|
|
448
448
|
};
|
|
@@ -450,11 +450,11 @@ export declare function getDomainConfig({ pathParams: { domain }, queryParams, c
|
|
|
450
450
|
/**
|
|
451
451
|
* @description Get information for a single domain in an account or team.
|
|
452
452
|
* @summary Get Information for a Single Domain
|
|
453
|
-
* {@link
|
|
453
|
+
* {@link /v5/domains/:domain}
|
|
454
454
|
*/
|
|
455
|
-
export declare function getDomain({ pathParams: { domain }, queryParams, config
|
|
455
|
+
export declare function getDomain({ pathParams: { domain }, queryParams, config }: {
|
|
456
456
|
pathParams: GetDomainPathParams;
|
|
457
|
-
queryParams?: GetDomainQueryParams;
|
|
457
|
+
queryParams?: GetDomainQueryParams | undefined;
|
|
458
458
|
config?: Partial<FetcherConfig> & {
|
|
459
459
|
client?: typeof client;
|
|
460
460
|
};
|
|
@@ -462,10 +462,10 @@ export declare function getDomain({ pathParams: { domain }, queryParams, config,
|
|
|
462
462
|
/**
|
|
463
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
464
|
* @summary List all the domains
|
|
465
|
-
* {@link
|
|
465
|
+
* {@link /v5/domains}
|
|
466
466
|
*/
|
|
467
|
-
export declare function getDomains({ queryParams, config
|
|
468
|
-
queryParams?: GetDomainsQueryParams;
|
|
467
|
+
export declare function getDomains({ queryParams, config }: {
|
|
468
|
+
queryParams?: GetDomainsQueryParams | undefined;
|
|
469
469
|
config?: Partial<FetcherConfig> & {
|
|
470
470
|
client?: typeof client;
|
|
471
471
|
};
|
|
@@ -473,10 +473,10 @@ export declare function getDomains({ queryParams, config, }: {
|
|
|
473
473
|
/**
|
|
474
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
475
|
* @summary Register or transfer-in a new Domain
|
|
476
|
-
* {@link
|
|
476
|
+
* {@link /v7/domains}
|
|
477
477
|
*/
|
|
478
|
-
export declare function createOrTransferDomain({ queryParams, config
|
|
479
|
-
queryParams?: CreateOrTransferDomainQueryParams;
|
|
478
|
+
export declare function createOrTransferDomain({ queryParams, config }: {
|
|
479
|
+
queryParams?: CreateOrTransferDomainQueryParams | undefined;
|
|
480
480
|
config?: Partial<FetcherConfig> & {
|
|
481
481
|
client?: typeof client;
|
|
482
482
|
};
|
|
@@ -484,11 +484,11 @@ export declare function createOrTransferDomain({ queryParams, config, }: {
|
|
|
484
484
|
/**
|
|
485
485
|
* @description Update or move apex domain.
|
|
486
486
|
* @summary Update or move apex domain
|
|
487
|
-
* {@link
|
|
487
|
+
* {@link /v3/domains/:domain}
|
|
488
488
|
*/
|
|
489
|
-
export declare function patchDomain({ pathParams: { domain }, queryParams, config
|
|
489
|
+
export declare function patchDomain({ pathParams: { domain }, queryParams, config }: {
|
|
490
490
|
pathParams: PatchDomainPathParams;
|
|
491
|
-
queryParams?: PatchDomainQueryParams;
|
|
491
|
+
queryParams?: PatchDomainQueryParams | undefined;
|
|
492
492
|
config?: Partial<FetcherConfig> & {
|
|
493
493
|
client?: typeof client;
|
|
494
494
|
};
|
|
@@ -496,11 +496,11 @@ export declare function patchDomain({ pathParams: { domain }, queryParams, confi
|
|
|
496
496
|
/**
|
|
497
497
|
* @description Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases.
|
|
498
498
|
* @summary Remove a domain by name
|
|
499
|
-
* {@link
|
|
499
|
+
* {@link /v6/domains/:domain}
|
|
500
500
|
*/
|
|
501
|
-
export declare function deleteDomain({ pathParams: { domain }, queryParams, config
|
|
501
|
+
export declare function deleteDomain({ pathParams: { domain }, queryParams, config }: {
|
|
502
502
|
pathParams: DeleteDomainPathParams;
|
|
503
|
-
queryParams?: DeleteDomainQueryParams;
|
|
503
|
+
queryParams?: DeleteDomainQueryParams | undefined;
|
|
504
504
|
config?: Partial<FetcherConfig> & {
|
|
505
505
|
client?: typeof client;
|
|
506
506
|
};
|
|
@@ -508,10 +508,10 @@ export declare function deleteDomain({ pathParams: { domain }, queryParams, conf
|
|
|
508
508
|
/**
|
|
509
509
|
* @description Returns all Edge Configs.
|
|
510
510
|
* @summary Get Edge Configs
|
|
511
|
-
* {@link
|
|
511
|
+
* {@link /v1/edge-config}
|
|
512
512
|
*/
|
|
513
|
-
export declare function getEdgeConfigs({ queryParams, config
|
|
514
|
-
queryParams?: GetEdgeConfigsQueryParams;
|
|
513
|
+
export declare function getEdgeConfigs({ queryParams, config }: {
|
|
514
|
+
queryParams?: GetEdgeConfigsQueryParams | undefined;
|
|
515
515
|
config?: Partial<FetcherConfig> & {
|
|
516
516
|
client?: typeof client;
|
|
517
517
|
};
|
|
@@ -519,10 +519,10 @@ export declare function getEdgeConfigs({ queryParams, config, }: {
|
|
|
519
519
|
/**
|
|
520
520
|
* @description Creates an Edge Config.
|
|
521
521
|
* @summary Create an Edge Config
|
|
522
|
-
* {@link
|
|
522
|
+
* {@link /v1/edge-config}
|
|
523
523
|
*/
|
|
524
|
-
export declare function createEdgeConfig({ queryParams, config
|
|
525
|
-
queryParams?: CreateEdgeConfigQueryParams;
|
|
524
|
+
export declare function createEdgeConfig({ queryParams, config }: {
|
|
525
|
+
queryParams?: CreateEdgeConfigQueryParams | undefined;
|
|
526
526
|
config?: Partial<FetcherConfig> & {
|
|
527
527
|
client?: typeof client;
|
|
528
528
|
};
|
|
@@ -530,11 +530,11 @@ export declare function createEdgeConfig({ queryParams, config, }: {
|
|
|
530
530
|
/**
|
|
531
531
|
* @description Returns an Edge Config.
|
|
532
532
|
* @summary Get an Edge Config
|
|
533
|
-
* {@link
|
|
533
|
+
* {@link /v1/edge-config/:edgeConfigId}
|
|
534
534
|
*/
|
|
535
|
-
export declare function getEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config
|
|
535
|
+
export declare function getEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
536
536
|
pathParams: GetEdgeConfigPathParams;
|
|
537
|
-
queryParams?: GetEdgeConfigQueryParams;
|
|
537
|
+
queryParams?: GetEdgeConfigQueryParams | undefined;
|
|
538
538
|
config?: Partial<FetcherConfig> & {
|
|
539
539
|
client?: typeof client;
|
|
540
540
|
};
|
|
@@ -542,11 +542,11 @@ export declare function getEdgeConfig({ pathParams: { edgeConfigId }, queryParam
|
|
|
542
542
|
/**
|
|
543
543
|
* @description Updates an Edge Config.
|
|
544
544
|
* @summary Update an Edge Config
|
|
545
|
-
* {@link
|
|
545
|
+
* {@link /v1/edge-config/:edgeConfigId}
|
|
546
546
|
*/
|
|
547
|
-
export declare function updateEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config
|
|
547
|
+
export declare function updateEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
548
548
|
pathParams: UpdateEdgeConfigPathParams;
|
|
549
|
-
queryParams?: UpdateEdgeConfigQueryParams;
|
|
549
|
+
queryParams?: UpdateEdgeConfigQueryParams | undefined;
|
|
550
550
|
config?: Partial<FetcherConfig> & {
|
|
551
551
|
client?: typeof client;
|
|
552
552
|
};
|
|
@@ -554,11 +554,11 @@ export declare function updateEdgeConfig({ pathParams: { edgeConfigId }, queryPa
|
|
|
554
554
|
/**
|
|
555
555
|
* @description Delete an Edge Config by id.
|
|
556
556
|
* @summary Delete an Edge Config
|
|
557
|
-
* {@link
|
|
557
|
+
* {@link /v1/edge-config/:edgeConfigId}
|
|
558
558
|
*/
|
|
559
|
-
export declare function deleteEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config
|
|
559
|
+
export declare function deleteEdgeConfig({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
560
560
|
pathParams: DeleteEdgeConfigPathParams;
|
|
561
|
-
queryParams?: DeleteEdgeConfigQueryParams;
|
|
561
|
+
queryParams?: DeleteEdgeConfigQueryParams | undefined;
|
|
562
562
|
config?: Partial<FetcherConfig> & {
|
|
563
563
|
client?: typeof client;
|
|
564
564
|
};
|
|
@@ -566,11 +566,11 @@ export declare function deleteEdgeConfig({ pathParams: { edgeConfigId }, queryPa
|
|
|
566
566
|
/**
|
|
567
567
|
* @description Returns all items of an Edge Config.
|
|
568
568
|
* @summary Get Edge Config items
|
|
569
|
-
* {@link
|
|
569
|
+
* {@link /v1/edge-config/:edgeConfigId/items}
|
|
570
570
|
*/
|
|
571
|
-
export declare function getEdgeConfigItems({ pathParams: { edgeConfigId }, queryParams, config
|
|
571
|
+
export declare function getEdgeConfigItems({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
572
572
|
pathParams: GetEdgeConfigItemsPathParams;
|
|
573
|
-
queryParams?: GetEdgeConfigItemsQueryParams;
|
|
573
|
+
queryParams?: GetEdgeConfigItemsQueryParams | undefined;
|
|
574
574
|
config?: Partial<FetcherConfig> & {
|
|
575
575
|
client?: typeof client;
|
|
576
576
|
};
|
|
@@ -578,11 +578,11 @@ export declare function getEdgeConfigItems({ pathParams: { edgeConfigId }, query
|
|
|
578
578
|
/**
|
|
579
579
|
* @description Update multiple Edge Config Items in batch.
|
|
580
580
|
* @summary Update Edge Config items in batch
|
|
581
|
-
* {@link
|
|
581
|
+
* {@link /v1/edge-config/:edgeConfigId/items}
|
|
582
582
|
*/
|
|
583
|
-
export declare function patchEdgeConfigItems({ pathParams: { edgeConfigId }, queryParams, config
|
|
583
|
+
export declare function patchEdgeConfigItems({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
584
584
|
pathParams: PatchEdgeConfigItemsPathParams;
|
|
585
|
-
queryParams?: PatchEdgeConfigItemsQueryParams;
|
|
585
|
+
queryParams?: PatchEdgeConfigItemsQueryParams | undefined;
|
|
586
586
|
config?: Partial<FetcherConfig> & {
|
|
587
587
|
client?: typeof client;
|
|
588
588
|
};
|
|
@@ -590,11 +590,11 @@ export declare function patchEdgeConfigItems({ pathParams: { edgeConfigId }, que
|
|
|
590
590
|
/**
|
|
591
591
|
* @description Returns the schema of an Edge Config.
|
|
592
592
|
* @summary Get Edge Config schema
|
|
593
|
-
* {@link
|
|
593
|
+
* {@link /v1/edge-config/:edgeConfigId/schema}
|
|
594
594
|
*/
|
|
595
|
-
export declare function getEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config
|
|
595
|
+
export declare function getEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
596
596
|
pathParams: GetEdgeConfigSchemaPathParams;
|
|
597
|
-
queryParams?: GetEdgeConfigSchemaQueryParams;
|
|
597
|
+
queryParams?: GetEdgeConfigSchemaQueryParams | undefined;
|
|
598
598
|
config?: Partial<FetcherConfig> & {
|
|
599
599
|
client?: typeof client;
|
|
600
600
|
};
|
|
@@ -602,11 +602,11 @@ export declare function getEdgeConfigSchema({ pathParams: { edgeConfigId }, quer
|
|
|
602
602
|
/**
|
|
603
603
|
* @description Update an Edge Config's schema.
|
|
604
604
|
* @summary Update Edge Config schema
|
|
605
|
-
* {@link
|
|
605
|
+
* {@link /v1/edge-config/:edgeConfigId/schema}
|
|
606
606
|
*/
|
|
607
|
-
export declare function patchEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config
|
|
607
|
+
export declare function patchEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
608
608
|
pathParams: PatchEdgeConfigSchemaPathParams;
|
|
609
|
-
queryParams?: PatchEdgeConfigSchemaQueryParams;
|
|
609
|
+
queryParams?: PatchEdgeConfigSchemaQueryParams | undefined;
|
|
610
610
|
config?: Partial<FetcherConfig> & {
|
|
611
611
|
client?: typeof client;
|
|
612
612
|
};
|
|
@@ -614,11 +614,11 @@ export declare function patchEdgeConfigSchema({ pathParams: { edgeConfigId }, qu
|
|
|
614
614
|
/**
|
|
615
615
|
* @description Deletes the schema of existing Edge Config.
|
|
616
616
|
* @summary Delete an Edge Config's schema
|
|
617
|
-
* {@link
|
|
617
|
+
* {@link /v1/edge-config/:edgeConfigId/schema}
|
|
618
618
|
*/
|
|
619
|
-
export declare function deleteEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config
|
|
619
|
+
export declare function deleteEdgeConfigSchema({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
620
620
|
pathParams: DeleteEdgeConfigSchemaPathParams;
|
|
621
|
-
queryParams?: DeleteEdgeConfigSchemaQueryParams;
|
|
621
|
+
queryParams?: DeleteEdgeConfigSchemaQueryParams | undefined;
|
|
622
622
|
config?: Partial<FetcherConfig> & {
|
|
623
623
|
client?: typeof client;
|
|
624
624
|
};
|
|
@@ -626,11 +626,11 @@ export declare function deleteEdgeConfigSchema({ pathParams: { edgeConfigId }, q
|
|
|
626
626
|
/**
|
|
627
627
|
* @description Returns a specific Edge Config Item.
|
|
628
628
|
* @summary Get an Edge Config item
|
|
629
|
-
* {@link
|
|
629
|
+
* {@link /v1/edge-config/:edgeConfigId/item/:edgeConfigItemKey}
|
|
630
630
|
*/
|
|
631
|
-
export declare function getEdgeConfigItem({ pathParams: { edgeConfigId, edgeConfigItemKey }, queryParams, config
|
|
631
|
+
export declare function getEdgeConfigItem({ pathParams: { edgeConfigId, edgeConfigItemKey }, queryParams, config }: {
|
|
632
632
|
pathParams: GetEdgeConfigItemPathParams;
|
|
633
|
-
queryParams?: GetEdgeConfigItemQueryParams;
|
|
633
|
+
queryParams?: GetEdgeConfigItemQueryParams | undefined;
|
|
634
634
|
config?: Partial<FetcherConfig> & {
|
|
635
635
|
client?: typeof client;
|
|
636
636
|
};
|
|
@@ -638,11 +638,11 @@ export declare function getEdgeConfigItem({ pathParams: { edgeConfigId, edgeConf
|
|
|
638
638
|
/**
|
|
639
639
|
* @description Returns all tokens of an Edge Config.
|
|
640
640
|
* @summary Get all tokens of an Edge Config
|
|
641
|
-
* {@link
|
|
641
|
+
* {@link /v1/edge-config/:edgeConfigId/tokens}
|
|
642
642
|
*/
|
|
643
|
-
export declare function getEdgeConfigTokens({ pathParams: { edgeConfigId }, queryParams, config
|
|
643
|
+
export declare function getEdgeConfigTokens({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
644
644
|
pathParams: GetEdgeConfigTokensPathParams;
|
|
645
|
-
queryParams?: GetEdgeConfigTokensQueryParams;
|
|
645
|
+
queryParams?: GetEdgeConfigTokensQueryParams | undefined;
|
|
646
646
|
config?: Partial<FetcherConfig> & {
|
|
647
647
|
client?: typeof client;
|
|
648
648
|
};
|
|
@@ -650,11 +650,11 @@ export declare function getEdgeConfigTokens({ pathParams: { edgeConfigId }, quer
|
|
|
650
650
|
/**
|
|
651
651
|
* @description Deletes one or more tokens of an existing Edge Config.
|
|
652
652
|
* @summary Delete one or more Edge Config tokens
|
|
653
|
-
* {@link
|
|
653
|
+
* {@link /v1/edge-config/:edgeConfigId/tokens}
|
|
654
654
|
*/
|
|
655
|
-
export declare function deleteEdgeConfigTokens({ pathParams: { edgeConfigId }, queryParams, config
|
|
655
|
+
export declare function deleteEdgeConfigTokens({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
656
656
|
pathParams: DeleteEdgeConfigTokensPathParams;
|
|
657
|
-
queryParams?: DeleteEdgeConfigTokensQueryParams;
|
|
657
|
+
queryParams?: DeleteEdgeConfigTokensQueryParams | undefined;
|
|
658
658
|
config?: Partial<FetcherConfig> & {
|
|
659
659
|
client?: typeof client;
|
|
660
660
|
};
|
|
@@ -662,11 +662,11 @@ export declare function deleteEdgeConfigTokens({ pathParams: { edgeConfigId }, q
|
|
|
662
662
|
/**
|
|
663
663
|
* @description Return meta data about an Edge Config token.
|
|
664
664
|
* @summary Get Edge Config token meta data
|
|
665
|
-
* {@link
|
|
665
|
+
* {@link /v1/edge-config/:edgeConfigId/token/:token}
|
|
666
666
|
*/
|
|
667
|
-
export declare function getEdgeConfigToken({ pathParams: { edgeConfigId, token }, queryParams, config
|
|
667
|
+
export declare function getEdgeConfigToken({ pathParams: { edgeConfigId, token }, queryParams, config }: {
|
|
668
668
|
pathParams: GetEdgeConfigTokenPathParams;
|
|
669
|
-
queryParams?: GetEdgeConfigTokenQueryParams;
|
|
669
|
+
queryParams?: GetEdgeConfigTokenQueryParams | undefined;
|
|
670
670
|
config?: Partial<FetcherConfig> & {
|
|
671
671
|
client?: typeof client;
|
|
672
672
|
};
|
|
@@ -674,11 +674,11 @@ export declare function getEdgeConfigToken({ pathParams: { edgeConfigId, token }
|
|
|
674
674
|
/**
|
|
675
675
|
* @description Adds a token to an existing Edge Config.
|
|
676
676
|
* @summary Create an Edge Config token
|
|
677
|
-
* {@link
|
|
677
|
+
* {@link /v1/edge-config/:edgeConfigId/token}
|
|
678
678
|
*/
|
|
679
|
-
export declare function createEdgeConfigToken({ pathParams: { edgeConfigId }, queryParams, config
|
|
679
|
+
export declare function createEdgeConfigToken({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
680
680
|
pathParams: CreateEdgeConfigTokenPathParams;
|
|
681
|
-
queryParams?: CreateEdgeConfigTokenQueryParams;
|
|
681
|
+
queryParams?: CreateEdgeConfigTokenQueryParams | undefined;
|
|
682
682
|
config?: Partial<FetcherConfig> & {
|
|
683
683
|
client?: typeof client;
|
|
684
684
|
};
|
|
@@ -686,11 +686,11 @@ export declare function createEdgeConfigToken({ pathParams: { edgeConfigId }, qu
|
|
|
686
686
|
/**
|
|
687
687
|
* @description Retrieves a specific version of an Edge Config from backup storage.
|
|
688
688
|
* @summary Get Edge Config backup
|
|
689
|
-
* {@link
|
|
689
|
+
* {@link /v1/edge-config/:edgeConfigId/backups/:edgeConfigBackupVersionId}
|
|
690
690
|
*/
|
|
691
|
-
export declare function getEdgeConfigBackup({ pathParams: { edgeConfigId, edgeConfigBackupVersionId }, queryParams, config
|
|
691
|
+
export declare function getEdgeConfigBackup({ pathParams: { edgeConfigId, edgeConfigBackupVersionId }, queryParams, config }: {
|
|
692
692
|
pathParams: GetEdgeConfigBackupPathParams;
|
|
693
|
-
queryParams?: GetEdgeConfigBackupQueryParams;
|
|
693
|
+
queryParams?: GetEdgeConfigBackupQueryParams | undefined;
|
|
694
694
|
config?: Partial<FetcherConfig> & {
|
|
695
695
|
client?: typeof client;
|
|
696
696
|
};
|
|
@@ -698,11 +698,11 @@ export declare function getEdgeConfigBackup({ pathParams: { edgeConfigId, edgeCo
|
|
|
698
698
|
/**
|
|
699
699
|
* @description Returns backups of an Edge Config.
|
|
700
700
|
* @summary Get Edge Config backups
|
|
701
|
-
* {@link
|
|
701
|
+
* {@link /v1/edge-config/:edgeConfigId/backups}
|
|
702
702
|
*/
|
|
703
|
-
export declare function getEdgeConfigBackups({ pathParams: { edgeConfigId }, queryParams, config
|
|
703
|
+
export declare function getEdgeConfigBackups({ pathParams: { edgeConfigId }, queryParams, config }: {
|
|
704
704
|
pathParams: GetEdgeConfigBackupsPathParams;
|
|
705
|
-
queryParams?: GetEdgeConfigBackupsQueryParams;
|
|
705
|
+
queryParams?: GetEdgeConfigBackupsQueryParams | undefined;
|
|
706
706
|
config?: Partial<FetcherConfig> & {
|
|
707
707
|
client?: typeof client;
|
|
708
708
|
};
|
|
@@ -710,10 +710,10 @@ export declare function getEdgeConfigBackups({ pathParams: { edgeConfigId }, que
|
|
|
710
710
|
/**
|
|
711
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
712
|
* @summary List User Events
|
|
713
|
-
* {@link
|
|
713
|
+
* {@link /v3/events}
|
|
714
714
|
*/
|
|
715
|
-
export declare function listUserEvents({ queryParams, config
|
|
716
|
-
queryParams?: ListUserEventsQueryParams;
|
|
715
|
+
export declare function listUserEvents({ queryParams, config }: {
|
|
716
|
+
queryParams?: ListUserEventsQueryParams | undefined;
|
|
717
717
|
config?: Partial<FetcherConfig> & {
|
|
718
718
|
client?: typeof client;
|
|
719
719
|
};
|
|
@@ -721,9 +721,9 @@ export declare function listUserEvents({ queryParams, config, }: {
|
|
|
721
721
|
/**
|
|
722
722
|
* @description Fetches the best account or user’s contact info
|
|
723
723
|
* @summary Get Account Information
|
|
724
|
-
* {@link
|
|
724
|
+
* {@link /v1/installations/:integrationConfigurationId/account}
|
|
725
725
|
*/
|
|
726
|
-
export declare function getAccountInfo({ pathParams: { integrationConfigurationId }, config
|
|
726
|
+
export declare function getAccountInfo({ pathParams: { integrationConfigurationId }, config }: {
|
|
727
727
|
pathParams: GetAccountInfoPathParams;
|
|
728
728
|
config?: Partial<FetcherConfig> & {
|
|
729
729
|
client?: typeof client;
|
|
@@ -732,9 +732,9 @@ export declare function getAccountInfo({ pathParams: { integrationConfigurationI
|
|
|
732
732
|
/**
|
|
733
733
|
* @description Returns the member role and other information for a given member ID ("user_id" claim in the SSO OIDC token).
|
|
734
734
|
* @summary Get Member Information
|
|
735
|
-
* {@link
|
|
735
|
+
* {@link /v1/installations/:integrationConfigurationId/member/:memberId}
|
|
736
736
|
*/
|
|
737
|
-
export declare function getMember({ pathParams: { integrationConfigurationId, memberId }, config
|
|
737
|
+
export declare function getMember({ pathParams: { integrationConfigurationId, memberId }, config }: {
|
|
738
738
|
pathParams: GetMemberPathParams;
|
|
739
739
|
config?: Partial<FetcherConfig> & {
|
|
740
740
|
client?: typeof client;
|
|
@@ -743,9 +743,9 @@ export declare function getMember({ pathParams: { integrationConfigurationId, me
|
|
|
743
743
|
/**
|
|
744
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
745
|
* @summary Create Event
|
|
746
|
-
* {@link
|
|
746
|
+
* {@link /v1/installations/:integrationConfigurationId/events}
|
|
747
747
|
*/
|
|
748
|
-
export declare function createEvent({ pathParams: { integrationConfigurationId }, config
|
|
748
|
+
export declare function createEvent({ pathParams: { integrationConfigurationId }, config }: {
|
|
749
749
|
pathParams: CreateEventPathParams;
|
|
750
750
|
config?: Partial<FetcherConfig> & {
|
|
751
751
|
client?: typeof client;
|
|
@@ -754,9 +754,9 @@ export declare function createEvent({ pathParams: { integrationConfigurationId }
|
|
|
754
754
|
/**
|
|
755
755
|
* @description Get all resources for a given installation ID.
|
|
756
756
|
* @summary Get Integration Resources
|
|
757
|
-
* {@link
|
|
757
|
+
* {@link /v1/installations/:integrationConfigurationId/resources}
|
|
758
758
|
*/
|
|
759
|
-
export declare function getIntegrationResources({ pathParams: { integrationConfigurationId }, config
|
|
759
|
+
export declare function getIntegrationResources({ pathParams: { integrationConfigurationId }, config }: {
|
|
760
760
|
pathParams: GetIntegrationResourcesPathParams;
|
|
761
761
|
config?: Partial<FetcherConfig> & {
|
|
762
762
|
client?: typeof client;
|
|
@@ -765,9 +765,9 @@ export declare function getIntegrationResources({ pathParams: { integrationConfi
|
|
|
765
765
|
/**
|
|
766
766
|
* @description Get a resource by its partner ID.
|
|
767
767
|
* @summary Get Integration Resource
|
|
768
|
-
* {@link
|
|
768
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId}
|
|
769
769
|
*/
|
|
770
|
-
export declare function getIntegrationResource({ pathParams: { integrationConfigurationId, resourceId }, config
|
|
770
|
+
export declare function getIntegrationResource({ pathParams: { integrationConfigurationId, resourceId }, config }: {
|
|
771
771
|
pathParams: GetIntegrationResourcePathParams;
|
|
772
772
|
config?: Partial<FetcherConfig> & {
|
|
773
773
|
client?: typeof client;
|
|
@@ -776,9 +776,9 @@ export declare function getIntegrationResource({ pathParams: { integrationConfig
|
|
|
776
776
|
/**
|
|
777
777
|
* @description Delete a resource owned by the selected installation ID.
|
|
778
778
|
* @summary Delete Integration Resource
|
|
779
|
-
* {@link
|
|
779
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId}
|
|
780
780
|
*/
|
|
781
|
-
export declare function deleteIntegrationResource({ pathParams: { integrationConfigurationId, resourceId }, config
|
|
781
|
+
export declare function deleteIntegrationResource({ pathParams: { integrationConfigurationId, resourceId }, config }: {
|
|
782
782
|
pathParams: DeleteIntegrationResourcePathParams;
|
|
783
783
|
config?: Partial<FetcherConfig> & {
|
|
784
784
|
client?: typeof client;
|
|
@@ -787,9 +787,9 @@ export declare function deleteIntegrationResource({ pathParams: { integrationCon
|
|
|
787
787
|
/**
|
|
788
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
789
|
* @summary Import Resource
|
|
790
|
-
* {@link
|
|
790
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId}
|
|
791
791
|
*/
|
|
792
|
-
export declare function importResource({ pathParams: { integrationConfigurationId, resourceId }, config
|
|
792
|
+
export declare function importResource({ pathParams: { integrationConfigurationId, resourceId }, config }: {
|
|
793
793
|
pathParams: ImportResourcePathParams;
|
|
794
794
|
config?: Partial<FetcherConfig> & {
|
|
795
795
|
client?: typeof client;
|
|
@@ -798,9 +798,9 @@ export declare function importResource({ pathParams: { integrationConfigurationI
|
|
|
798
798
|
/**
|
|
799
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
800
|
* @summary Submit Billing Data
|
|
801
|
-
* {@link
|
|
801
|
+
* {@link /v1/installations/:integrationConfigurationId/billing}
|
|
802
802
|
*/
|
|
803
|
-
export declare function submitBillingData({ pathParams: { integrationConfigurationId }, config
|
|
803
|
+
export declare function submitBillingData({ pathParams: { integrationConfigurationId }, config }: {
|
|
804
804
|
pathParams: SubmitBillingDataPathParams;
|
|
805
805
|
config?: Partial<FetcherConfig> & {
|
|
806
806
|
client?: typeof client;
|
|
@@ -809,9 +809,9 @@ export declare function submitBillingData({ pathParams: { integrationConfigurati
|
|
|
809
809
|
/**
|
|
810
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
811
|
* @summary Submit Invoice
|
|
812
|
-
* {@link
|
|
812
|
+
* {@link /v1/installations/:integrationConfigurationId/billing/invoices}
|
|
813
813
|
*/
|
|
814
|
-
export declare function submitInvoice({ pathParams: { integrationConfigurationId }, config
|
|
814
|
+
export declare function submitInvoice({ pathParams: { integrationConfigurationId }, config }: {
|
|
815
815
|
pathParams: SubmitInvoicePathParams;
|
|
816
816
|
config?: Partial<FetcherConfig> & {
|
|
817
817
|
client?: typeof client;
|
|
@@ -820,9 +820,9 @@ export declare function submitInvoice({ pathParams: { integrationConfigurationId
|
|
|
820
820
|
/**
|
|
821
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
822
|
* @summary Get Invoice
|
|
823
|
-
* {@link
|
|
823
|
+
* {@link /v1/installations/:integrationConfigurationId/billing/invoices/:invoiceId}
|
|
824
824
|
*/
|
|
825
|
-
export declare function getInvoice({ pathParams: { integrationConfigurationId, invoiceId }, config
|
|
825
|
+
export declare function getInvoice({ pathParams: { integrationConfigurationId, invoiceId }, config }: {
|
|
826
826
|
pathParams: GetInvoicePathParams;
|
|
827
827
|
config?: Partial<FetcherConfig> & {
|
|
828
828
|
client?: typeof client;
|
|
@@ -831,9 +831,9 @@ export declare function getInvoice({ pathParams: { integrationConfigurationId, i
|
|
|
831
831
|
/**
|
|
832
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
833
|
* @summary Invoice Actions
|
|
834
|
-
* {@link
|
|
834
|
+
* {@link /v1/installations/:integrationConfigurationId/billing/invoices/:invoiceId/actions}
|
|
835
835
|
*/
|
|
836
|
-
export declare function updateInvoice({ pathParams: { integrationConfigurationId, invoiceId }, config
|
|
836
|
+
export declare function updateInvoice({ pathParams: { integrationConfigurationId, invoiceId }, config }: {
|
|
837
837
|
pathParams: UpdateInvoicePathParams;
|
|
838
838
|
config?: Partial<FetcherConfig> & {
|
|
839
839
|
client?: typeof client;
|
|
@@ -842,9 +842,9 @@ export declare function updateInvoice({ pathParams: { integrationConfigurationId
|
|
|
842
842
|
/**
|
|
843
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
844
|
* @summary Submit Prepayment Balances
|
|
845
|
-
* {@link
|
|
845
|
+
* {@link /v1/installations/:integrationConfigurationId/billing/balance}
|
|
846
846
|
*/
|
|
847
|
-
export declare function submitPrepaymentBalances({ pathParams: { integrationConfigurationId }, config
|
|
847
|
+
export declare function submitPrepaymentBalances({ pathParams: { integrationConfigurationId }, config }: {
|
|
848
848
|
pathParams: SubmitPrepaymentBalancesPathParams;
|
|
849
849
|
config?: Partial<FetcherConfig> & {
|
|
850
850
|
client?: typeof client;
|
|
@@ -853,9 +853,9 @@ export declare function submitPrepaymentBalances({ pathParams: { integrationConf
|
|
|
853
853
|
/**
|
|
854
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
855
|
* @summary Update Resource Secrets (Deprecated)
|
|
856
|
-
* {@link
|
|
856
|
+
* {@link /v1/installations/:integrationConfigurationId/products/:integrationProductIdOrSlug/resources/:resourceId/secrets}
|
|
857
857
|
*/
|
|
858
|
-
export declare function updateResourceSecrets({ pathParams: { integrationConfigurationId, integrationProductIdOrSlug, resourceId }, config
|
|
858
|
+
export declare function updateResourceSecrets({ pathParams: { integrationConfigurationId, integrationProductIdOrSlug, resourceId }, config }: {
|
|
859
859
|
pathParams: UpdateResourceSecretsPathParams;
|
|
860
860
|
config?: Partial<FetcherConfig> & {
|
|
861
861
|
client?: typeof client;
|
|
@@ -864,9 +864,9 @@ export declare function updateResourceSecrets({ pathParams: { integrationConfigu
|
|
|
864
864
|
/**
|
|
865
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
866
|
* @summary Update Resource Secrets
|
|
867
|
-
* {@link
|
|
867
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId/secrets}
|
|
868
868
|
*/
|
|
869
|
-
export declare function updateResourceSecretsById({ pathParams: { integrationConfigurationId, resourceId }, config
|
|
869
|
+
export declare function updateResourceSecretsById({ pathParams: { integrationConfigurationId, resourceId }, config }: {
|
|
870
870
|
pathParams: UpdateResourceSecretsByIdPathParams;
|
|
871
871
|
config?: Partial<FetcherConfig> & {
|
|
872
872
|
client?: typeof client;
|
|
@@ -875,9 +875,9 @@ export declare function updateResourceSecretsById({ pathParams: { integrationCon
|
|
|
875
875
|
/**
|
|
876
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
877
|
* @summary Get configurations for the authenticated user or team
|
|
878
|
-
* {@link
|
|
878
|
+
* {@link /v1/integrations/configurations}
|
|
879
879
|
*/
|
|
880
|
-
export declare function getConfigurations({ queryParams, config
|
|
880
|
+
export declare function getConfigurations({ queryParams, config }: {
|
|
881
881
|
queryParams: GetConfigurationsQueryParams;
|
|
882
882
|
config?: Partial<FetcherConfig> & {
|
|
883
883
|
client?: typeof client;
|
|
@@ -886,11 +886,11 @@ export declare function getConfigurations({ queryParams, config, }: {
|
|
|
886
886
|
/**
|
|
887
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
888
|
* @summary Retrieve an integration configuration
|
|
889
|
-
* {@link
|
|
889
|
+
* {@link /v1/integrations/configuration/:id}
|
|
890
890
|
*/
|
|
891
|
-
export declare function getConfiguration({ pathParams: { id }, queryParams, config
|
|
891
|
+
export declare function getConfiguration({ pathParams: { id }, queryParams, config }: {
|
|
892
892
|
pathParams: GetConfigurationPathParams;
|
|
893
|
-
queryParams?: GetConfigurationQueryParams;
|
|
893
|
+
queryParams?: GetConfigurationQueryParams | undefined;
|
|
894
894
|
config?: Partial<FetcherConfig> & {
|
|
895
895
|
client?: typeof client;
|
|
896
896
|
};
|
|
@@ -898,11 +898,11 @@ export declare function getConfiguration({ pathParams: { id }, queryParams, conf
|
|
|
898
898
|
/**
|
|
899
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
900
|
* @summary Delete an integration configuration
|
|
901
|
-
* {@link
|
|
901
|
+
* {@link /v1/integrations/configuration/:id}
|
|
902
902
|
*/
|
|
903
|
-
export declare function deleteConfiguration({ pathParams: { id }, queryParams, config
|
|
903
|
+
export declare function deleteConfiguration({ pathParams: { id }, queryParams, config }: {
|
|
904
904
|
pathParams: DeleteConfigurationPathParams;
|
|
905
|
-
queryParams?: DeleteConfigurationQueryParams;
|
|
905
|
+
queryParams?: DeleteConfigurationQueryParams | undefined;
|
|
906
906
|
config?: Partial<FetcherConfig> & {
|
|
907
907
|
client?: typeof client;
|
|
908
908
|
};
|
|
@@ -910,7 +910,7 @@ export declare function deleteConfiguration({ pathParams: { id }, queryParams, c
|
|
|
910
910
|
/**
|
|
911
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
912
|
* @summary SSO Token Exchange
|
|
913
|
-
* {@link
|
|
913
|
+
* {@link /v1/integrations/sso/token}
|
|
914
914
|
*/
|
|
915
915
|
export declare function exchangeSsoToken({ config }: {
|
|
916
916
|
config?: Partial<FetcherConfig> & {
|
|
@@ -920,10 +920,10 @@ export declare function exchangeSsoToken({ config }: {
|
|
|
920
920
|
/**
|
|
921
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
922
|
* @summary Retrieves a list of Integration log drains
|
|
923
|
-
* {@link
|
|
923
|
+
* {@link /v2/integrations/log-drains}
|
|
924
924
|
*/
|
|
925
|
-
export declare function getIntegrationLogDrains({ queryParams, config
|
|
926
|
-
queryParams?: GetIntegrationLogDrainsQueryParams;
|
|
925
|
+
export declare function getIntegrationLogDrains({ queryParams, config }: {
|
|
926
|
+
queryParams?: GetIntegrationLogDrainsQueryParams | undefined;
|
|
927
927
|
config?: Partial<FetcherConfig> & {
|
|
928
928
|
client?: typeof client;
|
|
929
929
|
};
|
|
@@ -931,10 +931,10 @@ export declare function getIntegrationLogDrains({ queryParams, config, }: {
|
|
|
931
931
|
/**
|
|
932
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
933
|
* @summary Creates a new Integration Log Drain
|
|
934
|
-
* {@link
|
|
934
|
+
* {@link /v2/integrations/log-drains}
|
|
935
935
|
*/
|
|
936
|
-
export declare function createLogDrain({ queryParams, config
|
|
937
|
-
queryParams?: CreateLogDrainQueryParams;
|
|
936
|
+
export declare function createLogDrain({ queryParams, config }: {
|
|
937
|
+
queryParams?: CreateLogDrainQueryParams | undefined;
|
|
938
938
|
config?: Partial<FetcherConfig> & {
|
|
939
939
|
client?: typeof client;
|
|
940
940
|
};
|
|
@@ -942,11 +942,11 @@ export declare function createLogDrain({ queryParams, config, }: {
|
|
|
942
942
|
/**
|
|
943
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
944
|
* @summary Deletes the Integration log drain with the provided `id`
|
|
945
|
-
* {@link
|
|
945
|
+
* {@link /v1/integrations/log-drains/:id}
|
|
946
946
|
*/
|
|
947
|
-
export declare function deleteIntegrationLogDrain({ pathParams: { id }, queryParams, config
|
|
947
|
+
export declare function deleteIntegrationLogDrain({ pathParams: { id }, queryParams, config }: {
|
|
948
948
|
pathParams: DeleteIntegrationLogDrainPathParams;
|
|
949
|
-
queryParams?: DeleteIntegrationLogDrainQueryParams;
|
|
949
|
+
queryParams?: DeleteIntegrationLogDrainQueryParams | undefined;
|
|
950
950
|
config?: Partial<FetcherConfig> & {
|
|
951
951
|
client?: typeof client;
|
|
952
952
|
};
|
|
@@ -954,11 +954,11 @@ export declare function deleteIntegrationLogDrain({ pathParams: { id }, queryPar
|
|
|
954
954
|
/**
|
|
955
955
|
* @description Returns a stream of logs for a given deployment.
|
|
956
956
|
* @summary Get logs for a deployment
|
|
957
|
-
* {@link
|
|
957
|
+
* {@link /v1/projects/:projectId/deployments/:deploymentId/runtime-logs}
|
|
958
958
|
*/
|
|
959
|
-
export declare function getRuntimeLogs({ pathParams: { projectId, deploymentId }, queryParams, config
|
|
959
|
+
export declare function getRuntimeLogs({ pathParams: { projectId, deploymentId }, queryParams, config }: {
|
|
960
960
|
pathParams: GetRuntimeLogsPathParams;
|
|
961
|
-
queryParams?: GetRuntimeLogsQueryParams;
|
|
961
|
+
queryParams?: GetRuntimeLogsQueryParams | undefined;
|
|
962
962
|
config?: Partial<FetcherConfig> & {
|
|
963
963
|
client?: typeof client;
|
|
964
964
|
};
|
|
@@ -966,9 +966,9 @@ export declare function getRuntimeLogs({ pathParams: { projectId, deploymentId }
|
|
|
966
966
|
/**
|
|
967
967
|
* @description Create one or multiple experimentation items
|
|
968
968
|
* @summary Create one or multiple experimentation items
|
|
969
|
-
* {@link
|
|
969
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId/experimentation/items}
|
|
970
970
|
*/
|
|
971
|
-
export declare function createExperimentationItem({ pathParams: { integrationConfigurationId, resourceId }, config
|
|
971
|
+
export declare function createExperimentationItem({ pathParams: { integrationConfigurationId, resourceId }, config }: {
|
|
972
972
|
pathParams: CreateExperimentationItemPathParams;
|
|
973
973
|
config?: Partial<FetcherConfig> & {
|
|
974
974
|
client?: typeof client;
|
|
@@ -977,9 +977,9 @@ export declare function createExperimentationItem({ pathParams: { integrationCon
|
|
|
977
977
|
/**
|
|
978
978
|
* @description Patch an existing experimentation item
|
|
979
979
|
* @summary Patch an existing experimentation item
|
|
980
|
-
* {@link
|
|
980
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId/experimentation/items/:itemId}
|
|
981
981
|
*/
|
|
982
|
-
export declare function updateExperimentationItem({ pathParams: { integrationConfigurationId, resourceId, itemId }, config
|
|
982
|
+
export declare function updateExperimentationItem({ pathParams: { integrationConfigurationId, resourceId, itemId }, config }: {
|
|
983
983
|
pathParams: UpdateExperimentationItemPathParams;
|
|
984
984
|
config?: Partial<FetcherConfig> & {
|
|
985
985
|
client?: typeof client;
|
|
@@ -988,9 +988,9 @@ export declare function updateExperimentationItem({ pathParams: { integrationCon
|
|
|
988
988
|
/**
|
|
989
989
|
* @description Delete an existing experimentation item
|
|
990
990
|
* @summary Delete an existing experimentation item
|
|
991
|
-
* {@link
|
|
991
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId/experimentation/items/:itemId}
|
|
992
992
|
*/
|
|
993
|
-
export declare function deleteExperimentationItem({ pathParams: { integrationConfigurationId, resourceId, itemId }, config
|
|
993
|
+
export declare function deleteExperimentationItem({ pathParams: { integrationConfigurationId, resourceId, itemId }, config }: {
|
|
994
994
|
pathParams: DeleteExperimentationItemPathParams;
|
|
995
995
|
config?: Partial<FetcherConfig> & {
|
|
996
996
|
client?: typeof client;
|
|
@@ -999,9 +999,9 @@ export declare function deleteExperimentationItem({ pathParams: { integrationCon
|
|
|
999
999
|
/**
|
|
1000
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
1001
|
* @summary Push data into a user-provided Edge Config
|
|
1002
|
-
* {@link
|
|
1002
|
+
* {@link /v1/installations/:integrationConfigurationId/resources/:resourceId/experimentation/edge-config}
|
|
1003
1003
|
*/
|
|
1004
|
-
export declare function updateExperimentationEdgeConfig({ pathParams: { integrationConfigurationId, resourceId }, config
|
|
1004
|
+
export declare function updateExperimentationEdgeConfig({ pathParams: { integrationConfigurationId, resourceId }, config }: {
|
|
1005
1005
|
pathParams: UpdateExperimentationEdgeConfigPathParams;
|
|
1006
1006
|
config?: Partial<FetcherConfig> & {
|
|
1007
1007
|
client?: typeof client;
|
|
@@ -1010,11 +1010,11 @@ export declare function updateExperimentationEdgeConfig({ pathParams: { integrat
|
|
|
1010
1010
|
/**
|
|
1011
1011
|
* @description Lists all members of a project.
|
|
1012
1012
|
* @summary List project members
|
|
1013
|
-
* {@link
|
|
1013
|
+
* {@link /v1/projects/:idOrName/members}
|
|
1014
1014
|
*/
|
|
1015
|
-
export declare function getProjectMembers({ pathParams: { idOrName }, queryParams, config
|
|
1015
|
+
export declare function getProjectMembers({ pathParams: { idOrName }, queryParams, config }: {
|
|
1016
1016
|
pathParams: GetProjectMembersPathParams;
|
|
1017
|
-
queryParams?: GetProjectMembersQueryParams;
|
|
1017
|
+
queryParams?: GetProjectMembersQueryParams | undefined;
|
|
1018
1018
|
config?: Partial<FetcherConfig> & {
|
|
1019
1019
|
client?: typeof client;
|
|
1020
1020
|
};
|
|
@@ -1022,11 +1022,11 @@ export declare function getProjectMembers({ pathParams: { idOrName }, queryParam
|
|
|
1022
1022
|
/**
|
|
1023
1023
|
* @description Adds a new member to the project.
|
|
1024
1024
|
* @summary Adds a new member to a project.
|
|
1025
|
-
* {@link
|
|
1025
|
+
* {@link /v1/projects/:idOrName/members}
|
|
1026
1026
|
*/
|
|
1027
|
-
export declare function addProjectMember({ pathParams: { idOrName }, queryParams, config
|
|
1027
|
+
export declare function addProjectMember({ pathParams: { idOrName }, queryParams, config }: {
|
|
1028
1028
|
pathParams: AddProjectMemberPathParams;
|
|
1029
|
-
queryParams?: AddProjectMemberQueryParams;
|
|
1029
|
+
queryParams?: AddProjectMemberQueryParams | undefined;
|
|
1030
1030
|
config?: Partial<FetcherConfig> & {
|
|
1031
1031
|
client?: typeof client;
|
|
1032
1032
|
};
|
|
@@ -1034,11 +1034,11 @@ export declare function addProjectMember({ pathParams: { idOrName }, queryParams
|
|
|
1034
1034
|
/**
|
|
1035
1035
|
* @description Remove a member from a specific project
|
|
1036
1036
|
* @summary Remove a Project Member
|
|
1037
|
-
* {@link
|
|
1037
|
+
* {@link /v1/projects/:idOrName/members/:uid}
|
|
1038
1038
|
*/
|
|
1039
|
-
export declare function removeProjectMember({ pathParams: { idOrName, uid }, queryParams, config
|
|
1039
|
+
export declare function removeProjectMember({ pathParams: { idOrName, uid }, queryParams, config }: {
|
|
1040
1040
|
pathParams: RemoveProjectMemberPathParams;
|
|
1041
|
-
queryParams?: RemoveProjectMemberQueryParams;
|
|
1041
|
+
queryParams?: RemoveProjectMemberQueryParams | undefined;
|
|
1042
1042
|
config?: Partial<FetcherConfig> & {
|
|
1043
1043
|
client?: typeof client;
|
|
1044
1044
|
};
|
|
@@ -1046,10 +1046,10 @@ export declare function removeProjectMember({ pathParams: { idOrName, uid }, que
|
|
|
1046
1046
|
/**
|
|
1047
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
1048
|
* @summary Retrieve a list of projects
|
|
1049
|
-
* {@link
|
|
1049
|
+
* {@link /v10/projects}
|
|
1050
1050
|
*/
|
|
1051
|
-
export declare function getProjects({ queryParams, config
|
|
1052
|
-
queryParams?: GetProjectsQueryParams;
|
|
1051
|
+
export declare function getProjects({ queryParams, config }: {
|
|
1052
|
+
queryParams?: GetProjectsQueryParams | undefined;
|
|
1053
1053
|
config?: Partial<FetcherConfig> & {
|
|
1054
1054
|
client?: typeof client;
|
|
1055
1055
|
};
|
|
@@ -1057,10 +1057,10 @@ export declare function getProjects({ queryParams, config, }: {
|
|
|
1057
1057
|
/**
|
|
1058
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
1059
|
* @summary Create a new project
|
|
1060
|
-
* {@link
|
|
1060
|
+
* {@link /v11/projects}
|
|
1061
1061
|
*/
|
|
1062
|
-
export declare function createProject({ queryParams, config
|
|
1063
|
-
queryParams?: CreateProjectQueryParams;
|
|
1062
|
+
export declare function createProject({ queryParams, config }: {
|
|
1063
|
+
queryParams?: CreateProjectQueryParams | undefined;
|
|
1064
1064
|
config?: Partial<FetcherConfig> & {
|
|
1065
1065
|
client?: typeof client;
|
|
1066
1066
|
};
|
|
@@ -1068,11 +1068,11 @@ export declare function createProject({ queryParams, config, }: {
|
|
|
1068
1068
|
/**
|
|
1069
1069
|
* @description Get the information for a specific project by passing either the project `id` or `name` in the URL.
|
|
1070
1070
|
* @summary Find a project by id or name
|
|
1071
|
-
* {@link
|
|
1071
|
+
* {@link /v9/projects/:idOrName}
|
|
1072
1072
|
*/
|
|
1073
|
-
export declare function getProject({ pathParams: { idOrName }, queryParams, config
|
|
1073
|
+
export declare function getProject({ pathParams: { idOrName }, queryParams, config }: {
|
|
1074
1074
|
pathParams: GetProjectPathParams;
|
|
1075
|
-
queryParams?: GetProjectQueryParams;
|
|
1075
|
+
queryParams?: GetProjectQueryParams | undefined;
|
|
1076
1076
|
config?: Partial<FetcherConfig> & {
|
|
1077
1077
|
client?: typeof client;
|
|
1078
1078
|
};
|
|
@@ -1080,11 +1080,11 @@ export declare function getProject({ pathParams: { idOrName }, queryParams, conf
|
|
|
1080
1080
|
/**
|
|
1081
1081
|
* @description Update the fields of a project using either its `name` or `id`.
|
|
1082
1082
|
* @summary Update an existing project
|
|
1083
|
-
* {@link
|
|
1083
|
+
* {@link /v9/projects/:idOrName}
|
|
1084
1084
|
*/
|
|
1085
|
-
export declare function updateProject({ pathParams: { idOrName }, queryParams, config
|
|
1085
|
+
export declare function updateProject({ pathParams: { idOrName }, queryParams, config }: {
|
|
1086
1086
|
pathParams: UpdateProjectPathParams;
|
|
1087
|
-
queryParams?: UpdateProjectQueryParams;
|
|
1087
|
+
queryParams?: UpdateProjectQueryParams | undefined;
|
|
1088
1088
|
config?: Partial<FetcherConfig> & {
|
|
1089
1089
|
client?: typeof client;
|
|
1090
1090
|
};
|
|
@@ -1092,11 +1092,11 @@ export declare function updateProject({ pathParams: { idOrName }, queryParams, c
|
|
|
1092
1092
|
/**
|
|
1093
1093
|
* @description Delete a specific project by passing either the project `id` or `name` in the URL.
|
|
1094
1094
|
* @summary Delete a Project
|
|
1095
|
-
* {@link
|
|
1095
|
+
* {@link /v9/projects/:idOrName}
|
|
1096
1096
|
*/
|
|
1097
|
-
export declare function deleteProject({ pathParams: { idOrName }, queryParams, config
|
|
1097
|
+
export declare function deleteProject({ pathParams: { idOrName }, queryParams, config }: {
|
|
1098
1098
|
pathParams: DeleteProjectPathParams;
|
|
1099
|
-
queryParams?: DeleteProjectQueryParams;
|
|
1099
|
+
queryParams?: DeleteProjectQueryParams | undefined;
|
|
1100
1100
|
config?: Partial<FetcherConfig> & {
|
|
1101
1101
|
client?: typeof client;
|
|
1102
1102
|
};
|
|
@@ -1104,11 +1104,11 @@ export declare function deleteProject({ pathParams: { idOrName }, queryParams, c
|
|
|
1104
1104
|
/**
|
|
1105
1105
|
* @description Creates a custom environment for the current project. Cannot be named 'Production' or 'Preview'.
|
|
1106
1106
|
* @summary Create a custom environment for the current project.
|
|
1107
|
-
* {@link
|
|
1107
|
+
* {@link /v9/projects/:idOrName/custom-environments}
|
|
1108
1108
|
*/
|
|
1109
|
-
export declare function createCustomEnvironment({ pathParams: { idOrName }, queryParams, config
|
|
1109
|
+
export declare function createCustomEnvironment({ pathParams: { idOrName }, queryParams, config }: {
|
|
1110
1110
|
pathParams: CreateCustomEnvironmentPathParams;
|
|
1111
|
-
queryParams?: CreateCustomEnvironmentQueryParams;
|
|
1111
|
+
queryParams?: CreateCustomEnvironmentQueryParams | undefined;
|
|
1112
1112
|
config?: Partial<FetcherConfig> & {
|
|
1113
1113
|
client?: typeof client;
|
|
1114
1114
|
};
|
|
@@ -1116,11 +1116,11 @@ export declare function createCustomEnvironment({ pathParams: { idOrName }, quer
|
|
|
1116
1116
|
/**
|
|
1117
1117
|
* @description Retrieve custom environments for the project. Must not be named 'Production' or 'Preview'.
|
|
1118
1118
|
* @summary Retrieve custom environments
|
|
1119
|
-
* {@link
|
|
1119
|
+
* {@link /v9/projects/:idOrName/custom-environments}
|
|
1120
1120
|
*/
|
|
1121
|
-
export declare function listCustomEnvironments({ pathParams: { idOrName }, queryParams, config
|
|
1121
|
+
export declare function listCustomEnvironments({ pathParams: { idOrName }, queryParams, config }: {
|
|
1122
1122
|
pathParams: ListCustomEnvironmentsPathParams;
|
|
1123
|
-
queryParams?: ListCustomEnvironmentsQueryParams;
|
|
1123
|
+
queryParams?: ListCustomEnvironmentsQueryParams | undefined;
|
|
1124
1124
|
config?: Partial<FetcherConfig> & {
|
|
1125
1125
|
client?: typeof client;
|
|
1126
1126
|
};
|
|
@@ -1128,11 +1128,11 @@ export declare function listCustomEnvironments({ pathParams: { idOrName }, query
|
|
|
1128
1128
|
/**
|
|
1129
1129
|
* @description Retrieve a custom environment for the project. Must not be named 'Production' or 'Preview'.
|
|
1130
1130
|
* @summary Retrieve a custom environment
|
|
1131
|
-
* {@link
|
|
1131
|
+
* {@link /v9/projects/:idOrName/custom-environments/:environmentSlugOrId}
|
|
1132
1132
|
*/
|
|
1133
|
-
export declare function getCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config
|
|
1133
|
+
export declare function getCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config }: {
|
|
1134
1134
|
pathParams: GetCustomEnvironmentPathParams;
|
|
1135
|
-
queryParams?: GetCustomEnvironmentQueryParams;
|
|
1135
|
+
queryParams?: GetCustomEnvironmentQueryParams | undefined;
|
|
1136
1136
|
config?: Partial<FetcherConfig> & {
|
|
1137
1137
|
client?: typeof client;
|
|
1138
1138
|
};
|
|
@@ -1140,11 +1140,11 @@ export declare function getCustomEnvironment({ pathParams: { idOrName, environme
|
|
|
1140
1140
|
/**
|
|
1141
1141
|
* @description Update a custom environment for the project. Must not be named 'Production' or 'Preview'.
|
|
1142
1142
|
* @summary Update a custom environment
|
|
1143
|
-
* {@link
|
|
1143
|
+
* {@link /v9/projects/:idOrName/custom-environments/:environmentSlugOrId}
|
|
1144
1144
|
*/
|
|
1145
|
-
export declare function updateCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config
|
|
1145
|
+
export declare function updateCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config }: {
|
|
1146
1146
|
pathParams: UpdateCustomEnvironmentPathParams;
|
|
1147
|
-
queryParams?: UpdateCustomEnvironmentQueryParams;
|
|
1147
|
+
queryParams?: UpdateCustomEnvironmentQueryParams | undefined;
|
|
1148
1148
|
config?: Partial<FetcherConfig> & {
|
|
1149
1149
|
client?: typeof client;
|
|
1150
1150
|
};
|
|
@@ -1152,11 +1152,11 @@ export declare function updateCustomEnvironment({ pathParams: { idOrName, enviro
|
|
|
1152
1152
|
/**
|
|
1153
1153
|
* @description Remove a custom environment for the project. Must not be named 'Production' or 'Preview'.
|
|
1154
1154
|
* @summary Remove a custom environment
|
|
1155
|
-
* {@link
|
|
1155
|
+
* {@link /v9/projects/:idOrName/custom-environments/:environmentSlugOrId}
|
|
1156
1156
|
*/
|
|
1157
|
-
export declare function removeCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config
|
|
1157
|
+
export declare function removeCustomEnvironment({ pathParams: { idOrName, environmentSlugOrId }, queryParams, config }: {
|
|
1158
1158
|
pathParams: RemoveCustomEnvironmentPathParams;
|
|
1159
|
-
queryParams?: RemoveCustomEnvironmentQueryParams;
|
|
1159
|
+
queryParams?: RemoveCustomEnvironmentQueryParams | undefined;
|
|
1160
1160
|
config?: Partial<FetcherConfig> & {
|
|
1161
1161
|
client?: typeof client;
|
|
1162
1162
|
};
|
|
@@ -1164,11 +1164,11 @@ export declare function removeCustomEnvironment({ pathParams: { idOrName, enviro
|
|
|
1164
1164
|
/**
|
|
1165
1165
|
* @description Retrieve the domains associated with a given project by passing either the project `id` or `name` in the URL.
|
|
1166
1166
|
* @summary Retrieve project domains by project by id or name
|
|
1167
|
-
* {@link
|
|
1167
|
+
* {@link /v9/projects/:idOrName/domains}
|
|
1168
1168
|
*/
|
|
1169
|
-
export declare function getProjectDomains({ pathParams: { idOrName }, queryParams, config
|
|
1169
|
+
export declare function getProjectDomains({ pathParams: { idOrName }, queryParams, config }: {
|
|
1170
1170
|
pathParams: GetProjectDomainsPathParams;
|
|
1171
|
-
queryParams?: GetProjectDomainsQueryParams;
|
|
1171
|
+
queryParams?: GetProjectDomainsQueryParams | undefined;
|
|
1172
1172
|
config?: Partial<FetcherConfig> & {
|
|
1173
1173
|
client?: typeof client;
|
|
1174
1174
|
};
|
|
@@ -1176,11 +1176,11 @@ export declare function getProjectDomains({ pathParams: { idOrName }, queryParam
|
|
|
1176
1176
|
/**
|
|
1177
1177
|
* @description Get project domain by project id/name and domain name.
|
|
1178
1178
|
* @summary Get a project domain
|
|
1179
|
-
* {@link
|
|
1179
|
+
* {@link /v9/projects/:idOrName/domains/:domain}
|
|
1180
1180
|
*/
|
|
1181
|
-
export declare function getProjectDomain({ pathParams: { idOrName, domain }, queryParams, config
|
|
1181
|
+
export declare function getProjectDomain({ pathParams: { idOrName, domain }, queryParams, config }: {
|
|
1182
1182
|
pathParams: GetProjectDomainPathParams;
|
|
1183
|
-
queryParams?: GetProjectDomainQueryParams;
|
|
1183
|
+
queryParams?: GetProjectDomainQueryParams | undefined;
|
|
1184
1184
|
config?: Partial<FetcherConfig> & {
|
|
1185
1185
|
client?: typeof client;
|
|
1186
1186
|
};
|
|
@@ -1188,11 +1188,11 @@ export declare function getProjectDomain({ pathParams: { idOrName, domain }, que
|
|
|
1188
1188
|
/**
|
|
1189
1189
|
* @description Update a project domain's configuration, including the name, git branch and redirect of the domain.
|
|
1190
1190
|
* @summary Update a project domain
|
|
1191
|
-
* {@link
|
|
1191
|
+
* {@link /v9/projects/:idOrName/domains/:domain}
|
|
1192
1192
|
*/
|
|
1193
|
-
export declare function updateProjectDomain({ pathParams: { idOrName, domain }, queryParams, config
|
|
1193
|
+
export declare function updateProjectDomain({ pathParams: { idOrName, domain }, queryParams, config }: {
|
|
1194
1194
|
pathParams: UpdateProjectDomainPathParams;
|
|
1195
|
-
queryParams?: UpdateProjectDomainQueryParams;
|
|
1195
|
+
queryParams?: UpdateProjectDomainQueryParams | undefined;
|
|
1196
1196
|
config?: Partial<FetcherConfig> & {
|
|
1197
1197
|
client?: typeof client;
|
|
1198
1198
|
};
|
|
@@ -1200,11 +1200,11 @@ export declare function updateProjectDomain({ pathParams: { idOrName, domain },
|
|
|
1200
1200
|
/**
|
|
1201
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
1202
|
* @summary Remove a domain from a project
|
|
1203
|
-
* {@link
|
|
1203
|
+
* {@link /v9/projects/:idOrName/domains/:domain}
|
|
1204
1204
|
*/
|
|
1205
|
-
export declare function removeProjectDomain({ pathParams: { idOrName, domain }, queryParams, config
|
|
1205
|
+
export declare function removeProjectDomain({ pathParams: { idOrName, domain }, queryParams, config }: {
|
|
1206
1206
|
pathParams: RemoveProjectDomainPathParams;
|
|
1207
|
-
queryParams?: RemoveProjectDomainQueryParams;
|
|
1207
|
+
queryParams?: RemoveProjectDomainQueryParams | undefined;
|
|
1208
1208
|
config?: Partial<FetcherConfig> & {
|
|
1209
1209
|
client?: typeof client;
|
|
1210
1210
|
};
|
|
@@ -1212,11 +1212,11 @@ export declare function removeProjectDomain({ pathParams: { idOrName, domain },
|
|
|
1212
1212
|
/**
|
|
1213
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
1214
|
* @summary Add a domain to a project
|
|
1215
|
-
* {@link
|
|
1215
|
+
* {@link /v10/projects/:idOrName/domains}
|
|
1216
1216
|
*/
|
|
1217
|
-
export declare function addProjectDomain({ pathParams: { idOrName }, queryParams, config
|
|
1217
|
+
export declare function addProjectDomain({ pathParams: { idOrName }, queryParams, config }: {
|
|
1218
1218
|
pathParams: AddProjectDomainPathParams;
|
|
1219
|
-
queryParams?: AddProjectDomainQueryParams;
|
|
1219
|
+
queryParams?: AddProjectDomainQueryParams | undefined;
|
|
1220
1220
|
config?: Partial<FetcherConfig> & {
|
|
1221
1221
|
client?: typeof client;
|
|
1222
1222
|
};
|
|
@@ -1224,11 +1224,11 @@ export declare function addProjectDomain({ pathParams: { idOrName }, queryParams
|
|
|
1224
1224
|
/**
|
|
1225
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
1226
|
* @summary Move a project domain
|
|
1227
|
-
* {@link
|
|
1227
|
+
* {@link /v1/projects/:idOrName/domains/:domain/move}
|
|
1228
1228
|
*/
|
|
1229
|
-
export declare function moveProjectDomain({ pathParams: { idOrName, domain }, queryParams, config
|
|
1229
|
+
export declare function moveProjectDomain({ pathParams: { idOrName, domain }, queryParams, config }: {
|
|
1230
1230
|
pathParams: MoveProjectDomainPathParams;
|
|
1231
|
-
queryParams?: MoveProjectDomainQueryParams;
|
|
1231
|
+
queryParams?: MoveProjectDomainQueryParams | undefined;
|
|
1232
1232
|
config?: Partial<FetcherConfig> & {
|
|
1233
1233
|
client?: typeof client;
|
|
1234
1234
|
};
|
|
@@ -1236,11 +1236,11 @@ export declare function moveProjectDomain({ pathParams: { idOrName, domain }, qu
|
|
|
1236
1236
|
/**
|
|
1237
1237
|
* @description Attempts to verify a project domain with `verified = false` by checking the correctness of the project domain's `verification` challenge.
|
|
1238
1238
|
* @summary Verify project domain
|
|
1239
|
-
* {@link
|
|
1239
|
+
* {@link /v9/projects/:idOrName/domains/:domain/verify}
|
|
1240
1240
|
*/
|
|
1241
|
-
export declare function verifyProjectDomain({ pathParams: { idOrName, domain }, queryParams, config
|
|
1241
|
+
export declare function verifyProjectDomain({ pathParams: { idOrName, domain }, queryParams, config }: {
|
|
1242
1242
|
pathParams: VerifyProjectDomainPathParams;
|
|
1243
|
-
queryParams?: VerifyProjectDomainQueryParams;
|
|
1243
|
+
queryParams?: VerifyProjectDomainQueryParams | undefined;
|
|
1244
1244
|
config?: Partial<FetcherConfig> & {
|
|
1245
1245
|
client?: typeof client;
|
|
1246
1246
|
};
|
|
@@ -1248,11 +1248,11 @@ export declare function verifyProjectDomain({ pathParams: { idOrName, domain },
|
|
|
1248
1248
|
/**
|
|
1249
1249
|
* @description Retrieve the environment variables for a given project by passing either the project `id` or `name` in the URL.
|
|
1250
1250
|
* @summary Retrieve the environment variables of a project by id or name
|
|
1251
|
-
* {@link
|
|
1251
|
+
* {@link /v10/projects/:idOrName/env}
|
|
1252
1252
|
*/
|
|
1253
|
-
export declare function filterProjectEnvs({ pathParams: { idOrName }, queryParams, config
|
|
1253
|
+
export declare function filterProjectEnvs({ pathParams: { idOrName }, queryParams, config }: {
|
|
1254
1254
|
pathParams: FilterProjectEnvsPathParams;
|
|
1255
|
-
queryParams?: FilterProjectEnvsQueryParams;
|
|
1255
|
+
queryParams?: FilterProjectEnvsQueryParams | undefined;
|
|
1256
1256
|
config?: Partial<FetcherConfig> & {
|
|
1257
1257
|
client?: typeof client;
|
|
1258
1258
|
};
|
|
@@ -1260,11 +1260,11 @@ export declare function filterProjectEnvs({ pathParams: { idOrName }, queryParam
|
|
|
1260
1260
|
/**
|
|
1261
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
1262
|
* @summary Create one or more environment variables
|
|
1263
|
-
* {@link
|
|
1263
|
+
* {@link /v10/projects/:idOrName/env}
|
|
1264
1264
|
*/
|
|
1265
|
-
export declare function createProjectEnv({ pathParams: { idOrName }, queryParams, config
|
|
1265
|
+
export declare function createProjectEnv({ pathParams: { idOrName }, queryParams, config }: {
|
|
1266
1266
|
pathParams: CreateProjectEnvPathParams;
|
|
1267
|
-
queryParams?: CreateProjectEnvQueryParams;
|
|
1267
|
+
queryParams?: CreateProjectEnvQueryParams | undefined;
|
|
1268
1268
|
config?: Partial<FetcherConfig> & {
|
|
1269
1269
|
client?: typeof client;
|
|
1270
1270
|
};
|
|
@@ -1272,11 +1272,11 @@ export declare function createProjectEnv({ pathParams: { idOrName }, queryParams
|
|
|
1272
1272
|
/**
|
|
1273
1273
|
* @description Retrieve the environment variable for a given project.
|
|
1274
1274
|
* @summary Retrieve the decrypted value of an environment variable of a project by id
|
|
1275
|
-
* {@link
|
|
1275
|
+
* {@link /v1/projects/:idOrName/env/:id}
|
|
1276
1276
|
*/
|
|
1277
|
-
export declare function getProjectEnv({ pathParams: { idOrName, id }, queryParams, config
|
|
1277
|
+
export declare function getProjectEnv({ pathParams: { idOrName, id }, queryParams, config }: {
|
|
1278
1278
|
pathParams: GetProjectEnvPathParams;
|
|
1279
|
-
queryParams?: GetProjectEnvQueryParams;
|
|
1279
|
+
queryParams?: GetProjectEnvQueryParams | undefined;
|
|
1280
1280
|
config?: Partial<FetcherConfig> & {
|
|
1281
1281
|
client?: typeof client;
|
|
1282
1282
|
};
|
|
@@ -1284,11 +1284,11 @@ export declare function getProjectEnv({ pathParams: { idOrName, id }, queryParam
|
|
|
1284
1284
|
/**
|
|
1285
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
1286
|
* @summary Remove an environment variable
|
|
1287
|
-
* {@link
|
|
1287
|
+
* {@link /v9/projects/:idOrName/env/:id}
|
|
1288
1288
|
*/
|
|
1289
|
-
export declare function removeProjectEnv({ pathParams: { idOrName, id }, queryParams, config
|
|
1289
|
+
export declare function removeProjectEnv({ pathParams: { idOrName, id }, queryParams, config }: {
|
|
1290
1290
|
pathParams: RemoveProjectEnvPathParams;
|
|
1291
|
-
queryParams?: RemoveProjectEnvQueryParams;
|
|
1291
|
+
queryParams?: RemoveProjectEnvQueryParams | undefined;
|
|
1292
1292
|
config?: Partial<FetcherConfig> & {
|
|
1293
1293
|
client?: typeof client;
|
|
1294
1294
|
};
|
|
@@ -1296,11 +1296,11 @@ export declare function removeProjectEnv({ pathParams: { idOrName, id }, queryPa
|
|
|
1296
1296
|
/**
|
|
1297
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
1298
|
* @summary Edit an environment variable
|
|
1299
|
-
* {@link
|
|
1299
|
+
* {@link /v9/projects/:idOrName/env/:id}
|
|
1300
1300
|
*/
|
|
1301
|
-
export declare function editProjectEnv({ pathParams: { idOrName, id }, queryParams, config
|
|
1301
|
+
export declare function editProjectEnv({ pathParams: { idOrName, id }, queryParams, config }: {
|
|
1302
1302
|
pathParams: EditProjectEnvPathParams;
|
|
1303
|
-
queryParams?: EditProjectEnvQueryParams;
|
|
1303
|
+
queryParams?: EditProjectEnvQueryParams | undefined;
|
|
1304
1304
|
config?: Partial<FetcherConfig> & {
|
|
1305
1305
|
client?: typeof client;
|
|
1306
1306
|
};
|
|
@@ -1308,11 +1308,11 @@ export declare function editProjectEnv({ pathParams: { idOrName, id }, queryPara
|
|
|
1308
1308
|
/**
|
|
1309
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
1310
|
* @summary Get rolling release billing status
|
|
1311
|
-
* {@link
|
|
1311
|
+
* {@link /v1/projects/:idOrName/rolling-release/billing}
|
|
1312
1312
|
*/
|
|
1313
|
-
export declare function getRollingReleaseBillingStatus({ pathParams: { idOrName }, queryParams, config
|
|
1313
|
+
export declare function getRollingReleaseBillingStatus({ pathParams: { idOrName }, queryParams, config }: {
|
|
1314
1314
|
pathParams: GetRollingReleaseBillingStatusPathParams;
|
|
1315
|
-
queryParams?: GetRollingReleaseBillingStatusQueryParams;
|
|
1315
|
+
queryParams?: GetRollingReleaseBillingStatusQueryParams | undefined;
|
|
1316
1316
|
config?: Partial<FetcherConfig> & {
|
|
1317
1317
|
client?: typeof client;
|
|
1318
1318
|
};
|
|
@@ -1320,11 +1320,11 @@ export declare function getRollingReleaseBillingStatus({ pathParams: { idOrName
|
|
|
1320
1320
|
/**
|
|
1321
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
1322
|
* @summary Get rolling release configuration
|
|
1323
|
-
* {@link
|
|
1323
|
+
* {@link /v1/projects/:idOrName/rolling-release/config}
|
|
1324
1324
|
*/
|
|
1325
|
-
export declare function getRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config
|
|
1325
|
+
export declare function getRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config }: {
|
|
1326
1326
|
pathParams: GetRollingReleaseConfigPathParams;
|
|
1327
|
-
queryParams?: GetRollingReleaseConfigQueryParams;
|
|
1327
|
+
queryParams?: GetRollingReleaseConfigQueryParams | undefined;
|
|
1328
1328
|
config?: Partial<FetcherConfig> & {
|
|
1329
1329
|
client?: typeof client;
|
|
1330
1330
|
};
|
|
@@ -1332,11 +1332,11 @@ export declare function getRollingReleaseConfig({ pathParams: { idOrName }, quer
|
|
|
1332
1332
|
/**
|
|
1333
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
1334
|
* @summary Delete rolling release configuration
|
|
1335
|
-
* {@link
|
|
1335
|
+
* {@link /v1/projects/:idOrName/rolling-release/config}
|
|
1336
1336
|
*/
|
|
1337
|
-
export declare function deleteRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config
|
|
1337
|
+
export declare function deleteRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config }: {
|
|
1338
1338
|
pathParams: DeleteRollingReleaseConfigPathParams;
|
|
1339
|
-
queryParams?: DeleteRollingReleaseConfigQueryParams;
|
|
1339
|
+
queryParams?: DeleteRollingReleaseConfigQueryParams | undefined;
|
|
1340
1340
|
config?: Partial<FetcherConfig> & {
|
|
1341
1341
|
client?: typeof client;
|
|
1342
1342
|
};
|
|
@@ -1344,11 +1344,11 @@ export declare function deleteRollingReleaseConfig({ pathParams: { idOrName }, q
|
|
|
1344
1344
|
/**
|
|
1345
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
1346
|
* @summary Update the rolling release settings for the project
|
|
1347
|
-
* {@link
|
|
1347
|
+
* {@link /v1/projects/:idOrName/rolling-release/config}
|
|
1348
1348
|
*/
|
|
1349
|
-
export declare function updateRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config
|
|
1349
|
+
export declare function updateRollingReleaseConfig({ pathParams: { idOrName }, queryParams, config }: {
|
|
1350
1350
|
pathParams: UpdateRollingReleaseConfigPathParams;
|
|
1351
|
-
queryParams?: UpdateRollingReleaseConfigQueryParams;
|
|
1351
|
+
queryParams?: UpdateRollingReleaseConfigQueryParams | undefined;
|
|
1352
1352
|
config?: Partial<FetcherConfig> & {
|
|
1353
1353
|
client?: typeof client;
|
|
1354
1354
|
};
|
|
@@ -1356,11 +1356,11 @@ export declare function updateRollingReleaseConfig({ pathParams: { idOrName }, q
|
|
|
1356
1356
|
/**
|
|
1357
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
1358
|
* @summary Get the active rolling release information for a project
|
|
1359
|
-
* {@link
|
|
1359
|
+
* {@link /v1/projects/:idOrName/rolling-release}
|
|
1360
1360
|
*/
|
|
1361
|
-
export declare function getRollingRelease({ pathParams: { idOrName }, queryParams, config
|
|
1361
|
+
export declare function getRollingRelease({ pathParams: { idOrName }, queryParams, config }: {
|
|
1362
1362
|
pathParams: GetRollingReleasePathParams;
|
|
1363
|
-
queryParams?: GetRollingReleaseQueryParams;
|
|
1363
|
+
queryParams?: GetRollingReleaseQueryParams | undefined;
|
|
1364
1364
|
config?: Partial<FetcherConfig> & {
|
|
1365
1365
|
client?: typeof client;
|
|
1366
1366
|
};
|
|
@@ -1368,11 +1368,11 @@ export declare function getRollingRelease({ pathParams: { idOrName }, queryParam
|
|
|
1368
1368
|
/**
|
|
1369
1369
|
* @description Advance a rollout to the next stage. This is only needed when rolling releases is configured to require manual approval.
|
|
1370
1370
|
* @summary Update the active rolling release to the next stage for a project
|
|
1371
|
-
* {@link
|
|
1371
|
+
* {@link /v1/projects/:idOrName/rolling-release/approve-stage}
|
|
1372
1372
|
*/
|
|
1373
|
-
export declare function approveRollingReleaseStage({ pathParams: { idOrName }, queryParams, config
|
|
1373
|
+
export declare function approveRollingReleaseStage({ pathParams: { idOrName }, queryParams, config }: {
|
|
1374
1374
|
pathParams: ApproveRollingReleaseStagePathParams;
|
|
1375
|
-
queryParams?: ApproveRollingReleaseStageQueryParams;
|
|
1375
|
+
queryParams?: ApproveRollingReleaseStageQueryParams | undefined;
|
|
1376
1376
|
config?: Partial<FetcherConfig> & {
|
|
1377
1377
|
client?: typeof client;
|
|
1378
1378
|
};
|
|
@@ -1380,11 +1380,11 @@ export declare function approveRollingReleaseStage({ pathParams: { idOrName }, q
|
|
|
1380
1380
|
/**
|
|
1381
1381
|
* @description Force-complete a Rolling Release. The canary deployment will begin serving 100% of the traffic.
|
|
1382
1382
|
* @summary Complete the rolling release for the project
|
|
1383
|
-
* {@link
|
|
1383
|
+
* {@link /v1/projects/:idOrName/rolling-release/complete}
|
|
1384
1384
|
*/
|
|
1385
|
-
export declare function completeRollingRelease({ pathParams: { idOrName }, queryParams, config
|
|
1385
|
+
export declare function completeRollingRelease({ pathParams: { idOrName }, queryParams, config }: {
|
|
1386
1386
|
pathParams: CompleteRollingReleasePathParams;
|
|
1387
|
-
queryParams?: CompleteRollingReleaseQueryParams;
|
|
1387
|
+
queryParams?: CompleteRollingReleaseQueryParams | undefined;
|
|
1388
1388
|
config?: Partial<FetcherConfig> & {
|
|
1389
1389
|
client?: typeof client;
|
|
1390
1390
|
};
|
|
@@ -1392,11 +1392,11 @@ export declare function completeRollingRelease({ pathParams: { idOrName }, query
|
|
|
1392
1392
|
/**
|
|
1393
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
1394
|
* @summary Create project transfer request
|
|
1395
|
-
* {@link
|
|
1395
|
+
* {@link /projects/:idOrName/transfer-request}
|
|
1396
1396
|
*/
|
|
1397
|
-
export declare function createProjectTransferRequest({ pathParams: { idOrName }, queryParams, config
|
|
1397
|
+
export declare function createProjectTransferRequest({ pathParams: { idOrName }, queryParams, config }: {
|
|
1398
1398
|
pathParams: CreateProjectTransferRequestPathParams;
|
|
1399
|
-
queryParams?: CreateProjectTransferRequestQueryParams;
|
|
1399
|
+
queryParams?: CreateProjectTransferRequestQueryParams | undefined;
|
|
1400
1400
|
config?: Partial<FetcherConfig> & {
|
|
1401
1401
|
client?: typeof client;
|
|
1402
1402
|
};
|
|
@@ -1404,11 +1404,11 @@ export declare function createProjectTransferRequest({ pathParams: { idOrName },
|
|
|
1404
1404
|
/**
|
|
1405
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
1406
|
* @summary Accept project transfer request
|
|
1407
|
-
* {@link
|
|
1407
|
+
* {@link /projects/transfer-request/:code}
|
|
1408
1408
|
*/
|
|
1409
|
-
export declare function acceptProjectTransferRequest({ pathParams: { code }, queryParams, config
|
|
1409
|
+
export declare function acceptProjectTransferRequest({ pathParams: { code }, queryParams, config }: {
|
|
1410
1410
|
pathParams: AcceptProjectTransferRequestPathParams;
|
|
1411
|
-
queryParams?: AcceptProjectTransferRequestQueryParams;
|
|
1411
|
+
queryParams?: AcceptProjectTransferRequestQueryParams | undefined;
|
|
1412
1412
|
config?: Partial<FetcherConfig> & {
|
|
1413
1413
|
client?: typeof client;
|
|
1414
1414
|
};
|
|
@@ -1416,11 +1416,11 @@ export declare function acceptProjectTransferRequest({ pathParams: { code }, que
|
|
|
1416
1416
|
/**
|
|
1417
1417
|
* @description Update the deployment protection automation bypass for a project
|
|
1418
1418
|
* @summary Update Protection Bypass for Automation
|
|
1419
|
-
* {@link
|
|
1419
|
+
* {@link /v1/projects/:idOrName/protection-bypass}
|
|
1420
1420
|
*/
|
|
1421
|
-
export declare function updateProjectProtectionBypass({ pathParams: { idOrName }, queryParams, config
|
|
1421
|
+
export declare function updateProjectProtectionBypass({ pathParams: { idOrName }, queryParams, config }: {
|
|
1422
1422
|
pathParams: UpdateProjectProtectionBypassPathParams;
|
|
1423
|
-
queryParams?: UpdateProjectProtectionBypassQueryParams;
|
|
1423
|
+
queryParams?: UpdateProjectProtectionBypassQueryParams | undefined;
|
|
1424
1424
|
config?: Partial<FetcherConfig> & {
|
|
1425
1425
|
client?: typeof client;
|
|
1426
1426
|
};
|
|
@@ -1428,11 +1428,11 @@ export declare function updateProjectProtectionBypass({ pathParams: { idOrName }
|
|
|
1428
1428
|
/**
|
|
1429
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
1430
|
* @summary Points all production domains for a project to the given deploy
|
|
1431
|
-
* {@link
|
|
1431
|
+
* {@link /v10/projects/:projectId/promote/:deploymentId}
|
|
1432
1432
|
*/
|
|
1433
|
-
export declare function requestPromote({ pathParams: { projectId, deploymentId }, queryParams, config
|
|
1433
|
+
export declare function requestPromote({ pathParams: { projectId, deploymentId }, queryParams, config }: {
|
|
1434
1434
|
pathParams: RequestPromotePathParams;
|
|
1435
|
-
queryParams?: RequestPromoteQueryParams;
|
|
1435
|
+
queryParams?: RequestPromoteQueryParams | undefined;
|
|
1436
1436
|
config?: Partial<FetcherConfig> & {
|
|
1437
1437
|
client?: typeof client;
|
|
1438
1438
|
};
|
|
@@ -1440,11 +1440,11 @@ export declare function requestPromote({ pathParams: { projectId, deploymentId }
|
|
|
1440
1440
|
/**
|
|
1441
1441
|
* @description Get a list of aliases related to the last promote request with their mapping status
|
|
1442
1442
|
* @summary Gets a list of aliases with status for the current promote
|
|
1443
|
-
* {@link
|
|
1443
|
+
* {@link /v1/projects/:projectId/promote/aliases}
|
|
1444
1444
|
*/
|
|
1445
|
-
export declare function listPromoteAliases({ pathParams: { projectId }, queryParams, config
|
|
1445
|
+
export declare function listPromoteAliases({ pathParams: { projectId }, queryParams, config }: {
|
|
1446
1446
|
pathParams: ListPromoteAliasesPathParams;
|
|
1447
|
-
queryParams?: ListPromoteAliasesQueryParams;
|
|
1447
|
+
queryParams?: ListPromoteAliasesQueryParams | undefined;
|
|
1448
1448
|
config?: Partial<FetcherConfig> & {
|
|
1449
1449
|
client?: typeof client;
|
|
1450
1450
|
};
|
|
@@ -1452,11 +1452,11 @@ export declare function listPromoteAliases({ pathParams: { projectId }, queryPar
|
|
|
1452
1452
|
/**
|
|
1453
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
1454
|
* @summary Pause a project
|
|
1455
|
-
* {@link
|
|
1455
|
+
* {@link /v1/projects/:projectId/pause}
|
|
1456
1456
|
*/
|
|
1457
|
-
export declare function pauseProject({ pathParams: { projectId }, queryParams, config
|
|
1457
|
+
export declare function pauseProject({ pathParams: { projectId }, queryParams, config }: {
|
|
1458
1458
|
pathParams: PauseProjectPathParams;
|
|
1459
|
-
queryParams?: PauseProjectQueryParams;
|
|
1459
|
+
queryParams?: PauseProjectQueryParams | undefined;
|
|
1460
1460
|
config?: Partial<FetcherConfig> & {
|
|
1461
1461
|
client?: typeof client;
|
|
1462
1462
|
};
|
|
@@ -1464,11 +1464,11 @@ export declare function pauseProject({ pathParams: { projectId }, queryParams, c
|
|
|
1464
1464
|
/**
|
|
1465
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
1466
|
* @summary Unpause a project
|
|
1467
|
-
* {@link
|
|
1467
|
+
* {@link /v1/projects/:projectId/unpause}
|
|
1468
1468
|
*/
|
|
1469
|
-
export declare function unpauseProject({ pathParams: { projectId }, queryParams, config
|
|
1469
|
+
export declare function unpauseProject({ pathParams: { projectId }, queryParams, config }: {
|
|
1470
1470
|
pathParams: UnpauseProjectPathParams;
|
|
1471
|
-
queryParams?: UnpauseProjectQueryParams;
|
|
1471
|
+
queryParams?: UnpauseProjectQueryParams | undefined;
|
|
1472
1472
|
config?: Partial<FetcherConfig> & {
|
|
1473
1473
|
client?: typeof client;
|
|
1474
1474
|
};
|
|
@@ -1476,10 +1476,10 @@ export declare function unpauseProject({ pathParams: { projectId }, queryParams,
|
|
|
1476
1476
|
/**
|
|
1477
1477
|
* @description Update the setting for determining if the project has Attack Challenge mode enabled.
|
|
1478
1478
|
* @summary Update Attack Challenge mode
|
|
1479
|
-
* {@link
|
|
1479
|
+
* {@link /v1/security/attack-mode}
|
|
1480
1480
|
*/
|
|
1481
|
-
export declare function updateAttackChallengeMode({ queryParams, config
|
|
1482
|
-
queryParams?: UpdateAttackChallengeModeQueryParams;
|
|
1481
|
+
export declare function updateAttackChallengeMode({ queryParams, config }: {
|
|
1482
|
+
queryParams?: UpdateAttackChallengeModeQueryParams | undefined;
|
|
1483
1483
|
config?: Partial<FetcherConfig> & {
|
|
1484
1484
|
client?: typeof client;
|
|
1485
1485
|
};
|
|
@@ -1487,9 +1487,9 @@ export declare function updateAttackChallengeMode({ queryParams, config, }: {
|
|
|
1487
1487
|
/**
|
|
1488
1488
|
* @description Set the firewall configuration to provided rules and settings. Creates or overwrite the existing firewall configuration.
|
|
1489
1489
|
* @summary Put Firewall Configuration
|
|
1490
|
-
* {@link
|
|
1490
|
+
* {@link /v1/security/firewall/config}
|
|
1491
1491
|
*/
|
|
1492
|
-
export declare function putFirewallConfig({ queryParams, config
|
|
1492
|
+
export declare function putFirewallConfig({ queryParams, config }: {
|
|
1493
1493
|
queryParams: PutFirewallConfigQueryParams;
|
|
1494
1494
|
config?: Partial<FetcherConfig> & {
|
|
1495
1495
|
client?: typeof client;
|
|
@@ -1498,9 +1498,9 @@ export declare function putFirewallConfig({ queryParams, config, }: {
|
|
|
1498
1498
|
/**
|
|
1499
1499
|
* @description Process updates to modify the existing firewall config for a project
|
|
1500
1500
|
* @summary Update Firewall Configuration
|
|
1501
|
-
* {@link
|
|
1501
|
+
* {@link /v1/security/firewall/config}
|
|
1502
1502
|
*/
|
|
1503
|
-
export declare function updateFirewallConfig({ queryParams, config
|
|
1503
|
+
export declare function updateFirewallConfig({ queryParams, config }: {
|
|
1504
1504
|
queryParams: UpdateFirewallConfigQueryParams;
|
|
1505
1505
|
config?: Partial<FetcherConfig> & {
|
|
1506
1506
|
client?: typeof client;
|
|
@@ -1509,9 +1509,9 @@ export declare function updateFirewallConfig({ queryParams, config, }: {
|
|
|
1509
1509
|
/**
|
|
1510
1510
|
* @description Retrieve the specified firewall configuration for a project. The deployed configVersion will be `active`
|
|
1511
1511
|
* @summary Read Firewall Configuration
|
|
1512
|
-
* {@link
|
|
1512
|
+
* {@link /v1/security/firewall/config/:configVersion}
|
|
1513
1513
|
*/
|
|
1514
|
-
export declare function getFirewallConfig({ pathParams: { configVersion }, queryParams, config
|
|
1514
|
+
export declare function getFirewallConfig({ pathParams: { configVersion }, queryParams, config }: {
|
|
1515
1515
|
pathParams: GetFirewallConfigPathParams;
|
|
1516
1516
|
queryParams: GetFirewallConfigQueryParams;
|
|
1517
1517
|
config?: Partial<FetcherConfig> & {
|
|
@@ -1521,9 +1521,9 @@ export declare function getFirewallConfig({ pathParams: { configVersion }, query
|
|
|
1521
1521
|
/**
|
|
1522
1522
|
* @description Retrieve active attack data within the last 24h window
|
|
1523
1523
|
* @summary Read active attack data
|
|
1524
|
-
* {@link
|
|
1524
|
+
* {@link /v1/security/firewall/attack-status}
|
|
1525
1525
|
*/
|
|
1526
|
-
export declare function getActiveAttackStatus({ queryParams, config
|
|
1526
|
+
export declare function getActiveAttackStatus({ queryParams, config }: {
|
|
1527
1527
|
queryParams: GetActiveAttackStatusQueryParams;
|
|
1528
1528
|
config?: Partial<FetcherConfig> & {
|
|
1529
1529
|
client?: typeof client;
|
|
@@ -1532,9 +1532,9 @@ export declare function getActiveAttackStatus({ queryParams, config, }: {
|
|
|
1532
1532
|
/**
|
|
1533
1533
|
* @description Retrieve the system bypass rules configured for the specified project
|
|
1534
1534
|
* @summary Read System Bypass
|
|
1535
|
-
* {@link
|
|
1535
|
+
* {@link /v1/security/firewall/bypass}
|
|
1536
1536
|
*/
|
|
1537
|
-
export declare function getBypassIp({ queryParams, config
|
|
1537
|
+
export declare function getBypassIp({ queryParams, config }: {
|
|
1538
1538
|
queryParams: GetBypassIpQueryParams;
|
|
1539
1539
|
config?: Partial<FetcherConfig> & {
|
|
1540
1540
|
client?: typeof client;
|
|
@@ -1543,9 +1543,9 @@ export declare function getBypassIp({ queryParams, config, }: {
|
|
|
1543
1543
|
/**
|
|
1544
1544
|
* @description Create new system bypass rules
|
|
1545
1545
|
* @summary Create System Bypass Rule
|
|
1546
|
-
* {@link
|
|
1546
|
+
* {@link /v1/security/firewall/bypass}
|
|
1547
1547
|
*/
|
|
1548
|
-
export declare function addBypassIp({ queryParams, config
|
|
1548
|
+
export declare function addBypassIp({ queryParams, config }: {
|
|
1549
1549
|
queryParams: AddBypassIpQueryParams;
|
|
1550
1550
|
config?: Partial<FetcherConfig> & {
|
|
1551
1551
|
client?: typeof client;
|
|
@@ -1554,9 +1554,9 @@ export declare function addBypassIp({ queryParams, config, }: {
|
|
|
1554
1554
|
/**
|
|
1555
1555
|
* @description Remove system bypass rules
|
|
1556
1556
|
* @summary Remove System Bypass Rule
|
|
1557
|
-
* {@link
|
|
1557
|
+
* {@link /v1/security/firewall/bypass}
|
|
1558
1558
|
*/
|
|
1559
|
-
export declare function removeBypassIp({ queryParams, config
|
|
1559
|
+
export declare function removeBypassIp({ queryParams, config }: {
|
|
1560
1560
|
queryParams: RemoveBypassIpQueryParams;
|
|
1561
1561
|
config?: Partial<FetcherConfig> & {
|
|
1562
1562
|
client?: typeof client;
|
|
@@ -1565,11 +1565,11 @@ export declare function removeBypassIp({ queryParams, config, }: {
|
|
|
1565
1565
|
/**
|
|
1566
1566
|
* @description Get a paginated list of team members for the provided team.
|
|
1567
1567
|
* @summary List team members
|
|
1568
|
-
* {@link
|
|
1568
|
+
* {@link /v3/teams/:teamId/members}
|
|
1569
1569
|
*/
|
|
1570
|
-
export declare function getTeamMembers({ pathParams: { teamId }, queryParams, config
|
|
1570
|
+
export declare function getTeamMembers({ pathParams: { teamId }, queryParams, config }: {
|
|
1571
1571
|
pathParams: GetTeamMembersPathParams;
|
|
1572
|
-
queryParams?: GetTeamMembersQueryParams;
|
|
1572
|
+
queryParams?: GetTeamMembersQueryParams | undefined;
|
|
1573
1573
|
config?: Partial<FetcherConfig> & {
|
|
1574
1574
|
client?: typeof client;
|
|
1575
1575
|
};
|
|
@@ -1577,9 +1577,9 @@ export declare function getTeamMembers({ pathParams: { teamId }, queryParams, co
|
|
|
1577
1577
|
/**
|
|
1578
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
1579
|
* @summary Invite a user
|
|
1580
|
-
* {@link
|
|
1580
|
+
* {@link /v1/teams/:teamId/members}
|
|
1581
1581
|
*/
|
|
1582
|
-
export declare function inviteUserToTeam({ pathParams: { teamId }, config
|
|
1582
|
+
export declare function inviteUserToTeam({ pathParams: { teamId }, config }: {
|
|
1583
1583
|
pathParams: InviteUserToTeamPathParams;
|
|
1584
1584
|
config?: Partial<FetcherConfig> & {
|
|
1585
1585
|
client?: typeof client;
|
|
@@ -1588,9 +1588,9 @@ export declare function inviteUserToTeam({ pathParams: { teamId }, config, }: {
|
|
|
1588
1588
|
/**
|
|
1589
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
1590
|
* @summary Request access to a team
|
|
1591
|
-
* {@link
|
|
1591
|
+
* {@link /v1/teams/:teamId/request}
|
|
1592
1592
|
*/
|
|
1593
|
-
export declare function requestAccessToTeam({ pathParams: { teamId }, config
|
|
1593
|
+
export declare function requestAccessToTeam({ pathParams: { teamId }, config }: {
|
|
1594
1594
|
pathParams: RequestAccessToTeamPathParams;
|
|
1595
1595
|
config?: Partial<FetcherConfig> & {
|
|
1596
1596
|
client?: typeof client;
|
|
@@ -1599,9 +1599,9 @@ export declare function requestAccessToTeam({ pathParams: { teamId }, config, }:
|
|
|
1599
1599
|
/**
|
|
1600
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
1601
|
* @summary Get access request status
|
|
1602
|
-
* {@link
|
|
1602
|
+
* {@link /v1/teams/:teamId/request/:userId}
|
|
1603
1603
|
*/
|
|
1604
|
-
export declare function getTeamAccessRequest({ pathParams: { userId, teamId }, config
|
|
1604
|
+
export declare function getTeamAccessRequest({ pathParams: { userId, teamId }, config }: {
|
|
1605
1605
|
pathParams: GetTeamAccessRequestPathParams;
|
|
1606
1606
|
config?: Partial<FetcherConfig> & {
|
|
1607
1607
|
client?: typeof client;
|
|
@@ -1610,9 +1610,9 @@ export declare function getTeamAccessRequest({ pathParams: { userId, teamId }, c
|
|
|
1610
1610
|
/**
|
|
1611
1611
|
* @description Join a team with a provided invite code or team ID.
|
|
1612
1612
|
* @summary Join a team
|
|
1613
|
-
* {@link
|
|
1613
|
+
* {@link /v1/teams/:teamId/members/teams/join}
|
|
1614
1614
|
*/
|
|
1615
|
-
export declare function joinTeam({ pathParams: { teamId }, config
|
|
1615
|
+
export declare function joinTeam({ pathParams: { teamId }, config }: {
|
|
1616
1616
|
pathParams: JoinTeamPathParams;
|
|
1617
1617
|
config?: Partial<FetcherConfig> & {
|
|
1618
1618
|
client?: typeof client;
|
|
@@ -1621,9 +1621,9 @@ export declare function joinTeam({ pathParams: { teamId }, config, }: {
|
|
|
1621
1621
|
/**
|
|
1622
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
1623
|
* @summary Update a Team Member
|
|
1624
|
-
* {@link
|
|
1624
|
+
* {@link /v1/teams/:teamId/members/:uid}
|
|
1625
1625
|
*/
|
|
1626
|
-
export declare function updateTeamMember({ pathParams: { uid, teamId }, config
|
|
1626
|
+
export declare function updateTeamMember({ pathParams: { uid, teamId }, config }: {
|
|
1627
1627
|
pathParams: UpdateTeamMemberPathParams;
|
|
1628
1628
|
config?: Partial<FetcherConfig> & {
|
|
1629
1629
|
client?: typeof client;
|
|
@@ -1632,11 +1632,11 @@ export declare function updateTeamMember({ pathParams: { uid, teamId }, config,
|
|
|
1632
1632
|
/**
|
|
1633
1633
|
* @description Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team.
|
|
1634
1634
|
* @summary Remove a Team Member
|
|
1635
|
-
* {@link
|
|
1635
|
+
* {@link /v1/teams/:teamId/members/:uid}
|
|
1636
1636
|
*/
|
|
1637
|
-
export declare function removeTeamMember({ pathParams: { uid, teamId }, queryParams, config
|
|
1637
|
+
export declare function removeTeamMember({ pathParams: { uid, teamId }, queryParams, config }: {
|
|
1638
1638
|
pathParams: RemoveTeamMemberPathParams;
|
|
1639
|
-
queryParams?: RemoveTeamMemberQueryParams;
|
|
1639
|
+
queryParams?: RemoveTeamMemberQueryParams | undefined;
|
|
1640
1640
|
config?: Partial<FetcherConfig> & {
|
|
1641
1641
|
client?: typeof client;
|
|
1642
1642
|
};
|
|
@@ -1644,11 +1644,11 @@ export declare function removeTeamMember({ pathParams: { uid, teamId }, queryPar
|
|
|
1644
1644
|
/**
|
|
1645
1645
|
* @description Get information for the Team specified by the `teamId` parameter.
|
|
1646
1646
|
* @summary Get a Team
|
|
1647
|
-
* {@link
|
|
1647
|
+
* {@link /v2/teams/:teamId}
|
|
1648
1648
|
*/
|
|
1649
|
-
export declare function getTeam({ pathParams: { teamId }, queryParams, config
|
|
1649
|
+
export declare function getTeam({ pathParams: { teamId }, queryParams, config }: {
|
|
1650
1650
|
pathParams: GetTeamPathParams;
|
|
1651
|
-
queryParams?: GetTeamQueryParams;
|
|
1651
|
+
queryParams?: GetTeamQueryParams | undefined;
|
|
1652
1652
|
config?: Partial<FetcherConfig> & {
|
|
1653
1653
|
client?: typeof client;
|
|
1654
1654
|
};
|
|
@@ -1656,11 +1656,11 @@ export declare function getTeam({ pathParams: { teamId }, queryParams, config, }
|
|
|
1656
1656
|
/**
|
|
1657
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
1658
|
* @summary Update a Team
|
|
1659
|
-
* {@link
|
|
1659
|
+
* {@link /v2/teams/:teamId}
|
|
1660
1660
|
*/
|
|
1661
|
-
export declare function patchTeam({ pathParams: { teamId }, queryParams, config
|
|
1661
|
+
export declare function patchTeam({ pathParams: { teamId }, queryParams, config }: {
|
|
1662
1662
|
pathParams: PatchTeamPathParams;
|
|
1663
|
-
queryParams?: PatchTeamQueryParams;
|
|
1663
|
+
queryParams?: PatchTeamQueryParams | undefined;
|
|
1664
1664
|
config?: Partial<FetcherConfig> & {
|
|
1665
1665
|
client?: typeof client;
|
|
1666
1666
|
};
|
|
@@ -1668,10 +1668,10 @@ export declare function patchTeam({ pathParams: { teamId }, queryParams, config,
|
|
|
1668
1668
|
/**
|
|
1669
1669
|
* @description Get a paginated list of all the Teams the authenticated User is a member of.
|
|
1670
1670
|
* @summary List all teams
|
|
1671
|
-
* {@link
|
|
1671
|
+
* {@link /v2/teams}
|
|
1672
1672
|
*/
|
|
1673
|
-
export declare function getTeams({ queryParams, config
|
|
1674
|
-
queryParams?: GetTeamsQueryParams;
|
|
1673
|
+
export declare function getTeams({ queryParams, config }: {
|
|
1674
|
+
queryParams?: GetTeamsQueryParams | undefined;
|
|
1675
1675
|
config?: Partial<FetcherConfig> & {
|
|
1676
1676
|
client?: typeof client;
|
|
1677
1677
|
};
|
|
@@ -1679,7 +1679,7 @@ export declare function getTeams({ queryParams, config, }: {
|
|
|
1679
1679
|
/**
|
|
1680
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
1681
|
* @summary Create a Team
|
|
1682
|
-
* {@link
|
|
1682
|
+
* {@link /v1/teams}
|
|
1683
1683
|
*/
|
|
1684
1684
|
export declare function createTeam({ config }: {
|
|
1685
1685
|
config?: Partial<FetcherConfig> & {
|
|
@@ -1689,11 +1689,11 @@ export declare function createTeam({ config }: {
|
|
|
1689
1689
|
/**
|
|
1690
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
1691
|
* @summary Delete a Team
|
|
1692
|
-
* {@link
|
|
1692
|
+
* {@link /v1/teams/:teamId}
|
|
1693
1693
|
*/
|
|
1694
|
-
export declare function deleteTeam({ pathParams: { teamId }, queryParams, config
|
|
1694
|
+
export declare function deleteTeam({ pathParams: { teamId }, queryParams, config }: {
|
|
1695
1695
|
pathParams: DeleteTeamPathParams;
|
|
1696
|
-
queryParams?: DeleteTeamQueryParams;
|
|
1696
|
+
queryParams?: DeleteTeamQueryParams | undefined;
|
|
1697
1697
|
config?: Partial<FetcherConfig> & {
|
|
1698
1698
|
client?: typeof client;
|
|
1699
1699
|
};
|
|
@@ -1701,9 +1701,9 @@ export declare function deleteTeam({ pathParams: { teamId }, queryParams, config
|
|
|
1701
1701
|
/**
|
|
1702
1702
|
* @description Delete an active Team invite code.
|
|
1703
1703
|
* @summary Delete a Team invite code
|
|
1704
|
-
* {@link
|
|
1704
|
+
* {@link /v1/teams/:teamId/invites/:inviteId}
|
|
1705
1705
|
*/
|
|
1706
|
-
export declare function deleteTeamInviteCode({ pathParams: { inviteId, teamId }, config
|
|
1706
|
+
export declare function deleteTeamInviteCode({ pathParams: { inviteId, teamId }, config }: {
|
|
1707
1707
|
pathParams: DeleteTeamInviteCodePathParams;
|
|
1708
1708
|
config?: Partial<FetcherConfig> & {
|
|
1709
1709
|
client?: typeof client;
|
|
@@ -1712,11 +1712,11 @@ export declare function deleteTeamInviteCode({ pathParams: { inviteId, teamId },
|
|
|
1712
1712
|
/**
|
|
1713
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
1714
|
* @summary Upload Deployment Files
|
|
1715
|
-
* {@link
|
|
1715
|
+
* {@link /v2/files}
|
|
1716
1716
|
*/
|
|
1717
|
-
export declare function uploadFile({ queryParams, headers, config
|
|
1718
|
-
queryParams?: UploadFileQueryParams;
|
|
1719
|
-
headers?: UploadFileHeaderParams;
|
|
1717
|
+
export declare function uploadFile({ queryParams, headers, config }: {
|
|
1718
|
+
queryParams?: UploadFileQueryParams | undefined;
|
|
1719
|
+
headers?: UploadFileHeaderParams | undefined;
|
|
1720
1720
|
config?: Partial<FetcherConfig> & {
|
|
1721
1721
|
client?: typeof client;
|
|
1722
1722
|
};
|
|
@@ -1724,7 +1724,7 @@ export declare function uploadFile({ queryParams, headers, config, }: {
|
|
|
1724
1724
|
/**
|
|
1725
1725
|
* @description Retrieve a list of the current User's authentication tokens.
|
|
1726
1726
|
* @summary List Auth Tokens
|
|
1727
|
-
* {@link
|
|
1727
|
+
* {@link /v5/user/tokens}
|
|
1728
1728
|
*/
|
|
1729
1729
|
export declare function listAuthTokens({ config }: {
|
|
1730
1730
|
config?: Partial<FetcherConfig> & {
|
|
@@ -1734,10 +1734,10 @@ export declare function listAuthTokens({ config }: {
|
|
|
1734
1734
|
/**
|
|
1735
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
1736
|
* @summary Create an Auth Token
|
|
1737
|
-
* {@link
|
|
1737
|
+
* {@link /v3/user/tokens}
|
|
1738
1738
|
*/
|
|
1739
|
-
export declare function createAuthToken({ queryParams, config
|
|
1740
|
-
queryParams?: CreateAuthTokenQueryParams;
|
|
1739
|
+
export declare function createAuthToken({ queryParams, config }: {
|
|
1740
|
+
queryParams?: CreateAuthTokenQueryParams | undefined;
|
|
1741
1741
|
config?: Partial<FetcherConfig> & {
|
|
1742
1742
|
client?: typeof client;
|
|
1743
1743
|
};
|
|
@@ -1745,9 +1745,9 @@ export declare function createAuthToken({ queryParams, config, }: {
|
|
|
1745
1745
|
/**
|
|
1746
1746
|
* @description Retrieve metadata about an authentication token belonging to the currently authenticated User.
|
|
1747
1747
|
* @summary Get Auth Token Metadata
|
|
1748
|
-
* {@link
|
|
1748
|
+
* {@link /v5/user/tokens/:tokenId}
|
|
1749
1749
|
*/
|
|
1750
|
-
export declare function getAuthToken({ pathParams: { tokenId }, config
|
|
1750
|
+
export declare function getAuthToken({ pathParams: { tokenId }, config }: {
|
|
1751
1751
|
pathParams: GetAuthTokenPathParams;
|
|
1752
1752
|
config?: Partial<FetcherConfig> & {
|
|
1753
1753
|
client?: typeof client;
|
|
@@ -1756,9 +1756,9 @@ export declare function getAuthToken({ pathParams: { tokenId }, config, }: {
|
|
|
1756
1756
|
/**
|
|
1757
1757
|
* @description Invalidate an authentication token, such that it will no longer be valid for future HTTP requests.
|
|
1758
1758
|
* @summary Delete an authentication token
|
|
1759
|
-
* {@link
|
|
1759
|
+
* {@link /v3/user/tokens/:tokenId}
|
|
1760
1760
|
*/
|
|
1761
|
-
export declare function deleteAuthToken({ pathParams: { tokenId }, config
|
|
1761
|
+
export declare function deleteAuthToken({ pathParams: { tokenId }, config }: {
|
|
1762
1762
|
pathParams: DeleteAuthTokenPathParams;
|
|
1763
1763
|
config?: Partial<FetcherConfig> & {
|
|
1764
1764
|
client?: typeof client;
|
|
@@ -1767,7 +1767,7 @@ export declare function deleteAuthToken({ pathParams: { tokenId }, config, }: {
|
|
|
1767
1767
|
/**
|
|
1768
1768
|
* @description Retrieves information related to the currently authenticated User.
|
|
1769
1769
|
* @summary Get the User
|
|
1770
|
-
* {@link
|
|
1770
|
+
* {@link /v2/user}
|
|
1771
1771
|
*/
|
|
1772
1772
|
export declare function getAuthUser({ config }: {
|
|
1773
1773
|
config?: Partial<FetcherConfig> & {
|
|
@@ -1777,7 +1777,7 @@ export declare function getAuthUser({ config }: {
|
|
|
1777
1777
|
/**
|
|
1778
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
1779
|
* @summary Delete User Account
|
|
1780
|
-
* {@link
|
|
1780
|
+
* {@link /v1/user}
|
|
1781
1781
|
*/
|
|
1782
1782
|
export declare function requestDelete({ config }: {
|
|
1783
1783
|
config?: Partial<FetcherConfig> & {
|
|
@@ -1787,10 +1787,10 @@ export declare function requestDelete({ config }: {
|
|
|
1787
1787
|
/**
|
|
1788
1788
|
* @description Creates a webhook
|
|
1789
1789
|
* @summary Creates a webhook
|
|
1790
|
-
* {@link
|
|
1790
|
+
* {@link /v1/webhooks}
|
|
1791
1791
|
*/
|
|
1792
|
-
export declare function createWebhook({ queryParams, config
|
|
1793
|
-
queryParams?: CreateWebhookQueryParams;
|
|
1792
|
+
export declare function createWebhook({ queryParams, config }: {
|
|
1793
|
+
queryParams?: CreateWebhookQueryParams | undefined;
|
|
1794
1794
|
config?: Partial<FetcherConfig> & {
|
|
1795
1795
|
client?: typeof client;
|
|
1796
1796
|
};
|
|
@@ -1798,10 +1798,10 @@ export declare function createWebhook({ queryParams, config, }: {
|
|
|
1798
1798
|
/**
|
|
1799
1799
|
* @description Get a list of webhooks
|
|
1800
1800
|
* @summary Get a list of webhooks
|
|
1801
|
-
* {@link
|
|
1801
|
+
* {@link /v1/webhooks}
|
|
1802
1802
|
*/
|
|
1803
|
-
export declare function getWebhooks({ queryParams, config
|
|
1804
|
-
queryParams?: GetWebhooksQueryParams;
|
|
1803
|
+
export declare function getWebhooks({ queryParams, config }: {
|
|
1804
|
+
queryParams?: GetWebhooksQueryParams | undefined;
|
|
1805
1805
|
config?: Partial<FetcherConfig> & {
|
|
1806
1806
|
client?: typeof client;
|
|
1807
1807
|
};
|
|
@@ -1809,11 +1809,11 @@ export declare function getWebhooks({ queryParams, config, }: {
|
|
|
1809
1809
|
/**
|
|
1810
1810
|
* @description Get a webhook
|
|
1811
1811
|
* @summary Get a webhook
|
|
1812
|
-
* {@link
|
|
1812
|
+
* {@link /v1/webhooks/:id}
|
|
1813
1813
|
*/
|
|
1814
|
-
export declare function getWebhook({ pathParams: { id }, queryParams, config
|
|
1814
|
+
export declare function getWebhook({ pathParams: { id }, queryParams, config }: {
|
|
1815
1815
|
pathParams: GetWebhookPathParams;
|
|
1816
|
-
queryParams?: GetWebhookQueryParams;
|
|
1816
|
+
queryParams?: GetWebhookQueryParams | undefined;
|
|
1817
1817
|
config?: Partial<FetcherConfig> & {
|
|
1818
1818
|
client?: typeof client;
|
|
1819
1819
|
};
|
|
@@ -1821,11 +1821,11 @@ export declare function getWebhook({ pathParams: { id }, queryParams, config, }:
|
|
|
1821
1821
|
/**
|
|
1822
1822
|
* @description Deletes a webhook
|
|
1823
1823
|
* @summary Deletes a webhook
|
|
1824
|
-
* {@link
|
|
1824
|
+
* {@link /v1/webhooks/:id}
|
|
1825
1825
|
*/
|
|
1826
|
-
export declare function deleteWebhook({ pathParams: { id }, queryParams, config
|
|
1826
|
+
export declare function deleteWebhook({ pathParams: { id }, queryParams, config }: {
|
|
1827
1827
|
pathParams: DeleteWebhookPathParams;
|
|
1828
|
-
queryParams?: DeleteWebhookQueryParams;
|
|
1828
|
+
queryParams?: DeleteWebhookQueryParams | undefined;
|
|
1829
1829
|
config?: Partial<FetcherConfig> & {
|
|
1830
1830
|
client?: typeof client;
|
|
1831
1831
|
};
|
|
@@ -1833,11 +1833,11 @@ export declare function deleteWebhook({ pathParams: { id }, queryParams, config,
|
|
|
1833
1833
|
/**
|
|
1834
1834
|
* @description Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment.
|
|
1835
1835
|
* @summary List Deployment Aliases
|
|
1836
|
-
* {@link
|
|
1836
|
+
* {@link /v2/deployments/:id/aliases}
|
|
1837
1837
|
*/
|
|
1838
|
-
export declare function listDeploymentAliases({ pathParams: { id }, queryParams, config
|
|
1838
|
+
export declare function listDeploymentAliases({ pathParams: { id }, queryParams, config }: {
|
|
1839
1839
|
pathParams: ListDeploymentAliasesPathParams;
|
|
1840
|
-
queryParams?: ListDeploymentAliasesQueryParams;
|
|
1840
|
+
queryParams?: ListDeploymentAliasesQueryParams | undefined;
|
|
1841
1841
|
config?: Partial<FetcherConfig> & {
|
|
1842
1842
|
client?: typeof client;
|
|
1843
1843
|
};
|
|
@@ -1845,11 +1845,11 @@ export declare function listDeploymentAliases({ pathParams: { id }, queryParams,
|
|
|
1845
1845
|
/**
|
|
1846
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
1847
|
* @summary Assign an Alias
|
|
1848
|
-
* {@link
|
|
1848
|
+
* {@link /v2/deployments/:id/aliases}
|
|
1849
1849
|
*/
|
|
1850
|
-
export declare function assignAlias({ pathParams: { id }, queryParams, config
|
|
1850
|
+
export declare function assignAlias({ pathParams: { id }, queryParams, config }: {
|
|
1851
1851
|
pathParams: AssignAliasPathParams;
|
|
1852
|
-
queryParams?: AssignAliasQueryParams;
|
|
1852
|
+
queryParams?: AssignAliasQueryParams | undefined;
|
|
1853
1853
|
config?: Partial<FetcherConfig> & {
|
|
1854
1854
|
client?: typeof client;
|
|
1855
1855
|
};
|
|
@@ -1857,10 +1857,10 @@ export declare function assignAlias({ pathParams: { id }, queryParams, config, }
|
|
|
1857
1857
|
/**
|
|
1858
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
1859
|
* @summary List aliases
|
|
1860
|
-
* {@link
|
|
1860
|
+
* {@link /v4/aliases}
|
|
1861
1861
|
*/
|
|
1862
|
-
export declare function listAliases({ queryParams, config
|
|
1863
|
-
queryParams?: ListAliasesQueryParams;
|
|
1862
|
+
export declare function listAliases({ queryParams, config }: {
|
|
1863
|
+
queryParams?: ListAliasesQueryParams | undefined;
|
|
1864
1864
|
config?: Partial<FetcherConfig> & {
|
|
1865
1865
|
client?: typeof client;
|
|
1866
1866
|
};
|
|
@@ -1868,11 +1868,11 @@ export declare function listAliases({ queryParams, config, }: {
|
|
|
1868
1868
|
/**
|
|
1869
1869
|
* @description Retrieves an Alias for the given host name or alias ID.
|
|
1870
1870
|
* @summary Get an Alias
|
|
1871
|
-
* {@link
|
|
1871
|
+
* {@link /v4/aliases/:idOrAlias}
|
|
1872
1872
|
*/
|
|
1873
|
-
export declare function getAlias({ pathParams: { idOrAlias }, queryParams, config
|
|
1873
|
+
export declare function getAlias({ pathParams: { idOrAlias }, queryParams, config }: {
|
|
1874
1874
|
pathParams: GetAliasPathParams;
|
|
1875
|
-
queryParams?: GetAliasQueryParams;
|
|
1875
|
+
queryParams?: GetAliasQueryParams | undefined;
|
|
1876
1876
|
config?: Partial<FetcherConfig> & {
|
|
1877
1877
|
client?: typeof client;
|
|
1878
1878
|
};
|
|
@@ -1880,11 +1880,11 @@ export declare function getAlias({ pathParams: { idOrAlias }, queryParams, confi
|
|
|
1880
1880
|
/**
|
|
1881
1881
|
* @description Delete an Alias with the specified ID.
|
|
1882
1882
|
* @summary Delete an Alias
|
|
1883
|
-
* {@link
|
|
1883
|
+
* {@link /v2/aliases/:aliasId}
|
|
1884
1884
|
*/
|
|
1885
|
-
export declare function deleteAlias({ pathParams: { aliasId }, queryParams, config
|
|
1885
|
+
export declare function deleteAlias({ pathParams: { aliasId }, queryParams, config }: {
|
|
1886
1886
|
pathParams: DeleteAliasPathParams;
|
|
1887
|
-
queryParams?: DeleteAliasQueryParams;
|
|
1887
|
+
queryParams?: DeleteAliasQueryParams | undefined;
|
|
1888
1888
|
config?: Partial<FetcherConfig> & {
|
|
1889
1889
|
client?: typeof client;
|
|
1890
1890
|
};
|
|
@@ -1892,17 +1892,17 @@ export declare function deleteAlias({ pathParams: { aliasId }, queryParams, conf
|
|
|
1892
1892
|
/**
|
|
1893
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
1894
|
* @summary Update the protection bypass for a URL
|
|
1895
|
-
* {@link
|
|
1895
|
+
* {@link /aliases/:id/protection-bypass}
|
|
1896
1896
|
*/
|
|
1897
|
-
export declare function patchUrlProtectionBypass({ pathParams: { id }, queryParams, config
|
|
1897
|
+
export declare function patchUrlProtectionBypass({ pathParams: { id }, queryParams, config }: {
|
|
1898
1898
|
pathParams: PatchUrlProtectionBypassPathParams;
|
|
1899
|
-
queryParams?: PatchUrlProtectionBypassQueryParams;
|
|
1899
|
+
queryParams?: PatchUrlProtectionBypassQueryParams | undefined;
|
|
1900
1900
|
config?: Partial<FetcherConfig> & {
|
|
1901
1901
|
client?: typeof client;
|
|
1902
1902
|
};
|
|
1903
1903
|
}): Promise<unknown>;
|
|
1904
1904
|
/**
|
|
1905
|
-
* {@link certs}
|
|
1905
|
+
* {@link /certs}
|
|
1906
1906
|
*/
|
|
1907
1907
|
export declare function listCerts({ config }: {
|
|
1908
1908
|
config?: Partial<FetcherConfig> & {
|
|
@@ -1912,11 +1912,11 @@ export declare function listCerts({ config }: {
|
|
|
1912
1912
|
/**
|
|
1913
1913
|
* @description Get cert by id
|
|
1914
1914
|
* @summary Get cert by id
|
|
1915
|
-
* {@link
|
|
1915
|
+
* {@link /v8/certs/:id}
|
|
1916
1916
|
*/
|
|
1917
|
-
export declare function getCertById({ pathParams: { id }, queryParams, config
|
|
1917
|
+
export declare function getCertById({ pathParams: { id }, queryParams, config }: {
|
|
1918
1918
|
pathParams: GetCertByIdPathParams;
|
|
1919
|
-
queryParams?: GetCertByIdQueryParams;
|
|
1919
|
+
queryParams?: GetCertByIdQueryParams | undefined;
|
|
1920
1920
|
config?: Partial<FetcherConfig> & {
|
|
1921
1921
|
client?: typeof client;
|
|
1922
1922
|
};
|
|
@@ -1924,11 +1924,11 @@ export declare function getCertById({ pathParams: { id }, queryParams, config, }
|
|
|
1924
1924
|
/**
|
|
1925
1925
|
* @description Remove cert
|
|
1926
1926
|
* @summary Remove cert
|
|
1927
|
-
* {@link
|
|
1927
|
+
* {@link /v8/certs/:id}
|
|
1928
1928
|
*/
|
|
1929
|
-
export declare function removeCert({ pathParams: { id }, queryParams, config
|
|
1929
|
+
export declare function removeCert({ pathParams: { id }, queryParams, config }: {
|
|
1930
1930
|
pathParams: RemoveCertPathParams;
|
|
1931
|
-
queryParams?: RemoveCertQueryParams;
|
|
1931
|
+
queryParams?: RemoveCertQueryParams | undefined;
|
|
1932
1932
|
config?: Partial<FetcherConfig> & {
|
|
1933
1933
|
client?: typeof client;
|
|
1934
1934
|
};
|
|
@@ -1936,10 +1936,10 @@ export declare function removeCert({ pathParams: { id }, queryParams, config, }:
|
|
|
1936
1936
|
/**
|
|
1937
1937
|
* @description Issue a new cert
|
|
1938
1938
|
* @summary Issue a new cert
|
|
1939
|
-
* {@link
|
|
1939
|
+
* {@link /v8/certs}
|
|
1940
1940
|
*/
|
|
1941
|
-
export declare function issueCert({ queryParams, config
|
|
1942
|
-
queryParams?: IssueCertQueryParams;
|
|
1941
|
+
export declare function issueCert({ queryParams, config }: {
|
|
1942
|
+
queryParams?: IssueCertQueryParams | undefined;
|
|
1943
1943
|
config?: Partial<FetcherConfig> & {
|
|
1944
1944
|
client?: typeof client;
|
|
1945
1945
|
};
|
|
@@ -1947,10 +1947,10 @@ export declare function issueCert({ queryParams, config, }: {
|
|
|
1947
1947
|
/**
|
|
1948
1948
|
* @description Upload a cert
|
|
1949
1949
|
* @summary Upload a cert
|
|
1950
|
-
* {@link
|
|
1950
|
+
* {@link /v8/certs}
|
|
1951
1951
|
*/
|
|
1952
|
-
export declare function uploadCert({ queryParams, config
|
|
1953
|
-
queryParams?: UploadCertQueryParams;
|
|
1952
|
+
export declare function uploadCert({ queryParams, config }: {
|
|
1953
|
+
queryParams?: UploadCertQueryParams | undefined;
|
|
1954
1954
|
config?: Partial<FetcherConfig> & {
|
|
1955
1955
|
client?: typeof client;
|
|
1956
1956
|
};
|
|
@@ -1958,11 +1958,11 @@ export declare function uploadCert({ queryParams, config, }: {
|
|
|
1958
1958
|
/**
|
|
1959
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
1960
|
* @summary List Deployment Files
|
|
1961
|
-
* {@link
|
|
1961
|
+
* {@link /v6/deployments/:id/files}
|
|
1962
1962
|
*/
|
|
1963
|
-
export declare function listDeploymentFiles({ pathParams: { id }, queryParams, config
|
|
1963
|
+
export declare function listDeploymentFiles({ pathParams: { id }, queryParams, config }: {
|
|
1964
1964
|
pathParams: ListDeploymentFilesPathParams;
|
|
1965
|
-
queryParams?: ListDeploymentFilesQueryParams;
|
|
1965
|
+
queryParams?: ListDeploymentFilesQueryParams | undefined;
|
|
1966
1966
|
config?: Partial<FetcherConfig> & {
|
|
1967
1967
|
client?: typeof client;
|
|
1968
1968
|
};
|
|
@@ -1970,11 +1970,11 @@ export declare function listDeploymentFiles({ pathParams: { id }, queryParams, c
|
|
|
1970
1970
|
/**
|
|
1971
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
1972
|
* @summary Get Deployment File Contents
|
|
1973
|
-
* {@link
|
|
1973
|
+
* {@link /v8/deployments/:id/files/:fileId}
|
|
1974
1974
|
*/
|
|
1975
|
-
export declare function getDeploymentFileContents({ pathParams: { id, fileId }, queryParams, config
|
|
1975
|
+
export declare function getDeploymentFileContents({ pathParams: { id, fileId }, queryParams, config }: {
|
|
1976
1976
|
pathParams: GetDeploymentFileContentsPathParams;
|
|
1977
|
-
queryParams?: GetDeploymentFileContentsQueryParams;
|
|
1977
|
+
queryParams?: GetDeploymentFileContentsQueryParams | undefined;
|
|
1978
1978
|
config?: Partial<FetcherConfig> & {
|
|
1979
1979
|
client?: typeof client;
|
|
1980
1980
|
};
|
|
@@ -1982,10 +1982,10 @@ export declare function getDeploymentFileContents({ pathParams: { id, fileId },
|
|
|
1982
1982
|
/**
|
|
1983
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
1984
|
* @summary List deployments
|
|
1985
|
-
* {@link
|
|
1985
|
+
* {@link /v6/deployments}
|
|
1986
1986
|
*/
|
|
1987
|
-
export declare function getDeployments({ queryParams, config
|
|
1988
|
-
queryParams?: GetDeploymentsQueryParams;
|
|
1987
|
+
export declare function getDeployments({ queryParams, config }: {
|
|
1988
|
+
queryParams?: GetDeploymentsQueryParams | undefined;
|
|
1989
1989
|
config?: Partial<FetcherConfig> & {
|
|
1990
1990
|
client?: typeof client;
|
|
1991
1991
|
};
|
|
@@ -1993,11 +1993,11 @@ export declare function getDeployments({ queryParams, config, }: {
|
|
|
1993
1993
|
/**
|
|
1994
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
1995
|
* @summary Delete a Deployment
|
|
1996
|
-
* {@link
|
|
1996
|
+
* {@link /v13/deployments/:id}
|
|
1997
1997
|
*/
|
|
1998
|
-
export declare function deleteDeployment({ pathParams: { id }, queryParams, config
|
|
1998
|
+
export declare function deleteDeployment({ pathParams: { id }, queryParams, config }: {
|
|
1999
1999
|
pathParams: DeleteDeploymentPathParams;
|
|
2000
|
-
queryParams?: DeleteDeploymentQueryParams;
|
|
2000
|
+
queryParams?: DeleteDeploymentQueryParams | undefined;
|
|
2001
2001
|
config?: Partial<FetcherConfig> & {
|
|
2002
2002
|
client?: typeof client;
|
|
2003
2003
|
};
|
|
@@ -2005,10 +2005,10 @@ export declare function deleteDeployment({ pathParams: { id }, queryParams, conf
|
|
|
2005
2005
|
/**
|
|
2006
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
2007
|
* @summary List secrets
|
|
2008
|
-
* {@link
|
|
2008
|
+
* {@link /v3/secrets}
|
|
2009
2009
|
*/
|
|
2010
|
-
export declare function getSecrets({ queryParams, config
|
|
2011
|
-
queryParams?: GetSecretsQueryParams;
|
|
2010
|
+
export declare function getSecrets({ queryParams, config }: {
|
|
2011
|
+
queryParams?: GetSecretsQueryParams | undefined;
|
|
2012
2012
|
config?: Partial<FetcherConfig> & {
|
|
2013
2013
|
client?: typeof client;
|
|
2014
2014
|
};
|
|
@@ -2016,11 +2016,11 @@ export declare function getSecrets({ queryParams, config, }: {
|
|
|
2016
2016
|
/**
|
|
2017
2017
|
* @description Allows to create a new secret.
|
|
2018
2018
|
* @summary Create a new secret
|
|
2019
|
-
* {@link
|
|
2019
|
+
* {@link /v2/secrets/:name}
|
|
2020
2020
|
*/
|
|
2021
|
-
export declare function createSecret({ pathParams: { name }, queryParams, config
|
|
2021
|
+
export declare function createSecret({ pathParams: { name }, queryParams, config }: {
|
|
2022
2022
|
pathParams: CreateSecretPathParams;
|
|
2023
|
-
queryParams?: CreateSecretQueryParams;
|
|
2023
|
+
queryParams?: CreateSecretQueryParams | undefined;
|
|
2024
2024
|
config?: Partial<FetcherConfig> & {
|
|
2025
2025
|
client?: typeof client;
|
|
2026
2026
|
};
|
|
@@ -2028,11 +2028,11 @@ export declare function createSecret({ pathParams: { name }, queryParams, config
|
|
|
2028
2028
|
/**
|
|
2029
2029
|
* @description Enables to edit the name of a secret. The name has to be unique to the user or team’s secrets.
|
|
2030
2030
|
* @summary Change secret name
|
|
2031
|
-
* {@link
|
|
2031
|
+
* {@link /v2/secrets/:name}
|
|
2032
2032
|
*/
|
|
2033
|
-
export declare function renameSecret({ pathParams: { name }, queryParams, config
|
|
2033
|
+
export declare function renameSecret({ pathParams: { name }, queryParams, config }: {
|
|
2034
2034
|
pathParams: RenameSecretPathParams;
|
|
2035
|
-
queryParams?: RenameSecretQueryParams;
|
|
2035
|
+
queryParams?: RenameSecretQueryParams | undefined;
|
|
2036
2036
|
config?: Partial<FetcherConfig> & {
|
|
2037
2037
|
client?: typeof client;
|
|
2038
2038
|
};
|
|
@@ -2040,11 +2040,11 @@ export declare function renameSecret({ pathParams: { name }, queryParams, config
|
|
|
2040
2040
|
/**
|
|
2041
2041
|
* @description Retrieves the information for a specific secret by passing either the secret id or name in the URL.
|
|
2042
2042
|
* @summary Get a single secret
|
|
2043
|
-
* {@link
|
|
2043
|
+
* {@link /v3/secrets/:idOrName}
|
|
2044
2044
|
*/
|
|
2045
|
-
export declare function getSecret({ pathParams: { idOrName }, queryParams, config
|
|
2045
|
+
export declare function getSecret({ pathParams: { idOrName }, queryParams, config }: {
|
|
2046
2046
|
pathParams: GetSecretPathParams;
|
|
2047
|
-
queryParams?: GetSecretQueryParams;
|
|
2047
|
+
queryParams?: GetSecretQueryParams | undefined;
|
|
2048
2048
|
config?: Partial<FetcherConfig> & {
|
|
2049
2049
|
client?: typeof client;
|
|
2050
2050
|
};
|
|
@@ -2052,194 +2052,194 @@ export declare function getSecret({ pathParams: { idOrName }, queryParams, confi
|
|
|
2052
2052
|
/**
|
|
2053
2053
|
* @description This deletes the user or team’s secret defined in the URL.
|
|
2054
2054
|
* @summary Delete a secret
|
|
2055
|
-
* {@link
|
|
2055
|
+
* {@link /v2/secrets/:idOrName}
|
|
2056
2056
|
*/
|
|
2057
|
-
export declare function deleteSecret({ pathParams: { idOrName }, queryParams, config
|
|
2057
|
+
export declare function deleteSecret({ pathParams: { idOrName }, queryParams, config }: {
|
|
2058
2058
|
pathParams: DeleteSecretPathParams;
|
|
2059
|
-
queryParams?: DeleteSecretQueryParams;
|
|
2059
|
+
queryParams?: DeleteSecretQueryParams | undefined;
|
|
2060
2060
|
config?: Partial<FetcherConfig> & {
|
|
2061
2061
|
client?: typeof client;
|
|
2062
2062
|
};
|
|
2063
2063
|
}): Promise<unknown>;
|
|
2064
2064
|
export declare const operationsByPath: {
|
|
2065
|
-
'GET
|
|
2066
|
-
'POST
|
|
2067
|
-
'DELETE
|
|
2068
|
-
'GET
|
|
2069
|
-
'GET
|
|
2070
|
-
'POST
|
|
2071
|
-
'GET
|
|
2072
|
-
'POST
|
|
2073
|
-
'GET
|
|
2074
|
-
'PATCH
|
|
2075
|
-
'DELETE
|
|
2076
|
-
'POST
|
|
2077
|
-
'GET
|
|
2078
|
-
'PUT
|
|
2079
|
-
'GET
|
|
2080
|
-
'POST
|
|
2081
|
-
'POST
|
|
2082
|
-
'GET
|
|
2083
|
-
'GET
|
|
2084
|
-
'PATCH
|
|
2085
|
-
'POST
|
|
2086
|
-
'DELETE
|
|
2087
|
-
'PATCH
|
|
2088
|
-
'PATCH
|
|
2089
|
-
'GET
|
|
2090
|
-
'PATCH
|
|
2091
|
-
'GET
|
|
2092
|
-
'POST
|
|
2093
|
-
'PATCH
|
|
2094
|
-
'POST
|
|
2095
|
-
'GET
|
|
2096
|
-
'GET
|
|
2097
|
-
'GET
|
|
2098
|
-
'POST
|
|
2099
|
-
'PATCH
|
|
2100
|
-
'DELETE
|
|
2101
|
-
'GET
|
|
2102
|
-
'GET
|
|
2103
|
-
'GET
|
|
2104
|
-
'GET
|
|
2105
|
-
'POST
|
|
2106
|
-
'PATCH
|
|
2107
|
-
'DELETE
|
|
2108
|
-
'GET
|
|
2109
|
-
'POST
|
|
2110
|
-
'GET
|
|
2111
|
-
'PUT
|
|
2112
|
-
'DELETE
|
|
2113
|
-
'GET
|
|
2114
|
-
'PATCH
|
|
2115
|
-
'GET
|
|
2116
|
-
'POST
|
|
2117
|
-
'DELETE
|
|
2118
|
-
'GET
|
|
2119
|
-
'GET
|
|
2120
|
-
'DELETE
|
|
2121
|
-
'GET
|
|
2122
|
-
'POST
|
|
2123
|
-
'GET
|
|
2124
|
-
'GET
|
|
2125
|
-
'GET
|
|
2126
|
-
'GET
|
|
2127
|
-
'GET
|
|
2128
|
-
'POST
|
|
2129
|
-
'GET
|
|
2130
|
-
'GET
|
|
2131
|
-
'DELETE
|
|
2132
|
-
'PUT
|
|
2133
|
-
'POST
|
|
2134
|
-
'POST
|
|
2135
|
-
'GET
|
|
2136
|
-
'POST
|
|
2137
|
-
'POST
|
|
2138
|
-
'PUT
|
|
2139
|
-
'PUT
|
|
2140
|
-
'GET
|
|
2141
|
-
'GET
|
|
2142
|
-
'DELETE
|
|
2143
|
-
'POST
|
|
2144
|
-
'GET
|
|
2145
|
-
'POST
|
|
2146
|
-
'DELETE
|
|
2147
|
-
'GET
|
|
2148
|
-
'POST
|
|
2149
|
-
'PATCH
|
|
2150
|
-
'DELETE
|
|
2151
|
-
'PUT
|
|
2152
|
-
'GET
|
|
2153
|
-
'POST
|
|
2154
|
-
'DELETE
|
|
2155
|
-
'GET
|
|
2156
|
-
'POST
|
|
2157
|
-
'GET
|
|
2158
|
-
'PATCH
|
|
2159
|
-
'DELETE
|
|
2160
|
-
'POST
|
|
2161
|
-
'GET
|
|
2162
|
-
'GET
|
|
2163
|
-
'PATCH
|
|
2164
|
-
'DELETE
|
|
2165
|
-
'GET
|
|
2166
|
-
'GET
|
|
2167
|
-
'PATCH
|
|
2168
|
-
'DELETE
|
|
2169
|
-
'POST
|
|
2170
|
-
'POST
|
|
2171
|
-
'POST
|
|
2172
|
-
'GET
|
|
2173
|
-
'POST
|
|
2174
|
-
'GET
|
|
2175
|
-
'DELETE
|
|
2176
|
-
'PATCH
|
|
2177
|
-
'GET
|
|
2178
|
-
'GET
|
|
2179
|
-
'DELETE
|
|
2180
|
-
'PATCH
|
|
2181
|
-
'GET
|
|
2182
|
-
'POST
|
|
2183
|
-
'POST
|
|
2184
|
-
'POST
|
|
2185
|
-
'PUT
|
|
2186
|
-
'PATCH
|
|
2187
|
-
'POST
|
|
2188
|
-
'GET
|
|
2189
|
-
'POST
|
|
2190
|
-
'POST
|
|
2191
|
-
'POST
|
|
2192
|
-
'PUT
|
|
2193
|
-
'PATCH
|
|
2194
|
-
'GET
|
|
2195
|
-
'GET
|
|
2196
|
-
'GET
|
|
2197
|
-
'POST
|
|
2198
|
-
'DELETE
|
|
2199
|
-
'GET
|
|
2200
|
-
'POST
|
|
2201
|
-
'POST
|
|
2202
|
-
'GET
|
|
2203
|
-
'POST
|
|
2204
|
-
'PATCH
|
|
2205
|
-
'DELETE
|
|
2206
|
-
'GET
|
|
2207
|
-
'PATCH
|
|
2208
|
-
'GET
|
|
2209
|
-
'POST
|
|
2210
|
-
'DELETE
|
|
2211
|
-
'DELETE
|
|
2212
|
-
'POST
|
|
2213
|
-
'GET
|
|
2214
|
-
'POST
|
|
2215
|
-
'GET
|
|
2216
|
-
'DELETE
|
|
2217
|
-
'GET
|
|
2218
|
-
'DELETE
|
|
2219
|
-
'POST
|
|
2220
|
-
'GET
|
|
2221
|
-
'GET
|
|
2222
|
-
'DELETE
|
|
2223
|
-
'GET
|
|
2224
|
-
'POST
|
|
2225
|
-
'GET
|
|
2226
|
-
'GET
|
|
2227
|
-
'DELETE
|
|
2228
|
-
'PATCH
|
|
2229
|
-
'GET certs': typeof listCerts;
|
|
2230
|
-
'GET
|
|
2231
|
-
'DELETE
|
|
2232
|
-
'POST
|
|
2233
|
-
'PUT
|
|
2234
|
-
'GET
|
|
2235
|
-
'GET
|
|
2236
|
-
'GET
|
|
2237
|
-
'DELETE
|
|
2238
|
-
'GET
|
|
2239
|
-
'POST
|
|
2240
|
-
'PATCH
|
|
2241
|
-
'GET
|
|
2242
|
-
'DELETE
|
|
2065
|
+
'GET /v1/access-groups/{idOrName}': typeof readAccessGroup;
|
|
2066
|
+
'POST /v1/access-groups/{idOrName}': typeof updateAccessGroup;
|
|
2067
|
+
'DELETE /v1/access-groups/{idOrName}': typeof deleteAccessGroup;
|
|
2068
|
+
'GET /v1/access-groups/{idOrName}/members': typeof listAccessGroupMembers;
|
|
2069
|
+
'GET /v1/access-groups': typeof listAccessGroups;
|
|
2070
|
+
'POST /v1/access-groups': typeof createAccessGroup;
|
|
2071
|
+
'GET /v1/access-groups/{idOrName}/projects': typeof listAccessGroupProjects;
|
|
2072
|
+
'POST /v1/access-groups/{accessGroupIdOrName}/projects': typeof createAccessGroupProject;
|
|
2073
|
+
'GET /v1/access-groups/{accessGroupIdOrName}/projects/{projectId}': typeof readAccessGroupProject;
|
|
2074
|
+
'PATCH /v1/access-groups/{accessGroupIdOrName}/projects/{projectId}': typeof updateAccessGroupProject;
|
|
2075
|
+
'DELETE /v1/access-groups/{accessGroupIdOrName}/projects/{projectId}': typeof deleteAccessGroupProject;
|
|
2076
|
+
'POST /v8/artifacts/events': typeof recordEvents;
|
|
2077
|
+
'GET /v8/artifacts/status': typeof status;
|
|
2078
|
+
'PUT /v8/artifacts/{hash}': typeof uploadArtifact;
|
|
2079
|
+
'GET /v8/artifacts/{hash}': typeof downloadArtifact;
|
|
2080
|
+
'POST /v8/artifacts': typeof artifactQuery;
|
|
2081
|
+
'POST /v1/deployments/{deploymentId}/checks': typeof createCheck;
|
|
2082
|
+
'GET /v1/deployments/{deploymentId}/checks': typeof getAllChecks;
|
|
2083
|
+
'GET /v1/deployments/{deploymentId}/checks/{checkId}': typeof getCheck;
|
|
2084
|
+
'PATCH /v1/deployments/{deploymentId}/checks/{checkId}': typeof updateCheck;
|
|
2085
|
+
'POST /v1/deployments/{deploymentId}/checks/{checkId}/rerequest': typeof rerequestCheck;
|
|
2086
|
+
'DELETE /data-cache/purge-all': typeof purgeAllDataCache;
|
|
2087
|
+
'PATCH /data-cache/billing-settings': typeof updateDataCacheBillingSettings;
|
|
2088
|
+
'PATCH /v1/data-cache/projects/{projectId}': typeof updateProjectDataCache;
|
|
2089
|
+
'GET /v3/deployments/{idOrUrl}/events': typeof getDeploymentEvents;
|
|
2090
|
+
'PATCH /v1/deployments/{deploymentId}/integrations/{integrationConfigurationId}/resources/{resourceId}/actions/{action}': typeof updateIntegrationDeploymentAction;
|
|
2091
|
+
'GET /v13/deployments/{idOrUrl}': typeof getDeployment;
|
|
2092
|
+
'POST /v13/deployments': typeof createDeployment;
|
|
2093
|
+
'PATCH /v12/deployments/{id}/cancel': typeof cancelDeployment;
|
|
2094
|
+
'POST /v5/domains/buy': typeof buyDomain;
|
|
2095
|
+
'GET /v4/domains/price': typeof checkDomainPrice;
|
|
2096
|
+
'GET /v4/domains/status': typeof checkDomainStatus;
|
|
2097
|
+
'GET /v4/domains/{domain}/records': typeof getRecords;
|
|
2098
|
+
'POST /v2/domains/{domain}/records': typeof createRecord;
|
|
2099
|
+
'PATCH /v1/domains/records/{recordId}': typeof updateRecord;
|
|
2100
|
+
'DELETE /v2/domains/{domain}/records/{recordId}': typeof removeRecord;
|
|
2101
|
+
'GET /v1/domains/{domain}/registry': typeof getDomainTransfer;
|
|
2102
|
+
'GET /v6/domains/{domain}/config': typeof getDomainConfig;
|
|
2103
|
+
'GET /v5/domains/{domain}': typeof getDomain;
|
|
2104
|
+
'GET /v5/domains': typeof getDomains;
|
|
2105
|
+
'POST /v7/domains': typeof createOrTransferDomain;
|
|
2106
|
+
'PATCH /v3/domains/{domain}': typeof patchDomain;
|
|
2107
|
+
'DELETE /v6/domains/{domain}': typeof deleteDomain;
|
|
2108
|
+
'GET /v1/edge-config': typeof getEdgeConfigs;
|
|
2109
|
+
'POST /v1/edge-config': typeof createEdgeConfig;
|
|
2110
|
+
'GET /v1/edge-config/{edgeConfigId}': typeof getEdgeConfig;
|
|
2111
|
+
'PUT /v1/edge-config/{edgeConfigId}': typeof updateEdgeConfig;
|
|
2112
|
+
'DELETE /v1/edge-config/{edgeConfigId}': typeof deleteEdgeConfig;
|
|
2113
|
+
'GET /v1/edge-config/{edgeConfigId}/items': typeof getEdgeConfigItems;
|
|
2114
|
+
'PATCH /v1/edge-config/{edgeConfigId}/items': typeof patchEdgeConfigItems;
|
|
2115
|
+
'GET /v1/edge-config/{edgeConfigId}/schema': typeof getEdgeConfigSchema;
|
|
2116
|
+
'POST /v1/edge-config/{edgeConfigId}/schema': typeof patchEdgeConfigSchema;
|
|
2117
|
+
'DELETE /v1/edge-config/{edgeConfigId}/schema': typeof deleteEdgeConfigSchema;
|
|
2118
|
+
'GET /v1/edge-config/{edgeConfigId}/item/{edgeConfigItemKey}': typeof getEdgeConfigItem;
|
|
2119
|
+
'GET /v1/edge-config/{edgeConfigId}/tokens': typeof getEdgeConfigTokens;
|
|
2120
|
+
'DELETE /v1/edge-config/{edgeConfigId}/tokens': typeof deleteEdgeConfigTokens;
|
|
2121
|
+
'GET /v1/edge-config/{edgeConfigId}/token/{token}': typeof getEdgeConfigToken;
|
|
2122
|
+
'POST /v1/edge-config/{edgeConfigId}/token': typeof createEdgeConfigToken;
|
|
2123
|
+
'GET /v1/edge-config/{edgeConfigId}/backups/{edgeConfigBackupVersionId}': typeof getEdgeConfigBackup;
|
|
2124
|
+
'GET /v1/edge-config/{edgeConfigId}/backups': typeof getEdgeConfigBackups;
|
|
2125
|
+
'GET /v3/events': typeof listUserEvents;
|
|
2126
|
+
'GET /v1/installations/{integrationConfigurationId}/account': typeof getAccountInfo;
|
|
2127
|
+
'GET /v1/installations/{integrationConfigurationId}/member/{memberId}': typeof getMember;
|
|
2128
|
+
'POST /v1/installations/{integrationConfigurationId}/events': typeof createEvent;
|
|
2129
|
+
'GET /v1/installations/{integrationConfigurationId}/resources': typeof getIntegrationResources;
|
|
2130
|
+
'GET /v1/installations/{integrationConfigurationId}/resources/{resourceId}': typeof getIntegrationResource;
|
|
2131
|
+
'DELETE /v1/installations/{integrationConfigurationId}/resources/{resourceId}': typeof deleteIntegrationResource;
|
|
2132
|
+
'PUT /v1/installations/{integrationConfigurationId}/resources/{resourceId}': typeof importResource;
|
|
2133
|
+
'POST /v1/installations/{integrationConfigurationId}/billing': typeof submitBillingData;
|
|
2134
|
+
'POST /v1/installations/{integrationConfigurationId}/billing/invoices': typeof submitInvoice;
|
|
2135
|
+
'GET /v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}': typeof getInvoice;
|
|
2136
|
+
'POST /v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}/actions': typeof updateInvoice;
|
|
2137
|
+
'POST /v1/installations/{integrationConfigurationId}/billing/balance': typeof submitPrepaymentBalances;
|
|
2138
|
+
'PUT /v1/installations/{integrationConfigurationId}/products/{integrationProductIdOrSlug}/resources/{resourceId}/secrets': typeof updateResourceSecrets;
|
|
2139
|
+
'PUT /v1/installations/{integrationConfigurationId}/resources/{resourceId}/secrets': typeof updateResourceSecretsById;
|
|
2140
|
+
'GET /v1/integrations/configurations': typeof getConfigurations;
|
|
2141
|
+
'GET /v1/integrations/configuration/{id}': typeof getConfiguration;
|
|
2142
|
+
'DELETE /v1/integrations/configuration/{id}': typeof deleteConfiguration;
|
|
2143
|
+
'POST /v1/integrations/sso/token': typeof exchangeSsoToken;
|
|
2144
|
+
'GET /v2/integrations/log-drains': typeof getIntegrationLogDrains;
|
|
2145
|
+
'POST /v2/integrations/log-drains': typeof createLogDrain;
|
|
2146
|
+
'DELETE /v1/integrations/log-drains/{id}': typeof deleteIntegrationLogDrain;
|
|
2147
|
+
'GET /v1/projects/{projectId}/deployments/{deploymentId}/runtime-logs': typeof getRuntimeLogs;
|
|
2148
|
+
'POST /v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items': typeof createExperimentationItem;
|
|
2149
|
+
'PATCH /v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items/{itemId}': typeof updateExperimentationItem;
|
|
2150
|
+
'DELETE /v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items/{itemId}': typeof deleteExperimentationItem;
|
|
2151
|
+
'PUT /v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/edge-config': typeof updateExperimentationEdgeConfig;
|
|
2152
|
+
'GET /v1/projects/{idOrName}/members': typeof getProjectMembers;
|
|
2153
|
+
'POST /v1/projects/{idOrName}/members': typeof addProjectMember;
|
|
2154
|
+
'DELETE /v1/projects/{idOrName}/members/{uid}': typeof removeProjectMember;
|
|
2155
|
+
'GET /v10/projects': typeof getProjects;
|
|
2156
|
+
'POST /v11/projects': typeof createProject;
|
|
2157
|
+
'GET /v9/projects/{idOrName}': typeof getProject;
|
|
2158
|
+
'PATCH /v9/projects/{idOrName}': typeof updateProject;
|
|
2159
|
+
'DELETE /v9/projects/{idOrName}': typeof deleteProject;
|
|
2160
|
+
'POST /v9/projects/{idOrName}/custom-environments': typeof createCustomEnvironment;
|
|
2161
|
+
'GET /v9/projects/{idOrName}/custom-environments': typeof listCustomEnvironments;
|
|
2162
|
+
'GET /v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}': typeof getCustomEnvironment;
|
|
2163
|
+
'PATCH /v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}': typeof updateCustomEnvironment;
|
|
2164
|
+
'DELETE /v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}': typeof removeCustomEnvironment;
|
|
2165
|
+
'GET /v9/projects/{idOrName}/domains': typeof getProjectDomains;
|
|
2166
|
+
'GET /v9/projects/{idOrName}/domains/{domain}': typeof getProjectDomain;
|
|
2167
|
+
'PATCH /v9/projects/{idOrName}/domains/{domain}': typeof updateProjectDomain;
|
|
2168
|
+
'DELETE /v9/projects/{idOrName}/domains/{domain}': typeof removeProjectDomain;
|
|
2169
|
+
'POST /v10/projects/{idOrName}/domains': typeof addProjectDomain;
|
|
2170
|
+
'POST /v1/projects/{idOrName}/domains/{domain}/move': typeof moveProjectDomain;
|
|
2171
|
+
'POST /v9/projects/{idOrName}/domains/{domain}/verify': typeof verifyProjectDomain;
|
|
2172
|
+
'GET /v10/projects/{idOrName}/env': typeof filterProjectEnvs;
|
|
2173
|
+
'POST /v10/projects/{idOrName}/env': typeof createProjectEnv;
|
|
2174
|
+
'GET /v1/projects/{idOrName}/env/{id}': typeof getProjectEnv;
|
|
2175
|
+
'DELETE /v9/projects/{idOrName}/env/{id}': typeof removeProjectEnv;
|
|
2176
|
+
'PATCH /v9/projects/{idOrName}/env/{id}': typeof editProjectEnv;
|
|
2177
|
+
'GET /v1/projects/{idOrName}/rolling-release/billing': typeof getRollingReleaseBillingStatus;
|
|
2178
|
+
'GET /v1/projects/{idOrName}/rolling-release/config': typeof getRollingReleaseConfig;
|
|
2179
|
+
'DELETE /v1/projects/{idOrName}/rolling-release/config': typeof deleteRollingReleaseConfig;
|
|
2180
|
+
'PATCH /v1/projects/{idOrName}/rolling-release/config': typeof updateRollingReleaseConfig;
|
|
2181
|
+
'GET /v1/projects/{idOrName}/rolling-release': typeof getRollingRelease;
|
|
2182
|
+
'POST /v1/projects/{idOrName}/rolling-release/approve-stage': typeof approveRollingReleaseStage;
|
|
2183
|
+
'POST /v1/projects/{idOrName}/rolling-release/complete': typeof completeRollingRelease;
|
|
2184
|
+
'POST /projects/{idOrName}/transfer-request': typeof createProjectTransferRequest;
|
|
2185
|
+
'PUT /projects/transfer-request/{code}': typeof acceptProjectTransferRequest;
|
|
2186
|
+
'PATCH /v1/projects/{idOrName}/protection-bypass': typeof updateProjectProtectionBypass;
|
|
2187
|
+
'POST /v10/projects/{projectId}/promote/{deploymentId}': typeof requestPromote;
|
|
2188
|
+
'GET /v1/projects/{projectId}/promote/aliases': typeof listPromoteAliases;
|
|
2189
|
+
'POST /v1/projects/{projectId}/pause': typeof pauseProject;
|
|
2190
|
+
'POST /v1/projects/{projectId}/unpause': typeof unpauseProject;
|
|
2191
|
+
'POST /v1/security/attack-mode': typeof updateAttackChallengeMode;
|
|
2192
|
+
'PUT /v1/security/firewall/config': typeof putFirewallConfig;
|
|
2193
|
+
'PATCH /v1/security/firewall/config': typeof updateFirewallConfig;
|
|
2194
|
+
'GET /v1/security/firewall/config/{configVersion}': typeof getFirewallConfig;
|
|
2195
|
+
'GET /v1/security/firewall/attack-status': typeof getActiveAttackStatus;
|
|
2196
|
+
'GET /v1/security/firewall/bypass': typeof getBypassIp;
|
|
2197
|
+
'POST /v1/security/firewall/bypass': typeof addBypassIp;
|
|
2198
|
+
'DELETE /v1/security/firewall/bypass': typeof removeBypassIp;
|
|
2199
|
+
'GET /v3/teams/{teamId}/members': typeof getTeamMembers;
|
|
2200
|
+
'POST /v1/teams/{teamId}/members': typeof inviteUserToTeam;
|
|
2201
|
+
'POST /v1/teams/{teamId}/request': typeof requestAccessToTeam;
|
|
2202
|
+
'GET /v1/teams/{teamId}/request/{userId}': typeof getTeamAccessRequest;
|
|
2203
|
+
'POST /v1/teams/{teamId}/members/teams/join': typeof joinTeam;
|
|
2204
|
+
'PATCH /v1/teams/{teamId}/members/{uid}': typeof updateTeamMember;
|
|
2205
|
+
'DELETE /v1/teams/{teamId}/members/{uid}': typeof removeTeamMember;
|
|
2206
|
+
'GET /v2/teams/{teamId}': typeof getTeam;
|
|
2207
|
+
'PATCH /v2/teams/{teamId}': typeof patchTeam;
|
|
2208
|
+
'GET /v2/teams': typeof getTeams;
|
|
2209
|
+
'POST /v1/teams': typeof createTeam;
|
|
2210
|
+
'DELETE /v1/teams/{teamId}': typeof deleteTeam;
|
|
2211
|
+
'DELETE /v1/teams/{teamId}/invites/{inviteId}': typeof deleteTeamInviteCode;
|
|
2212
|
+
'POST /v2/files': typeof uploadFile;
|
|
2213
|
+
'GET /v5/user/tokens': typeof listAuthTokens;
|
|
2214
|
+
'POST /v3/user/tokens': typeof createAuthToken;
|
|
2215
|
+
'GET /v5/user/tokens/{tokenId}': typeof getAuthToken;
|
|
2216
|
+
'DELETE /v3/user/tokens/{tokenId}': typeof deleteAuthToken;
|
|
2217
|
+
'GET /v2/user': typeof getAuthUser;
|
|
2218
|
+
'DELETE /v1/user': typeof requestDelete;
|
|
2219
|
+
'POST /v1/webhooks': typeof createWebhook;
|
|
2220
|
+
'GET /v1/webhooks': typeof getWebhooks;
|
|
2221
|
+
'GET /v1/webhooks/{id}': typeof getWebhook;
|
|
2222
|
+
'DELETE /v1/webhooks/{id}': typeof deleteWebhook;
|
|
2223
|
+
'GET /v2/deployments/{id}/aliases': typeof listDeploymentAliases;
|
|
2224
|
+
'POST /v2/deployments/{id}/aliases': typeof assignAlias;
|
|
2225
|
+
'GET /v4/aliases': typeof listAliases;
|
|
2226
|
+
'GET /v4/aliases/{idOrAlias}': typeof getAlias;
|
|
2227
|
+
'DELETE /v2/aliases/{aliasId}': typeof deleteAlias;
|
|
2228
|
+
'PATCH /aliases/{id}/protection-bypass': typeof patchUrlProtectionBypass;
|
|
2229
|
+
'GET /certs': typeof listCerts;
|
|
2230
|
+
'GET /v8/certs/{id}': typeof getCertById;
|
|
2231
|
+
'DELETE /v8/certs/{id}': typeof removeCert;
|
|
2232
|
+
'POST /v8/certs': typeof issueCert;
|
|
2233
|
+
'PUT /v8/certs': typeof uploadCert;
|
|
2234
|
+
'GET /v6/deployments/{id}/files': typeof listDeploymentFiles;
|
|
2235
|
+
'GET /v8/deployments/{id}/files/{fileId}': typeof getDeploymentFileContents;
|
|
2236
|
+
'GET /v6/deployments': typeof getDeployments;
|
|
2237
|
+
'DELETE /v13/deployments/{id}': typeof deleteDeployment;
|
|
2238
|
+
'GET /v3/secrets': typeof getSecrets;
|
|
2239
|
+
'POST /v2/secrets/{name}': typeof createSecret;
|
|
2240
|
+
'PATCH /v2/secrets/{name}': typeof renameSecret;
|
|
2241
|
+
'GET /v3/secrets/{idOrName}': typeof getSecret;
|
|
2242
|
+
'DELETE /v2/secrets/{idOrName}': typeof deleteSecret;
|
|
2243
2243
|
};
|
|
2244
2244
|
export declare const operationsByTag: {
|
|
2245
2245
|
accessGroups: {
|