@compass-labs/api-sdk 2.2.70-rc.0 → 2.2.70

package/src/funcs/onrampOnrampCreate.ts

@@ -0,0 +1,192 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } 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 * as components from "../models/components/index.js";
+import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function onrampOnrampCreate(
+  client: CompassApiSDKCore,
+  request: components.OnrampCreateRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.OnrampCreate,
+    | errors.OnrampErrorResponse
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.OnrampCreateRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.OnrampCreate,
+      | errors.OnrampErrorResponse
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.OnrampCreateRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/onramp/create")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "v2_onramp_create",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    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<
+    components.OnrampCreate,
+    | errors.OnrampErrorResponse
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.OnrampCreate$inboundSchema),
+    M.jsonErr([400, 402, 410, 422], errors.OnrampErrorResponse$inboundSchema),
+    M.jsonErr(502, errors.OnrampErrorResponse$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 }];
+}

package/src/funcs/onrampOnrampQuote.ts

@@ -0,0 +1,181 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } 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 * as components from "../models/components/index.js";
+import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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`.
+ */
+export function onrampOnrampQuote(
+  client: CompassApiSDKCore,
+  request: components.OnrampQuoteRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.OnrampQuote,
+    | errors.OnrampErrorResponse
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.OnrampQuoteRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.OnrampQuote,
+      | errors.OnrampErrorResponse
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.OnrampQuoteRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/onramp/quote")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "v2_onramp_quote",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    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<
+    components.OnrampQuote,
+    | errors.OnrampErrorResponse
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.OnrampQuote$inboundSchema),
+    M.jsonErr([400, 422], errors.OnrampErrorResponse$inboundSchema),
+    M.jsonErr(502, errors.OnrampErrorResponse$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 }];
+}

package/src/funcs/onrampOnrampStatus.ts

@@ -0,0 +1,189 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeFormQuery } 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 * as components from "../models/components/index.js";
+import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function onrampOnrampStatus(
+  client: CompassApiSDKCore,
+  request: operations.V2OnrampStatusRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.OnrampStatus,
+    | errors.OnrampErrorResponse
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.V2OnrampStatusRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.OnrampStatus,
+      | errors.OnrampErrorResponse
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.V2OnrampStatusRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v2/onramp/status")();
+
+  const query = encodeFormQuery({
+    "payment_id": payload.payment_id,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "v2_onramp_status",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    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<
+    components.OnrampStatus,
+    | errors.OnrampErrorResponse
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.OnrampStatus$inboundSchema),
+    M.jsonErr([404, 422], errors.OnrampErrorResponse$inboundSchema),
+    M.jsonErr(502, errors.OnrampErrorResponse$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 }];
+}

package/src/lib/config.ts

@@ -62,7 +62,7 @@ export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
   sdkVersion: "2.0.0",
-  genVersion: "2.911.3",
+  genVersion: "2.912.1",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.911.3 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.912.1 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/models/components/index.ts

@@ -216,6 +216,12 @@ export * from "./odosswaprequest.js";
 export * from "./odostransactionresponse.js";
 export * from "./ohlccandle.js";
 export * from "./oneinchswapparams.js";
+export * from "./onrampcreate.js";
+export * from "./onrampcreaterequest.js";
+export * from "./onrampfees.js";
+export * from "./onrampquote.js";
+export * from "./onrampquoterequest.js";
+export * from "./onrampstatus.js";
 export * from "./openposition.js";
 export * from "./operationtype.js";
 export * from "./orderstatus.js";

package/src/models/components/onrampcreate.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { OnrampQuote, OnrampQuote$inboundSchema } from "./onrampquote.js";
+
+/**
+ * Initial lifecycle state (typically `pending`).
+ */
+export const OnrampCreateStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Delivered: "delivered",
+  Failed: "failed",
+} as const;
+/**
+ * Initial lifecycle state (typically `pending`).
+ */
+export type OnrampCreateStatus = ClosedEnum<typeof OnrampCreateStatus>;
+
+/**
+ * A created on-ramp payment, with the browser-handoff affordances.
+ *
+ * @remarks
+ *
+ * The caller (CLI / MCP agent / UI) presents ``checkout_url`` to the user to
+ * pay by card and complete identity verification, then polls
+ * ``GET /v2/onramp/status`` until ``status`` is ``delivered``.
+ */
+export type OnrampCreate = {
+  /**
+   * Halliday's payment id. Use it to poll status.
+   */
+  paymentId: string;
+  /**
+   * The one-time-wallet (OTW) deposit address for this payment, owned solely by the user's wallet (non-custodial).
+   */
+  depositAddress: string;
+  /**
+   * Compass-hosted checkout page to open in a browser. It renders the card + identity-verification flow and delivers USDC to the destination wallet.
+   */
+  checkoutUrl: string;
+  /**
+   * Short, agent-actionable guidance: open the checkout link, pay, then poll status until delivered.
+   */
+  userInstructions: string;
+  /**
+   * Initial lifecycle state (typically `pending`).
+   */
+  status: OnrampCreateStatus;
+  /**
+   * An indicative fiat -> USDC-on-Ethereum quote.
+   */
+  quote: OnrampQuote;
+};
+
+/** @internal */
+export const OnrampCreateStatus$inboundSchema: z.ZodNativeEnum<
+  typeof OnrampCreateStatus
+> = z.nativeEnum(OnrampCreateStatus);
+
+/** @internal */
+export const OnrampCreate$inboundSchema: z.ZodType<
+  OnrampCreate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  payment_id: z.string(),
+  deposit_address: z.string(),
+  checkout_url: z.string(),
+  user_instructions: z.string(),
+  status: OnrampCreateStatus$inboundSchema,
+  quote: OnrampQuote$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "payment_id": "paymentId",
+    "deposit_address": "depositAddress",
+    "checkout_url": "checkoutUrl",
+    "user_instructions": "userInstructions",
+  });
+});
+
+export function onrampCreateFromJSON(
+  jsonString: string,
+): SafeParseResult<OnrampCreate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OnrampCreate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OnrampCreate' from JSON`,
+  );
+}