@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>
202 lines • 8.91 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";
/**
* move-in
*/
export type CreateOrTransferDomainRequestBody2 = {
/**
* The domain name you want to add.
*/
name: string;
/**
* The domain operation to perform. It can be either `add` or `move-in`.
*/
method: string;
/**
* The move-in token from Move Requested email.
*/
token?: string | undefined;
};
/**
* add
*/
export type CreateOrTransferDomainRequestBody1 = {
/**
* The domain name you want to add.
*/
name: string;
/**
* Whether the domain has the Vercel CDN enabled or not.
*/
cdnEnabled?: boolean | undefined;
/**
* Whether to create a DNS zone on Vercel. Set `true` if using Vercel nameservers.
*/
zone?: boolean | undefined;
/**
* The domain operation to perform. It can be either `add` or `move-in`.
*/
method?: string | undefined;
};
export type CreateOrTransferDomainRequestBody = CreateOrTransferDomainRequestBody2 | CreateOrTransferDomainRequestBody1;
export type CreateOrTransferDomainRequest = {
/**
* 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;
requestBody?: CreateOrTransferDomainRequestBody2 | CreateOrTransferDomainRequestBody1 | undefined;
};
/**
* An object containing information of the domain creator, including the user's id, username, and email.
*/
export type CreateOrTransferDomainCreator = {
username: string;
email: string;
customerId?: string | null | undefined;
isDomainReseller?: boolean | undefined;
id: string;
};
/**
* Whether the domain is enrolled in Encrypted Client Hello. `auto` leaves the decision to Vercel, `enabled` always enrolls, and `disabled` never enrolls and opts out of automatic enrollment.
*/
export declare const CreateOrTransferDomainEchMode: {
readonly Auto: "auto";
readonly Disabled: "disabled";
readonly Enabled: "enabled";
};
/**
* Whether the domain is enrolled in Encrypted Client Hello. `auto` leaves the decision to Vercel, `enabled` always enrolls, and `disabled` never enrolls and opts out of automatic enrollment.
*/
export type CreateOrTransferDomainEchMode = ClosedEnum<typeof CreateOrTransferDomainEchMode>;
/**
* The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available.
*/
export declare const CreateOrTransferDomainServiceType: {
readonly External: "external";
readonly Na: "na";
readonly ZeitWorld: "zeit.world";
};
/**
* The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available.
*/
export type CreateOrTransferDomainServiceType = ClosedEnum<typeof CreateOrTransferDomainServiceType>;
export type CreateOrTransferDomainDomain = {
/**
* Timestamp in milliseconds at which the domain is set to expire. null if not bought with Vercel.
*/
expiresAt: number | null;
/**
* If the domain has the ownership verified.
*/
verified: boolean;
/**
* A list of the current nameservers of the domain.
*/
nameservers: Array<string>;
/**
* A list of the intended nameservers for the domain to point to Vercel DNS.
*/
intendedNameservers: Array<string>;
/**
* A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel.
*/
customNameservers?: Array<string> | undefined;
/**
* An object containing information of the domain creator, including the user's id, username, and email.
*/
creator: CreateOrTransferDomainCreator;
/**
* Whether the domain is enrolled in Encrypted Client Hello. `auto` leaves the decision to Vercel, `enabled` always enrolls, and `disabled` never enrolls and opts out of automatic enrollment.
*/
echMode: CreateOrTransferDomainEchMode;
/**
* The domain name.
*/
name: string;
teamId: string | null;
/**
* If it was purchased through Vercel, the timestamp in milliseconds when it was purchased.
*/
boughtAt: number | null;
/**
* Timestamp in milliseconds when the domain was created in the registry.
*/
createdAt: number;
/**
* The unique identifier of the domain.
*/
id: string;
/**
* Indicates whether the domain is set to automatically renew.
*/
renew?: boolean | undefined;
/**
* The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available.
*/
serviceType: CreateOrTransferDomainServiceType;
/**
* Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in.
*/
transferredAt?: number | null | undefined;
/**
* If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated.
*/
transferStartedAt?: number | undefined;
userId: string;
};
export type CreateOrTransferDomainResponseBody = {
domain: CreateOrTransferDomainDomain;
};
/** @internal */
export type CreateOrTransferDomainRequestBody2$Outbound = {
name: string;
method: string;
token?: string | undefined;
};
/** @internal */
export declare const CreateOrTransferDomainRequestBody2$outboundSchema: z.ZodType<CreateOrTransferDomainRequestBody2$Outbound, z.ZodTypeDef, CreateOrTransferDomainRequestBody2>;
export declare function createOrTransferDomainRequestBody2ToJSON(createOrTransferDomainRequestBody2: CreateOrTransferDomainRequestBody2): string;
/** @internal */
export type CreateOrTransferDomainRequestBody1$Outbound = {
name: string;
cdnEnabled?: boolean | undefined;
zone?: boolean | undefined;
method?: string | undefined;
};
/** @internal */
export declare const CreateOrTransferDomainRequestBody1$outboundSchema: z.ZodType<CreateOrTransferDomainRequestBody1$Outbound, z.ZodTypeDef, CreateOrTransferDomainRequestBody1>;
export declare function createOrTransferDomainRequestBody1ToJSON(createOrTransferDomainRequestBody1: CreateOrTransferDomainRequestBody1): string;
/** @internal */
export type CreateOrTransferDomainRequestBody$Outbound = CreateOrTransferDomainRequestBody2$Outbound | CreateOrTransferDomainRequestBody1$Outbound;
/** @internal */
export declare const CreateOrTransferDomainRequestBody$outboundSchema: z.ZodType<CreateOrTransferDomainRequestBody$Outbound, z.ZodTypeDef, CreateOrTransferDomainRequestBody>;
export declare function createOrTransferDomainRequestBodyToJSON(createOrTransferDomainRequestBody: CreateOrTransferDomainRequestBody): string;
/** @internal */
export type CreateOrTransferDomainRequest$Outbound = {
teamId?: string | undefined;
slug?: string | undefined;
RequestBody?: CreateOrTransferDomainRequestBody2$Outbound | CreateOrTransferDomainRequestBody1$Outbound | undefined;
};
/** @internal */
export declare const CreateOrTransferDomainRequest$outboundSchema: z.ZodType<CreateOrTransferDomainRequest$Outbound, z.ZodTypeDef, CreateOrTransferDomainRequest>;
export declare function createOrTransferDomainRequestToJSON(createOrTransferDomainRequest: CreateOrTransferDomainRequest): string;
/** @internal */
export declare const CreateOrTransferDomainCreator$inboundSchema: z.ZodType<CreateOrTransferDomainCreator, z.ZodTypeDef, unknown>;
export declare function createOrTransferDomainCreatorFromJSON(jsonString: string): SafeParseResult<CreateOrTransferDomainCreator, SDKValidationError>;
/** @internal */
export declare const CreateOrTransferDomainEchMode$inboundSchema: z.ZodNativeEnum<typeof CreateOrTransferDomainEchMode>;
/** @internal */
export declare const CreateOrTransferDomainServiceType$inboundSchema: z.ZodNativeEnum<typeof CreateOrTransferDomainServiceType>;
/** @internal */
export declare const CreateOrTransferDomainDomain$inboundSchema: z.ZodType<CreateOrTransferDomainDomain, z.ZodTypeDef, unknown>;
export declare function createOrTransferDomainDomainFromJSON(jsonString: string): SafeParseResult<CreateOrTransferDomainDomain, SDKValidationError>;
/** @internal */
export declare const CreateOrTransferDomainResponseBody$inboundSchema: z.ZodType<CreateOrTransferDomainResponseBody, z.ZodTypeDef, unknown>;
export declare function createOrTransferDomainResponseBodyFromJSON(jsonString: string): SafeParseResult<CreateOrTransferDomainResponseBody, SDKValidationError>;
//# sourceMappingURL=createortransferdomainop.d.ts.map