@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>
107 lines • 4.93 kB
TypeScript
import * as z from "zod/v3";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
/**
* move-out
*/
export type PatchDomainRequestBody2 = {
op?: string | undefined;
/**
* User or team to move domain to
*/
destination?: string | undefined;
};
/**
* update
*/
export type PatchDomainRequestBody1 = {
op?: string | undefined;
/**
* This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/auto-renew instead.
*
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
*/
renew?: boolean | undefined;
/**
* This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/nameservers instead.
*
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
*/
customNameservers?: Array<string> | undefined;
/**
* Specifies whether this is a DNS zone that intends to use Vercel's nameservers.
*/
zone?: boolean | undefined;
};
export type PatchDomainRequestBody = PatchDomainRequestBody1 | PatchDomainRequestBody2;
export type PatchDomainRequest = {
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;
requestBody: PatchDomainRequestBody1 | PatchDomainRequestBody2;
};
export type PatchDomainResponseBody3 = {
renew?: boolean | undefined;
customNameservers?: Array<string> | undefined;
zone?: boolean | undefined;
};
export type PatchDomainResponseBody2 = {
moved: boolean;
token: string;
};
export type PatchDomainResponseBody1 = {
moved: boolean;
};
export type PatchDomainResponseBody = PatchDomainResponseBody2 | PatchDomainResponseBody1 | PatchDomainResponseBody3;
/** @internal */
export type PatchDomainRequestBody2$Outbound = {
op?: string | undefined;
destination?: string | undefined;
};
/** @internal */
export declare const PatchDomainRequestBody2$outboundSchema: z.ZodType<PatchDomainRequestBody2$Outbound, z.ZodTypeDef, PatchDomainRequestBody2>;
export declare function patchDomainRequestBody2ToJSON(patchDomainRequestBody2: PatchDomainRequestBody2): string;
/** @internal */
export type PatchDomainRequestBody1$Outbound = {
op?: string | undefined;
renew?: boolean | undefined;
customNameservers?: Array<string> | undefined;
zone?: boolean | undefined;
};
/** @internal */
export declare const PatchDomainRequestBody1$outboundSchema: z.ZodType<PatchDomainRequestBody1$Outbound, z.ZodTypeDef, PatchDomainRequestBody1>;
export declare function patchDomainRequestBody1ToJSON(patchDomainRequestBody1: PatchDomainRequestBody1): string;
/** @internal */
export type PatchDomainRequestBody$Outbound = PatchDomainRequestBody1$Outbound | PatchDomainRequestBody2$Outbound;
/** @internal */
export declare const PatchDomainRequestBody$outboundSchema: z.ZodType<PatchDomainRequestBody$Outbound, z.ZodTypeDef, PatchDomainRequestBody>;
export declare function patchDomainRequestBodyToJSON(patchDomainRequestBody: PatchDomainRequestBody): string;
/** @internal */
export type PatchDomainRequest$Outbound = {
domain: string;
teamId?: string | undefined;
slug?: string | undefined;
RequestBody: PatchDomainRequestBody1$Outbound | PatchDomainRequestBody2$Outbound;
};
/** @internal */
export declare const PatchDomainRequest$outboundSchema: z.ZodType<PatchDomainRequest$Outbound, z.ZodTypeDef, PatchDomainRequest>;
export declare function patchDomainRequestToJSON(patchDomainRequest: PatchDomainRequest): string;
/** @internal */
export declare const PatchDomainResponseBody3$inboundSchema: z.ZodType<PatchDomainResponseBody3, z.ZodTypeDef, unknown>;
export declare function patchDomainResponseBody3FromJSON(jsonString: string): SafeParseResult<PatchDomainResponseBody3, SDKValidationError>;
/** @internal */
export declare const PatchDomainResponseBody2$inboundSchema: z.ZodType<PatchDomainResponseBody2, z.ZodTypeDef, unknown>;
export declare function patchDomainResponseBody2FromJSON(jsonString: string): SafeParseResult<PatchDomainResponseBody2, SDKValidationError>;
/** @internal */
export declare const PatchDomainResponseBody1$inboundSchema: z.ZodType<PatchDomainResponseBody1, z.ZodTypeDef, unknown>;
export declare function patchDomainResponseBody1FromJSON(jsonString: string): SafeParseResult<PatchDomainResponseBody1, SDKValidationError>;
/** @internal */
export declare const PatchDomainResponseBody$inboundSchema: z.ZodType<PatchDomainResponseBody, z.ZodTypeDef, unknown>;
export declare function patchDomainResponseBodyFromJSON(jsonString: string): SafeParseResult<PatchDomainResponseBody, SDKValidationError>;
//# sourceMappingURL=patchdomainop.d.ts.map