@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>
90 lines • 4.31 kB
TypeScript
import * as z from "zod/v3";
import { Result as SafeParseResult } from "../types/fp.js";
import { Pagination } from "./pagination.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
export type GetDomainProjectDomainsRequest = {
/**
* The apex domain name.
*/
domain: string;
/**
* Maximum number of project domains to list from a request.
*/
limit?: number | undefined;
/**
* Get project domains created after this JavaScript timestamp.
*/
since?: number | undefined;
/**
* Get project domains created before this JavaScript timestamp.
*/
until?: number | undefined;
/**
* 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;
};
/**
* A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`.
*/
export type GetDomainProjectDomainsVerification = {
type: string;
domain: string;
value: string;
reason: string;
};
export type ProjectDomains = {
name: string;
apexName: string;
projectId: string;
redirect?: string | null | undefined;
redirectStatusCode?: number | null | undefined;
gitBranch?: string | null | undefined;
customEnvironmentId?: string | null | undefined;
updatedAt?: number | undefined;
createdAt?: number | undefined;
/**
* `true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed.
*/
verified: boolean;
/**
* A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`.
*/
verification?: Array<GetDomainProjectDomainsVerification> | undefined;
};
/**
* Successful response retrieving project domains for an apex domain.
*/
export type GetDomainProjectDomainsResponseBody = {
projectDomains: Array<ProjectDomains>;
/**
* This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data.
*/
pagination: Pagination;
};
/** @internal */
export type GetDomainProjectDomainsRequest$Outbound = {
domain: string;
limit?: number | undefined;
since?: number | undefined;
until?: number | undefined;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const GetDomainProjectDomainsRequest$outboundSchema: z.ZodType<GetDomainProjectDomainsRequest$Outbound, z.ZodTypeDef, GetDomainProjectDomainsRequest>;
export declare function getDomainProjectDomainsRequestToJSON(getDomainProjectDomainsRequest: GetDomainProjectDomainsRequest): string;
/** @internal */
export declare const GetDomainProjectDomainsVerification$inboundSchema: z.ZodType<GetDomainProjectDomainsVerification, z.ZodTypeDef, unknown>;
export declare function getDomainProjectDomainsVerificationFromJSON(jsonString: string): SafeParseResult<GetDomainProjectDomainsVerification, SDKValidationError>;
/** @internal */
export declare const ProjectDomains$inboundSchema: z.ZodType<ProjectDomains, z.ZodTypeDef, unknown>;
export declare function projectDomainsFromJSON(jsonString: string): SafeParseResult<ProjectDomains, SDKValidationError>;
/** @internal */
export declare const GetDomainProjectDomainsResponseBody$inboundSchema: z.ZodType<GetDomainProjectDomainsResponseBody, z.ZodTypeDef, unknown>;
export declare function getDomainProjectDomainsResponseBodyFromJSON(jsonString: string): SafeParseResult<GetDomainProjectDomainsResponseBody, SDKValidationError>;
//# sourceMappingURL=getdomainprojectdomainsop.d.ts.map