@compass-labs/api-sdk 2.2.92-rc.0 → 2.2.93-rc.0

package/src/models/components/globalmarketsperpsposition.ts

@@ -1,118 +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";
-
-/**
- * Position side: 'long' or 'short'
- */
-export const GlobalMarketsPerpsPositionSide = {
-  Long: "long",
-  Short: "short",
-} as const;
-/**
- * Position side: 'long' or 'short'
- */
-export type GlobalMarketsPerpsPositionSide = ClosedEnum<
-  typeof GlobalMarketsPerpsPositionSide
->;
-
-/**
- * A single open perpetual futures position.
- */
-export type GlobalMarketsPerpsPosition = {
-  /**
-   * Asset ticker symbol
-   */
-  asset: string;
-  /**
-   * Hyperliquid asset index
-   */
-  assetId: number;
-  /**
-   * Position side: 'long' or 'short'
-   */
-  side: GlobalMarketsPerpsPositionSide;
-  /**
-   * Position size in contracts
-   */
-  size: string;
-  /**
-   * Average entry price
-   */
-  entryPrice: string;
-  /**
-   * Current mark price
-   */
-  markPrice: string;
-  /**
-   * Estimated liquidation price
-   */
-  liquidationPrice?: string | null | undefined;
-  /**
-   * Unrealized PnL in USD
-   */
-  unrealizedPnl: string;
-  /**
-   * Current leverage
-   */
-  leverage: string;
-  /**
-   * Margin used for this position in USD
-   */
-  marginUsed: string;
-  /**
-   * Cumulative funding payments (negative = paid)
-   */
-  fundingAccrued: string;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsPositionSide$inboundSchema: z.ZodNativeEnum<
-  typeof GlobalMarketsPerpsPositionSide
-> = z.nativeEnum(GlobalMarketsPerpsPositionSide);
-
-/** @internal */
-export const GlobalMarketsPerpsPosition$inboundSchema: z.ZodType<
-  GlobalMarketsPerpsPosition,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  asset: z.string(),
-  asset_id: z.number().int(),
-  side: GlobalMarketsPerpsPositionSide$inboundSchema,
-  size: z.string(),
-  entry_price: z.string(),
-  mark_price: z.string(),
-  liquidation_price: z.nullable(z.string()).optional(),
-  unrealized_pnl: z.string(),
-  leverage: z.string(),
-  margin_used: z.string(),
-  funding_accrued: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    "asset_id": "assetId",
-    "entry_price": "entryPrice",
-    "mark_price": "markPrice",
-    "liquidation_price": "liquidationPrice",
-    "unrealized_pnl": "unrealizedPnl",
-    "margin_used": "marginUsed",
-    "funding_accrued": "fundingAccrued",
-  });
-});
-
-export function globalMarketsPerpsPositionFromJSON(
-  jsonString: string,
-): SafeParseResult<GlobalMarketsPerpsPosition, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GlobalMarketsPerpsPosition$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GlobalMarketsPerpsPosition' from JSON`,
-  );
-}

package/src/models/components/globalmarketsperpspositionsresponse.ts

@@ -1,57 +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 {
-  GlobalMarketsPerpsPosition,
-  GlobalMarketsPerpsPosition$inboundSchema,
-} from "./globalmarketsperpsposition.js";
-
-/**
- * List of open global markets perps positions with account balance.
- */
-export type GlobalMarketsPerpsPositionsResponse = {
-  /**
-   * Open perpetual futures positions
-   */
-  positions: Array<GlobalMarketsPerpsPosition>;
-  /**
-   * Total account value in USD (margin + unrealized PnL)
-   */
-  accountValue?: string | undefined;
-  /**
-   * Available USDC balance (withdrawable margin)
-   */
-  withdrawable?: string | undefined;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsPositionsResponse$inboundSchema: z.ZodType<
-  GlobalMarketsPerpsPositionsResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  positions: z.array(GlobalMarketsPerpsPosition$inboundSchema),
-  account_value: z.string().optional(),
-  withdrawable: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "account_value": "accountValue",
-  });
-});
-
-export function globalMarketsPerpsPositionsResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<GlobalMarketsPerpsPositionsResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) =>
-      GlobalMarketsPerpsPositionsResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GlobalMarketsPerpsPositionsResponse' from JSON`,
-  );
-}

