@compass-labs/api-sdk 2.2.104 → 2.2.105-rc.0

package/src/models/errors/onramperrorresponse.ts

@@ -1,75 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { CompassAPISDKError } from "./compassapisdkerror.js";
-
-/**
- * Standard error envelope returned by every non-2xx on-ramp response.
- *
- * @remarks
- *
- * Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode
- * failures uniformly without inspecting per-status-code shapes.
- */
-export type OnrampErrorResponseData = {
-  /**
-   * Short human-readable error label (e.g. `Payment not found.`, `On-ramp provider unavailable`, `Identity verification required`).
-   */
-  error: string;
-  /**
-   * Human-readable explanation.
-   */
-  message: string;
-};
-
-/**
- * Standard error envelope returned by every non-2xx on-ramp response.
- *
- * @remarks
- *
- * Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode
- * failures uniformly without inspecting per-status-code shapes.
- */
-export class OnrampErrorResponse extends CompassAPISDKError {
-  /**
-   * Short human-readable error label (e.g. `Payment not found.`, `On-ramp provider unavailable`, `Identity verification required`).
-   */
-  error: string;
-
-  /** The original data that was passed to this error instance. */
-  data$: OnrampErrorResponseData;
-
-  constructor(
-    err: OnrampErrorResponseData,
-    httpMeta: { response: Response; request: Request; body: string },
-  ) {
-    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
-    super(message, httpMeta);
-    this.data$ = err;
-    this.error = err.error;
-
-    this.name = "OnrampErrorResponse";
-  }
-}
-
-/** @internal */
-export const OnrampErrorResponse$inboundSchema: z.ZodType<
-  OnrampErrorResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  error: z.string(),
-  message: z.string(),
-  request$: z.instanceof(Request),
-  response$: z.instanceof(Response),
-  body$: z.string(),
-})
-  .transform((v) => {
-    return new OnrampErrorResponse(v, {
-      request: v.request$,
-      response: v.response$,
-      body: v.body$,
-    });
-  });

package/src/models/operations/v2onrampstatus.ts

@@ -1,39 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-
-export type V2OnrampStatusRequest = {
-  /**
-   * The `payment_id` returned by `POST /v2/onramp/create`.
-   */
-  paymentId: string;
-};
-
-/** @internal */
-export type V2OnrampStatusRequest$Outbound = {
-  payment_id: string;
-};
-
-/** @internal */
-export const V2OnrampStatusRequest$outboundSchema: z.ZodType<
-  V2OnrampStatusRequest$Outbound,
-  z.ZodTypeDef,
-  V2OnrampStatusRequest
-> = z.object({
-  paymentId: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    paymentId: "payment_id",
-  });
-});
-
-export function v2OnrampStatusRequestToJSON(
-  v2OnrampStatusRequest: V2OnrampStatusRequest,
-): string {
-  return JSON.stringify(
-    V2OnrampStatusRequest$outboundSchema.parse(v2OnrampStatusRequest),
-  );
-}

package/src/sdk/onramp.ts

@@ -1,105 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { onrampOnrampCreate } from "../funcs/onrampOnrampCreate.js";
-import { onrampOnrampQuote } from "../funcs/onrampOnrampQuote.js";
-import { onrampOnrampStatus } from "../funcs/onrampOnrampStatus.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";
-
-export class Onramp extends ClientSDK {
-  /**
-   * Get a fiat on-ramp quote (card -> USDC on Ethereum)
-   *
-   * @remarks
-   * Get an indicative quote for buying USDC on Ethereum with a card.
-   *
-   * Returns the estimated USDC the user will receive for a given fiat amount,
-   * the exchange rate, fee breakdown (`business_fees` is `0`), and the provider
-   * min/max limits. The output is always **USDC on Ethereum** delivered to the
-   * `destination_address` — this is a non-custodial on-ramp, so Compass never
-   * holds the funds.
-   *
-   * This quote is indicative and may expire (`expires_at`). To actually start a
-   * payment, call `POST /v2/onramp/create`.
-   */
-  async onrampQuote(
-    request: components.OnrampQuoteRequest,
-    options?: RequestOptions,
-  ): Promise<components.OnrampQuote> {
-    return unwrapAsync(onrampOnrampQuote(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Create a fiat on-ramp payment + get the checkout link
-   *
-   * @remarks
-   * Create a fiat on-ramp payment and return the browser-checkout handoff.
-   *
-   * A fiat card + identity-verification flow can only render in a browser, so
-   * this endpoint returns a **`checkout_url`** (a Compass-hosted page) together
-   * with `payment_id`, the one-time-wallet `deposit_address`, an initial
-   * `status`, and a `user_instructions` string.
-   *
-   * **How to drive this (CLI / MCP agent / UI):**
-   *
-   * 1. **Present `checkout_url` to the user and open it in a browser.** It
-   *    renders the card payment + identity verification and delivers USDC on
-   *    Ethereum to the destination wallet. (An MCP agent cannot open a browser
-   *    itself — show the link and ask the user to open it.)
-   * 2. **Poll `GET /v2/onramp/status?payment_id=...`** until `status` becomes
-   *    `delivered` (or `failed`). `pending` = awaiting payment, `processing` =
-   *    payment received and bridging/swapping to USDC.
-   * 3. Once `delivered`, the USDC is in the user's own wallet — continue with
-   *    the tokenized buy.
-   *
-   * Funds are never held by Compass: the `deposit_address` is a one-time wallet
-   * owned solely by the user's wallet.
-   */
-  async onrampCreate(
-    request: components.OnrampCreateRequest,
-    options?: RequestOptions,
-  ): Promise<components.OnrampCreate> {
-    return unwrapAsync(onrampOnrampCreate(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Get the status of a fiat on-ramp payment
-   *
-   * @remarks
-   * Get the current status of a fiat on-ramp payment.
-   *
-   * Poll this after `create` until `status` is `delivered`. The `status` field
-   * is one of:
-   *
-   * - `pending` — awaiting the card payment in the hosted checkout.
-   * - `processing` — payment received; bridging/swapping the proceeds to USDC.
-   * - `delivered` — USDC has been delivered to the destination wallet
-   *   (`delivery_tx_hash` and `output_amount_delivered` are populated).
-   * - `failed` — the payment failed, expired, or was refunded.
-   *
-   * State is re-read live from the on-ramp provider on every call — Compass
-   * stores nothing of its own.
-   */
-  async onrampStatus(
-    request: operations.V2OnrampStatusRequest,
-    options?: RequestOptions,
-  ): Promise<components.OnrampStatus> {
-    return unwrapAsync(onrampOnrampStatus(
-      this,
-      request,
-      options,
-    ));
-  }
-}