vercel-api-js 0.1.21 → 0.1.23

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/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
  /**
@@ -266,7 +266,7 @@ const getDomain = (variables, signal) => fetch$1({
266
266
  signal
267
267
  });
268
268
  /**
269
- * Retrieves a list of domains registered for the authenticating user. By default it returns the last 20 domains if no limit is provided.
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.
270
270
  */
271
271
  const getDomains = (variables, signal) => fetch$1({
272
272
  url: '/v5/domains',
@@ -376,7 +376,7 @@ const getConfiguration = (variables, signal) => fetch$1({ url: '/v1/integrations
376
376
  */
377
377
  const deleteConfiguration = (variables, signal) => fetch$1({ url: '/v1/integrations/configuration/{id}', method: 'delete', ...variables, signal });
378
378
  /**
379
- * Retrieves a list of all Integration log drains that are defined for the authorized account. When using an OAuth2 token, the list is limited to log drains created by the authenticated integration.
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.
380
380
  */
381
381
  const getIntegrationLogDrains = (variables, signal) => fetch$1({ url: '/v2/integrations/log-drains', method: 'get', ...variables, signal });
382
382
  /**
@@ -427,7 +427,19 @@ const getConfigurableLogDrains = (variables, signal) => fetch$1({ url: '/v1/log-
427
427
  */
428
428
  const createConfigurableLogDrain = (variables, signal) => fetch$1({ url: '/v1/log-drains', method: 'post', ...variables, signal });
429
429
  /**
430
- * Allows to retrieve the list of projects of the authenticated user. The list will be paginated and the provided query parameters allow filtering the returned projects.
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.
431
443
  */
432
444
  const getProjects = (variables, signal) => fetch$1({
433
445
  url: '/v9/projects',
@@ -515,6 +527,24 @@ const removeProjectEnv = (variables, signal) => fetch$1({ url: '/v9/projects/{id
515
527
  * 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.
516
528
  */
517
529
  const editProjectEnv = (variables, signal) => fetch$1({ url: '/v9/projects/{idOrName}/env/{id}', method: 'patch', ...variables, signal });
530
+ /**
531
+ * 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.
532
+ */
533
+ const pauseProject = (variables, signal) => fetch$1({
534
+ url: '/v1/projects/{projectId}/pause',
535
+ method: 'post',
536
+ ...variables,
537
+ signal
538
+ });
539
+ /**
540
+ * 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.
541
+ */
542
+ const unpauseProject = (variables, signal) => fetch$1({
543
+ url: '/v1/projects/{projectId}/unpause',
544
+ method: 'post',
545
+ ...variables,
546
+ signal
547
+ });
518
548
  /**
519
549
  * Get a paginated list of team members for the provided team.
520
550
  */
@@ -562,12 +592,7 @@ const updateTeamMember = (variables, signal) => fetch$1({ url: '/v1/teams/{teamI
562
592
  /**
563
593
  * Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team.
564
594
  */
565
- const removeTeamMember = (variables, signal) => fetch$1({
566
- url: '/v1/teams/{teamId}/members/{uid}',
567
- method: 'delete',
568
- ...variables,
569
- signal
570
- });
595
+ const removeTeamMember = (variables, signal) => fetch$1({ url: '/v1/teams/{teamId}/members/{uid}', method: 'delete', ...variables, signal });
571
596
  /**
572
597
  * Get information for the Team specified by the `teamId` parameter.
573
598
  */
@@ -734,11 +759,11 @@ const deleteAlias = (variables, signal) => fetch$1({
734
759
  signal
735
760
  });
736
761
  /**
737
- * Retrieves all Aliases for the Deployment with the given ID. The authenticated User must own the deployment.
762
+ * Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment.
738
763
  */
739
764
  const listDeploymentAliases = (variables, signal) => fetch$1({ url: '/v2/deployments/{id}/aliases', method: 'get', ...variables, signal });
740
765
  /**
741
- * 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.
766
+ * 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.
742
767
  */
743
768
  const assignAlias = (variables, signal) => fetch$1({ url: '/v2/deployments/{id}/aliases', method: 'post', ...variables, signal });
744
769
  /**
@@ -786,7 +811,7 @@ const listDeploymentFiles = (variables, signal) => fetch$1({ url: '/v6/deploymen
786
811
  */
787
812
  const getDeploymentFileContents = (variables, signal) => fetch$1({ url: '/v6/deployments/{id}/files/{fileId}', method: 'get', ...variables, signal });
788
813
  /**
789
- * List deployments under the account corresponding to the API token. If a deployment hasn't finished uploading (is incomplete), the `url` property will have a value of `null`.
814
+ * 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`.
790
815
  */
791
816
  const getDeployments = (variables, signal) => fetch$1({
792
817
  url: '/v6/deployments',
@@ -817,7 +842,7 @@ const emailLogin = (variables, signal) => fetch$1({
817
842
  */
818
843
  const deleteDeployment = (variables, signal) => fetch$1({ url: '/v13/deployments/{id}', method: 'delete', ...variables, signal });
819
844
  /**
820
- * 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.
845
+ * 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.
821
846
  */
822
847
  const getSecrets = (variables, signal) => fetch$1({
823
848
  url: '/v3/secrets',
@@ -835,7 +860,7 @@ const createSecret = (variables, signal) => fetch$1({
835
860
  signal
836
861
  });
837
862
  /**
838
- * Enables to edit the name of a user's secret. The name has to be unique to that user's secrets.
863
+ * Enables to edit the name of a secret. The name has to be unique to the user or team’s secrets.
839
864
  */
840
865
  const renameSecret = (variables, signal) => fetch$1({ url: '/v2/secrets/{name}', method: 'patch', ...variables, signal });
841
866
  /**
@@ -848,7 +873,7 @@ const getSecret = (variables, signal) => fetch$1({
848
873
  signal
849
874
  });
850
875
  /**
851
- * This deletes the user's secret defined in the URL.
876
+ * This deletes the user or team’s secret defined in the URL.
852
877
  */
853
878
  const deleteSecret = (variables, signal) => fetch$1({
854
879
  url: '/v2/secrets/{idOrName}',
@@ -876,7 +901,9 @@ const operationsByTag = {
876
901
  getProjectEnv,
877
902
  createProjectEnv,
878
903
  removeProjectEnv,
879
- editProjectEnv
904
+ editProjectEnv,
905
+ pauseProject,
906
+ unpauseProject
880
907
  },
881
908
  deployments: {
882
909
  getDeploymentEvents,
@@ -927,6 +954,7 @@ const operationsByTag = {
927
954
  getConfigurableLogDrains,
928
955
  createConfigurableLogDrain
929
956
  },
957
+ projectMembers: { getProjectMembers, addProjectMember, removeProjectMember },
930
958
  teams: {
931
959
  getTeamMembers,
932
960
  inviteUserToTeam,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vercel-api-js",
3
- "version": "0.1.21",
3
+ "version": "0.1.23",
4
4
  "description": "Vercel API client for Node.js",
5
5
  "author": "SferaDev",
6
6
  "license": "ISC",