@compass-labs/api-sdk 2.2.66 → 2.2.67-rc.0

package/src/funcs/tokenizedAssetsTokenizedAssetsBalances.ts

@@ -0,0 +1,184 @@
+/*
+ * 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 tokenized-asset account balances + transfer history
+ *
+ * @remarks
+ * Get the full token ledger for a Tokenized Assets Account.
+ *
+ * Returns every token the account has transferred — current balances plus
+ * complete transfer history — keyed by symbol. Unlike `/positions` (current
+ * equity holdings, priced), this includes **USDC funding** movements and
+ * **fully-sold positions** (zero balance), making it the account's cash +
+ * activity ledger. Pass `chain=base` for Base holdings.
+ */
+export function tokenizedAssetsTokenizedAssetsBalances(
+  client: CompassApiSDKCore,
+  request: operations.V2TokenizedAssetsBalancesRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.TokenizedAssetsBalancesResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.V2TokenizedAssetsBalancesRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.TokenizedAssetsBalancesResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.V2TokenizedAssetsBalancesRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v2/tokenized_assets/balances")();
+
+  const query = encodeFormQuery({
+    "chain": payload.chain,
+    "owner": payload.owner,
+  });
+
+  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_tokenized_assets_balances",
+    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.TokenizedAssetsBalancesResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.TokenizedAssetsBalancesResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$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.910.1",
+  genVersion: "2.911.0",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.910.1 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.911.0 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.ts

@@ -16,6 +16,10 @@ import {
   TokenizedAssetProvider,
   TokenizedAssetProvider$inboundSchema,
 } from "./tokenizedassetprovider.js";
+import {
+  TokenizedAssetsActivityEvent,
+  TokenizedAssetsActivityEvent$inboundSchema,
+} from "./tokenizedassetsactivityevent.js";
 import {
   TokenizedAssetsPnl,
   TokenizedAssetsPnl$inboundSchema,
@@ -80,6 +84,10 @@ export type CompassApiBackendV2ModelsTokenizedAssetsReadResponsePositionsPositio
      * Realized + unrealized PnL for this position, or `null` when it cannot be priced (no current price, or externally-funded inventory with no on-chain cost basis).
      */
     pnl?: TokenizedAssetsPnl | null | undefined;
+    /**
+     * Chronological activity for this position (buy / sell / transfer_in / transfer_out). Pure-USDC funding is excluded — it appears on the balances endpoint.
+     */
+    events?: Array<TokenizedAssetsActivityEvent> | undefined;
   };
 
 /** @internal */
@@ -101,6 +109,7 @@ export const CompassApiBackendV2ModelsTokenizedAssetsReadResponsePositionsPositi
     asset_class: TokenizedAssetClass$inboundSchema.optional(),
     chain: Chain$inboundSchema.optional(),
     pnl: z.nullable(TokenizedAssetsPnl$inboundSchema).optional(),
+    events: z.array(TokenizedAssetsActivityEvent$inboundSchema).optional(),
   }).transform((v) => {
     return remap$(v, {
       "underlying_ticker": "underlyingTicker",

package/src/models/components/creditevent.ts

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * Type of credit event.
  */
-export const EventType = {
+export const CreditEventEventType = {
   Supply: "supply",
   Withdraw: "withdraw",
   Borrow: "borrow",
@@ -24,7 +24,7 @@ export const EventType = {
 /**
  * Type of credit event.
  */
-export type EventType = ClosedEnum<typeof EventType>;
+export type CreditEventEventType = ClosedEnum<typeof CreditEventEventType>;
 
 /**
  * A single historical event in a credit position.
@@ -33,7 +33,7 @@ export type CreditEvent = {
   /**
    * Type of credit event.
    */
-  eventType: EventType;
+  eventType: CreditEventEventType;
   /**
    * Block number when the event occurred
    */
@@ -57,8 +57,9 @@ export type CreditEvent = {
 };
 
 /** @internal */
-export const EventType$inboundSchema: z.ZodNativeEnum<typeof EventType> = z
-  .nativeEnum(EventType);
+export const CreditEventEventType$inboundSchema: z.ZodNativeEnum<
+  typeof CreditEventEventType
+> = z.nativeEnum(CreditEventEventType);
 
 /** @internal */
 export const CreditEvent$inboundSchema: z.ZodType<
@@ -66,7 +67,7 @@ export const CreditEvent$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  event_type: EventType$inboundSchema,
+  event_type: CreditEventEventType$inboundSchema,
   block_number: z.number().int(),
   block_timestamp: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)

package/src/models/components/index.ts

@@ -287,6 +287,8 @@ export * from "./tokenbalanceresponse.js";
 export * from "./tokenconfig.js";
 export * from "./tokenizedassetclass.js";
 export * from "./tokenizedassetprovider.js";
+export * from "./tokenizedassetsactivityevent.js";
+export * from "./tokenizedassetsbalancesresponse.js";
 export * from "./tokenizedassetsbuildorderrequest.js";
 export * from "./tokenizedassetsbuildorderresponse.js";
 export * from "./tokenizedassetscancelorderrequest.js";

package/src/models/components/tokenizedassetsactivityevent.ts

@@ -0,0 +1,132 @@
+/*
+ * 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";
+
+/**
+ * Kind of activity for this transaction.
+ */
+export const TokenizedAssetsActivityEventEventType = {
+  Buy: "buy",
+  Sell: "sell",
+  TransferIn: "transfer_in",
+  TransferOut: "transfer_out",
+} as const;
+/**
+ * Kind of activity for this transaction.
+ */
+export type TokenizedAssetsActivityEventEventType = ClosedEnum<
+  typeof TokenizedAssetsActivityEventEventType
+>;
+
+/**
+ * One classified activity event on a tokenized-asset position.
+ *
+ * @remarks
+ *
+ * Mirrors Earn's deposit/withdrawal event shape (generic ``input``/``output``
+ * legs) with an ``event_type`` discriminator, so buys, sells and transfers share
+ * one chronological feed. A ``buy`` has ``input`` = USDC paid and ``output`` =
+ * tokens received (``cost_per_unit`` = USDC/token); a ``sell`` is the reverse and
+ * carries ``realized_pnl``; a ``transfer_in``/``transfer_out`` carries only the
+ * token leg, so the opposite side is ``null``. All amounts are decimal strings.
+ * Pure-USDC funding movements are not position activity — they appear on the
+ * balances endpoint.
+ */
+export type TokenizedAssetsActivityEvent = {
+  /**
+   * Kind of activity for this transaction.
+   */
+  eventType: TokenizedAssetsActivityEventEventType;
+  /**
+   * Block the transaction was mined in.
+   */
+  blockNumber: number;
+  /**
+   * Time the transaction was mined.
+   */
+  blockTimestamp: Date;
+  /**
+   * Transaction hash.
+   */
+  transactionHash: string;
+  /**
+   * Amount sent: USDC for a buy, tokens for a sell/transfer_out.
+   */
+  inputAmount?: string | null | undefined;
+  /**
+   * Symbol of the sent leg, or `null` for a transfer_in.
+   */
+  inputSymbol?: string | null | undefined;
+  /**
+   * Amount received: tokens for a buy/transfer_in, USDC for a sell.
+   */
+  outputAmount?: string | null | undefined;
+  /**
+   * Symbol of the received leg, or `null` for a transfer_out.
+   */
+  outputSymbol?: string | null | undefined;
+  /**
+   * Cost basis per token at buy time; `null` for non-buys.
+   */
+  costPerUnit?: string | null | undefined;
+  /**
+   * Realized profit/loss on a sell; `null` for non-sells.
+   */
+  realizedPnl?: string | null | undefined;
+};
+
+/** @internal */
+export const TokenizedAssetsActivityEventEventType$inboundSchema:
+  z.ZodNativeEnum<typeof TokenizedAssetsActivityEventEventType> = z.nativeEnum(
+    TokenizedAssetsActivityEventEventType,
+  );
+
+/** @internal */
+export const TokenizedAssetsActivityEvent$inboundSchema: z.ZodType<
+  TokenizedAssetsActivityEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  event_type: TokenizedAssetsActivityEventEventType$inboundSchema,
+  block_number: z.number().int(),
+  block_timestamp: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  transaction_hash: z.string(),
+  input_amount: z.nullable(z.string()).optional(),
+  input_symbol: z.nullable(z.string()).optional(),
+  output_amount: z.nullable(z.string()).optional(),
+  output_symbol: z.nullable(z.string()).optional(),
+  cost_per_unit: z.nullable(z.string()).optional(),
+  realized_pnl: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "event_type": "eventType",
+    "block_number": "blockNumber",
+    "block_timestamp": "blockTimestamp",
+    "transaction_hash": "transactionHash",
+    "input_amount": "inputAmount",
+    "input_symbol": "inputSymbol",
+    "output_amount": "outputAmount",
+    "output_symbol": "outputSymbol",
+    "cost_per_unit": "costPerUnit",
+    "realized_pnl": "realizedPnl",
+  });
+});
+
+export function tokenizedAssetsActivityEventFromJSON(
+  jsonString: string,
+): SafeParseResult<TokenizedAssetsActivityEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TokenizedAssetsActivityEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TokenizedAssetsActivityEvent' from JSON`,
+  );
+}

