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

package/docs/models/components/tradfiorderresponse.md

@@ -1,29 +0,0 @@
-# TradFiOrderResponse
-
-Response containing an unsigned HyperEVM transaction for an order operation.
-
-## Example Usage
-
-```typescript
-import { TradFiOrderResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: TradFiOrderResponse = {
-  transaction: {
-    chainId: "<id>",
-    data: "<value>",
-    from: "<value>",
-    gas: "<value>",
-    to: "<value>",
-    value: "<value>",
-    nonce: "<value>",
-    maxFeePerGas: "<value>",
-    maxPriorityFeePerGas: "<value>",
-  },
-};
-```
-
-## Fields
-
-| Field                                                                            | Type                                                                             | Required                                                                         | Description                                                                      |
-| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| `transaction`                                                                    | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_check_mark:                                                               | N/A                                                                              |

package/docs/models/components/tradfipositionsresponse.md

@@ -1,19 +0,0 @@
-# TradFiPositionsResponse
-
-List of open TradFi perp positions.
-
-## Example Usage
-
-```typescript
-import { TradFiPositionsResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: TradFiPositionsResponse = {
-  positions: [],
-};
-```
-
-## Fields
-
-| Field                                                                    | Type                                                                     | Required                                                                 | Description                                                              |
-| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
-| `positions`                                                              | [components.TradFiPosition](../../models/components/tradfiposition.md)[] | :heavy_check_mark:                                                       | Open perpetual futures positions                                         |

package/docs/models/components/tradfiwithdrawrequest.md

@@ -1,22 +0,0 @@
-# TradFiWithdrawRequest
-
-Request to withdraw USDC from HyperEVM TradFi account to Arbitrum.
-
-## Example Usage
-
-```typescript
-import { TradFiWithdrawRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: TradFiWithdrawRequest = {
-  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
-  amount: "100.0",
-};
-```
-
-## Fields
-
-| Field                                                             | Type                                                              | Required                                                          | Description                                                       | Example                                                           |
-| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
-| `owner`                                                           | *string*                                                          | :heavy_check_mark:                                                | The user's EOA address (owner of the TradFi account)              | 0x01E62835dd7F52173546A325294762143eE4a882                        |
-| `amount`                                                          | *string*                                                          | :heavy_check_mark:                                                | USDC amount to withdraw (human-readable, e.g. '500.0')            | 100.0                                                             |
-| `destination`                                                     | *string*                                                          | :heavy_minus_sign:                                                | Arbitrum destination address (defaults to owner if not specified) |                                                                   |

package/docs/models/components/tradfiwithdrawresponse.md

@@ -1,19 +0,0 @@
-# TradFiWithdrawResponse
-
-Response containing unsigned HyperEVM transactions for USDC withdrawal.
-
-## Example Usage
-
-```typescript
-import { TradFiWithdrawResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: TradFiWithdrawResponse = {
-  transactions: [],
-};
-```
-
-## Fields
-
-| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
-| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| `transactions`                                                                     | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)[] | :heavy_check_mark:                                                                 | Unsigned HyperEVM transactions to withdraw USDC to Arbitrum                        |

package/docs/models/operations/tradfisortby.md

@@ -1,17 +0,0 @@
-# TradFiSortBy
-
-Sort results by this field
-
-## Example Usage
-
-```typescript
-import { TradFiSortBy } from "@compass-labs/api-sdk/models/operations";
-
-let value: TradFiSortBy = "volume_24h";
-```
-
-## Values
-
-```typescript
-"open_interest" | "volume_24h" | "funding_rate"
-```

package/docs/models/operations/tradfisortorder.md

@@ -1,17 +0,0 @@
-# TradFiSortOrder
-
-Sort direction
-
-## Example Usage
-
-```typescript
-import { TradFiSortOrder } from "@compass-labs/api-sdk/models/operations";
-
-let value: TradFiSortOrder = "desc";
-```
-
-## Values
-
-```typescript
-"asc" | "desc"
-```

package/docs/models/operations/v2tradfiopportunitiesrequest.md

