sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ ApiGateway/ GetUsagePlanKeys.ts

import type * as ag from "@distilled.cloud/aws/api-gateway";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { UsagePlan } from "./UsagePlan.ts";

export interface GetUsagePlanKeysRequest extends Omit<ag.GetUsagePlanKeysRequest, "usagePlanId"> {}

/**
 * Runtime binding for listing the API keys enrolled in a
 * {@link UsagePlan} (`apigateway:GET` on `/usageplans/{id}/keys`).
 *
 * Provide `ApiGateway.GetUsagePlanKeysHttp` on the Function effect to
 * implement the binding.
 *
 * ### Managing plan keys
 * **Example:** List enrolled keys
 * ```typescript
 * // init
 * const getUsagePlanKeys = yield* ApiGateway.GetUsagePlanKeys(plan);
 *
 * // runtime
 * const page = yield* getUsagePlanKeys({ limit: 100 });
 * ```
 *
 * @binding
 */
export interface GetUsagePlanKeys extends Binding.Service<
  GetUsagePlanKeys,
  "AWS.ApiGateway.GetUsagePlanKeys",
  <P extends UsagePlan>(
    usagePlan: P,
  ) => Effect.Effect<
    (request?: GetUsagePlanKeysRequest) => Effect.Effect<ag.UsagePlanKeys, ag.GetUsagePlanKeysError>
  >
> {}
export const GetUsagePlanKeys = Binding.Service<GetUsagePlanKeys>(
  "AWS.ApiGateway.GetUsagePlanKeys",
);