package/src/models/components/tokenizedassetsbalancesresponse.ts

@@ -0,0 +1,70 @@
+/*
+ * 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 {
+  CompassApiBackendV2ModelsBalancesTokenBalance,
+  CompassApiBackendV2ModelsBalancesTokenBalance$inboundSchema,
+} from "./compassapibackendv2modelsbalancestokenbalance.js";
+
+/**
+ * Token balances and transfer history for a Tokenized Assets Account.
+ *
+ * @remarks
+ *
+ * Unlike `/positions` (current equity holdings only, priced), this surfaces
+ * every token the account has ever transferred — each with its full transfer
+ * history — including **USDC funding** movements and **fully-sold positions**
+ * (zero balance). It is the account's cash + activity ledger. Balances are keyed
+ * by token symbol, reusing the same `TokenBalance`/`TokenTransfer` shape as the
+ * earn and credit balances endpoints.
+ */
+export type TokenizedAssetsBalancesResponse = {
+  /**
+   * The derived Tokenized Assets Account address.
+   */
+  tokenizedAssetsAccountAddress: string;
+  /**
+   * Token balances keyed by token symbol, including USDC cash and fully-sold positions (zero balance). Each carries its transfer history.
+   */
+  balances?:
+    | { [k: string]: CompassApiBackendV2ModelsBalancesTokenBalance }
+    | undefined;
+  /**
+   * Total USD value of all priced balances.
+   */
+  totalUsdValue?: string | null | undefined;
+};
+
+/** @internal */
+export const TokenizedAssetsBalancesResponse$inboundSchema: z.ZodType<
+  TokenizedAssetsBalancesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tokenized_assets_account_address: z.string(),
+  balances: z.record(
+    CompassApiBackendV2ModelsBalancesTokenBalance$inboundSchema,
+  ).optional(),
+  total_usd_value: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "tokenized_assets_account_address": "tokenizedAssetsAccountAddress",
+    "total_usd_value": "totalUsdValue",
+  });
+});
+
+export function tokenizedAssetsBalancesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TokenizedAssetsBalancesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TokenizedAssetsBalancesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TokenizedAssetsBalancesResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -54,6 +54,7 @@ export * from "./v2globalmarketsperpsactivity.js";
 export * from "./v2globalmarketsperpscandles.js";
 export * from "./v2globalmarketsperpsopportunities.js";
 export * from "./v2globalmarketsperpspositions.js";