@@ -1,22 +0,0 @@
-# V2TradfiOpportunitiesRequest
-
-## Example Usage
-
-```typescript
-import { V2TradfiOpportunitiesRequest } from "@compass-labs/api-sdk/models/operations";
-
-let value: V2TradfiOpportunitiesRequest = {
-  sortBy: "volume_24h",
-  sortOrder: "desc",
-};
-```
-
-## Fields
-
-| Field                                                                    | Type                                                                     | Required                                                                 | Description                                                              | Example                                                                  |
-| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
-| `minOpenInterest`                                                        | *number*                                                                 | :heavy_minus_sign:                                                       | Filter by minimum open interest in USD                                   |                                                                          |
-| `minVolume24h`                                                           | *number*                                                                 | :heavy_minus_sign:                                                       | Filter by minimum 24h volume in USD                                      |                                                                          |
-| `category`                                                               | [components.TradFiCategory](../../models/components/tradficategory.md)   | :heavy_minus_sign:                                                       | Filter by asset category: stock, commodity, forex                        |                                                                          |
-| `sortBy`                                                                 | [operations.TradFiSortBy](../../models/operations/tradfisortby.md)       | :heavy_minus_sign:                                                       | Sort results by this field                                               | volume_24h                                                               |
-| `sortOrder`                                                              | [operations.TradFiSortOrder](../../models/operations/tradfisortorder.md) | :heavy_minus_sign:                                                       | Sort direction                                                           | desc                                                                     |

package/docs/models/operations/v2tradfipositionsrequest.md

@@ -1,18 +0,0 @@
-# V2TradfiPositionsRequest
-
-## Example Usage
-
-```typescript
-import { V2TradfiPositionsRequest } from "@compass-labs/api-sdk/models/operations";
-
-let value: V2TradfiPositionsRequest = {
-  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
-};
-```
-
-## Fields
-
-| Field                                                      | Type                                                       | Required                                                   | Description                                                | Example                                                    |
-| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
-| `owner`                                                    | *string*                                                   | :heavy_check_mark:                                         | User's EOA address (looks up their TradFi product account) | 0x01E62835dd7F52173546A325294762143eE4a882                 |
-| `asset`                                                    | *string*                                                   | :heavy_minus_sign:                                         | Filter to a specific asset ticker (e.g. AAPL)              |                                                            |

package/src/funcs/tradFiTradfiWithdraw.ts

@@ -1,174 +0,0 @@
-/*
- * 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 TradFi account
- *
- * @remarks
- * Withdraw USDC from HyperEVM Safe back to Arbitrum.
- *
- * Returns unsigned HyperEVM transactions to transfer USDC from the Safe to HyperCore,
- * then initiate a withdrawal to the destination address on Arbitrum.
- *
- * Withdrawal processing takes minutes to hours depending on bridge conditions.
- */
-export function tradFiTradfiWithdraw(
-  client: CompassApiSDKCore,
-  request: components.TradFiWithdrawRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    components.TradFiWithdrawResponse,
-    | errors.HTTPValidationError
-    | CompassAPISDKError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: CompassApiSDKCore,
-  request: components.TradFiWithdrawRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      components.TradFiWithdrawResponse,
-      | errors.HTTPValidationError
-      | CompassAPISDKError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) => components.TradFiWithdrawRequest$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/tradfi/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_tradfi_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.TradFiWithdrawResponse,
-    | errors.HTTPValidationError
-    | CompassAPISDKError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, components.TradFiWithdrawResponse$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/models/components/createtradfiaccountrequest.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";
-import { ClosedEnum } from "../../types/enums.js";
-
-export const CreateTradFiAccountRequestChain = {
-  Hyperevm: "hyperevm",
-} as const;
-export type CreateTradFiAccountRequestChain = ClosedEnum<
-  typeof CreateTradFiAccountRequestChain
->;
-
-/**
- * Request to create a TradFi product account on HyperEVM.
- */
-export type CreateTradFiAccountRequest = {
-  chain: CreateTradFiAccountRequestChain;
-  /**
-   * The address of the transaction sender.
-   */
-  sender: string;
-  /**
-   * Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
-   */
-  estimateGas?: boolean | undefined;
-  /**
-   * The address that will own and control the product account
-   */
-  owner: string;
-};
-
-/** @internal */
-export const CreateTradFiAccountRequestChain$outboundSchema: z.ZodNativeEnum<
-  typeof CreateTradFiAccountRequestChain
-> = z.nativeEnum(CreateTradFiAccountRequestChain);
-
-/** @internal */
-export type CreateTradFiAccountRequest$Outbound = {
-  chain: string;
-  sender: string;
-  estimate_gas?: boolean | undefined;
-  owner: string;
-};
-
-/** @internal */
-export const CreateTradFiAccountRequest$outboundSchema: z.ZodType<
-  CreateTradFiAccountRequest$Outbound,
-  z.ZodTypeDef,
-  CreateTradFiAccountRequest
-> = z.object({
-  chain: CreateTradFiAccountRequestChain$outboundSchema,
-  sender: z.string(),
-  estimateGas: z.boolean().optional(),
-  owner: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    estimateGas: "estimate_gas",
-  });
-});
-
-export function createTradFiAccountRequestToJSON(
-  createTradFiAccountRequest: CreateTradFiAccountRequest,
-): string {
-  return JSON.stringify(
-    CreateTradFiAccountRequest$outboundSchema.parse(createTradFiAccountRequest),
-  );
-}

