@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>
160 lines • 5.22 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";
/**
* The type of the DNS record
*/
export declare const UpdateRecordType: {
readonly A: "A";
readonly Aaaa: "AAAA";
readonly Alias: "ALIAS";
readonly Caa: "CAA";
readonly Cname: "CNAME";
readonly Https: "HTTPS";
readonly Mx: "MX";
readonly Srv: "SRV";
readonly Txt: "TXT";
readonly Ns: "NS";
};
/**
* The type of the DNS record
*/
export type UpdateRecordType = ClosedEnum<typeof UpdateRecordType>;
export type Srv = {
target: string | null;
weight: number | null;
port: number | null;
priority: number | null;
};
export type Https = {
priority: number | null;
target: string | null;
params?: string | null | undefined;
};
export type UpdateRecordRequestBody = {
/**
* The name of the DNS record
*/
name?: string | null | undefined;
/**
* The value of the DNS record
*/
value?: string | null | undefined;
/**
* The type of the DNS record
*/
type?: UpdateRecordType | null | undefined;
/**
* The Time to live (TTL) value of the DNS record
*/
ttl?: number | null | undefined;
/**
* The MX priority value of the DNS record
*/
mxPriority?: number | null | undefined;
srv?: Srv | null | undefined;
https?: Https | null | undefined;
/**
* A comment to add context on what this DNS record is for
*/
comment?: string | undefined;
};
export type UpdateRecordRequest = {
/**
* The id of the DNS record
*/
recordId: 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: UpdateRecordRequestBody;
};
export declare const UpdateRecordDnsType: {
readonly Record: "record";
readonly RecordSys: "record-sys";
};
export type UpdateRecordDnsType = ClosedEnum<typeof UpdateRecordDnsType>;
export declare const RecordType: {
readonly A: "A";
readonly Aaaa: "AAAA";
readonly Alias: "ALIAS";
readonly Caa: "CAA";
readonly Cname: "CNAME";
readonly Https: "HTTPS";
readonly Mx: "MX";
readonly Ns: "NS";
readonly Srv: "SRV";
readonly Txt: "TXT";
};
export type RecordType = ClosedEnum<typeof RecordType>;
export type UpdateRecordResponseBody = {
id: string;
name: string;
type: UpdateRecordDnsType;
value: string;
creator: string;
domain: string;
ttl?: number | undefined;
comment?: string | undefined;
recordType: RecordType;
createdAt?: number | null | undefined;
};
/** @internal */
export declare const UpdateRecordType$outboundSchema: z.ZodNativeEnum<typeof UpdateRecordType>;
/** @internal */
export type Srv$Outbound = {
target: string | null;
weight: number | null;
port: number | null;
priority: number | null;
};
/** @internal */
export declare const Srv$outboundSchema: z.ZodType<Srv$Outbound, z.ZodTypeDef, Srv>;
export declare function srvToJSON(srv: Srv): string;
/** @internal */
export type Https$Outbound = {
priority: number | null;
target: string | null;
params?: string | null | undefined;
};
/** @internal */
export declare const Https$outboundSchema: z.ZodType<Https$Outbound, z.ZodTypeDef, Https>;
export declare function httpsToJSON(https: Https): string;
/** @internal */
export type UpdateRecordRequestBody$Outbound = {
name?: string | null | undefined;
value?: string | null | undefined;
type?: string | null | undefined;
ttl?: number | null | undefined;
mxPriority?: number | null | undefined;
srv?: Srv$Outbound | null | undefined;
https?: Https$Outbound | null | undefined;
comment?: string | undefined;
};
/** @internal */
export declare const UpdateRecordRequestBody$outboundSchema: z.ZodType<UpdateRecordRequestBody$Outbound, z.ZodTypeDef, UpdateRecordRequestBody>;
export declare function updateRecordRequestBodyToJSON(updateRecordRequestBody: UpdateRecordRequestBody): string;
/** @internal */
export type UpdateRecordRequest$Outbound = {
recordId: string;
teamId?: string | undefined;
slug?: string | undefined;
RequestBody: UpdateRecordRequestBody$Outbound;
};
/** @internal */
export declare const UpdateRecordRequest$outboundSchema: z.ZodType<UpdateRecordRequest$Outbound, z.ZodTypeDef, UpdateRecordRequest>;
export declare function updateRecordRequestToJSON(updateRecordRequest: UpdateRecordRequest): string;
/** @internal */
export declare const UpdateRecordDnsType$inboundSchema: z.ZodNativeEnum<typeof UpdateRecordDnsType>;
/** @internal */
export declare const RecordType$inboundSchema: z.ZodNativeEnum<typeof RecordType>;
/** @internal */
export declare const UpdateRecordResponseBody$inboundSchema: z.ZodType<UpdateRecordResponseBody, z.ZodTypeDef, unknown>;
export declare function updateRecordResponseBodyFromJSON(jsonString: string): SafeParseResult<UpdateRecordResponseBody, SDKValidationError>;
//# sourceMappingURL=updaterecordop.d.ts.map