@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>
145 lines • 6.11 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 ClaimDomainOwnershipRequest = {
/**
* The domain name to claim ownership of
*/
domain: 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;
};
/**
* An object containing information of the domain creator, including the user's id, username, and email.
*/
export type ClaimDomainOwnershipCreator = {
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 ClaimDomainOwnershipEchMode: {
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 ClaimDomainOwnershipEchMode = ClosedEnum<typeof ClaimDomainOwnershipEchMode>;
/**
* 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 ServiceType: {
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 ServiceType = ClosedEnum<typeof ServiceType>;
export type ClaimDomainOwnershipDomain = {
/**
* 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: ClaimDomainOwnershipCreator;
/**
* 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: ClaimDomainOwnershipEchMode;
/**
* 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: ServiceType;
/**
* 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;
};
/**
* Domain ownership successfully claimed.
*/
export type ClaimDomainOwnershipResponseBody = {
domain: ClaimDomainOwnershipDomain;
};
/** @internal */
export type ClaimDomainOwnershipRequest$Outbound = {
domain: string;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const ClaimDomainOwnershipRequest$outboundSchema: z.ZodType<ClaimDomainOwnershipRequest$Outbound, z.ZodTypeDef, ClaimDomainOwnershipRequest>;
export declare function claimDomainOwnershipRequestToJSON(claimDomainOwnershipRequest: ClaimDomainOwnershipRequest): string;
/** @internal */
export declare const ClaimDomainOwnershipCreator$inboundSchema: z.ZodType<ClaimDomainOwnershipCreator, z.ZodTypeDef, unknown>;
export declare function claimDomainOwnershipCreatorFromJSON(jsonString: string): SafeParseResult<ClaimDomainOwnershipCreator, SDKValidationError>;
/** @internal */
export declare const ClaimDomainOwnershipEchMode$inboundSchema: z.ZodNativeEnum<typeof ClaimDomainOwnershipEchMode>;
/** @internal */
export declare const ServiceType$inboundSchema: z.ZodNativeEnum<typeof ServiceType>;
/** @internal */
export declare const ClaimDomainOwnershipDomain$inboundSchema: z.ZodType<ClaimDomainOwnershipDomain, z.ZodTypeDef, unknown>;
export declare function claimDomainOwnershipDomainFromJSON(jsonString: string): SafeParseResult<ClaimDomainOwnershipDomain, SDKValidationError>;
/** @internal */
export declare const ClaimDomainOwnershipResponseBody$inboundSchema: z.ZodType<ClaimDomainOwnershipResponseBody, z.ZodTypeDef, unknown>;
export declare function claimDomainOwnershipResponseBodyFromJSON(jsonString: string): SafeParseResult<ClaimDomainOwnershipResponseBody, SDKValidationError>;
//# sourceMappingURL=claimdomainownershipop.d.ts.map