vercel-api-js 0.1.20 → 0.1.22
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/.turbo/turbo-build.log +3 -3
- package/CHANGELOG.md +16 -0
- package/dist/index.cjs +40 -17
- package/dist/index.d.ts +1058 -966
- package/dist/index.mjs +40 -17
- package/package.json +1 -1
package/dist/index.mjs
CHANGED
|
@@ -184,7 +184,7 @@ const updateProjectDataCache = (variables, signal) => fetch$1({ url: '/v1/data-c
|
|
|
184
184
|
*/
|
|
185
185
|
const getDeploymentEvents = (variables, signal) => fetch$1({ url: '/v2/deployments/{idOrUrl}/events', method: 'get', ...variables, signal });
|
|
186
186
|
/**
|
|
187
|
-
* 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 is an owner of the deployment.
|
|
187
|
+
* 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.
|
|
188
188
|
*/
|
|
189
189
|
const getDeployment = (variables, signal) => fetch$1({ url: '/v13/deployments/{idOrUrl}', method: 'get', ...variables, signal });
|
|
190
190
|
/**
|
|
@@ -243,6 +243,15 @@ const checkDomainStatus = (variables, signal) => fetch$1({
|
|
|
243
243
|
...variables,
|
|
244
244
|
signal
|
|
245
245
|
});
|
|
246
|
+
/**
|
|
247
|
+
* Fetch domain transfer availability or transfer status if a transfer is in progress.
|
|
248
|
+
*/
|
|
249
|
+
const getDomainTransfer = (variables, signal) => fetch$1({
|
|
250
|
+
url: '/v1/domains/{domain}/registry',
|
|
251
|
+
method: 'get',
|
|
252
|
+
...variables,
|
|
253
|
+
signal
|
|
254
|
+
});
|
|
246
255
|
/**
|
|
247
256
|
* Get a Domain's configuration.
|
|
248
257
|
*/
|
|
@@ -257,7 +266,7 @@ const getDomain = (variables, signal) => fetch$1({
|
|
|
257
266
|
signal
|
|
258
267
|
});
|
|
259
268
|
/**
|
|
260
|
-
* Retrieves a list of domains registered for the
|
|
269
|
+
* 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.
|
|
261
270
|
*/
|
|
262
271
|
const getDomains = (variables, signal) => fetch$1({
|
|
263
272
|
url: '/v5/domains',
|
|
@@ -266,9 +275,13 @@ const getDomains = (variables, signal) => fetch$1({
|
|
|
266
275
|
signal
|
|
267
276
|
});
|
|
268
277
|
/**
|
|
269
|
-
* This endpoint is used for
|
|
278
|
+
* 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.
|
|
270
279
|
*/
|
|
271
280
|
const createOrTransferDomain = (variables, signal) => fetch$1({ url: '/v5/domains', method: 'post', ...variables, signal });
|
|
281
|
+
/**
|
|
282
|
+
* Update or move apex domain.
|
|
283
|
+
*/
|
|
284
|
+
const patchDomain = (variables, signal) => fetch$1({ url: '/v3/domains/{domain}', method: 'patch', ...variables, signal });
|
|
272
285
|
/**
|
|
273
286
|
* Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases.
|
|
274
287
|
*/
|
|
@@ -363,7 +376,7 @@ const getConfiguration = (variables, signal) => fetch$1({ url: '/v1/integrations
|
|
|
363
376
|
*/
|
|
364
377
|
const deleteConfiguration = (variables, signal) => fetch$1({ url: '/v1/integrations/configuration/{id}', method: 'delete', ...variables, signal });
|
|
365
378
|
/**
|
|
366
|
-
* Retrieves a list of all Integration log drains that are defined for the
|
|
379
|
+
* 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.
|
|
367
380
|
*/
|
|
368
381
|
const getIntegrationLogDrains = (variables, signal) => fetch$1({ url: '/v2/integrations/log-drains', method: 'get', ...variables, signal });
|
|
369
382
|
/**
|
|
@@ -414,7 +427,19 @@ const getConfigurableLogDrains = (variables, signal) => fetch$1({ url: '/v1/log-
|
|
|
414
427
|
*/
|
|
415
428
|
const createConfigurableLogDrain = (variables, signal) => fetch$1({ url: '/v1/log-drains', method: 'post', ...variables, signal });
|
|
416
429
|
/**
|
|
417
|
-
*
|
|
430
|
+
* Lists all members of a project.
|
|
431
|
+
*/
|
|
432
|
+
const getProjectMembers = (variables, signal) => fetch$1({ url: '/v1/projects/{idOrName}/members', method: 'get', ...variables, signal });
|
|
433
|
+
/**
|
|
434
|
+
* Adds a new member to the project.
|
|
435
|
+
*/
|
|
436
|
+
const addProjectMember = (variables, signal) => fetch$1({ url: '/v1/projects/{idOrName}/members', method: 'post', ...variables, signal });
|
|
437
|
+
/**
|
|
438
|
+
* Remove a member from a specific project
|
|
439
|
+
*/
|
|
440
|
+
const removeProjectMember = (variables, signal) => fetch$1({ url: '/v1/projects/{idOrName}/members/{uid}', method: 'delete', ...variables, signal });
|
|
441
|
+
/**
|
|
442
|
+
* 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.
|
|
418
443
|
*/
|
|
419
444
|
const getProjects = (variables, signal) => fetch$1({
|
|
420
445
|
url: '/v9/projects',
|
|
@@ -549,12 +574,7 @@ const updateTeamMember = (variables, signal) => fetch$1({ url: '/v1/teams/{teamI
|
|
|
549
574
|
/**
|
|
550
575
|
* Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team.
|
|
551
576
|
*/
|
|
552
|
-
const removeTeamMember = (variables, signal) => fetch$1({
|
|
553
|
-
url: '/v1/teams/{teamId}/members/{uid}',
|
|
554
|
-
method: 'delete',
|
|
555
|
-
...variables,
|
|
556
|
-
signal
|
|
557
|
-
});
|
|
577
|
+
const removeTeamMember = (variables, signal) => fetch$1({ url: '/v1/teams/{teamId}/members/{uid}', method: 'delete', ...variables, signal });
|
|
558
578
|
/**
|
|
559
579
|
* Get information for the Team specified by the `teamId` parameter.
|
|
560
580
|
*/
|
|
@@ -721,11 +741,11 @@ const deleteAlias = (variables, signal) => fetch$1({
|
|
|
721
741
|
signal
|
|
722
742
|
});
|
|
723
743
|
/**
|
|
724
|
-
* Retrieves all Aliases for the Deployment with the given ID. The authenticated
|
|
744
|
+
* Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment.
|
|
725
745
|
*/
|
|
726
746
|
const listDeploymentAliases = (variables, signal) => fetch$1({ url: '/v2/deployments/{id}/aliases', method: 'get', ...variables, signal });
|
|
727
747
|
/**
|
|
728
|
-
* Creates a new alias for the deployment with the given deployment ID. The authenticated user 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.
|
|
748
|
+
* 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.
|
|
729
749
|
*/
|
|
730
750
|
const assignAlias = (variables, signal) => fetch$1({ url: '/v2/deployments/{id}/aliases', method: 'post', ...variables, signal });
|
|
731
751
|
/**
|
|
@@ -773,7 +793,7 @@ const listDeploymentFiles = (variables, signal) => fetch$1({ url: '/v6/deploymen
|
|
|
773
793
|
*/
|
|
774
794
|
const getDeploymentFileContents = (variables, signal) => fetch$1({ url: '/v6/deployments/{id}/files/{fileId}', method: 'get', ...variables, signal });
|
|
775
795
|
/**
|
|
776
|
-
* List deployments under the
|
|
796
|
+
* 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`.
|
|
777
797
|
*/
|
|
778
798
|
const getDeployments = (variables, signal) => fetch$1({
|
|
779
799
|
url: '/v6/deployments',
|
|
@@ -804,7 +824,7 @@ const emailLogin = (variables, signal) => fetch$1({
|
|
|
804
824
|
*/
|
|
805
825
|
const deleteDeployment = (variables, signal) => fetch$1({ url: '/v13/deployments/{id}', method: 'delete', ...variables, signal });
|
|
806
826
|
/**
|
|
807
|
-
* Retrieves the active Vercel secrets for the authenticated user. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret.
|
|
827
|
+
* 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.
|
|
808
828
|
*/
|
|
809
829
|
const getSecrets = (variables, signal) => fetch$1({
|
|
810
830
|
url: '/v3/secrets',
|
|
@@ -822,7 +842,7 @@ const createSecret = (variables, signal) => fetch$1({
|
|
|
822
842
|
signal
|
|
823
843
|
});
|
|
824
844
|
/**
|
|
825
|
-
* Enables to edit the name of a
|
|
845
|
+
* Enables to edit the name of a secret. The name has to be unique to the user or team’s secrets.
|
|
826
846
|
*/
|
|
827
847
|
const renameSecret = (variables, signal) => fetch$1({ url: '/v2/secrets/{name}', method: 'patch', ...variables, signal });
|
|
828
848
|
/**
|
|
@@ -835,7 +855,7 @@ const getSecret = (variables, signal) => fetch$1({
|
|
|
835
855
|
signal
|
|
836
856
|
});
|
|
837
857
|
/**
|
|
838
|
-
* This deletes the user
|
|
858
|
+
* This deletes the user or team’s secret defined in the URL.
|
|
839
859
|
*/
|
|
840
860
|
const deleteSecret = (variables, signal) => fetch$1({
|
|
841
861
|
url: '/v2/secrets/{idOrName}',
|
|
@@ -880,10 +900,12 @@ const operationsByTag = {
|
|
|
880
900
|
buyDomain,
|
|
881
901
|
checkDomainPrice,
|
|
882
902
|
checkDomainStatus,
|
|
903
|
+
getDomainTransfer,
|
|
883
904
|
getDomainConfig,
|
|
884
905
|
getDomain,
|
|
885
906
|
getDomains,
|
|
886
907
|
createOrTransferDomain,
|
|
908
|
+
patchDomain,
|
|
887
909
|
deleteDomain
|
|
888
910
|
},
|
|
889
911
|
dns: { getRecords, createRecord, updateRecord, removeRecord },
|
|
@@ -912,6 +934,7 @@ const operationsByTag = {
|
|
|
912
934
|
getConfigurableLogDrains,
|
|
913
935
|
createConfigurableLogDrain
|
|
914
936
|
},
|
|
937
|
+
projectMembers: { getProjectMembers, addProjectMember, removeProjectMember },
|
|
915
938
|
teams: {
|
|
916
939
|
getTeamMembers,
|
|
917
940
|
inviteUserToTeam,
|