@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>
100 lines • 3.79 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { Flag } from "./flag.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
/**
* The state of the flags to retrieve. Defaults to `active`.
*/
export declare const ListTeamFlagsQueryParamState: {
readonly Active: "active";
readonly Archived: "archived";
};
/**
* The state of the flags to retrieve. Defaults to `active`.
*/
export type ListTeamFlagsQueryParamState = ClosedEnum<typeof ListTeamFlagsQueryParamState>;
/**
* The kind of flags to retrieve.
*/
export declare const ListTeamFlagsQueryParamKind: {
readonly Boolean: "boolean";
readonly String: "string";
readonly Number: "number";
readonly Json: "json";
};
/**
* The kind of flags to retrieve.
*/
export type ListTeamFlagsQueryParamKind = ClosedEnum<typeof ListTeamFlagsQueryParamKind>;
export type ListTeamFlagsRequest = {
/**
* The state of the flags to retrieve. Defaults to `active`.
*/
state?: ListTeamFlagsQueryParamState | undefined;
/**
* Deprecated. Whether to include creator metadata in each flag in the response. Resolve creator identity client-side (e.g. via the team members endpoint) instead; this parameter will be removed in a future release.
*/
withMetadata?: boolean | undefined;
/**
* Maximum number of flags to return.
*/
limit?: number | undefined;
/**
* Pagination cursor to continue from.
*/
cursor?: string | undefined;
/**
* Search flags by their slug or description. Case-insensitive.
*/
search?: string | undefined;
/**
* The kind of flags to retrieve.
*/
kind?: ListTeamFlagsQueryParamKind | undefined;
/**
* Filter flags by tag. Repeat the parameter for multiple tags (all must match).
*/
tags?: Array<string> | undefined;
/**
* The Team identifier to perform the request on behalf of.
*/
teamId: string;
/**
* The Team slug to perform the request on behalf of.
*/
slug?: string | undefined;
};
export type ListTeamFlagsPagination = {
next: string | null;
};
export type ListTeamFlagsResponseBody = {
data: Array<Flag>;
pagination: ListTeamFlagsPagination;
};
/** @internal */
export declare const ListTeamFlagsQueryParamState$outboundSchema: z.ZodNativeEnum<typeof ListTeamFlagsQueryParamState>;
/** @internal */
export declare const ListTeamFlagsQueryParamKind$outboundSchema: z.ZodNativeEnum<typeof ListTeamFlagsQueryParamKind>;
/** @internal */
export type ListTeamFlagsRequest$Outbound = {
state?: string | undefined;
withMetadata?: boolean | undefined;
limit: number;
cursor?: string | undefined;
search?: string | undefined;
kind?: string | undefined;
tags?: Array<string> | undefined;
teamId: string;
slug?: string | undefined;
};
/** @internal */
export declare const ListTeamFlagsRequest$outboundSchema: z.ZodType<ListTeamFlagsRequest$Outbound, z.ZodTypeDef, ListTeamFlagsRequest>;
export declare function listTeamFlagsRequestToJSON(listTeamFlagsRequest: ListTeamFlagsRequest): string;
/** @internal */
export declare const ListTeamFlagsPagination$inboundSchema: z.ZodType<ListTeamFlagsPagination, z.ZodTypeDef, unknown>;
export declare function listTeamFlagsPaginationFromJSON(jsonString: string): SafeParseResult<ListTeamFlagsPagination, SDKValidationError>;
/** @internal */
export declare const ListTeamFlagsResponseBody$inboundSchema: z.ZodType<ListTeamFlagsResponseBody, z.ZodTypeDef, unknown>;
export declare function listTeamFlagsResponseBodyFromJSON(jsonString: string): SafeParseResult<ListTeamFlagsResponseBody, SDKValidationError>;
//# sourceMappingURL=listteamflagsop.d.ts.map