package/src/models/components/globalmarketsperpssetleveragerequest.ts

@@ -1,55 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-
-/**
- * Request to set leverage on a global markets perps asset.
- *
- * @remarks
- *
- * Omit ``leverage`` (or pass null) to target the asset's maximum leverage.
- */
-export type GlobalMarketsPerpsSetLeverageRequest = {
-  /**
-   * User's EOA address
-   */
-  owner: string;
-  /**
-   * Asset ticker (e.g. 'AAPL', 'CL')
-   */
-  asset: string;
-  /**
-   * Target leverage as a whole-number multiplier. Omit (or pass null) to use the asset's maximum leverage. Must be between 1 and the asset's max leverage, which is available from the /opportunities endpoint.
-   */
-  leverage?: number | null | undefined;
-};
-
-/** @internal */
-export type GlobalMarketsPerpsSetLeverageRequest$Outbound = {
-  owner: string;
-  asset: string;
-  leverage?: number | null | undefined;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsSetLeverageRequest$outboundSchema: z.ZodType<
-  GlobalMarketsPerpsSetLeverageRequest$Outbound,
-  z.ZodTypeDef,
-  GlobalMarketsPerpsSetLeverageRequest
-> = z.object({
-  owner: z.string(),
-  asset: z.string(),
-  leverage: z.nullable(z.number().int()).optional(),
-});
-
-export function globalMarketsPerpsSetLeverageRequestToJSON(
-  globalMarketsPerpsSetLeverageRequest: GlobalMarketsPerpsSetLeverageRequest,
-): string {
-  return JSON.stringify(
-    GlobalMarketsPerpsSetLeverageRequest$outboundSchema.parse(
-      globalMarketsPerpsSetLeverageRequest,
-    ),
-  );
-}

package/src/models/components/globalmarketsperpssetleverageresponse.ts

@@ -1,64 +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";
-
-/**
- * Returned by the set_leverage endpoint.
- *
- * @remarks
- *
- * If the asset is already at the requested leverage, typed_data/action/nonce
- * are null. If not, they contain the EIP-712 payload the user must sign.
- */
-export type GlobalMarketsPerpsSetLeverageResponse = {
-  /**
-   * True if leverage already matches the requested value, false if an update is needed
-   */
-  leverageOk: boolean;
-  /**
-   * EIP-712 typed data for wallet signing, or null if no change is needed
-   */
-  typedData?: { [k: string]: any } | null | undefined;
-  /**
-   * Raw Hyperliquid action (passed back to the execute endpoint), or null
-   */
-  action?: { [k: string]: any } | null | undefined;
-  /**
-   * Timestamp-based nonce, or null if no action needed
-   */
-  nonce?: number | null | undefined;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsSetLeverageResponse$inboundSchema: z.ZodType<
-  GlobalMarketsPerpsSetLeverageResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  leverage_ok: z.boolean(),
-  typed_data: z.nullable(z.record(z.any())).optional(),
-  action: z.nullable(z.record(z.any())).optional(),
-  nonce: z.nullable(z.number().int()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "leverage_ok": "leverageOk",
-    "typed_data": "typedData",
-  });
-});
-
-export function globalMarketsPerpsSetLeverageResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<GlobalMarketsPerpsSetLeverageResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) =>
-      GlobalMarketsPerpsSetLeverageResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GlobalMarketsPerpsSetLeverageResponse' from JSON`,
-  );
-}

package/src/models/components/globalmarketsperpssignableactionresponse.ts

