@vercel/sdk/src/funcs/domainsRegistrarGetTld.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 { VercelCore } from "../core.js";
import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
import { matchStatusCode } from "../lib/http.js";
import * as M from "../lib/matchers.js";
import { compactMap } from "../lib/primitives.js";
import { safeParse } from "../lib/schemas.js";
import { RequestOptions } from "../lib/sdks.js";
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
import { pathToFunc } from "../lib/url.js";
import {
  GetTldDomainsRegistrarResponseBody,
  GetTldDomainsRegistrarResponseBody$inboundSchema,
  GetTldRequest,
  GetTldRequest$outboundSchema,
  GetTldResponseBody,
  GetTldResponseBody$inboundSchema,
} from "../models/gettldop.js";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/httpclienterrors.js";
import {
  InternalServerError,
  InternalServerError$inboundSchema,
} from "../models/internalservererror.js";
import {
  NotAuthorizedForScope,
  NotAuthorizedForScope$inboundSchema,
} from "../models/notauthorizedforscope.js";
import { ResponseValidationError } from "../models/responsevalidationerror.js";
import { SDKValidationError } from "../models/sdkvalidationerror.js";
import {
  TooManyRequests,
  TooManyRequests$inboundSchema,
} from "../models/toomanyrequests.js";
import {
  Unauthorized,
  Unauthorized$inboundSchema,
} from "../models/unauthorized.js";
import { VercelError } from "../models/vercelerror.js";
import { APICall, APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";

/**
 * Get TLD
 *
 * @remarks
 * Get the metadata for a specific TLD.
 *
 * If set, this operation will use {@link Security.bearerToken} from the global security.
 */
export function domainsRegistrarGetTld(
  client: VercelCore,
  request: GetTldRequest,
  options?: RequestOptions,
): APIPromise<
  Result<
    GetTldResponseBody,
    | GetTldDomainsRegistrarResponseBody
    | Unauthorized
    | NotAuthorizedForScope
    | TooManyRequests
    | InternalServerError
    | VercelError
    | ResponseValidationError
    | ConnectionError
    | RequestAbortedError
    | RequestTimeoutError
    | InvalidRequestError
    | UnexpectedClientError
    | SDKValidationError
  >
> {
  return new APIPromise($do(
    client,
    request,
    options,
  ));
}

async function $do(
  client: VercelCore,
  request: GetTldRequest,
  options?: RequestOptions,
): Promise<
  [
    Result<
      GetTldResponseBody,
      | GetTldDomainsRegistrarResponseBody
      | Unauthorized
      | NotAuthorizedForScope
      | TooManyRequests
      | InternalServerError
      | VercelError
      | ResponseValidationError
      | ConnectionError
      | RequestAbortedError
      | RequestTimeoutError
      | InvalidRequestError
      | UnexpectedClientError
      | SDKValidationError
    >,
    APICall,
  ]
> {
  const parsed = safeParse(
    request,
    (value) => GetTldRequest$outboundSchema.parse(value),
    "Input validation failed",
  );
  if (!parsed.ok) {
    return [parsed, { status: "invalid" }];
  }
  const payload = parsed.value;
  const body = null;

  const pathParams = {
    tld: encodeSimple("tld", payload.tld, {
      explode: false,
      charEncoding: "percent",
    }),
  };
  const path = pathToFunc("/v1/registrar/tlds/{tld}")(pathParams);

  const query = encodeFormQuery({
    "teamId": payload.teamId,
  });

  const headers = new Headers(compactMap({
    Accept: "application/json",
  }));

  const secConfig = await extractSecurity(client._options.bearerToken);
  const securityInput = secConfig == null ? {} : { bearerToken: secConfig };
  const requestSecurity = resolveGlobalSecurity(securityInput, [0]);

  const context = {
    options: client._options,
    baseURL: options?.serverURL ?? client._baseURL ?? "",
    operationID: "getTld",
    oAuth2Scopes: null,

    resolvedSecurity: requestSecurity,

    securitySource: client._options.bearerToken,
    retryConfig: options?.retries
      || client._options.retryConfig
      || { strategy: "none" },
    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
  };

  const requestRes = client._createRequest(context, {
    security: requestSecurity,
    method: "GET",
    baseURL: options?.serverURL,
    path: path,
    headers: headers,
    query: query,
    body: body,
    userAgent: client._options.userAgent,
    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
  }, options);
  if (!requestRes.ok) {
    return [requestRes, { status: "invalid" }];
  }
  const req = requestRes.value;

  const doResult = await client._do(req, {
    context,
    isErrorStatusCode: (statusCode: number) =>
      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
    retryConfig: context.retryConfig,
    retryCodes: context.retryCodes,
  });
  if (!doResult.ok) {
    return [doResult, { status: "request-error", request: req }];
  }
  const response = doResult.value;

  const responseFields = {
    HttpMeta: { Response: response, Request: req },
  };

  const [result] = await M.match<
    GetTldResponseBody,
    | GetTldDomainsRegistrarResponseBody
    | Unauthorized
    | NotAuthorizedForScope
    | TooManyRequests
    | InternalServerError
    | VercelError
    | ResponseValidationError
    | ConnectionError
    | RequestAbortedError
    | RequestTimeoutError
    | InvalidRequestError
    | UnexpectedClientError
    | SDKValidationError
  >(
    M.json(200, GetTldResponseBody$inboundSchema),
    M.jsonErr(400, GetTldDomainsRegistrarResponseBody$inboundSchema),
    M.jsonErr(401, Unauthorized$inboundSchema),
    M.jsonErr(403, NotAuthorizedForScope$inboundSchema),
    M.jsonErr(429, TooManyRequests$inboundSchema),
    M.jsonErr(500, InternalServerError$inboundSchema),
    M.fail("4XX"),
    M.fail("5XX"),
  )(response, req, { extraFields: responseFields });
  if (!result.ok) {
    return [result, { status: "complete", request: req, response }];
  }

  return [result, { status: "complete", request: req, response }];
}