@compass-labs/api-sdk 2.2.34-rc.3 → 2.2.34-rc.4

package/src/funcs/{tradFiTradfiOpportunities.ts → traditionalInvestingTraditionalInvestingOpportunities.ts}

@@ -27,24 +27,24 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List TradFi perp markets
+ * List traditional investing perp markets
  *
  * @remarks
- * List available TradFi perpetual futures markets with key metrics.
+ * List available traditional investing perpetual futures markets with key metrics.
  *
- * Returns tradfi perp markets (stocks, commodities, forex) with open interest,
+ * Returns perp markets (stocks, commodities, forex) with open interest,
  * 24h volume, funding rate, and max leverage. Supports filtering by category,
  * minimum OI/volume, and sorting.
  *
- * Only tradfi assets are returned — crypto perps are excluded.
+ * Only traditional investing assets are returned — crypto perps are excluded.
  */
-export function tradFiTradfiOpportunities(
+export function traditionalInvestingTraditionalInvestingOpportunities(
   client: CompassApiSDKCore,
-  request: operations.V2TradfiOpportunitiesRequest,
+  request: operations.V2TraditionalInvestingOpportunitiesRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.TradFiOpportunitiesResponse,
+    components.TraditionalInvestingOpportunitiesResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -65,12 +65,12 @@ export function tradFiTradfiOpportunities(
 
 async function $do(
   client: CompassApiSDKCore,
-  request: operations.V2TradfiOpportunitiesRequest,
+  request: operations.V2TraditionalInvestingOpportunitiesRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      components.TradFiOpportunitiesResponse,
+      components.TraditionalInvestingOpportunitiesResponse,
       | errors.HTTPValidationError
       | CompassAPISDKError
       | ResponseValidationError
@@ -87,7 +87,8 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.V2TradfiOpportunitiesRequest$outboundSchema.parse(value),
+      operations.V2TraditionalInvestingOpportunitiesRequest$outboundSchema
+        .parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -96,7 +97,7 @@ async function $do(
   const payload = parsed.value;
   const body = null;
 
-  const path = pathToFunc("/v2/tradfi/opportunities")();
+  const path = pathToFunc("/v2/traditional_investing/opportunities")();
 
   const query = encodeFormQuery({
     "category": payload.category,
@@ -117,7 +118,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v2_tradfi_opportunities",
+    operationID: "v2_traditional_investing_opportunities",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -161,7 +162,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.TradFiOpportunitiesResponse,
+    components.TraditionalInvestingOpportunitiesResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -172,7 +173,10 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.TradFiOpportunitiesResponse$inboundSchema),
+    M.json(
+      200,
+      components.TraditionalInvestingOpportunitiesResponse$inboundSchema,
+    ),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/{tradFiTradfiPositions.ts → traditionalInvestingTraditionalInvestingPositions.ts}

@@ -27,24 +27,22 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List TradFi positions
+ * List traditional investing positions
  *
  * @remarks
- * List open perpetual futures positions for a user's TradFi account.
+ * List open perpetual futures positions for a user.
  *
  * Returns position data including size, entry price, mark price, PnL, liquidation price,
  * leverage, and cumulative funding. Optionally filter by asset ticker.
- *
- * Returns 404 if the user has no TradFi product account.
  * Returns an empty list if no positions are open.
  */
-export function tradFiTradfiPositions(
+export function traditionalInvestingTraditionalInvestingPositions(
   client: CompassApiSDKCore,
-  request: operations.V2TradfiPositionsRequest,
+  request: operations.V2TraditionalInvestingPositionsRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.TradFiPositionsResponse,
+    components.TraditionalInvestingPositionsResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -65,12 +63,12 @@ export function tradFiTradfiPositions(
 
 async function $do(
   client: CompassApiSDKCore,
-  request: operations.V2TradfiPositionsRequest,
+  request: operations.V2TraditionalInvestingPositionsRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      components.TradFiPositionsResponse,
+      components.TraditionalInvestingPositionsResponse,
       | errors.HTTPValidationError
       | CompassAPISDKError
       | ResponseValidationError
@@ -86,7 +84,10 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.V2TradfiPositionsRequest$outboundSchema.parse(value),
+    (value) =>
+      operations.V2TraditionalInvestingPositionsRequest$outboundSchema.parse(
+        value,
+      ),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -95,7 +96,7 @@ async function $do(
   const payload = parsed.value;
   const body = null;
 
-  const path = pathToFunc("/v2/tradfi/positions")();
+  const path = pathToFunc("/v2/traditional_investing/positions")();
 
   const query = encodeFormQuery({
     "asset": payload.asset,
@@ -113,7 +114,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v2_tradfi_positions",
+    operationID: "v2_traditional_investing_positions",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -157,7 +158,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.TradFiPositionsResponse,
+    components.TraditionalInvestingPositionsResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -168,7 +169,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.TradFiPositionsResponse$inboundSchema),
+    M.json(200, components.TraditionalInvestingPositionsResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/traditionalInvestingTraditionalInvestingWithdraw.ts

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.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";
+
+/**
+ * Withdraw USDC from traditional investments account
+ *
+ * @remarks
+ * Prepare a USDC withdrawal from Hyperliquid to Arbitrum.
+ *
+ * Returns EIP-712 typed data for the user to sign. After signing, submit
+ * the signature via the /execute endpoint. Withdrawal processing takes
+ * minutes to hours depending on bridge conditions.
+ */
+export function traditionalInvestingTraditionalInvestingWithdraw(
+  client: CompassApiSDKCore,
+  request: components.TraditionalInvestingWithdrawRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.TraditionalInvestingSignableActionResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.TraditionalInvestingWithdrawRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.TraditionalInvestingSignableActionResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.TraditionalInvestingWithdrawRequest$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/traditional_investing/withdraw")();
+
+  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_traditional_investing_withdraw",
+    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,
+    errorCodes: ["422", "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.TraditionalInvestingSignableActionResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      components.TraditionalInvestingSignableActionResponse$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.873.1",
+  genVersion: "2.879.1",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.873.1 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.879.1 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/models/components/index.ts

@@ -85,8 +85,6 @@ export * from "./createaccountrequest.js";
 export * from "./createaccountresponse.js";
 export * from "./createcreditaccountrequest.js";
 export * from "./createcreditaccountresponse.js";
-export * from "./createtradfiaccountrequest.js";
-export * from "./createtradfiaccountresponse.js";
 export * from "./creditbalancesresponse.js";
 export * from "./creditborrowparams.js";
 export * from "./creditborrowrequest.js";
@@ -244,19 +242,21 @@ export * from "./tokenpriceresponse.js";
 export * from "./tokentransfer.js";
 export * from "./tokentransferparams.js";
 export * from "./tokentransferrequest.js";
-export * from "./tradficancelorderrequest.js";
-export * from "./tradficategory.js";
-export * from "./tradfidepositrequest.js";
-export * from "./tradfidepositresponse.js";
-export * from "./tradfilimitorderrequest.js";
-export * from "./tradfimarketorderrequest.js";
-export * from "./tradfiopportunitiesresponse.js";
-export * from "./tradfiopportunity.js";
-export * from "./tradfiorderresponse.js";
-export * from "./tradfiposition.js";
-export * from "./tradfipositionsresponse.js";
-export * from "./tradfiwithdrawrequest.js";
-export * from "./tradfiwithdrawresponse.js";
+export * from "./traditionalinvestingapprovebuilderfeerequest.js";
+export * from "./traditionalinvestingcancelorderrequest.js";
+export * from "./traditionalinvestingcategory.js";
+export * from "./traditionalinvestingdepositrequest.js";
+export * from "./traditionalinvestingdepositresponse.js";
+export * from "./traditionalinvestingexecuterequest.js";
+export * from "./traditionalinvestingexecuteresponse.js";
+export * from "./traditionalinvestinglimitorderrequest.js";
+export * from "./traditionalinvestingmarketorderrequest.js";
+export * from "./traditionalinvestingopportunitiesresponse.js";
+export * from "./traditionalinvestingopportunity.js";
+export * from "./traditionalinvestingposition.js";
+export * from "./traditionalinvestingpositionsresponse.js";
+export * from "./traditionalinvestingsignableactionresponse.js";
+export * from "./traditionalinvestingwithdrawrequest.js";
 export * from "./transactionresponse.js";
 export * from "./underlyingtoken.js";
 export * from "./uniswapbuyexactlyparams.js";

package/src/models/components/traditionalinvestingapprovebuilderfeerequest.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request to approve builder fees before trading on the traditional investing DEX.
+ */
+export type TraditionalInvestingApproveBuilderFeeRequest = {
+  /**
+   * User's EOA address
+   */
+  owner: string;
+};
+
+/** @internal */
+export type TraditionalInvestingApproveBuilderFeeRequest$Outbound = {
+  owner: string;
+};
+
+/** @internal */
+export const TraditionalInvestingApproveBuilderFeeRequest$outboundSchema:
+  z.ZodType<
+    TraditionalInvestingApproveBuilderFeeRequest$Outbound,
+    z.ZodTypeDef,
+    TraditionalInvestingApproveBuilderFeeRequest
+  > = z.object({
+    owner: z.string(),
+  });
+
+export function traditionalInvestingApproveBuilderFeeRequestToJSON(
+  traditionalInvestingApproveBuilderFeeRequest:
+    TraditionalInvestingApproveBuilderFeeRequest,
+): string {
+  return JSON.stringify(
+    TraditionalInvestingApproveBuilderFeeRequest$outboundSchema.parse(
+      traditionalInvestingApproveBuilderFeeRequest,
+    ),
+  );
+}

package/src/models/components/{tradficancelorderrequest.ts → traditionalinvestingcancelorderrequest.ts}

@@ -6,11 +6,11 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 /**
- * Request to cancel an open order on a TradFi perp market.
+ * Request to cancel an open order on a traditional investing perp market.
  */
-export type TradFiCancelOrderRequest = {
+export type TraditionalInvestingCancelOrderRequest = {
   /**
-   * Owner of the TradFi product account
+   * Owner of the traditional investing product account
    */
   owner: string;
   /**
@@ -28,7 +28,7 @@ export type TradFiCancelOrderRequest = {
 };
 
 /** @internal */
-export type TradFiCancelOrderRequest$Outbound = {
+export type TraditionalInvestingCancelOrderRequest$Outbound = {
   owner: string;
   asset: string;
   order_id?: number | null | undefined;
@@ -36,10 +36,10 @@ export type TradFiCancelOrderRequest$Outbound = {
 };
 
 /** @internal */
-export const TradFiCancelOrderRequest$outboundSchema: z.ZodType<
-  TradFiCancelOrderRequest$Outbound,
+export const TraditionalInvestingCancelOrderRequest$outboundSchema: z.ZodType<
+  TraditionalInvestingCancelOrderRequest$Outbound,
   z.ZodTypeDef,
-  TradFiCancelOrderRequest
+  TraditionalInvestingCancelOrderRequest
 > = z.object({
   owner: z.string(),
   asset: z.string(),
@@ -52,10 +52,13 @@ export const TradFiCancelOrderRequest$outboundSchema: z.ZodType<
   });
 });
 
-export function tradFiCancelOrderRequestToJSON(
-  tradFiCancelOrderRequest: TradFiCancelOrderRequest,
+export function traditionalInvestingCancelOrderRequestToJSON(
+  traditionalInvestingCancelOrderRequest:
+    TraditionalInvestingCancelOrderRequest,
 ): string {
   return JSON.stringify(
-    TradFiCancelOrderRequest$outboundSchema.parse(tradFiCancelOrderRequest),
+    TraditionalInvestingCancelOrderRequest$outboundSchema.parse(
+      traditionalInvestingCancelOrderRequest,
+    ),
   );
 }

package/src/models/components/traditionalinvestingcategory.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const TraditionalInvestingCategory = {
+  Stock: "stock",
+  Commodity: "commodity",
+  Forex: "forex",
+} as const;
+export type TraditionalInvestingCategory = ClosedEnum<
+  typeof TraditionalInvestingCategory
+>;
+
+/** @internal */
+export const TraditionalInvestingCategory$outboundSchema: z.ZodNativeEnum<
+  typeof TraditionalInvestingCategory
+> = z.nativeEnum(TraditionalInvestingCategory);

package/src/models/components/traditionalinvestingdepositrequest.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request to deposit USDC from Arbitrum into the user's traditional investing account.
+ */
+export type TraditionalInvestingDepositRequest = {
+  /**
+   * The user's EOA address on Arbitrum
+   */
+  owner: string;
+  /**
+   * USDC amount to deposit (human-readable, e.g. '1000.0')
+   */
+  amount: string;
+};
+
+/** @internal */
+export type TraditionalInvestingDepositRequest$Outbound = {
+  owner: string;
+  amount: string;
+};
+
+/** @internal */
+export const TraditionalInvestingDepositRequest$outboundSchema: z.ZodType<
+  TraditionalInvestingDepositRequest$Outbound,
+  z.ZodTypeDef,
+  TraditionalInvestingDepositRequest
+> = z.object({
+  owner: z.string(),
+  amount: z.string(),
+});
+
+export function traditionalInvestingDepositRequestToJSON(
+  traditionalInvestingDepositRequest: TraditionalInvestingDepositRequest,
+): string {
+  return JSON.stringify(
+    TraditionalInvestingDepositRequest$outboundSchema.parse(
+      traditionalInvestingDepositRequest,
+    ),
+  );
+}

package/src/models/components/traditionalinvestingdepositresponse.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 {
+  PermitTypedDataResponseOutput,
+  PermitTypedDataResponseOutput$inboundSchema,
+} from "./permittypeddataresponseoutput.js";
+
+/**
+ * EIP-2612 permit data for the user to sign, plus deposit metadata.
+ *
+ * @remarks
+ *
+ * After the user signs the permit, the gas sponsor calls
+ * batchedDepositWithPermit on the Hyperliquid Bridge2 contract.
+ */
+export type TraditionalInvestingDepositResponse = {
+  /**
+   * Response containing EIP-712 typed data for ERC-20 Permit signing.
+   */
+  permit: PermitTypedDataResponseOutput;
+  /**
+   * USDC amount in raw units (6 decimals)
+   */
+  amountRaw: number;
+  /**
+   * Traditional investing Safe address on HyperEVM that receives the deposit on HyperCore
+   */
+  destination: string;
+};
+
+/** @internal */
+export const TraditionalInvestingDepositResponse$inboundSchema: z.ZodType<
+  TraditionalInvestingDepositResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  permit: PermitTypedDataResponseOutput$inboundSchema,
+  amount_raw: z.number().int(),
+  destination: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "amount_raw": "amountRaw",
+  });
+});
+
+export function traditionalInvestingDepositResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TraditionalInvestingDepositResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TraditionalInvestingDepositResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TraditionalInvestingDepositResponse' from JSON`,
+  );
+}