@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>
63 lines • 2.54 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
export type GetSDKKeysRequest = {
/**
* The project id or name
*/
projectIdOrName: 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;
};
export declare const GetSDKKeysType: {
readonly Client: "client";
readonly Mobile: "mobile";
readonly Server: "server";
};
export type GetSDKKeysType = ClosedEnum<typeof GetSDKKeysType>;
/**
* Shared metadata for a Flags SDK key, safe to return on both LIST and CREATE. Never contains cleartext secrets.
*/
export type GetSDKKeysData = {
hashKey: string;
projectId: string;
type: GetSDKKeysType;
environment: string;
createdBy: string;
createdAt: number;
updatedAt: number;
label?: string | undefined;
deletedAt?: number | undefined;
/**
* Partially-masked representation of the SDK key value, safe to display in UIs. The value is the `vf_<type>_` prefix followed by the first 3 characters of the secret portion and a fixed 8-character `*` mask (e.g. `vf_server_abc********`).
*/
partialKeyValue: string;
};
export type GetSDKKeysResponseBody = {
data: Array<GetSDKKeysData>;
};
/** @internal */
export type GetSDKKeysRequest$Outbound = {
projectIdOrName: string;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const GetSDKKeysRequest$outboundSchema: z.ZodType<GetSDKKeysRequest$Outbound, z.ZodTypeDef, GetSDKKeysRequest>;
export declare function getSDKKeysRequestToJSON(getSDKKeysRequest: GetSDKKeysRequest): string;
/** @internal */
export declare const GetSDKKeysType$inboundSchema: z.ZodNativeEnum<typeof GetSDKKeysType>;
/** @internal */
export declare const GetSDKKeysData$inboundSchema: z.ZodType<GetSDKKeysData, z.ZodTypeDef, unknown>;
export declare function getSDKKeysDataFromJSON(jsonString: string): SafeParseResult<GetSDKKeysData, SDKValidationError>;
/** @internal */
export declare const GetSDKKeysResponseBody$inboundSchema: z.ZodType<GetSDKKeysResponseBody, z.ZodTypeDef, unknown>;
export declare function getSDKKeysResponseBodyFromJSON(jsonString: string): SafeParseResult<GetSDKKeysResponseBody, SDKValidationError>;
//# sourceMappingURL=getsdkkeysop.d.ts.map