@compass-labs/api-sdk 2.2.24 → 2.2.25-rc.0

package/src/funcs/earnEarnPositionsAll.ts

@@ -0,0 +1,181 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeFormQuery } 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 * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List earn positions across all chains
+ *
+ * @remarks
+ * List all Earn positions across all supported chains (Ethereum, Base, Arbitrum).
+ *
+ * Returns positions grouped by chain, with per-chain and total USD values.
+ * Each chain includes Aave, vault, and Pendle PT positions. Chains where
+ * the user has no earn account return empty position lists.
+ *
+ * Use this endpoint for a cross-chain portfolio overview instead of making
+ * separate calls per chain to /positions.
+ */
+export function earnEarnPositionsAll(
+  client: CompassApiSDKCore,
+  request: operations.V2EarnPositionsAllRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.EarnPositionsAllResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.V2EarnPositionsAllRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.EarnPositionsAllResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.V2EarnPositionsAllRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v2/earn/positions_all")();
+
+  const query = encodeFormQuery({
+    "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_earn_positions_all",
+    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,
+    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.EarnPositionsAllResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.EarnPositionsAllResponse$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.856.1",
+  genVersion: "2.859.2",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.856.1 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.859.2 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/models/components/earnpositionsallresponse.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 {
+  EarnPositionsResponse,
+  EarnPositionsResponse$inboundSchema,
+} from "./earnpositionsresponse.js";
+
+/**
+ * Positions across all chains, grouped by chain name.
+ *
+ * @remarks
+ *
+ * Each chain key maps to an EarnPositionsResponse containing that chain's
+ * aave, vaults, and pendle_pt positions with per-chain total_usd_value.
+ */
+export type EarnPositionsAllResponse = {
+  /**
+   * Positions grouped by chain. Keys: 'ethereum', 'base', 'arbitrum'.
+   */
+  chains: { [k: string]: EarnPositionsResponse };
+  /**
+   * Total USD value of all positions across all chains.
+   */
+  totalUsdValue?: string | null | undefined;
+};
+
+/** @internal */
+export const EarnPositionsAllResponse$inboundSchema: z.ZodType<
+  EarnPositionsAllResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chains: z.record(EarnPositionsResponse$inboundSchema),
+  total_usd_value: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_usd_value": "totalUsdValue",
+  });
+});
+
+export function earnPositionsAllResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EarnPositionsAllResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EarnPositionsAllResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EarnPositionsAllResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -109,6 +109,7 @@ export * from "./earnbalancesresponse.js";
 export * from "./earnmanageparams.js";
 export * from "./earnmanagerequest.js";
 export * from "./earnmanageresponse.js";
+export * from "./earnpositionsallresponse.js";
 export * from "./earnpositionsresponse.js";
 export * from "./earnswapparams.js";
 export * from "./earnswaprequest.js";

package/src/models/operations/index.ts

@@ -46,4 +46,5 @@ export * from "./v2earnaavemarkets.js";
 export * from "./v2earnbalances.js";
 export * from "./v2earnpendlemarkets.js";
 export * from "./v2earnpositions.js";
+export * from "./v2earnpositionsall.js";
 export * from "./v2earnvaults.js";

package/src/models/operations/v2earnpositionsall.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type V2EarnPositionsAllRequest = {
+  /**
+   * The address of the owner of the earn account.
+   */
+  owner: string;
+};
+
+/** @internal */
+export type V2EarnPositionsAllRequest$Outbound = {
+  owner: string;
+};
+
+/** @internal */
+export const V2EarnPositionsAllRequest$outboundSchema: z.ZodType<
+  V2EarnPositionsAllRequest$Outbound,
+  z.ZodTypeDef,
+  V2EarnPositionsAllRequest
+> = z.object({
+  owner: z.string(),
+});
+
+export function v2EarnPositionsAllRequestToJSON(
+  v2EarnPositionsAllRequest: V2EarnPositionsAllRequest,
+): string {
+  return JSON.stringify(
+    V2EarnPositionsAllRequest$outboundSchema.parse(v2EarnPositionsAllRequest),
+  );
+}

package/src/sdk/earn.ts

@@ -9,6 +9,7 @@ import { earnEarnCreateAccount } from "../funcs/earnEarnCreateAccount.js";
 import { earnEarnManage } from "../funcs/earnEarnManage.js";
 import { earnEarnPendleMarkets } from "../funcs/earnEarnPendleMarkets.js";
 import { earnEarnPositions } from "../funcs/earnEarnPositions.js";
+import { earnEarnPositionsAll } from "../funcs/earnEarnPositionsAll.js";
 import { earnEarnSwap } from "../funcs/earnEarnSwap.js";
 import { earnEarnTransfer } from "../funcs/earnEarnTransfer.js";
 import { earnEarnVaults } from "../funcs/earnEarnVaults.js";
@@ -42,6 +43,30 @@ export class Earn extends ClientSDK {
     ));
   }
 
+  /**
+   * List earn positions across all chains
+   *
+   * @remarks
+   * List all Earn positions across all supported chains (Ethereum, Base, Arbitrum).
+   *
+   * Returns positions grouped by chain, with per-chain and total USD values.
+   * Each chain includes Aave, vault, and Pendle PT positions. Chains where
+   * the user has no earn account return empty position lists.
+   *
+   * Use this endpoint for a cross-chain portfolio overview instead of making
+   * separate calls per chain to /positions.
+   */
+  async earnPositionsAll(
+    request: operations.V2EarnPositionsAllRequest,
+    options?: RequestOptions,
+  ): Promise<components.EarnPositionsAllResponse> {
+    return unwrapAsync(earnEarnPositionsAll(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List vaults
    *