@vercel/sdk 1.0.0-canary.10

package/src/sdk/projects.ts

@@ -0,0 +1,420 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { projectsAddProjectDomain } from "../funcs/projectsAddProjectDomain.js";
+import { projectsCreateProject } from "../funcs/projectsCreateProject.js";
+import { projectsCreateProjectEnv } from "../funcs/projectsCreateProjectEnv.js";
+import { projectsDeleteProject } from "../funcs/projectsDeleteProject.js";
+import { projectsEditProjectEnv } from "../funcs/projectsEditProjectEnv.js";
+import { projectsFilterProjectEnvs } from "../funcs/projectsFilterProjectEnvs.js";
+import { projectsGetProjectDomain } from "../funcs/projectsGetProjectDomain.js";
+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 { projectsRemoveProjectDomain } from "../funcs/projectsRemoveProjectDomain.js";
+import { projectsRemoveProjectEnv } from "../funcs/projectsRemoveProjectEnv.js";
+import { projectsRequestPromote } from "../funcs/projectsRequestPromote.js";
+import { projectsUpdateProject } from "../funcs/projectsUpdateProject.js";
+import { projectsUpdateProjectDataCache } from "../funcs/projectsUpdateProjectDataCache.js";
+import { projectsUpdateProjectDomain } from "../funcs/projectsUpdateProjectDomain.js";
+import { projectsUpdateProjectProtectionBypass } from "../funcs/projectsUpdateProjectProtectionBypass.js";
+import { projectsVerifyProjectDomain } from "../funcs/projectsVerifyProjectDomain.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import {
+  AddProjectDomainRequest,
+  AddProjectDomainResponseBody,
+} from "../models/operations/addprojectdomain.js";
+import {
+  CreateProjectRequest,
+  CreateProjectResponseBody,
+} from "../models/operations/createproject.js";
+import {
+  CreateProjectEnvRequest,
+  CreateProjectEnvResponseBody,
+} from "../models/operations/createprojectenv.js";
+import { DeleteProjectRequest } from "../models/operations/deleteproject.js";
+import {
+  EditProjectEnvRequest,
+  EditProjectEnvResponseBody,
+} from "../models/operations/editprojectenv.js";
+import {
+  FilterProjectEnvsRequest,
+  FilterProjectEnvsResponseBody,
+} from "../models/operations/filterprojectenvs.js";
+import {
+  GetProjectDomainRequest,
+  GetProjectDomainResponseBody,
+} from "../models/operations/getprojectdomain.js";
+import {
+  GetProjectDomainsRequest,
+  GetProjectDomainsResponseBody,
+} from "../models/operations/getprojectdomains.js";
+import {
+  GetProjectEnvRequest,
+  GetProjectEnvResponseBody,
+} from "../models/operations/getprojectenv.js";
+import {
+  GetProjectsRequest,
+  GetProjectsResponseBody,
+} from "../models/operations/getprojects.js";
+import {
+  ListPromoteAliasesRequest,
+  ListPromoteAliasesResponseBody,
+} from "../models/operations/listpromotealiases.js";
+import {
+  RemoveProjectDomainRequest,
+  RemoveProjectDomainResponseBody,
+} from "../models/operations/removeprojectdomain.js";
+import {
+  RemoveProjectEnvRequest,
+  RemoveProjectEnvResponseBody,
+} from "../models/operations/removeprojectenv.js";
+import { RequestPromoteRequest } from "../models/operations/requestpromote.js";
+import {
+  UpdateProjectRequest,
+  UpdateProjectResponseBody,
+} from "../models/operations/updateproject.js";
+import {
+  UpdateProjectDataCacheRequest,
+  UpdateProjectDataCacheResponseBody,
+} from "../models/operations/updateprojectdatacache.js";
+import {
+  UpdateProjectDomainRequest,
+  UpdateProjectDomainResponseBody,
+} from "../models/operations/updateprojectdomain.js";
+import {
+  UpdateProjectProtectionBypassRequest,
+  UpdateProjectProtectionBypassResponseBody,
+} from "../models/operations/updateprojectprotectionbypass.js";
+import {
+  VerifyProjectDomainRequest,
+  VerifyProjectDomainResponseBody,
+} from "../models/operations/verifyprojectdomain.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Projects extends ClientSDK {
+  /**
+   * Update the data cache feature
+   *
+   * @remarks
+   * Update the data cache feature on a project.
+   */
+  async updateProjectDataCache(
+    request: UpdateProjectDataCacheRequest,
+    options?: RequestOptions,
+  ): Promise<UpdateProjectDataCacheResponseBody> {
+    return unwrapAsync(projectsUpdateProjectDataCache(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a list of projects
+   *
+   * @remarks
+   * 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.
+   */
+  async getProjects(
+    request: GetProjectsRequest,
+    options?: RequestOptions,
+  ): Promise<GetProjectsResponseBody> {
+    return unwrapAsync(projectsGetProjects(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a new project
+   *
+   * @remarks
+   * 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.
+   */
+  async createProject(
+    request: CreateProjectRequest,
+    options?: RequestOptions,
+  ): Promise<CreateProjectResponseBody> {
+    return unwrapAsync(projectsCreateProject(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update an existing project
+   *
+   * @remarks
+   * Update the fields of a project using either its `name` or `id`.
+   */
+  async updateProject(
+    request: UpdateProjectRequest,
+    options?: RequestOptions,
+  ): Promise<UpdateProjectResponseBody> {
+    return unwrapAsync(projectsUpdateProject(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a Project
+   *
+   * @remarks
+   * Delete a specific project by passing either the project `id` or `name` in the URL.
+   */
+  async deleteProject(
+    request: DeleteProjectRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(projectsDeleteProject(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve project domains by project by id or name
+   *
+   * @remarks
+   * Retrieve the domains associated with a given project by passing either the project `id` or `name` in the URL.
+   */
+  async getProjectDomains(
+    request: GetProjectDomainsRequest,
+    options?: RequestOptions,
+  ): Promise<GetProjectDomainsResponseBody> {
+    return unwrapAsync(projectsGetProjectDomains(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a project domain
+   *
+   * @remarks
+   * Get project domain by project id/name and domain name.
+   */
+  async getProjectDomain(
+    request: GetProjectDomainRequest,
+    options?: RequestOptions,
+  ): Promise<GetProjectDomainResponseBody> {
+    return unwrapAsync(projectsGetProjectDomain(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a project domain
+   *
+   * @remarks
+   * Update a project domain's configuration, including the name, git branch and redirect of the domain.
+   */
+  async updateProjectDomain(
+    request: UpdateProjectDomainRequest,
+    options?: RequestOptions,
+  ): Promise<UpdateProjectDomainResponseBody> {
+    return unwrapAsync(projectsUpdateProjectDomain(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Remove a domain from a project
+   *
+   * @remarks
+   * 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.
+   */
+  async removeProjectDomain(
+    request: RemoveProjectDomainRequest,
+    options?: RequestOptions,
+  ): Promise<RemoveProjectDomainResponseBody> {
+    return unwrapAsync(projectsRemoveProjectDomain(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Add a domain to a project
+   *
+   * @remarks
+   * 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.
+   */
+  async addProjectDomain(
+    request: AddProjectDomainRequest,
+    options?: RequestOptions,
+  ): Promise<AddProjectDomainResponseBody> {
+    return unwrapAsync(projectsAddProjectDomain(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Verify project domain
+   *
+   * @remarks
+   * Attempts to verify a project domain with `verified = false` by checking the correctness of the project domain's `verification` challenge.
+   */
+  async verifyProjectDomain(
+    request: VerifyProjectDomainRequest,
+    options?: RequestOptions,
+  ): Promise<VerifyProjectDomainResponseBody> {
+    return unwrapAsync(projectsVerifyProjectDomain(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve the environment variables of a project by id or name
+   *
+   * @remarks
+   * Retrieve the environment variables for a given project by passing either the project `id` or `name` in the URL.
+   */
+  async filterProjectEnvs(
+    request: FilterProjectEnvsRequest,
+    options?: RequestOptions,
+  ): Promise<FilterProjectEnvsResponseBody> {
+    return unwrapAsync(projectsFilterProjectEnvs(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve the decrypted value of an environment variable of a project by id
+   *
+   * @remarks
+   * Retrieve the environment variable for a given project.
+   */
+  async getProjectEnv(
+    request: GetProjectEnvRequest,
+    options?: RequestOptions,
+  ): Promise<GetProjectEnvResponseBody> {
+    return unwrapAsync(projectsGetProjectEnv(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create one or more environment variables
+   *
+   * @remarks
+   * Create one ore 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.
+   */
+  async createProjectEnv(
+    request: CreateProjectEnvRequest,
+    options?: RequestOptions,
+  ): Promise<CreateProjectEnvResponseBody> {
+    return unwrapAsync(projectsCreateProjectEnv(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Remove an environment variable
+   *
+   * @remarks
+   * 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.
+   */
+  async removeProjectEnv(
+    request: RemoveProjectEnvRequest,
+    options?: RequestOptions,
+  ): Promise<RemoveProjectEnvResponseBody> {
+    return unwrapAsync(projectsRemoveProjectEnv(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Edit an environment variable
+   *
+   * @remarks
+   * 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.
+   */
+  async editProjectEnv(
+    request: EditProjectEnvRequest,
+    options?: RequestOptions,
+  ): Promise<EditProjectEnvResponseBody> {
+    return unwrapAsync(projectsEditProjectEnv(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update Protection Bypass for Automation
+   *
+   * @remarks
+   * Update the deployment protection automation bypass for a project
+   */
+  async updateProjectProtectionBypass(
+    request: UpdateProjectProtectionBypassRequest,
+    options?: RequestOptions,
+  ): Promise<UpdateProjectProtectionBypassResponseBody> {
+    return unwrapAsync(projectsUpdateProjectProtectionBypass(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Points all production domains for a project to the given deploy
+   *
+   * @remarks
+   * Allows users to promote a deployment to production. Note: This does NOT rebuild the deployment. If you need that, then call create-deployments endpoint.
+   */
+  async requestPromote(
+    request: RequestPromoteRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(projectsRequestPromote(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Gets a list of aliases with status for the current promote
+   *
+   * @remarks
+   * Get a list of aliases related to the last promote request with their mapping status
+   */
+  async listPromoteAliases(
+    request: ListPromoteAliasesRequest,
+    options?: RequestOptions,
+  ): Promise<ListPromoteAliasesResponseBody> {
+    return unwrapAsync(projectsListPromoteAliases(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -0,0 +1,121 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "../lib/sdks.js";
+import { AccessGroups } from "./accessgroups.js";
+import { Aliases } from "./aliases.js";
+import { Artifacts } from "./artifacts.js";
+import { Authentication } from "./authentication.js";
+import { Certs } from "./certs.js";
+import { Checks } from "./checks.js";
+import { Deployments } from "./deployments.js";
+import { Dns } from "./dns.js";
+import { Domains } from "./domains.js";
+import { EdgeConfig } from "./edgeconfig.js";
+import { Integrations } from "./integrations.js";
+import { LogDrains } from "./logdrains.js";
+import { Marketplace } from "./marketplace.js";
+import { ProjectMembers } from "./projectmembers.js";
+import { Projects } from "./projects.js";
+import { Security } from "./security.js";
+import { Teams } from "./teams.js";
+import { User } from "./user.js";
+import { Webhooks } from "./webhooks.js";
+
+export class Vercel extends ClientSDK {
+  private _accessGroups?: AccessGroups;
+  get accessGroups(): AccessGroups {
+    return (this._accessGroups ??= new AccessGroups(this._options));
+  }
+
+  private _artifacts?: Artifacts;
+  get artifacts(): Artifacts {
+    return (this._artifacts ??= new Artifacts(this._options));
+  }
+
+  private _checks?: Checks;
+  get checks(): Checks {
+    return (this._checks ??= new Checks(this._options));
+  }
+
+  private _projects?: Projects;
+  get projects(): Projects {
+    return (this._projects ??= new Projects(this._options));
+  }
+
+  private _deployments?: Deployments;
+  get deployments(): Deployments {
+    return (this._deployments ??= new Deployments(this._options));
+  }
+
+  private _domains?: Domains;
+  get domains(): Domains {
+    return (this._domains ??= new Domains(this._options));
+  }
+
+  private _dns?: Dns;
+  get dns(): Dns {
+    return (this._dns ??= new Dns(this._options));
+  }
+
+  private _edgeConfig?: EdgeConfig;
+  get edgeConfig(): EdgeConfig {
+    return (this._edgeConfig ??= new EdgeConfig(this._options));
+  }
+
+  private _user?: User;
+  get user(): User {
+    return (this._user ??= new User(this._options));
+  }
+
+  private _marketplace?: Marketplace;
+  get marketplace(): Marketplace {
+    return (this._marketplace ??= new Marketplace(this._options));
+  }
+
+  private _integrations?: Integrations;
+  get integrations(): Integrations {
+    return (this._integrations ??= new Integrations(this._options));
+  }
+
+  private _authentication?: Authentication;
+  get authentication(): Authentication {
+    return (this._authentication ??= new Authentication(this._options));
+  }
+
+  private _logDrains?: LogDrains;
+  get logDrains(): LogDrains {
+    return (this._logDrains ??= new LogDrains(this._options));
+  }
+
+  private _projectMembers?: ProjectMembers;
+  get projectMembers(): ProjectMembers {
+    return (this._projectMembers ??= new ProjectMembers(this._options));
+  }
+
+  private _security?: Security;
+  get security(): Security {
+    return (this._security ??= new Security(this._options));
+  }
+
+  private _teams?: Teams;
+  get teams(): Teams {
+    return (this._teams ??= new Teams(this._options));
+  }
+
+  private _webhooks?: Webhooks;
+  get webhooks(): Webhooks {
+    return (this._webhooks ??= new Webhooks(this._options));
+  }
+
+  private _aliases?: Aliases;
+  get aliases(): Aliases {
+    return (this._aliases ??= new Aliases(this._options));
+  }
+
+  private _certs?: Certs;
+  get certs(): Certs {
+    return (this._certs ??= new Certs(this._options));
+  }
+}

package/src/sdk/security.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { securityGetFirewallConfig } from "../funcs/securityGetFirewallConfig.js";
+import { securityPutFirewallConfig } from "../funcs/securityPutFirewallConfig.js";
+import { securityUpdateAttackChallengeMode } from "../funcs/securityUpdateAttackChallengeMode.js";
+import { securityUpdateFirewallConfig } from "../funcs/securityUpdateFirewallConfig.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import {
+  GetFirewallConfigRequest,
+  GetFirewallConfigResponseBody,
+} from "../models/operations/getfirewallconfig.js";
+import {
+  PutFirewallConfigRequest,
+  PutFirewallConfigResponseBody,
+} from "../models/operations/putfirewallconfig.js";
+import {
+  UpdateAttackChallengeModeRequest,
+  UpdateAttackChallengeModeResponseBody,
+} from "../models/operations/updateattackchallengemode.js";
+import {
+  UpdateFirewallConfigRequest,
+  UpdateFirewallConfigResponseBody,
+} from "../models/operations/updatefirewallconfig.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Security extends ClientSDK {
+  /**
+   * Update Attack Challenge mode
+   *
+   * @remarks
+   * Update the setting for determining if the project has Attack Challenge mode enabled.
+   */
+  async updateAttackChallengeMode(
+    request: UpdateAttackChallengeModeRequest,
+    options?: RequestOptions,
+  ): Promise<UpdateAttackChallengeModeResponseBody> {
+    return unwrapAsync(securityUpdateAttackChallengeMode(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Put Firewall Configuration
+   *
+   * @remarks
+   * Set the firewall configuration to provided rules and settings. Creates or overwrite the existing firewall configuration.
+   */
+  async putFirewallConfig(
+    request: PutFirewallConfigRequest,
+    options?: RequestOptions,
+  ): Promise<PutFirewallConfigResponseBody> {
+    return unwrapAsync(securityPutFirewallConfig(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update Firewall Configuration
+   *
+   * @remarks
+   * Process updates to modify the existing firewall config for a project
+   */
+  async updateFirewallConfig(
+    request: UpdateFirewallConfigRequest,
+    options?: RequestOptions,
+  ): Promise<UpdateFirewallConfigResponseBody> {
+    return unwrapAsync(securityUpdateFirewallConfig(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Read Firewall Configuration
+   *
+   * @remarks
+   * Retrieve the specified firewall configuration for a project. The deployed configVersion will be `active`
+   */
+  async getFirewallConfig(
+    request: GetFirewallConfigRequest,
+    options?: RequestOptions,
+  ): Promise<GetFirewallConfigResponseBody> {
+    return unwrapAsync(securityGetFirewallConfig(
+      this,
+      request,
+      options,
+    ));
+  }
+}