@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>
55 lines (50 loc) • 2.35 kB
text/typescript
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import * as z from "zod/v3";
import { safeParse } from "../lib/schemas.js";
import { Result as SafeParseResult } from "../types/fp.js";
import * as types from "../types/primitives.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
/**
* The Global Config.
*/
export type GlobalConfigToken = {
/**
* A partially-masked representation of the token, safe to display in UIs. The format is the first 3 characters of the token followed by a fixed 8-character `*` mask (e.g. `550e8400-e29b-41d4-a716-446655440000` → `550********`). The mask length is intentionally fixed (not proportional to the original token length) to avoid leaking the token length. Prefer this field for display/reference in UIs and logs. The full, plaintext token is only disclosed once at creation time via `POST /v1/edge-config/:edgeConfigId/token`; use `id` to reference a token in subsequent calls (e.g. when deleting).
*/
partialToken: string;
label: string;
/**
* This is not the token itself, but rather an id to identify the token by
*/
id: string;
edgeConfigId: string;
createdAt: number;
/**
* Deprecated: the full, plaintext token. - Returned once by `POST /v1/edge-config/:edgeConfigId/token` (create). - Still returned by `GET /v1/edge-config/:edgeConfigId/token/:token` (detail) for backwards compatibility, but scheduled for removal. - **Not** returned by `GET /v1/edge-config/:edgeConfigId/tokens` (list); use `partialToken` for display and `id` to reference tokens. Do not rely on this field being present on read operations. Prefer `partialToken` for display and `id` for references.
*/
token?: string | undefined;
};
/** @internal */
export const GlobalConfigToken$inboundSchema: z.ZodType<
GlobalConfigToken,
z.ZodTypeDef,
unknown
> = z.object({
partialToken: types.string(),
label: types.string(),
id: types.string(),
edgeConfigId: types.string(),
createdAt: types.number(),
token: types.optional(types.string()),
});
export function globalConfigTokenFromJSON(
jsonString: string,
): SafeParseResult<GlobalConfigToken, SDKValidationError> {
return safeParse(
jsonString,
(x) => GlobalConfigToken$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'GlobalConfigToken' from JSON`,
);
}