@moovio/sdk 0.3.5 → 0.4.0

package/src/models/operations/listfeesfetch.ts

@@ -0,0 +1,233 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListFeesFetchGlobals = {
+  /**
+   * Specify an API version.
+   *
+   * @remarks
+   *
+   * API versioning follows the format `vYYYY.QQ.BB`, where
+   *   - `YYYY` is the year
+   *   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+   *   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
+   *     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+   *
+   * The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type ListFeesFetchRequest = {
+  accountID: string;
+  listFeesFetchRequest?: components.ListFeesFetchRequest | undefined;
+};
+
+export type ListFeesFetchResponse = {
+  headers: { [k: string]: Array<string> };
+  result: Array<components.IncurredFee>;
+};
+
+/** @internal */
+export const ListFeesFetchGlobals$inboundSchema: z.ZodType<
+  ListFeesFetchGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "x-moov-version": z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    "x-moov-version": "xMoovVersion",
+  });
+});
+
+/** @internal */
+export type ListFeesFetchGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const ListFeesFetchGlobals$outboundSchema: z.ZodType<
+  ListFeesFetchGlobals$Outbound,
+  z.ZodTypeDef,
+  ListFeesFetchGlobals
+> = z.object({
+  xMoovVersion: z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "x-moov-version",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListFeesFetchGlobals$ {
+  /** @deprecated use `ListFeesFetchGlobals$inboundSchema` instead. */
+  export const inboundSchema = ListFeesFetchGlobals$inboundSchema;
+  /** @deprecated use `ListFeesFetchGlobals$outboundSchema` instead. */
+  export const outboundSchema = ListFeesFetchGlobals$outboundSchema;
+  /** @deprecated use `ListFeesFetchGlobals$Outbound` instead. */
+  export type Outbound = ListFeesFetchGlobals$Outbound;
+}
+
+export function listFeesFetchGlobalsToJSON(
+  listFeesFetchGlobals: ListFeesFetchGlobals,
+): string {
+  return JSON.stringify(
+    ListFeesFetchGlobals$outboundSchema.parse(listFeesFetchGlobals),
+  );
+}
+
+export function listFeesFetchGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListFeesFetchGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListFeesFetchGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListFeesFetchGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListFeesFetchRequest$inboundSchema: z.ZodType<
+  ListFeesFetchRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  ListFeesFetchRequest: components.ListFeesFetchRequest$inboundSchema
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "ListFeesFetchRequest": "listFeesFetchRequest",
+  });
+});
+
+/** @internal */
+export type ListFeesFetchRequest$Outbound = {
+  accountID: string;
+  ListFeesFetchRequest?: components.ListFeesFetchRequest$Outbound | undefined;
+};
+
+/** @internal */
+export const ListFeesFetchRequest$outboundSchema: z.ZodType<
+  ListFeesFetchRequest$Outbound,
+  z.ZodTypeDef,
+  ListFeesFetchRequest
+> = z.object({
+  accountID: z.string(),
+  listFeesFetchRequest: components.ListFeesFetchRequest$outboundSchema
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    listFeesFetchRequest: "ListFeesFetchRequest",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListFeesFetchRequest$ {
+  /** @deprecated use `ListFeesFetchRequest$inboundSchema` instead. */
+  export const inboundSchema = ListFeesFetchRequest$inboundSchema;
+  /** @deprecated use `ListFeesFetchRequest$outboundSchema` instead. */
+  export const outboundSchema = ListFeesFetchRequest$outboundSchema;
+  /** @deprecated use `ListFeesFetchRequest$Outbound` instead. */
+  export type Outbound = ListFeesFetchRequest$Outbound;
+}
+
+export function listFeesFetchRequestToJSON(
+  listFeesFetchRequest: ListFeesFetchRequest,
+): string {
+  return JSON.stringify(
+    ListFeesFetchRequest$outboundSchema.parse(listFeesFetchRequest),
+  );
+}
+
+export function listFeesFetchRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListFeesFetchRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListFeesFetchRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListFeesFetchRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListFeesFetchResponse$inboundSchema: z.ZodType<
+  ListFeesFetchResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: z.array(components.IncurredFee$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListFeesFetchResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: Array<components.IncurredFee$Outbound>;
+};
+
+/** @internal */
+export const ListFeesFetchResponse$outboundSchema: z.ZodType<
+  ListFeesFetchResponse$Outbound,
+  z.ZodTypeDef,
+  ListFeesFetchResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: z.array(components.IncurredFee$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListFeesFetchResponse$ {
+  /** @deprecated use `ListFeesFetchResponse$inboundSchema` instead. */
+  export const inboundSchema = ListFeesFetchResponse$inboundSchema;
+  /** @deprecated use `ListFeesFetchResponse$outboundSchema` instead. */
+  export const outboundSchema = ListFeesFetchResponse$outboundSchema;
+  /** @deprecated use `ListFeesFetchResponse$Outbound` instead. */
+  export type Outbound = ListFeesFetchResponse$Outbound;
+}
+
+export function listFeesFetchResponseToJSON(
+  listFeesFetchResponse: ListFeesFetchResponse,
+): string {
+  return JSON.stringify(
+    ListFeesFetchResponse$outboundSchema.parse(listFeesFetchResponse),
+  );
+}
+
+export function listFeesFetchResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListFeesFetchResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListFeesFetchResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListFeesFetchResponse' from JSON`,
+  );
+}

package/src/models/operations/retrievefees.ts

@@ -0,0 +1,255 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type RetrieveFeesGlobals = {
+  /**
+   * Specify an API version.
+   *
+   * @remarks
+   *
+   * API versioning follows the format `vYYYY.QQ.BB`, where
+   *   - `YYYY` is the year
+   *   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+   *   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
+   *     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+   *
+   * The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type RetrieveFeesRequest = {
+  accountID: string;
+  /**
+   * Optional transfer ID to filter the results by.
+   */
+  transferID?: string | undefined;
+  /**
+   * Optional dispute ID to filter the results by.
+   */
+  disputeID?: string | undefined;
+  /**
+   * Optional date-time to inclusively filter all fees created after this date-time.
+   */
+  startDateTime?: string | undefined;
+  /**
+   * Optional date-time to exclusively filter all fees created before this date-time.
+   */
+  endDateTime?: string | undefined;
+  skip?: number | undefined;
+  count?: number | undefined;
+};
+
+export type RetrieveFeesResponse = {
+  headers: { [k: string]: Array<string> };
+  result: Array<components.IncurredFee>;
+};
+
+/** @internal */
+export const RetrieveFeesGlobals$inboundSchema: z.ZodType<
+  RetrieveFeesGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "x-moov-version": z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    "x-moov-version": "xMoovVersion",
+  });
+});
+
+/** @internal */
+export type RetrieveFeesGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const RetrieveFeesGlobals$outboundSchema: z.ZodType<
+  RetrieveFeesGlobals$Outbound,
+  z.ZodTypeDef,
+  RetrieveFeesGlobals
+> = z.object({
+  xMoovVersion: z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "x-moov-version",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RetrieveFeesGlobals$ {
+  /** @deprecated use `RetrieveFeesGlobals$inboundSchema` instead. */
+  export const inboundSchema = RetrieveFeesGlobals$inboundSchema;
+  /** @deprecated use `RetrieveFeesGlobals$outboundSchema` instead. */
+  export const outboundSchema = RetrieveFeesGlobals$outboundSchema;
+  /** @deprecated use `RetrieveFeesGlobals$Outbound` instead. */
+  export type Outbound = RetrieveFeesGlobals$Outbound;
+}
+
+export function retrieveFeesGlobalsToJSON(
+  retrieveFeesGlobals: RetrieveFeesGlobals,
+): string {
+  return JSON.stringify(
+    RetrieveFeesGlobals$outboundSchema.parse(retrieveFeesGlobals),
+  );
+}
+
+export function retrieveFeesGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveFeesGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrieveFeesGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveFeesGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const RetrieveFeesRequest$inboundSchema: z.ZodType<
+  RetrieveFeesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  transferID: z.string().optional(),
+  disputeID: z.string().optional(),
+  startDateTime: z.string().optional(),
+  endDateTime: z.string().optional(),
+  skip: z.number().int().optional(),
+  count: z.number().int().optional(),
+});
+
+/** @internal */
+export type RetrieveFeesRequest$Outbound = {
+  accountID: string;
+  transferID?: string | undefined;
+  disputeID?: string | undefined;
+  startDateTime?: string | undefined;
+  endDateTime?: string | undefined;
+  skip?: number | undefined;
+  count?: number | undefined;
+};
+
+/** @internal */
+export const RetrieveFeesRequest$outboundSchema: z.ZodType<
+  RetrieveFeesRequest$Outbound,
+  z.ZodTypeDef,
+  RetrieveFeesRequest
+> = z.object({
+  accountID: z.string(),
+  transferID: z.string().optional(),
+  disputeID: z.string().optional(),
+  startDateTime: z.string().optional(),
+  endDateTime: z.string().optional(),
+  skip: z.number().int().optional(),
+  count: z.number().int().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RetrieveFeesRequest$ {
+  /** @deprecated use `RetrieveFeesRequest$inboundSchema` instead. */
+  export const inboundSchema = RetrieveFeesRequest$inboundSchema;
+  /** @deprecated use `RetrieveFeesRequest$outboundSchema` instead. */
+  export const outboundSchema = RetrieveFeesRequest$outboundSchema;
+  /** @deprecated use `RetrieveFeesRequest$Outbound` instead. */
+  export type Outbound = RetrieveFeesRequest$Outbound;
+}
+
+export function retrieveFeesRequestToJSON(
+  retrieveFeesRequest: RetrieveFeesRequest,
+): string {
+  return JSON.stringify(
+    RetrieveFeesRequest$outboundSchema.parse(retrieveFeesRequest),
+  );
+}
+
+export function retrieveFeesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveFeesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrieveFeesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveFeesRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const RetrieveFeesResponse$inboundSchema: z.ZodType<
+  RetrieveFeesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: z.array(components.IncurredFee$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type RetrieveFeesResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: Array<components.IncurredFee$Outbound>;
+};
+
+/** @internal */
+export const RetrieveFeesResponse$outboundSchema: z.ZodType<
+  RetrieveFeesResponse$Outbound,
+  z.ZodTypeDef,
+  RetrieveFeesResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: z.array(components.IncurredFee$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RetrieveFeesResponse$ {
+  /** @deprecated use `RetrieveFeesResponse$inboundSchema` instead. */
+  export const inboundSchema = RetrieveFeesResponse$inboundSchema;
+  /** @deprecated use `RetrieveFeesResponse$outboundSchema` instead. */
+  export const outboundSchema = RetrieveFeesResponse$outboundSchema;
+  /** @deprecated use `RetrieveFeesResponse$Outbound` instead. */
+  export type Outbound = RetrieveFeesResponse$Outbound;
+}
+
+export function retrieveFeesResponseToJSON(
+  retrieveFeesResponse: RetrieveFeesResponse,
+): string {
+  return JSON.stringify(
+    RetrieveFeesResponse$outboundSchema.parse(retrieveFeesResponse),
+  );
+}
+
+export function retrieveFeesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveFeesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrieveFeesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveFeesResponse' from JSON`,
+  );
+}

package/src/sdk/{billing.ts → feeplans.ts}

@@ -2,16 +2,18 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { billingCreateFeePlanAgreements } from "../funcs/billingCreateFeePlanAgreements.js";
-import { billingListFeePlanAgreements } from "../funcs/billingListFeePlanAgreements.js";
-import { billingListFeePlans } from "../funcs/billingListFeePlans.js";
-import { billingListPartnerPricing } from "../funcs/billingListPartnerPricing.js";
-import { billingListPartnerPricingAgreements } from "../funcs/billingListPartnerPricingAgreements.js";
+import { feePlansCreateFeePlanAgreements } from "../funcs/feePlansCreateFeePlanAgreements.js";
+import { feePlansListFeePlanAgreements } from "../funcs/feePlansListFeePlanAgreements.js";
+import { feePlansListFeePlans } from "../funcs/feePlansListFeePlans.js";
+import { feePlansListFeesFetch } from "../funcs/feePlansListFeesFetch.js";
+import { feePlansListPartnerPricing } from "../funcs/feePlansListPartnerPricing.js";
+import { feePlansListPartnerPricingAgreements } from "../funcs/feePlansListPartnerPricingAgreements.js";
+import { feePlansRetrieveFees } from "../funcs/feePlansRetrieveFees.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
-export class Billing extends ClientSDK {
+export class FeePlans extends ClientSDK {
   /**
    * List all fee plan agreements associated with an account.
    *
@@ -22,7 +24,7 @@ export class Billing extends ClientSDK {
     request: operations.ListFeePlanAgreementsRequest,
     options?: RequestOptions,
   ): Promise<operations.ListFeePlanAgreementsResponse> {
-    return unwrapAsync(billingListFeePlanAgreements(
+    return unwrapAsync(feePlansListFeePlanAgreements(
       this,
       request,
       options,
@@ -39,7 +41,7 @@ export class Billing extends ClientSDK {
     request: operations.CreateFeePlanAgreementsRequest,
     options?: RequestOptions,
   ): Promise<operations.CreateFeePlanAgreementsResponse> {
-    return unwrapAsync(billingCreateFeePlanAgreements(
+    return unwrapAsync(feePlansCreateFeePlanAgreements(
       this,
       request,
       options,
@@ -57,7 +59,41 @@ export class Billing extends ClientSDK {
     request: operations.ListFeePlansRequest,
     options?: RequestOptions,
   ): Promise<operations.ListFeePlansResponse> {
-    return unwrapAsync(billingListFeePlans(
+    return unwrapAsync(feePlansListFeePlans(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve fees associated with an account.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
+   */
+  async retrieveFees(
+    request: operations.RetrieveFeesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveFeesResponse> {
+    return unwrapAsync(feePlansRetrieveFees(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List fees associated with an account.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
+   */
+  async listFeesFetch(
+    request: operations.ListFeesFetchRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListFeesFetchResponse> {
+    return unwrapAsync(feePlansListFeesFetch(
       this,
       request,
       options,
@@ -74,7 +110,7 @@ export class Billing extends ClientSDK {
     request: operations.ListPartnerPricingRequest,
     options?: RequestOptions,
   ): Promise<operations.ListPartnerPricingResponse> {
-    return unwrapAsync(billingListPartnerPricing(
+    return unwrapAsync(feePlansListPartnerPricing(
       this,
       request,
       options,
@@ -91,7 +127,7 @@ export class Billing extends ClientSDK {
     request: operations.ListPartnerPricingAgreementsRequest,
     options?: RequestOptions,
   ): Promise<operations.ListPartnerPricingAgreementsResponse> {
-    return unwrapAsync(billingListPartnerPricingAgreements(
+    return unwrapAsync(feePlansListPartnerPricingAgreements(
       this,
       request,
       options,

package/src/sdk/sdk.ts

@@ -9,7 +9,6 @@ import { ApplePay } from "./applepay.js";
 import { Authentication } from "./authentication.js";
 import { Avatars } from "./avatars.js";
 import { BankAccounts } from "./bankaccounts.js";
-import { Billing } from "./billing.js";
 import { Branding } from "./branding.js";
 import { Capabilities } from "./capabilities.js";
 import { CardIssuing } from "./cardissuing.js";
@@ -18,6 +17,7 @@ import { Disputes } from "./disputes.js";
 import { EndToEndEncryption } from "./endtoendencryption.js";
 import { EnrichedAddress } from "./enrichedaddress.js";
 import { EnrichedProfile } from "./enrichedprofile.js";
+import { FeePlans } from "./feeplans.js";
 import { Files } from "./files.js";
 import { Industries } from "./industries.js";
 import { Institutions } from "./institutions.js";
@@ -75,9 +75,9 @@ export class Moov extends ClientSDK {
     return (this._disputes ??= new Disputes(this._options));
   }
 
-  private _billing?: Billing;
-  get billing(): Billing {
-    return (this._billing ??= new Billing(this._options));
+  private _feePlans?: FeePlans;
+  get feePlans(): FeePlans {
+    return (this._feePlans ??= new FeePlans(this._options));
   }
 
   private _files?: Files;

package/src/sdk/transfers.ts

@@ -12,6 +12,7 @@ import { transfersList } from "../funcs/transfersList.js";
 import { transfersListRefunds } from "../funcs/transfersListRefunds.js";
 import { transfersUpdate } from "../funcs/transfersUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
@@ -181,7 +182,7 @@ export class Transfers extends ClientSDK {
    * you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
    */
   async generateOptions(
-    request: operations.CreateTransferOptionsRequest,
+    request: components.CreateTransferOptions,
     options?: RequestOptions,
   ): Promise<operations.CreateTransferOptionsResponse> {
     return unwrapAsync(transfersGenerateOptions(

package/src/types/async.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type APICall =
+  | {
+      status: "complete";
+      request: Request;
+      response: Response;
+    }
+  | {
+      status: "request-error";
+      request: Request;
+      response?: undefined;
+    }
+  | {
+      status: "invalid";
+      request?: undefined;
+      response?: undefined;
+    };
+
+export class APIPromise<T> implements Promise<T> {
+  readonly #promise: Promise<[T, APICall]>;
+  readonly #unwrapped: Promise<T>;
+
+  readonly [Symbol.toStringTag] = "APIPromise";
+
+  constructor(p: [T, APICall] | Promise<[T, APICall]>) {
+    this.#promise = p instanceof Promise ? p : Promise.resolve(p);
+    this.#unwrapped =
+      p instanceof Promise
+        ? this.#promise.then(([value]) => value)
+        : Promise.resolve(p[0]);
+  }
+
+  then<TResult1 = T, TResult2 = never>(
+    onfulfilled?:
+      | ((value: T) => TResult1 | PromiseLike<TResult1>)
+      | null
+      | undefined,
+    onrejected?:
+      | ((reason: any) => TResult2 | PromiseLike<TResult2>)
+      | null
+      | undefined,
+  ): Promise<TResult1 | TResult2> {
+    return this.#promise.then(
+      onfulfilled ? ([value]) => onfulfilled(value) : void 0,
+      onrejected,
+    );
+  }
+
+  catch<TResult = never>(
+    onrejected?:
+      | ((reason: any) => TResult | PromiseLike<TResult>)
+      | null
+      | undefined,
+  ): Promise<T | TResult> {
+    return this.#unwrapped.catch(onrejected);
+  }
+
+  finally(onfinally?: (() => void) | null | undefined): Promise<T> {
+    return this.#unwrapped.finally(onfinally);
+  }
+
+  $inspect(): Promise<[T, APICall]> {
+    return this.#promise;
+  }
+}