package/src/models/components/createtradfiaccountresponse.ts

@@ -1,51 +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 {
-  UnsignedTransaction,
-  UnsignedTransaction$inboundSchema,
-} from "./unsignedtransaction.js";
-
-/**
- * Response containing unsigned transaction to create a TradFi product account.
- */
-export type CreateTradFiAccountResponse = {
-  /**
-   * Transaction to create the product account (None if already deployed)
-   */
-  transaction: UnsignedTransaction | null;
-  /**
-   * Predicted address of the product account that will be deployed on HyperEVM
-   */
-  tradfiAccountAddress: string;
-};
-
-/** @internal */
-export const CreateTradFiAccountResponse$inboundSchema: z.ZodType<
-  CreateTradFiAccountResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  transaction: z.nullable(UnsignedTransaction$inboundSchema),
-  tradfi_account_address: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    "tradfi_account_address": "tradfiAccountAddress",
-  });
-});
-
-export function createTradFiAccountResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<CreateTradFiAccountResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CreateTradFiAccountResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CreateTradFiAccountResponse' from JSON`,
-  );
-}

package/src/models/components/tradficategory.ts

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

package/src/models/components/tradfidepositrequest.ts

@@ -1,43 +0,0 @@
-/*
- * 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 TradFi account.
- */
-export type TradFiDepositRequest = {
-  /**
-   * The user's EOA address on Arbitrum
-   */
-  owner: string;
-  /**
-   * USDC amount to deposit (human-readable, e.g. '1000.0')
-   */
-  amount: string;
-};
-
-/** @internal */
-export type TradFiDepositRequest$Outbound = {
-  owner: string;
-  amount: string;
-};
-
-/** @internal */
-export const TradFiDepositRequest$outboundSchema: z.ZodType<
-  TradFiDepositRequest$Outbound,
-  z.ZodTypeDef,
-  TradFiDepositRequest
-> = z.object({
-  owner: z.string(),
-  amount: z.string(),
-});
-
-export function tradFiDepositRequestToJSON(
-  tradFiDepositRequest: TradFiDepositRequest,
-): string {
-  return JSON.stringify(
-    TradFiDepositRequest$outboundSchema.parse(tradFiDepositRequest),
-  );
-}

package/src/models/components/tradfidepositresponse.ts

@@ -1,41 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  UnsignedTransaction,
-  UnsignedTransaction$inboundSchema,
-} from "./unsignedtransaction.js";
-
-/**
- * Response containing unsigned Arbitrum transactions for USDC deposit.
- */
-export type TradFiDepositResponse = {
-  /**
-   * Unsigned Arbitrum transactions: USDC approval (if needed) + bridge deposit
-   */
-  transactions: Array<UnsignedTransaction>;
-};
-
-/** @internal */
-export const TradFiDepositResponse$inboundSchema: z.ZodType<
-  TradFiDepositResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  transactions: z.array(UnsignedTransaction$inboundSchema),
-});
-
-export function tradFiDepositResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<TradFiDepositResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => TradFiDepositResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'TradFiDepositResponse' from JSON`,
-  );
-}

package/src/models/components/tradfiopportunitiesresponse.ts

@@ -1,41 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  TradFiOpportunity,
-  TradFiOpportunity$inboundSchema,
-} from "./tradfiopportunity.js";
-
-/**
- * List of available TradFi perpetual futures markets.
- */
-export type TradFiOpportunitiesResponse = {
-  /**
-   * Available tradfi perp markets
-   */
-  opportunities: Array<TradFiOpportunity>;
-};
-
-/** @internal */
-export const TradFiOpportunitiesResponse$inboundSchema: z.ZodType<
-  TradFiOpportunitiesResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  opportunities: z.array(TradFiOpportunity$inboundSchema),
-});
-
-export function tradFiOpportunitiesResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<TradFiOpportunitiesResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => TradFiOpportunitiesResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'TradFiOpportunitiesResponse' from JSON`,
-  );
-}

package/src/models/components/tradfiorderresponse.ts

@@ -1,38 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  UnsignedTransaction,
-  UnsignedTransaction$inboundSchema,
-} from "./unsignedtransaction.js";
-
-/**
- * Response containing an unsigned HyperEVM transaction for an order operation.
- */
-export type TradFiOrderResponse = {
-  transaction: UnsignedTransaction;
-};
-
-/** @internal */
-export const TradFiOrderResponse$inboundSchema: z.ZodType<
-  TradFiOrderResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  transaction: UnsignedTransaction$inboundSchema,
-});
-
-export function tradFiOrderResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<TradFiOrderResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => TradFiOrderResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'TradFiOrderResponse' from JSON`,
-  );
-}