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

package/src/funcs/onrampOnrampStatus.ts

@@ -1,189 +0,0 @@
-/*
- * 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/models/components/onrampcreate.ts

@@ -1,97 +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";
-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`,
-  );
-}

package/src/models/components/onrampcreaterequest.ts

@@ -1,70 +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";
-
-/**
- * Create a fiat on-ramp payment delivering USDC on Ethereum.
- *
- * @remarks
- *
- * Carries the same fields as the quote (a quote is implicit — we do not
- * persist a quote handle). ``quote_id`` is optional and only echoed upstream
- * if Halliday's ``/payments/confirm`` requires a previously-issued quote
- * handle; omit it to confirm against a fresh quote.
- */
-export type OnrampCreateRequest = {
-  /**
-   * Amount of fiat to spend, as a decimal string (e.g. `100`).
-   */
-  fiatAmount: string;
-  /**
-   * ISO-4217 fiat currency code. Defaults to `USD`.
-   */
-  fiatCurrency?: string | undefined;
-  /**
-   * The wallet that will receive the USDC on Ethereum. Funds are delivered here directly — Compass never holds them.
-   */
-  destinationAddress: string;
-  /**
-   * Optional Halliday quote handle to confirm against. Omit to confirm against a fresh quote derived from the amount and currency.
-   */
-  quoteId?: string | null | undefined;
-};
-
-/** @internal */
-export type OnrampCreateRequest$Outbound = {
-  fiat_amount: string;
-  fiat_currency?: string | undefined;
-  destination_address: string;
-  quote_id?: string | null | undefined;
-};
-
-/** @internal */
-export const OnrampCreateRequest$outboundSchema: z.ZodType<
-  OnrampCreateRequest$Outbound,
-  z.ZodTypeDef,
-  OnrampCreateRequest
-> = z.object({
-  fiatAmount: z.string(),
-  fiatCurrency: z.string().optional(),
-  destinationAddress: z.string(),
-  quoteId: z.nullable(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    fiatAmount: "fiat_amount",
-    fiatCurrency: "fiat_currency",
-    destinationAddress: "destination_address",
-    quoteId: "quote_id",
-  });
-});
-
-export function onrampCreateRequestToJSON(
-  onrampCreateRequest: OnrampCreateRequest,
-): string {
-  return JSON.stringify(
-    OnrampCreateRequest$outboundSchema.parse(onrampCreateRequest),
-  );
-}

package/src/models/components/onrampfees.ts

@@ -1,59 +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";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-/**
- * Fee breakdown for an on-ramp quote.
- *
- * @remarks
- *
- * ``business_fees`` is a fixed ``"0"`` for now — monetization is a single
- * future lever and is intentionally not charged.
- */
-export type OnrampFees = {
-  /**
-   * Fee charged by the on-ramp provider, in fiat.
-   */
-  providerFee: string;
-  /**
-   * Estimated network/gas fee, in fiat.
-   */
-  networkFee: string;
-  /**
-   * Compass business fee, in fiat. Always `0` for now.
-   */
-  businessFees?: string | undefined;
-};
-
-/** @internal */
-export const OnrampFees$inboundSchema: z.ZodType<
-  OnrampFees,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  provider_fee: z.string(),
-  network_fee: z.string(),
-  business_fees: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "provider_fee": "providerFee",
-    "network_fee": "networkFee",
-    "business_fees": "businessFees",
-  });
-});
-
-export function onrampFeesFromJSON(
-  jsonString: string,
-): SafeParseResult<OnrampFees, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => OnrampFees$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'OnrampFees' from JSON`,
-  );
-}

package/src/models/components/onrampquote.ts

@@ -1,101 +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";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import { OnrampFees, OnrampFees$inboundSchema } from "./onrampfees.js";
-
-/**
- * An indicative fiat -> USDC-on-Ethereum quote.
- */
-export type OnrampQuote = {
-  /**
-   * Fiat amount to spend.
-   */
-  fiatAmount: string;
-  /**
-   * ISO-4217 fiat currency code.
-   */
-  fiatCurrency: string;
-  /**
-   * Estimated USDC delivered, human-readable (6-decimal token).
-   */
-  outputAmount: string;
-  /**
-   * Delivered asset. Always USDC for this on-ramp.
-   */
-  outputAsset?: "USDC" | undefined;
-  /**
-   * Delivery chain. Always Ethereum for this on-ramp.
-   */
-  outputChain?: "ethereum" | undefined;
-  /**
-   * USDC received per unit of fiat.
-   */
-  exchangeRate: string;
-  /**
-   * Fee breakdown for an on-ramp quote.
-   *
-   * @remarks
-   *
-   * ``business_fees`` is a fixed ``"0"`` for now — monetization is a single
-   * future lever and is intentionally not charged.
-   */
-  fees: OnrampFees;
-  /**
-   * Minimum fiat amount accepted, if advertised by the provider.
-   */
-  minAmount?: string | null | undefined;
-  /**
-   * Maximum fiat amount accepted, if advertised by the provider.
-   */
-  maxAmount?: string | null | undefined;
-  /**
-   * ISO-8601 timestamp after which this quote is stale, if any.
-   */
-  expiresAt?: string | null | undefined;
-};
-
-/** @internal */
-export const OnrampQuote$inboundSchema: z.ZodType<
-  OnrampQuote,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  fiat_amount: z.string(),
-  fiat_currency: z.string(),
-  output_amount: z.string(),
-  output_asset: z.literal("USDC").optional(),
-  output_chain: z.literal("ethereum").optional(),
-  exchange_rate: z.string(),
-  fees: OnrampFees$inboundSchema,
-  min_amount: z.nullable(z.string()).optional(),
-  max_amount: z.nullable(z.string()).optional(),
-  expires_at: z.nullable(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "fiat_amount": "fiatAmount",
-    "fiat_currency": "fiatCurrency",
-    "output_amount": "outputAmount",
-    "output_asset": "outputAsset",
-    "output_chain": "outputChain",
-    "exchange_rate": "exchangeRate",
-    "min_amount": "minAmount",
-    "max_amount": "maxAmount",
-    "expires_at": "expiresAt",
-  });
-});
-
-export function onrampQuoteFromJSON(
-  jsonString: string,
-): SafeParseResult<OnrampQuote, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => OnrampQuote$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'OnrampQuote' from JSON`,
-  );
-}

