@vercel/sdk/src/sdk/environment.ts

<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>

/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import { environmentCreateCustomEnvironment } from "../funcs/environmentCreateCustomEnvironment.js";
import { environmentCreateSharedEnvVariable } from "../funcs/environmentCreateSharedEnvVariable.js";
import { environmentDeleteSharedEnvVariable } from "../funcs/environmentDeleteSharedEnvVariable.js";
import { environmentGetCustomEnvironment } from "../funcs/environmentGetCustomEnvironment.js";
import { environmentGetProjectsByIdOrNameCustomEnvironments } from "../funcs/environmentGetProjectsByIdOrNameCustomEnvironments.js";
import { environmentGetSharedEnvVar } from "../funcs/environmentGetSharedEnvVar.js";
import { environmentListSharedEnvVariable } from "../funcs/environmentListSharedEnvVariable.js";
import { environmentRemoveCustomEnvironment } from "../funcs/environmentRemoveCustomEnvironment.js";
import { environmentUnlinkSharedEnvVariable } from "../funcs/environmentUnlinkSharedEnvVariable.js";
import { environmentUpdateCustomEnvironment } from "../funcs/environmentUpdateCustomEnvironment.js";
import { environmentUpdateSharedEnvVariable } from "../funcs/environmentUpdateSharedEnvVariable.js";
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import {
  CreateCustomEnvironmentRequest,
  CreateCustomEnvironmentResponseBody,
} from "../models/createcustomenvironmentop.js";
import {
  CreateSharedEnvVariableRequest,
  CreateSharedEnvVariableResponseBody,
} from "../models/createsharedenvvariableop.js";
import {
  DeleteSharedEnvVariableRequest,
  DeleteSharedEnvVariableResponseBody,
} from "../models/deletesharedenvvariableop.js";
import {
  GetCustomEnvironmentRequest,
  GetCustomEnvironmentResponseBody,
} from "../models/getcustomenvironmentop.js";
import {
  GetProjectsByIdOrNameCustomEnvironmentsRequest,
  GetProjectsByIdOrNameCustomEnvironmentsResponseBody,
} from "../models/getprojectsbyidornamecustomenvironmentsop.js";
import {
  GetSharedEnvVarRequest,
  GetSharedEnvVarResponseBody,
} from "../models/getsharedenvvarop.js";
import {
  ListSharedEnvVariableRequest,
  ListSharedEnvVariableResponseBody,
} from "../models/listsharedenvvariableop.js";
import {
  RemoveCustomEnvironmentRequest,
  RemoveCustomEnvironmentResponseBody,
} from "../models/removecustomenvironmentop.js";
import {
  UnlinkSharedEnvVariableRequest,
  UnlinkSharedEnvVariableResponseBody,
} from "../models/unlinksharedenvvariableop.js";
import {
  UpdateCustomEnvironmentRequest,
  UpdateCustomEnvironmentResponseBody,
} from "../models/updatecustomenvironmentop.js";
import {
  UpdateSharedEnvVariableRequest,
  UpdateSharedEnvVariableResponseBody,
} from "../models/updatesharedenvvariableop.js";
import { unwrapAsync } from "../types/fp.js";

export class Environment extends ClientSDK {
  /**
   * Create one or more shared environment variables
   *
   * @remarks
   * Creates shared environment variable(s) for a team.
   */
  async createSharedEnvVariable(
    request: CreateSharedEnvVariableRequest,
    options?: RequestOptions,
  ): Promise<CreateSharedEnvVariableResponseBody> {
    return unwrapAsync(environmentCreateSharedEnvVariable(
      this,
      request,
      options,
    ));
  }

  /**
   * Lists all Shared Environment Variables for a team
   *
   * @remarks
   * Lists all Shared Environment Variables for a team, taking into account optional filters.
   */
  async listSharedEnvVariable(
    request: ListSharedEnvVariableRequest,
    options?: RequestOptions,
  ): Promise<ListSharedEnvVariableResponseBody> {
    return unwrapAsync(environmentListSharedEnvVariable(
      this,
      request,
      options,
    ));
  }