@@ -1,58 +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";
-
-/**
- * Returned by prepare endpoints — contains EIP-712 typed data for the user to sign.
- */
-export type GlobalMarketsPerpsSignableActionResponse = {
-  /**
-   * EIP-712 typed data for wallet signing (domain, types, primaryType, message)
-   */
-  typedData: { [k: string]: any };
-  /**
-   * Raw Hyperliquid action (passed back to the execute endpoint)
-   */
-  action: { [k: string]: any };
-  /**
-   * Timestamp-based nonce used during signing
-   */
-  nonce: number;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsSignableActionResponse$inboundSchema: z.ZodType<
-  GlobalMarketsPerpsSignableActionResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  typed_data: z.record(z.any()),
-  action: z.record(z.any()),
-  nonce: z.number().int(),
-}).transform((v) => {
-  return remap$(v, {
-    "typed_data": "typedData",
-  });
-});
-
-export function globalMarketsPerpsSignableActionResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<
-  GlobalMarketsPerpsSignableActionResponse,
-  SDKValidationError
-> {
-  return safeParse(
-    jsonString,
-    (x) =>
-      GlobalMarketsPerpsSignableActionResponse$inboundSchema.parse(
-        JSON.parse(x),
-      ),
-    `Failed to parse 'GlobalMarketsPerpsSignableActionResponse' from JSON`,
-  );
-}

package/src/models/components/globalmarketsperpswithdrawrequest.ts

@@ -1,51 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-
-/**
- * Request to withdraw USDC from HyperEVM global markets perps account to Arbitrum.
- */
-export type GlobalMarketsPerpsWithdrawRequest = {
-  /**
-   * The user's EOA address (owner of the global markets perps account)
-   */
-  owner: string;
-  /**
-   * USDC amount to withdraw (human-readable, e.g. '500.0')
-   */
-  amount: string;
-  /**
-   * Arbitrum destination address (defaults to owner if not specified)
-   */
-  destination?: string | null | undefined;
-};
-
-/** @internal */
-export type GlobalMarketsPerpsWithdrawRequest$Outbound = {
-  owner: string;
-  amount: string;
-  destination?: string | null | undefined;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsWithdrawRequest$outboundSchema: z.ZodType<
-  GlobalMarketsPerpsWithdrawRequest$Outbound,
-  z.ZodTypeDef,
-  GlobalMarketsPerpsWithdrawRequest
-> = z.object({
-  owner: z.string(),
-  amount: z.string(),
-  destination: z.nullable(z.string()).optional(),
-});
-
-export function globalMarketsPerpsWithdrawRequestToJSON(
-  globalMarketsPerpsWithdrawRequest: GlobalMarketsPerpsWithdrawRequest,
-): string {
-  return JSON.stringify(
-    GlobalMarketsPerpsWithdrawRequest$outboundSchema.parse(
-      globalMarketsPerpsWithdrawRequest,
-    ),
-  );
-}

package/src/models/operations/v2globalmarketsperpsactivity.ts

@@ -1,42 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-
-export type V2GlobalMarketsPerpsActivityRequest = {
-  /**
-   * End-user EOA whose activity should be fetched.
-   */
-  owner: string;
-  /**
-   * Optional builder address. When provided, the response includes the current builder-fee approval state for this (owner, builder) pair.
-   */
-  builder?: string | null | undefined;
-};
-
-/** @internal */
-export type V2GlobalMarketsPerpsActivityRequest$Outbound = {
-  owner: string;
-  builder?: string | null | undefined;
-};
-
-/** @internal */
-export const V2GlobalMarketsPerpsActivityRequest$outboundSchema: z.ZodType<
-  V2GlobalMarketsPerpsActivityRequest$Outbound,
-  z.ZodTypeDef,
-  V2GlobalMarketsPerpsActivityRequest
-> = z.object({
-  owner: z.string(),
-  builder: z.nullable(z.string()).optional(),
-});
-
-export function v2GlobalMarketsPerpsActivityRequestToJSON(
-  v2GlobalMarketsPerpsActivityRequest: V2GlobalMarketsPerpsActivityRequest,
-): string {
-  return JSON.stringify(
-    V2GlobalMarketsPerpsActivityRequest$outboundSchema.parse(
-      v2GlobalMarketsPerpsActivityRequest,
-    ),
-  );
-}

package/src/models/operations/v2globalmarketsperpscandles.ts

@@ -1,89 +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 { ClosedEnum } from "../../types/enums.js";
-
-/**
- * Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w
- */
-export const CandleInterval = {
-  Onem: "1m",
-  Fivem: "5m",
-  Fifteenm: "15m",
-  Oneh: "1h",
-  Fourh: "4h",
-  Oned: "1d",
-  Onew: "1w",
-} as const;
-/**
- * Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w
- */
-export type CandleInterval = ClosedEnum<typeof CandleInterval>;
-
-export type V2GlobalMarketsPerpsCandlesRequest = {
-  /**
-   * Asset ticker (e.g. AAPL, GOLD, EUR). The xyz: HIP-3 DEX prefix is added server-side if not already present.
-   */
-  symbol: string;
-  /**
-   * Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w
-   */
-  interval: CandleInterval;
-  /**
-   * Number of candles to return (max 5000, capped by Hyperliquid).
-   */
-  limit?: number | undefined;
-  /**
-   * Optional start of the candle window in unix milliseconds. If omitted, computed as end_time - limit * interval.
-   */
-  startTime?: number | null | undefined;
-  /**
-   * Optional end of the candle window in unix milliseconds. Defaults to now.
-   */
-  endTime?: number | null | undefined;
-};
-
-/** @internal */
-export const CandleInterval$outboundSchema: z.ZodNativeEnum<
-  typeof CandleInterval
-> = z.nativeEnum(CandleInterval);
-
-/** @internal */
-export type V2GlobalMarketsPerpsCandlesRequest$Outbound = {
-  symbol: string;
-  interval: string;
-  limit?: number | undefined;
-  start_time?: number | null | undefined;
-  end_time?: number | null | undefined;
-};
-
-/** @internal */
-export const V2GlobalMarketsPerpsCandlesRequest$outboundSchema: z.ZodType<
-  V2GlobalMarketsPerpsCandlesRequest$Outbound,
-  z.ZodTypeDef,
-  V2GlobalMarketsPerpsCandlesRequest
-> = z.object({
-  symbol: z.string(),
-  interval: CandleInterval$outboundSchema,
-  limit: z.number().int().optional(),
-  startTime: z.nullable(z.number().int()).optional(),
-  endTime: z.nullable(z.number().int()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    startTime: "start_time",
-    endTime: "end_time",
-  });
-});
-
-export function v2GlobalMarketsPerpsCandlesRequestToJSON(
-  v2GlobalMarketsPerpsCandlesRequest: V2GlobalMarketsPerpsCandlesRequest,
-): string {
-  return JSON.stringify(
-    V2GlobalMarketsPerpsCandlesRequest$outboundSchema.parse(
-      v2GlobalMarketsPerpsCandlesRequest,
-    ),
-  );
-}

