UNPKG

@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>

115 lines 5.01 kB
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"; /** * Status code for domain redirect */ export declare const MoveProjectDomainRedirectStatusCode: { readonly ThreeHundredAndOne: 301; readonly ThreeHundredAndTwo: 302; readonly ThreeHundredAndSeven: 307; readonly ThreeHundredAndEight: 308; }; /** * Status code for domain redirect */ export type MoveProjectDomainRedirectStatusCode = ClosedEnum<typeof MoveProjectDomainRedirectStatusCode>; export type MoveProjectDomainRequestBody = { /** * The unique target project identifier */ projectId: string; /** * Git branch to link the project domain */ gitBranch?: string | null | undefined; /** * Target destination domain for redirect */ redirect?: string | null | undefined; /** * Status code for domain redirect */ redirectStatusCode?: MoveProjectDomainRedirectStatusCode | null | undefined; }; export type MoveProjectDomainRequest = { /** * The unique project identifier or the project name */ idOrName: string; /** * The project domain name */ 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?: MoveProjectDomainRequestBody | 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 MoveProjectDomainVerification = { type: string; domain: string; value: string; reason: string; }; /** * The domain was updated successfuly */ export type MoveProjectDomainResponseBody = { 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<MoveProjectDomainVerification> | undefined; }; /** @internal */ export declare const MoveProjectDomainRedirectStatusCode$outboundSchema: z.ZodNativeEnum<typeof MoveProjectDomainRedirectStatusCode>; /** @internal */ export type MoveProjectDomainRequestBody$Outbound = { projectId: string; gitBranch?: string | null | undefined; redirect?: string | null | undefined; redirectStatusCode?: number | null | undefined; }; /** @internal */ export declare const MoveProjectDomainRequestBody$outboundSchema: z.ZodType<MoveProjectDomainRequestBody$Outbound, z.ZodTypeDef, MoveProjectDomainRequestBody>; export declare function moveProjectDomainRequestBodyToJSON(moveProjectDomainRequestBody: MoveProjectDomainRequestBody): string; /** @internal */ export type MoveProjectDomainRequest$Outbound = { idOrName: string; domain: string; teamId?: string | undefined; slug?: string | undefined; RequestBody?: MoveProjectDomainRequestBody$Outbound | undefined; }; /** @internal */ export declare const MoveProjectDomainRequest$outboundSchema: z.ZodType<MoveProjectDomainRequest$Outbound, z.ZodTypeDef, MoveProjectDomainRequest>; export declare function moveProjectDomainRequestToJSON(moveProjectDomainRequest: MoveProjectDomainRequest): string; /** @internal */ export declare const MoveProjectDomainVerification$inboundSchema: z.ZodType<MoveProjectDomainVerification, z.ZodTypeDef, unknown>; export declare function moveProjectDomainVerificationFromJSON(jsonString: string): SafeParseResult<MoveProjectDomainVerification, SDKValidationError>; /** @internal */ export declare const MoveProjectDomainResponseBody$inboundSchema: z.ZodType<MoveProjectDomainResponseBody, z.ZodTypeDef, unknown>; export declare function moveProjectDomainResponseBodyFromJSON(jsonString: string): SafeParseResult<MoveProjectDomainResponseBody, SDKValidationError>; //# sourceMappingURL=moveprojectdomainop.d.ts.map