@vercel/sdk 1.6.1 → 1.6.2

package/src/models/unpauseprojectop.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+
+export type UnpauseProjectRequest = {
+  /**
+   * The unique project identifier
+   */
+  projectId: string;
+  /**
+   * The Team identifier to perform the request on behalf of.
+   */
+  teamId?: string | undefined;
+  /**
+   * The Team slug to perform the request on behalf of.
+   */
+  slug?: string | undefined;
+};
+
+/** @internal */
+export const UnpauseProjectRequest$inboundSchema: z.ZodType<
+  UnpauseProjectRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  projectId: z.string(),
+  teamId: z.string().optional(),
+  slug: z.string().optional(),
+});
+
+/** @internal */
+export type UnpauseProjectRequest$Outbound = {
+  projectId: string;
+  teamId?: string | undefined;
+  slug?: string | undefined;
+};
+
+/** @internal */
+export const UnpauseProjectRequest$outboundSchema: z.ZodType<
+  UnpauseProjectRequest$Outbound,
+  z.ZodTypeDef,
+  UnpauseProjectRequest
+> = z.object({
+  projectId: z.string(),
+  teamId: z.string().optional(),
+  slug: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UnpauseProjectRequest$ {
+  /** @deprecated use `UnpauseProjectRequest$inboundSchema` instead. */
+  export const inboundSchema = UnpauseProjectRequest$inboundSchema;
+  /** @deprecated use `UnpauseProjectRequest$outboundSchema` instead. */
+  export const outboundSchema = UnpauseProjectRequest$outboundSchema;
+  /** @deprecated use `UnpauseProjectRequest$Outbound` instead. */
+  export type Outbound = UnpauseProjectRequest$Outbound;
+}
+
+export function unpauseProjectRequestToJSON(
+  unpauseProjectRequest: UnpauseProjectRequest,
+): string {
+  return JSON.stringify(
+    UnpauseProjectRequest$outboundSchema.parse(unpauseProjectRequest),
+  );
+}
+
+export function unpauseProjectRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UnpauseProjectRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UnpauseProjectRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UnpauseProjectRequest' from JSON`,
+  );
+}

package/src/sdk/projects.ts

@@ -15,9 +15,11 @@ import { projectsGetProjectDomains } from "../funcs/projectsGetProjectDomains.js
 import { projectsGetProjectEnv } from "../funcs/projectsGetProjectEnv.js";
 import { projectsGetProjects } from "../funcs/projectsGetProjects.js";
 import { projectsListPromoteAliases } from "../funcs/projectsListPromoteAliases.js";
+import { projectsPauseProject } from "../funcs/projectsPauseProject.js";
 import { projectsRemoveProjectDomain } from "../funcs/projectsRemoveProjectDomain.js";
 import { projectsRemoveProjectEnv } from "../funcs/projectsRemoveProjectEnv.js";
 import { projectsRequestPromote } from "../funcs/projectsRequestPromote.js";
+import { projectsUnpauseProject } from "../funcs/projectsUnpauseProject.js";
 import { projectsUpdateProject } from "../funcs/projectsUpdateProject.js";
 import { projectsUpdateProjectDataCache } from "../funcs/projectsUpdateProjectDataCache.js";
 import { projectsUpdateProjectDomain } from "../funcs/projectsUpdateProjectDomain.js";
@@ -73,6 +75,7 @@ import {
   ListPromoteAliasesRequest,
   ListPromoteAliasesResponseBody,
 } from "../models/listpromotealiasesop.js";
+import { PauseProjectRequest } from "../models/pauseprojectop.js";
 import {
   RemoveProjectDomainRequest,
   RemoveProjectDomainResponseBody,
@@ -82,6 +85,7 @@ import {
   RemoveProjectEnvResponseBody,
 } from "../models/removeprojectenvop.js";
 import { RequestPromoteRequest } from "../models/requestpromoteop.js";
+import { UnpauseProjectRequest } from "../models/unpauseprojectop.js";
 import {
   UpdateProjectDataCacheRequest,
   UpdateProjectDataCacheResponseBody,
@@ -461,4 +465,38 @@ export class Projects extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Pause a project
+   *
+   * @remarks
+   * 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.
+   */
+  async pauseProject(
+    request: PauseProjectRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(projectsPauseProject(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Unpause a project
+   *
+   * @remarks
+   * 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.
+   */
+  async unpauseProject(
+    request: UnpauseProjectRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(projectsUnpauseProject(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/vercel-spec.json

@@ -49859,6 +49859,161 @@
         ]
       }
     },
+    "/v1/projects/{projectId}/pause": {
+      "post": {
+        "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.",
+        "operationId": "pauseProject",
+        "security": [
+          {
+            "bearerToken": []
+          }
+        ],
+        "summary": "Pause a project",
+        "tags": [
+          "projects"
+        ],
+        "responses": {
+          "200": {
+            "description": ""
+          },
+          "400": {
+            "description": "One of the provided values in the request query is invalid.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VercelBadRequestError"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VercelForbiddenError"
+                }
+              }
+            }
+          },
+          "402": {
+            "description": "The account was soft-blocked for an unhandled reason.\nThe account is missing a payment so payment method must be updated"
+          },
+          "403": {
+            "description": "You do not have permission to access this resource."
+          },
+          "500": {
+            "description": ""
+          }
+        },
+        "parameters": [
+          {
+            "name": "projectId",
+            "description": "The unique project identifier",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "description": "The unique project identifier"
+            }
+          },
+          {
+            "description": "The Team identifier to perform the request on behalf of.",
+            "in": "query",
+            "name": "teamId",
+            "schema": {
+              "type": "string",
+              "example": "team_1a2b3c4d5e6f7g8h9i0j1k2l"
+            }
+          },
+          {
+            "description": "The Team slug to perform the request on behalf of.",
+            "in": "query",
+            "name": "slug",
+            "schema": {
+              "type": "string",
+              "example": "my-team-url-slug"
+            }
+          }
+        ]
+      }
+    },
+    "/v1/projects/{projectId}/unpause": {
+      "post": {
+        "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.",
+        "operationId": "unpauseProject",
+        "security": [
+          {
+            "bearerToken": []
+          }
+        ],
+        "summary": "Unpause a project",
+        "tags": [
+          "projects"
+        ],
+        "responses": {
+          "200": {
+            "description": ""
+          },
+          "400": {
+            "description": "One of the provided values in the request query is invalid.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VercelBadRequestError"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VercelForbiddenError"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "You do not have permission to access this resource."
+          },
+          "500": {
+            "description": ""
+          }
+        },
+        "parameters": [
+          {
+            "name": "projectId",
+            "description": "The unique project identifier",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "description": "The unique project identifier"
+            }
+          },
+          {
+            "description": "The Team identifier to perform the request on behalf of.",
+            "in": "query",
+            "name": "teamId",
+            "schema": {
+              "type": "string",
+              "example": "team_1a2b3c4d5e6f7g8h9i0j1k2l"
+            }
+          },
+          {
+            "description": "The Team slug to perform the request on behalf of.",
+            "in": "query",
+            "name": "slug",
+            "schema": {
+              "type": "string",
+              "example": "my-team-url-slug"
+            }
+          }
+        ]
+      }
+    },
     "/v1/security/attack-mode": {
       "post": {
         "description": "Update the setting for determining if the project has Attack Challenge mode enabled.",