package/src/models/operations/v2globalmarketsperpsopportunities.ts

@@ -1,111 +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 { ClosedEnum } from "../../types/enums.js";
-import * as components from "../components/index.js";
-
-/**
- * Sort results by this field
- */
-export const GlobalMarketsPerpsSortBy = {
-  OpenInterest: "open_interest",
-  Volume24h: "volume_24h",
-  FundingRate: "funding_rate",
-} as const;
-/**
- * Sort results by this field
- */
-export type GlobalMarketsPerpsSortBy = ClosedEnum<
-  typeof GlobalMarketsPerpsSortBy
->;
-
-/**
- * Sort direction
- */
-export const GlobalMarketsPerpsSortOrder = {
-  Asc: "asc",
-  Desc: "desc",
-} as const;
-/**
- * Sort direction
- */
-export type GlobalMarketsPerpsSortOrder = ClosedEnum<
-  typeof GlobalMarketsPerpsSortOrder
->;
-
-export type V2GlobalMarketsPerpsOpportunitiesRequest = {
-  /**
-   * Filter by minimum open interest in USD
-   */
-  minOpenInterest?: number | null | undefined;
-  /**
-   * Filter by minimum 24h volume in USD
-   */
-  minVolume24h?: number | null | undefined;
-  /**
-   * Filter by asset category: stock, commodity, forex
-   */
-  category?: components.GlobalMarketsPerpsCategory | null | undefined;
-  /**
-   * Sort results by this field
-   */
-  sortBy?: GlobalMarketsPerpsSortBy | undefined;
-  /**
-   * Sort direction
-   */
-  sortOrder?: GlobalMarketsPerpsSortOrder | undefined;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsSortBy$outboundSchema: z.ZodNativeEnum<
-  typeof GlobalMarketsPerpsSortBy
-> = z.nativeEnum(GlobalMarketsPerpsSortBy);
-
-/** @internal */
-export const GlobalMarketsPerpsSortOrder$outboundSchema: z.ZodNativeEnum<
-  typeof GlobalMarketsPerpsSortOrder
-> = z.nativeEnum(GlobalMarketsPerpsSortOrder);
-
-/** @internal */
-export type V2GlobalMarketsPerpsOpportunitiesRequest$Outbound = {
-  min_open_interest?: number | null | undefined;
-  min_volume_24h?: number | null | undefined;
-  category?: string | null | undefined;
-  sort_by?: string | undefined;
-  sort_order?: string | undefined;
-};
-
-/** @internal */
-export const V2GlobalMarketsPerpsOpportunitiesRequest$outboundSchema: z.ZodType<
-  V2GlobalMarketsPerpsOpportunitiesRequest$Outbound,
-  z.ZodTypeDef,
-  V2GlobalMarketsPerpsOpportunitiesRequest
-> = z.object({
-  minOpenInterest: z.nullable(z.number()).optional(),
-  minVolume24h: z.nullable(z.number()).optional(),
-  category: z.nullable(components.GlobalMarketsPerpsCategory$outboundSchema)
-    .optional(),
-  sortBy: GlobalMarketsPerpsSortBy$outboundSchema.optional(),
-  sortOrder: GlobalMarketsPerpsSortOrder$outboundSchema.optional(),
-}).transform((v) => {
-  return remap$(v, {
-    minOpenInterest: "min_open_interest",
-    minVolume24h: "min_volume_24h",
-    sortBy: "sort_by",
-    sortOrder: "sort_order",
-  });
-});
-
-export function v2GlobalMarketsPerpsOpportunitiesRequestToJSON(
-  v2GlobalMarketsPerpsOpportunitiesRequest:
-    V2GlobalMarketsPerpsOpportunitiesRequest,
-): string {
-  return JSON.stringify(
-    V2GlobalMarketsPerpsOpportunitiesRequest$outboundSchema.parse(
-      v2GlobalMarketsPerpsOpportunitiesRequest,
-    ),
-  );
-}

package/src/models/operations/v2globalmarketsperpspositions.ts

@@ -1,42 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-
-export type V2GlobalMarketsPerpsPositionsRequest = {
-  /**
-   * User's EOA address (looks up their global markets perps product account)
-   */
-  owner: string;
-  /**
-   * Filter to a specific asset ticker (e.g. AAPL)
-   */
-  asset?: string | null | undefined;
-};
-
-/** @internal */
-export type V2GlobalMarketsPerpsPositionsRequest$Outbound = {
-  owner: string;
-  asset?: string | null | undefined;
-};
-
-/** @internal */
-export const V2GlobalMarketsPerpsPositionsRequest$outboundSchema: z.ZodType<
-  V2GlobalMarketsPerpsPositionsRequest$Outbound,
-  z.ZodTypeDef,
-  V2GlobalMarketsPerpsPositionsRequest
-> = z.object({
-  owner: z.string(),
-  asset: z.nullable(z.string()).optional(),
-});
-
-export function v2GlobalMarketsPerpsPositionsRequestToJSON(
-  v2GlobalMarketsPerpsPositionsRequest: V2GlobalMarketsPerpsPositionsRequest,
-): string {
-  return JSON.stringify(
-    V2GlobalMarketsPerpsPositionsRequest$outboundSchema.parse(
-      v2GlobalMarketsPerpsPositionsRequest,
-    ),
-  );
-}