@compass-labs/api-sdk 2.2.105 → 2.2.106

package/src/funcs/riskYieldRiskYieldSwap.ts

@@ -0,0 +1,185 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } 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 { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Swap tokens
+ *
+ * @remarks
+ * Trade one token for another from inside your Risk Yield Account.
+ *
+ * Mostly used to reach the ratio a range needs before opening a position:
+ * a range fixes the proportion of the two assets, and a caller holding one of
+ * them has to swap to it.
+ *
+ * There is no aggregator on this chain, so the route is a Uniswap v3 pool. The
+ * API quotes every enabled fee tier and takes whichever returns the most — a
+ * 1% pool with depth beats a 0.05% pool with none, which here is the common
+ * case rather than the corner one.
+ *
+ * The transaction is simulated before it is returned. A failing simulation is
+ * a 422 rather than something to sign: on this chain a token may tax
+ * transfers, block an address or be paused, and none of that is visible until
+ * the call is actually made.
+ */
+export function riskYieldRiskYieldSwap(
+  client: CompassApiSDKCore,
+  request: components.RiskYieldSwapRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.RiskYieldSwapResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.RiskYieldSwapRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.RiskYieldSwapResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.RiskYieldSwapRequest$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/risk_yield/swap")();
+
+  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_risk_yield_swap",
+    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,
+    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.RiskYieldSwapResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.RiskYieldSwapResponse$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/funcs/riskYieldRiskYieldTokens.ts

@@ -0,0 +1,195 @@
+/*
+ * 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";
+
+/**
+ * List tokens
+ *
+ * @remarks
+ * The assets that trade on Robinhood Chain.
+ *
+ * Tokenized stocks carry their issuer metadata, including the corporate-action
+ * multiplier — balances do not rebase on a split, so a quote for the
+ * underlying only becomes a token price once that is applied.
+ *
+ * Memecoins carry the launch they came from. Every price carries the source it
+ * was resolved from and a confidence: below 0.6 it came from a pool shallow
+ * enough that one trade moves it, and every dollar figure derived from it is
+ * indicative.
+ */
+export function riskYieldRiskYieldTokens(
+  client: CompassApiSDKCore,
+  request: operations.V2RiskYieldTokensRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.DexTokensResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.V2RiskYieldTokensRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.DexTokensResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.V2RiskYieldTokensRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v2/risk_yield/tokens")();
+
+  const query = encodeFormQuery({
+    "chain": payload.chain,
+    "direction": payload.direction,
+    "has_price": payload.has_price,
+    "kind": payload.kind,
+    "launchpad": payload.launchpad,
+    "limit": payload.limit,
+    "min_liquidity_usd": payload.min_liquidity_usd,
+    "offset": payload.offset,
+    "order_by": payload.order_by,
+    "search": payload.search,
+    "stock_ticker": payload.stock_ticker,
+  });
+
+  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_risk_yield_tokens",
+    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.DexTokensResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.DexTokensResponse$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/funcs/riskYieldRiskYieldTransfer.ts

@@ -0,0 +1,178 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } 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 { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Transfer tokens to/from account
+ *
+ * @remarks
+ * Move tokens between your wallet and your Risk Yield Account.
+ *
+ * `DEPOSIT` pulls from the owner's wallet into the account; `WITHDRAW` sends
+ * them back. Native ETH is supported, which matters here because many pools on
+ * this chain are quoted in it.
+ *
+ * The account is shared with Earn, so a deposit made through either product is
+ * available to both.
+ */
+export function riskYieldRiskYieldTransfer(
+  client: CompassApiSDKCore,
+  request: components.RiskYieldTransferRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.EarnTransferResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.RiskYieldTransferRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.EarnTransferResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.RiskYieldTransferRequest$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/risk_yield/transfer")();
+
+  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_risk_yield_transfer",
+    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,
+    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.EarnTransferResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.EarnTransferResponse$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/bothsidesdeposit.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type Amount0 = number | string;
+
+export type Amount1 = number | string;
+
+/**
+ * Explicit amounts of each token.
+ */
+export type BothSidesDeposit = {
+  type: "both";
+  amount0: number | string;
+  amount1: number | string;
+};
+
+/** @internal */
+export type Amount0$Outbound = number | string;
+
+/** @internal */
+export const Amount0$outboundSchema: z.ZodType<
+  Amount0$Outbound,
+  z.ZodTypeDef,
+  Amount0
+> = z.union([z.number(), z.string()]);
+
+export function amount0ToJSON(amount0: Amount0): string {
+  return JSON.stringify(Amount0$outboundSchema.parse(amount0));
+}
+
+/** @internal */
+export type Amount1$Outbound = number | string;
+
+/** @internal */
+export const Amount1$outboundSchema: z.ZodType<
+  Amount1$Outbound,
+  z.ZodTypeDef,
+  Amount1
+> = z.union([z.number(), z.string()]);
+
+export function amount1ToJSON(amount1: Amount1): string {
+  return JSON.stringify(Amount1$outboundSchema.parse(amount1));
+}
+
+/** @internal */
+export type BothSidesDeposit$Outbound = {
+  type: "both";
+  amount0: number | string;
+  amount1: number | string;
+};
+
+/** @internal */
+export const BothSidesDeposit$outboundSchema: z.ZodType<
+  BothSidesDeposit$Outbound,
+  z.ZodTypeDef,
+  BothSidesDeposit
+> = z.object({
+  type: z.literal("both"),
+  amount0: z.union([z.number(), z.string()]),
+  amount1: z.union([z.number(), z.string()]),
+});
+
+export function bothSidesDepositToJSON(
+  bothSidesDeposit: BothSidesDeposit,
+): string {
+  return JSON.stringify(
+    BothSidesDeposit$outboundSchema.parse(bothSidesDeposit),
+  );
+}

package/src/models/components/chain.ts

@@ -15,6 +15,7 @@ export const Chain = {
   Hyperevm: "hyperevm",
   Tempo: "tempo",
   Bsc: "bsc",
+  Robinhood: "robinhood",
   EthereumSepolia: "ethereum_sepolia",
 } as const;
 /**

package/src/models/components/costbasis.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 {
+  CostBasisSource,
+  CostBasisSource$inboundSchema,
+} from "./costbasissource.js";
+
+/**
+ * What the position cost to open.
+ *
+ * @remarks
+ *
+ * Not readable from the chain: a position reports its liquidity, never the
+ * amounts that bought it. This comes from recorded events, and when there are
+ * none the PnL fields are null rather than guessed — an invented cost basis
+ * would make every number derived from it quietly wrong.
+ */
+export type CostBasis = {
+  source: CostBasisSource;
+  amount0?: string | null | undefined;
+  amount1?: string | null | undefined;
+  valueUsd?: string | null | undefined;
+  openedAt?: Date | null | undefined;
+};
+
+/** @internal */
+export const CostBasis$inboundSchema: z.ZodType<
+  CostBasis,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  source: CostBasisSource$inboundSchema,
+  amount0: z.nullable(z.string()).optional(),
+  amount1: z.nullable(z.string()).optional(),
+  value_usd: z.nullable(z.string()).optional(),
+  opened_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "value_usd": "valueUsd",
+    "opened_at": "openedAt",
+  });
+});
+
+export function costBasisFromJSON(
+  jsonString: string,
+): SafeParseResult<CostBasis, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CostBasis$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CostBasis' from JSON`,
+  );
+}