+export * from "./v2tokenizedassetsbalances.js";
 export * from "./v2tokenizedassetsmarkets.js";
 export * from "./v2tokenizedassetsmarketssymbol.js";
 export * from "./v2tokenizedassetsorderorderhash.js";

package/src/models/operations/v2tokenizedassetsbalances.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The chain to use.
+ */
+export const V2TokenizedAssetsBalancesChain = {
+  Base: "base",
+  Ethereum: "ethereum",
+  Arbitrum: "arbitrum",
+  Hyperevm: "hyperevm",
+  Tempo: "tempo",
+} as const;
+/**
+ * The chain to use.
+ */
+export type V2TokenizedAssetsBalancesChain = ClosedEnum<
+  typeof V2TokenizedAssetsBalancesChain
+>;
+
+export type V2TokenizedAssetsBalancesRequest = {
+  /**
+   * The address of the owner of the Tokenized Assets Account to read balances for. The account address is derived deterministically from this owner; balances are read from the derived account.
+   */
+  owner: string;
+  /**
+   * Network to read balances on (defaults to Ethereum). Equities exist on Ethereum only; RWA yield assets also exist on Base.
+   */
+  chain?: V2TokenizedAssetsBalancesChain | undefined;
+};
+
+/** @internal */
+export const V2TokenizedAssetsBalancesChain$outboundSchema: z.ZodNativeEnum<
+  typeof V2TokenizedAssetsBalancesChain
+> = z.nativeEnum(V2TokenizedAssetsBalancesChain);
+
+/** @internal */
+export type V2TokenizedAssetsBalancesRequest$Outbound = {
+  owner: string;
+  chain?: string | undefined;
+};
+
+/** @internal */
+export const V2TokenizedAssetsBalancesRequest$outboundSchema: z.ZodType<
+  V2TokenizedAssetsBalancesRequest$Outbound,
+  z.ZodTypeDef,
+  V2TokenizedAssetsBalancesRequest
+> = z.object({
+  owner: z.string(),
+  chain: V2TokenizedAssetsBalancesChain$outboundSchema.optional(),
+});
+
+export function v2TokenizedAssetsBalancesRequestToJSON(
+  v2TokenizedAssetsBalancesRequest: V2TokenizedAssetsBalancesRequest,
+): string {
+  return JSON.stringify(
+    V2TokenizedAssetsBalancesRequest$outboundSchema.parse(
+      v2TokenizedAssetsBalancesRequest,
+    ),
+  );
+}