  /**
   * Updates one or more shared environment variables
   *
   * @remarks
   * Updates a given Shared Environment Variable for a Team.
   */
  async updateSharedEnvVariable(
    request: UpdateSharedEnvVariableRequest,
    options?: RequestOptions,
  ): Promise<UpdateSharedEnvVariableResponseBody> {
    return unwrapAsync(environmentUpdateSharedEnvVariable(
      this,
      request,
      options,
    ));
  }

  /**
   * Delete one or more Env Var
   *
   * @remarks
   * Deletes one or many Shared Environment Variables for a given team.
   */
  async deleteSharedEnvVariable(
    request: DeleteSharedEnvVariableRequest,
    options?: RequestOptions,
  ): Promise<DeleteSharedEnvVariableResponseBody> {
    return unwrapAsync(environmentDeleteSharedEnvVariable(
      this,
      request,
      options,
    ));
  }

  /**
   * Retrieve the decrypted value of a Shared Environment Variable by id.
   *
   * @remarks
   * Retrieve the decrypted value of a Shared Environment Variable by id.
   */
  async getSharedEnvVar(
    request: GetSharedEnvVarRequest,
    options?: RequestOptions,
  ): Promise<GetSharedEnvVarResponseBody> {
    return unwrapAsync(environmentGetSharedEnvVar(
      this,
      request,
      options,
    ));
  }

  /**
   * Disconnects a shared environment variable for a given project
   *
   * @remarks
   * Disconnects a shared environment variable for a given project
   */
  async unlinkSharedEnvVariable(
    request: UnlinkSharedEnvVariableRequest,
    options?: RequestOptions,
  ): Promise<UnlinkSharedEnvVariableResponseBody> {
    return unwrapAsync(environmentUnlinkSharedEnvVariable(
      this,
      request,
      options,
    ));
  }

  /**
   * Create a custom environment for the current project.
   *
   * @remarks
   * Creates a custom environment for the current project. Cannot be named 'Production' or 'Preview'.
   */
  async createCustomEnvironment(
    request: CreateCustomEnvironmentRequest,
    options?: RequestOptions,
  ): Promise<CreateCustomEnvironmentResponseBody> {
    return unwrapAsync(environmentCreateCustomEnvironment(
      this,
      request,
      options,
    ));
  }

  /**
   * Retrieve custom environments
   *
   * @remarks
   * Retrieve custom environments for the project. Must not be named 'Production' or 'Preview'.
   */
  async getProjectsByIdOrNameCustomEnvironments(
    request: GetProjectsByIdOrNameCustomEnvironmentsRequest,
    options?: RequestOptions,
  ): Promise<GetProjectsByIdOrNameCustomEnvironmentsResponseBody> {
    return unwrapAsync(environmentGetProjectsByIdOrNameCustomEnvironments(
      this,
      request,
      options,
    ));
  }

  /**
   * Retrieve a custom environment
   *
   * @remarks
   * Retrieve a custom environment for the project. Must not be named 'Production' or 'Preview'.
   */
  async getCustomEnvironment(
    request: GetCustomEnvironmentRequest,
    options?: RequestOptions,
  ): Promise<GetCustomEnvironmentResponseBody> {
    return unwrapAsync(environmentGetCustomEnvironment(
      this,
      request,
      options,
    ));
  }

  /**
   * Update a custom environment
   *
   * @remarks
   * Update a custom environment for the project. Must not be named 'Production' or 'Preview'.
   */
  async updateCustomEnvironment(
    request: UpdateCustomEnvironmentRequest,
    options?: RequestOptions,
  ): Promise<UpdateCustomEnvironmentResponseBody> {
    return unwrapAsync(environmentUpdateCustomEnvironment(
      this,
      request,
      options,
    ));
  }

  /**
   * Remove a custom environment
   *
   * @remarks
   * Remove a custom environment for the project. Must not be named 'Production' or 'Preview'.
   */
  async removeCustomEnvironment(
    request: RemoveCustomEnvironmentRequest,
    options?: RequestOptions,
  ): Promise<RemoveCustomEnvironmentResponseBody> {
    return unwrapAsync(environmentRemoveCustomEnvironment(
      this,
      request,
      options,
    ));
  }
}