@vercel/sdk/src/models/getdomainsop.ts

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

/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import * as z from "zod/v3";
import { safeParse } from "../lib/schemas.js";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import * as types from "../types/primitives.js";
import { Pagination, Pagination$inboundSchema } from "./pagination.js";
import { SDKValidationError } from "./sdkvalidationerror.js";

export type GetDomainsRequest = {
  /**
   * Maximum number of domains to list from a request.
   */
  limit?: number | undefined;
  /**
   * Get domains created after this JavaScript timestamp.
   */
  since?: number | undefined;
  /**
   * Get 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;
};

/**
 * An object containing information of the domain creator, including the user's id, username, and email.
 */
export type GetDomainsCreator = {
  username: string;
  email: string;
  customerId?: string | null | undefined;
  isDomainReseller?: boolean | undefined;
  id: string;
};

/**
 * 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 const GetDomainsServiceType = {
  External: "external",
  Na: "na",
  ZeitWorld: "zeit.world",
} as const;
/**
 * 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 GetDomainsServiceType = ClosedEnum<typeof GetDomainsServiceType>;

export type GetDomainsDomains = {
  /**
   * 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: GetDomainsCreator;
  /**
   * 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: GetDomainsServiceType;
  /**
   * 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;
};

/**
 * Successful response retrieving a list of domains.
 */
export type GetDomainsResponseBody = {
  domains: Array<GetDomainsDomains>;
  /**
   * 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 GetDomainsRequest$Outbound = {
  limit?: number | undefined;
  since?: number | undefined;
  until?: number | undefined;
  teamId?: string | undefined;
  slug?: string | undefined;
};

/** @internal */
export const GetDomainsRequest$outboundSchema: z.ZodType<
  GetDomainsRequest$Outbound,
  z.ZodTypeDef,
  GetDomainsRequest
> = z.object({
  limit: z.number().optional(),
  since: z.number().optional(),
  until: z.number().optional(),
  teamId: z.string().optional(),
  slug: z.string().optional(),
});

export function getDomainsRequestToJSON(
  getDomainsRequest: GetDomainsRequest,
): string {
  return JSON.stringify(
    GetDomainsRequest$outboundSchema.parse(getDomainsRequest),
  );
}

/** @internal */
export const GetDomainsCreator$inboundSchema: z.ZodType<
  GetDomainsCreator,
  z.ZodTypeDef,
  unknown
> = z.object({
  username: types.string(),
  email: types.string(),
  customerId: z.nullable(types.string()).optional(),
  isDomainReseller: types.optional(types.boolean()),
  id: types.string(),
});

export function getDomainsCreatorFromJSON(
  jsonString: string,
): SafeParseResult<GetDomainsCreator, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetDomainsCreator$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetDomainsCreator' from JSON`,
  );
}

/** @internal */
export const GetDomainsServiceType$inboundSchema: z.ZodNativeEnum<
  typeof GetDomainsServiceType
> = z.nativeEnum(GetDomainsServiceType);

/** @internal */
export const GetDomainsDomains$inboundSchema: z.ZodType<
  GetDomainsDomains,
  z.ZodTypeDef,
  unknown
> = z.object({
  expiresAt: types.nullable(types.number()),
  verified: types.boolean(),
  nameservers: z.array(types.string()),
  intendedNameservers: z.array(types.string()),
  customNameservers: types.optional(z.array(types.string())),
  creator: z.lazy(() => GetDomainsCreator$inboundSchema),
  name: types.string(),
  teamId: types.nullable(types.string()),
  boughtAt: types.nullable(types.number()),
  createdAt: types.number(),
  id: types.string(),
  renew: types.optional(types.boolean()),
  serviceType: GetDomainsServiceType$inboundSchema,
  transferredAt: z.nullable(types.number()).optional(),
  transferStartedAt: types.optional(types.number()),
  userId: types.string(),
});

export function getDomainsDomainsFromJSON(
  jsonString: string,
): SafeParseResult<GetDomainsDomains, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetDomainsDomains$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetDomainsDomains' from JSON`,
  );
}

/** @internal */
export const GetDomainsResponseBody$inboundSchema: z.ZodType<
  GetDomainsResponseBody,
  z.ZodTypeDef,
  unknown
> = z.object({
  domains: z.array(z.lazy(() => GetDomainsDomains$inboundSchema)),
  pagination: Pagination$inboundSchema,
});

export function getDomainsResponseBodyFromJSON(
  jsonString: string,
): SafeParseResult<GetDomainsResponseBody, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetDomainsResponseBody$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetDomainsResponseBody' from JSON`,
  );
}