UNPKG

@vercel/sdk

Version:

<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>

184 lines 6.71 kB
import * as z from "zod/v3"; import { ClosedEnum } from "../types/enums.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { Pagination } from "./pagination.js"; import { SDKValidationError } from "./sdkvalidationerror.js"; export type ListSharedEnvVariableRequest = { search?: string | undefined; /** * Filter SharedEnvVariables that belong to a project */ projectId?: string | undefined; /** * Filter SharedEnvVariables based on comma separated ids */ ids?: string | undefined; /** * Filter SharedEnvVariables based on comma separated ids */ excludeIdsQueryParameter?: string | undefined; /** * Filter SharedEnvVariables based on comma separated ids */ excludeIdsQueryParameter1?: string | undefined; /** * Filter SharedEnvVariables that belong to a project */ excludeProjectIdQueryParameter?: string | undefined; /** * Filter SharedEnvVariables that belong to a project */ excludeProjectIdQueryParameter1?: string | undefined; /** * 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; }; export declare const SecurityIssues: { readonly FlagsSecretNeedsSplit: "flags-secret-needs-split"; readonly ReadableSecret: "readable-secret"; }; export type SecurityIssues = ClosedEnum<typeof SecurityIssues>; /** * The type of this cosmos doc instance, if blank, assume secret. */ export declare const ListSharedEnvVariableType: { readonly Encrypted: "encrypted"; readonly Plain: "plain"; readonly Sensitive: "sensitive"; readonly System: "system"; }; /** * The type of this cosmos doc instance, if blank, assume secret. */ export type ListSharedEnvVariableType = ClosedEnum<typeof ListSharedEnvVariableType>; /** * environments this env variable targets */ export declare const ListSharedEnvVariableTarget: { readonly Development: "development"; readonly Preview: "preview"; readonly Production: "production"; }; /** * environments this env variable targets */ export type ListSharedEnvVariableTarget = ClosedEnum<typeof ListSharedEnvVariableTarget>; export type ListSharedEnvVariableData = { securityIssues: Array<SecurityIssues>; /** * The date when the Shared Env Var was created. */ created: Date; /** * The name of the Shared Env Var. */ key: string; /** * The unique identifier of the owner (team) the Shared Env Var was created for. */ ownerId?: string | null | undefined; /** * The unique identifier of the Shared Env Var. */ id: string; /** * The unique identifier of the user who created the Shared Env Var. */ createdBy?: string | null | undefined; /** * The unique identifier of the user who deleted the Shared Env Var. */ deletedBy?: string | null | undefined; /** * The unique identifier of the user who last updated the Shared Env Var. */ updatedBy?: string | null | undefined; /** * Timestamp for when the Shared Env Var was created. */ createdAt?: number | undefined; /** * Timestamp for when the Shared Env Var was (soft) deleted. */ deletedAt?: number | undefined; /** * Timestamp for when the Shared Env Var was last updated. */ updatedAt?: number | undefined; /** * The value of the Shared Env Var. */ value?: string | undefined; /** * The unique identifiers of the projects which the Shared Env Var is linked to. */ projectId?: Array<string> | undefined; /** * The type of this cosmos doc instance, if blank, assume secret. */ type?: ListSharedEnvVariableType | undefined; /** * environments this env variable targets */ target?: Array<ListSharedEnvVariableTarget> | undefined; /** * whether or not this env varible applies to custom environments */ applyToAllCustomEnvironments?: boolean | undefined; /** * The custom environment IDs that this Shared Env Var is scoped to. */ customEnvironmentIds?: Array<string> | undefined; /** * whether or not this env variable is decrypted */ decrypted: boolean; /** * A user provided comment that describes what this Shared Env Var is for. */ comment?: string | undefined; /** * The last editor full name or username. */ lastEditedByDisplayName?: string | undefined; }; export type ListSharedEnvVariableResponseBody = { data: Array<ListSharedEnvVariableData>; /** * This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data. */ pagination: Pagination; }; /** @internal */ export type ListSharedEnvVariableRequest$Outbound = { search?: string | undefined; projectId?: string | undefined; ids?: string | undefined; exclude_idsQueryParameter?: string | undefined; "exclude-idsQueryParameter1"?: string | undefined; exclude_projectIdQueryParameter?: string | undefined; "exclude-projectIdQueryParameter1"?: string | undefined; teamId?: string | undefined; slug?: string | undefined; }; /** @internal */ export declare const ListSharedEnvVariableRequest$outboundSchema: z.ZodType<ListSharedEnvVariableRequest$Outbound, z.ZodTypeDef, ListSharedEnvVariableRequest>; export declare function listSharedEnvVariableRequestToJSON(listSharedEnvVariableRequest: ListSharedEnvVariableRequest): string; /** @internal */ export declare const SecurityIssues$inboundSchema: z.ZodNativeEnum<typeof SecurityIssues>; /** @internal */ export declare const ListSharedEnvVariableType$inboundSchema: z.ZodNativeEnum<typeof ListSharedEnvVariableType>; /** @internal */ export declare const ListSharedEnvVariableTarget$inboundSchema: z.ZodNativeEnum<typeof ListSharedEnvVariableTarget>; /** @internal */ export declare const ListSharedEnvVariableData$inboundSchema: z.ZodType<ListSharedEnvVariableData, z.ZodTypeDef, unknown>; export declare function listSharedEnvVariableDataFromJSON(jsonString: string): SafeParseResult<ListSharedEnvVariableData, SDKValidationError>; /** @internal */ export declare const ListSharedEnvVariableResponseBody$inboundSchema: z.ZodType<ListSharedEnvVariableResponseBody, z.ZodTypeDef, unknown>; export declare function listSharedEnvVariableResponseBodyFromJSON(jsonString: string): SafeParseResult<ListSharedEnvVariableResponseBody, SDKValidationError>; //# sourceMappingURL=listsharedenvvariableop.d.ts.map