sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Route53Domains/ GetDomainSuggestions.ts

import type * as route53domains from "@distilled.cloud/aws/route-53-domains";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

export interface GetDomainSuggestionsRequest extends route53domains.GetDomainSuggestionsRequest {}

/**
 * Runtime binding for `route53domains:GetDomainSuggestions` — return a list
 * of suggested domain names based on a seed name, optionally restricted to
 * names that are currently available for registration.
 *
 * Route 53 Domains is a global registration API with no resource-level IAM:
 * the binding takes no arguments and grants the function
 * `route53domains:GetDomainSuggestions` on `*`. Calls are pinned to
 * `us-east-1`, the only region that serves the Route 53 Domains API,
 * regardless of where the function runs.
 *
 * Provide the implementation with
 * `Effect.provide(AWS.Route53Domains.GetDomainSuggestionsHttp)`.
 *
 * ### Suggesting Domain Names
 * **Example:** Suggest Available Alternatives for a Name
 * ```typescript
 * // init
 * const getDomainSuggestions =
 *   yield* AWS.Route53Domains.GetDomainSuggestions();
 *
 * // runtime
 * const result = yield* getDomainSuggestions({
 *   DomainName: "example.com",
 *   SuggestionCount: 10,
 *   OnlyAvailable: true,
 * });
 * const names = (result.SuggestionsList ?? []).map((s) => s.DomainName);
 * ```
 *
 * @binding
 */
export interface GetDomainSuggestions extends Binding.Service<
  GetDomainSuggestions,
  "AWS.Route53Domains.GetDomainSuggestions",
  () => Effect.Effect<
    (
      request: GetDomainSuggestionsRequest,
    ) => Effect.Effect<
      route53domains.GetDomainSuggestionsResponse,
      route53domains.GetDomainSuggestionsError
    >
  >
> {}
export const GetDomainSuggestions = Binding.Service<GetDomainSuggestions>(
  "AWS.Route53Domains.GetDomainSuggestions",
);