package/src/models/components/onrampquoterequest.ts

@@ -1,62 +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";
-
-/**
- * An indicative fiat -> USDC-on-Ethereum quote request.
- *
- * @remarks
- *
- * The output asset and chain are fixed to USDC on Ethereum and are not
- * user-supplied — this product group delivers only USDC to the user's own
- * wallet (non-custodial).
- */
-export type OnrampQuoteRequest = {
-  /**
-   * Amount of fiat to spend, as a decimal string (e.g. `100`).
-   */
-  fiatAmount: string;
-  /**
-   * ISO-4217 fiat currency code. Defaults to `USD`.
-   */
-  fiatCurrency?: string | undefined;
-  /**
-   * The wallet that will receive the USDC on Ethereum. Funds are delivered here directly — Compass never holds them.
-   */
-  destinationAddress: string;
-};
-
-/** @internal */
-export type OnrampQuoteRequest$Outbound = {
-  fiat_amount: string;
-  fiat_currency?: string | undefined;
-  destination_address: string;
-};
-
-/** @internal */
-export const OnrampQuoteRequest$outboundSchema: z.ZodType<
-  OnrampQuoteRequest$Outbound,
-  z.ZodTypeDef,
-  OnrampQuoteRequest
-> = z.object({
-  fiatAmount: z.string(),
-  fiatCurrency: z.string().optional(),
-  destinationAddress: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    fiatAmount: "fiat_amount",
-    fiatCurrency: "fiat_currency",
-    destinationAddress: "destination_address",
-  });
-});
-
-export function onrampQuoteRequestToJSON(
-  onrampQuoteRequest: OnrampQuoteRequest,
-): string {
-  return JSON.stringify(
-    OnrampQuoteRequest$outboundSchema.parse(onrampQuoteRequest),
-  );
-}

package/src/models/components/onrampstatus.ts

@@ -1,96 +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";
-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";
-
-/**
- * Lifecycle state: `pending` (awaiting card payment), `processing` (payment received, bridging/swapping to USDC), `delivered` (USDC received in the destination wallet), or `failed`.
- */
-export const OnrampStatusStatus = {
-  Pending: "pending",
-  Processing: "processing",
-  Delivered: "delivered",
-  Failed: "failed",
-} as const;
-/**
- * Lifecycle state: `pending` (awaiting card payment), `processing` (payment received, bridging/swapping to USDC), `delivered` (USDC received in the destination wallet), or `failed`.
- */
-export type OnrampStatusStatus = ClosedEnum<typeof OnrampStatusStatus>;
-
-/**
- * Current state of a fiat on-ramp payment.
- *
- * @remarks
- *
- * Re-read on demand from Halliday (the system of record) — Compass holds no
- * state of its own.
- */
-export type OnrampStatus = {
-  /**
-   * Halliday's payment id, echoed straight through.
-   */
-  paymentId: string;
-  /**
-   * Lifecycle state: `pending` (awaiting card payment), `processing` (payment received, bridging/swapping to USDC), `delivered` (USDC received in the destination wallet), or `failed`.
-   */
-  status: OnrampStatusStatus;
-  /**
-   * USDC delivered so far, human-readable. Set once delivered.
-   */
-  outputAmountDelivered?: string | null | undefined;
-  /**
-   * Ethereum tx hash of the USDC delivery, once available.
-   */
-  deliveryTxHash?: string | null | undefined;
-  /**
-   * The wallet the USDC is delivered to.
-   */
-  destinationAddress?: string | null | undefined;
-  /**
-   * ISO-8601 timestamp of the last status change, if provided.
-   */
-  updatedAt?: string | null | undefined;
-};
-
-/** @internal */
-export const OnrampStatusStatus$inboundSchema: z.ZodNativeEnum<
-  typeof OnrampStatusStatus
-> = z.nativeEnum(OnrampStatusStatus);
-
-/** @internal */
-export const OnrampStatus$inboundSchema: z.ZodType<
-  OnrampStatus,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  payment_id: z.string(),
-  status: OnrampStatusStatus$inboundSchema,
-  output_amount_delivered: z.nullable(z.string()).optional(),
-  delivery_tx_hash: z.nullable(z.string()).optional(),
-  destination_address: z.nullable(z.string()).optional(),
-  updated_at: z.nullable(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "payment_id": "paymentId",
-    "output_amount_delivered": "outputAmountDelivered",
-    "delivery_tx_hash": "deliveryTxHash",
-    "destination_address": "destinationAddress",
-    "updated_at": "updatedAt",
-  });
-});
-
-export function onrampStatusFromJSON(
-  jsonString: string,
-): SafeParseResult<OnrampStatus, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => OnrampStatus$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'OnrampStatus' from JSON`,
-  );
-}