package/src/sdk/tokenizedassets.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { tokenizedAssetsTokenizedAssetsBalances } from "../funcs/tokenizedAssetsTokenizedAssetsBalances.js";
 import { tokenizedAssetsTokenizedAssetsCreateAccount } from "../funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js";
 import { tokenizedAssetsTokenizedAssetsMarkets } from "../funcs/tokenizedAssetsTokenizedAssetsMarkets.js";
 import { tokenizedAssetsTokenizedAssetsMarketsSymbol } from "../funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js";
@@ -111,6 +112,29 @@ export class TokenizedAssets extends ClientSDK {
     ));
   }
 
+  /**
+   * Get tokenized-asset account balances + transfer history
+   *
+   * @remarks
+   * Get the full token ledger for a Tokenized Assets Account.
+   *
+   * Returns every token the account has transferred — current balances plus
+   * complete transfer history — keyed by symbol. Unlike `/positions` (current
+   * equity holdings, priced), this includes **USDC funding** movements and
+   * **fully-sold positions** (zero balance), making it the account's cash +
+   * activity ledger. Pass `chain=base` for Base holdings.
+   */
+  async tokenizedAssetsBalances(
+    request: operations.V2TokenizedAssetsBalancesRequest,
+    options?: RequestOptions,
+  ): Promise<components.TokenizedAssetsBalancesResponse> {
+    return unwrapAsync(tokenizedAssetsTokenizedAssetsBalances(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get tokenized-equity order status (Ondo)
    *