@compass-labs/api-sdk 2.1.6 → 2.1.7-rc.2

package/src/funcs/earnEarnSwap.ts

@@ -0,0 +1,169 @@
+/*
+ * 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";
+
+/**
+ * Swap tokens within Earn Account
+ *
+ * @remarks
+ * Swap tokens within an Earn Account.
+ */
+export function earnEarnSwap(
+  client: CompassApiSDKCore,
+  request: components.EarnSwapRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.EarnSwapResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.EarnSwapRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.EarnSwapResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.EarnSwapRequest$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/earn/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_earn_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,
+    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.EarnSwapResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.EarnSwapResponse$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.760.2",
+  genVersion: "2.763.3",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.760.2 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.763.3 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/lib/encodings.ts

@@ -102,8 +102,9 @@ export function encodeLabel(
       });
       encValue = mapped?.join("").slice(1);
     } else {
-      const k =
-        options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : "";
+      const k = options?.explode && isPlainObject(value)
+        ? `${encodeString(pk)}=`
+        : "";
       encValue = `${k}${encodeValue(pv)}`;
     }
 
@@ -440,7 +441,7 @@ type BulkQueryEncoder = (
 ) => string;
 
 export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
-  const bulkEncode = function (
+  const bulkEncode = function(
     values: Record<string, unknown>,
     options?: QueryEncoderOptions,
   ): string {

package/src/models/components/aavehistoricaltransactionsresponse.ts

@@ -63,39 +63,17 @@ export const AaveHistoricalTransactionsResponseTransaction$inboundSchema:
     unknown
   > = z.union([
     LiquidationCall$inboundSchema.and(
-      z.object({ action: z.literal("LiquidationCall") }).transform((v) => ({
-        action: v.action,
-      })),
+      z.object({ action: z.literal("LiquidationCall") }),
     ),
     SwapBorrowRate$inboundSchema.and(
-      z.object({ action: z.literal("SwapBorrowRate") }).transform((v) => ({
-        action: v.action,
-      })),
-    ),
-    Borrow$inboundSchema.and(
-      z.object({ action: z.literal("Borrow") }).transform((v) => ({
-        action: v.action,
-      })),
-    ),
-    Withdraw$inboundSchema.and(
-      z.object({ action: z.literal("Withdraw") }).transform((v) => ({
-        action: v.action,
-      })),
-    ),
-    Repay$inboundSchema.and(
-      z.object({ action: z.literal("Repay") }).transform((v) => ({
-        action: v.action,
-      })),
-    ),
-    Supply$inboundSchema.and(
-      z.object({ action: z.literal("Supply") }).transform((v) => ({
-        action: v.action,
-      })),
+      z.object({ action: z.literal("SwapBorrowRate") }),
     ),
+    Borrow$inboundSchema.and(z.object({ action: z.literal("Borrow") })),
+    Withdraw$inboundSchema.and(z.object({ action: z.literal("Withdraw") })),
+    Repay$inboundSchema.and(z.object({ action: z.literal("Repay") })),
+    Supply$inboundSchema.and(z.object({ action: z.literal("Supply") })),
     UsageAsCollateral$inboundSchema.and(
-      z.object({ action: z.literal("UsageAsCollateral") }).transform((v) => ({
-        action: v.action,
-      })),
+      z.object({ action: z.literal("UsageAsCollateral") }),
     ),
   ]);
 
@@ -126,39 +104,17 @@ export const AaveHistoricalTransactionsResponse$inboundSchema: z.ZodType<
   transactions: z.array(
     z.union([
       LiquidationCall$inboundSchema.and(
-        z.object({ action: z.literal("LiquidationCall") }).transform((v) => ({
-          action: v.action,
-        })),
+        z.object({ action: z.literal("LiquidationCall") }),
       ),
       SwapBorrowRate$inboundSchema.and(
-        z.object({ action: z.literal("SwapBorrowRate") }).transform((v) => ({
-          action: v.action,
-        })),
-      ),
-      Borrow$inboundSchema.and(
-        z.object({ action: z.literal("Borrow") }).transform((v) => ({
-          action: v.action,
-        })),
-      ),
-      Withdraw$inboundSchema.and(
-        z.object({ action: z.literal("Withdraw") }).transform((v) => ({
-          action: v.action,
-        })),
-      ),
-      Repay$inboundSchema.and(
-        z.object({ action: z.literal("Repay") }).transform((v) => ({
-          action: v.action,
-        })),
-      ),
-      Supply$inboundSchema.and(
-        z.object({ action: z.literal("Supply") }).transform((v) => ({
-          action: v.action,
-        })),
+        z.object({ action: z.literal("SwapBorrowRate") }),
       ),
+      Borrow$inboundSchema.and(z.object({ action: z.literal("Borrow") })),
+      Withdraw$inboundSchema.and(z.object({ action: z.literal("Withdraw") })),
+      Repay$inboundSchema.and(z.object({ action: z.literal("Repay") })),
+      Supply$inboundSchema.and(z.object({ action: z.literal("Supply") })),
       UsageAsCollateral$inboundSchema.and(
-        z.object({ action: z.literal("UsageAsCollateral") }).transform((v) => ({
-          action: v.action,
-        })),
+        z.object({ action: z.literal("UsageAsCollateral") }),
       ),
     ]),
   ),

package/src/models/components/approvetransferrequest.ts

@@ -20,7 +20,7 @@ export type ApproveTransferRequest = {
    */
   token: string;
   /**
-   * Optionally request gas sponsorship. If set to `true`, EIP-712 signature data will be returned that must be signed by the `owner` and submitted to the `/sponsor_gas` endpoint.
+   * Optionally request gas sponsorship. If set to `true`, EIP-712 signature data will be returned that must be signed by the `owner` and submitted to the `/gas_sponsorship/prepare` endpoint.
    */
   gasSponsorship?: boolean | undefined;
 };

package/src/models/components/earnmanagerequest.ts

@@ -81,12 +81,8 @@ export const Venue$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Venue
 > = z.union([
-  AaveVenue$outboundSchema.and(
-    z.object({ type: z.literal("AAVE") }).transform((v) => ({ type: v.type })),
-  ),
-  VaultVenue$outboundSchema.and(
-    z.object({ type: z.literal("VAULT") }).transform((v) => ({ type: v.type })),
-  ),
+  AaveVenue$outboundSchema.and(z.object({ type: z.literal("AAVE") })),
+  VaultVenue$outboundSchema.and(z.object({ type: z.literal("VAULT") })),
 ]);
 
 export function venueToJSON(venue: Venue): string {
@@ -120,16 +116,8 @@ export const EarnManageRequest$outboundSchema: z.ZodType<
   owner: z.string(),
   chain: Chain$outboundSchema,
   venue: z.union([
-    AaveVenue$outboundSchema.and(
-      z.object({ type: z.literal("AAVE") }).transform((v) => ({
-        type: v.type,
-      })),
-    ),
-    VaultVenue$outboundSchema.and(
-      z.object({ type: z.literal("VAULT") }).transform((v) => ({
-        type: v.type,
-      })),
-    ),
+    AaveVenue$outboundSchema.and(z.object({ type: z.literal("AAVE") })),
+    VaultVenue$outboundSchema.and(z.object({ type: z.literal("VAULT") })),
   ]),
   action: EarnManageRequestAction$outboundSchema,
   amount: z.any().optional(),

package/src/models/components/earnpositionresponse.ts

@@ -42,14 +42,8 @@ export const PositionUnion$inboundSchema: z.ZodType<
   unknown
 > = z.union([
   CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema
-    .and(
-      z.object({ type: z.literal("VAULT") }).transform((v) => ({
-        type: v.type,
-      })),
-    ),
-  AavePosition$inboundSchema.and(
-    z.object({ type: z.literal("AAVE") }).transform((v) => ({ type: v.type })),
-  ),
+    .and(z.object({ type: z.literal("VAULT") })),
+  AavePosition$inboundSchema.and(z.object({ type: z.literal("AAVE") })),
 ]);
 
 export function positionUnionFromJSON(
@@ -70,16 +64,8 @@ export const EarnPositionResponse$inboundSchema: z.ZodType<
 > = z.object({
   position: z.union([
     CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema
-      .and(
-        z.object({ type: z.literal("VAULT") }).transform((v) => ({
-          type: v.type,
-        })),
-      ),
-    AavePosition$inboundSchema.and(
-      z.object({ type: z.literal("AAVE") }).transform((v) => ({
-        type: v.type,
-      })),
-    ),
+      .and(z.object({ type: z.literal("VAULT") })),
+    AavePosition$inboundSchema.and(z.object({ type: z.literal("AAVE") })),
   ]),
 });
 

package/src/models/components/earnpositionsresponse.ts

@@ -37,14 +37,8 @@ export const UserPosition$inboundSchema: z.ZodType<
   unknown
 > = z.union([
   CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema
-    .and(
-      z.object({ type: z.literal("VAULT") }).transform((v) => ({
-        type: v.type,
-      })),
-    ),
-  AavePosition$inboundSchema.and(
-    z.object({ type: z.literal("AAVE") }).transform((v) => ({ type: v.type })),
-  ),
+    .and(z.object({ type: z.literal("VAULT") })),
+  AavePosition$inboundSchema.and(z.object({ type: z.literal("AAVE") })),
 ]);
 
 export function userPositionFromJSON(
@@ -66,16 +60,8 @@ export const EarnPositionsResponse$inboundSchema: z.ZodType<
   user_positions: z.array(
     z.union([
       CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema
-        .and(
-          z.object({ type: z.literal("VAULT") }).transform((v) => ({
-            type: v.type,
-          })),
-        ),
-      AavePosition$inboundSchema.and(
-        z.object({ type: z.literal("AAVE") }).transform((v) => ({
-          type: v.type,
-        })),
-      ),
+        .and(z.object({ type: z.literal("VAULT") })),
+      AavePosition$inboundSchema.and(z.object({ type: z.literal("AAVE") })),
     ]),
   ),
 }).transform((v) => {

package/src/models/components/earnswaprequest.ts

@@ -0,0 +1,119 @@
+/*
+ * 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 { Chain, Chain$outboundSchema } from "./chain.js";
+
+/**
+ * Human-readable amount of `token_in` to swap (token units, not wei).
+ */
+export type EarnSwapRequestAmountIn = number | string;
+
+/**
+ * Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%).
+ */
+export type Slippage = number | string;
+
+export type EarnSwapRequest = {
+  /**
+   * The owner's wallet address.
+   */
+  owner: string;
+  /**
+   * The chain to use.
+   */
+  chain: Chain;
+  /**
+   * Token to sell (input). Provide a token symbol from a limited set (e.g., 'USDC') or any token address.
+   */
+  tokenIn: string;
+  /**
+   * Token to buy (output). Provide a token symbol from a limited set (e.g., 'USDT') or any token address.
+   */
+  tokenOut: string;
+  /**
+   * Human-readable amount of `token_in` to swap (token units, not wei).
+   */
+  amountIn: number | string;
+  /**
+   * Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%).
+   */
+  slippage: number | string;
+  /**
+   * Optionally request gas sponsorship. If `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
+   */
+  gasSponsorship?: boolean | undefined;
+};
+
+/** @internal */
+export type EarnSwapRequestAmountIn$Outbound = number | string;
+
+/** @internal */
+export const EarnSwapRequestAmountIn$outboundSchema: z.ZodType<
+  EarnSwapRequestAmountIn$Outbound,
+  z.ZodTypeDef,
+  EarnSwapRequestAmountIn
+> = z.union([z.number(), z.string()]);
+
+export function earnSwapRequestAmountInToJSON(
+  earnSwapRequestAmountIn: EarnSwapRequestAmountIn,
+): string {
+  return JSON.stringify(
+    EarnSwapRequestAmountIn$outboundSchema.parse(earnSwapRequestAmountIn),
+  );
+}
+
+/** @internal */
+export type Slippage$Outbound = number | string;
+
+/** @internal */
+export const Slippage$outboundSchema: z.ZodType<
+  Slippage$Outbound,
+  z.ZodTypeDef,
+  Slippage
+> = z.union([z.number(), z.string()]);
+
+export function slippageToJSON(slippage: Slippage): string {
+  return JSON.stringify(Slippage$outboundSchema.parse(slippage));
+}
+
+/** @internal */
+export type EarnSwapRequest$Outbound = {
+  owner: string;
+  chain: string;
+  token_in: string;
+  token_out: string;
+  amount_in: number | string;
+  slippage: number | string;
+  gas_sponsorship?: boolean | undefined;
+};
+
+/** @internal */
+export const EarnSwapRequest$outboundSchema: z.ZodType<
+  EarnSwapRequest$Outbound,
+  z.ZodTypeDef,
+  EarnSwapRequest
+> = z.object({
+  owner: z.string(),
+  chain: Chain$outboundSchema,
+  tokenIn: z.string(),
+  tokenOut: z.string(),
+  amountIn: z.union([z.number(), z.string()]),
+  slippage: z.union([z.number(), z.string()]),
+  gasSponsorship: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    tokenIn: "token_in",
+    tokenOut: "token_out",
+    amountIn: "amount_in",
+    gasSponsorship: "gas_sponsorship",
+  });
+});
+
+export function earnSwapRequestToJSON(
+  earnSwapRequest: EarnSwapRequest,
+): string {
+  return JSON.stringify(EarnSwapRequest$outboundSchema.parse(earnSwapRequest));
+}

package/src/models/components/earnswapresponse.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 {
+  BatchedSafeOperationsResponseOutput,
+  BatchedSafeOperationsResponseOutput$inboundSchema,
+} from "./batchedsafeoperationsresponseoutput.js";
+import {
+  UnsignedTransaction,
+  UnsignedTransaction$inboundSchema,
+} from "./unsignedtransaction.js";
+
+export type EarnSwapResponse = {
+  transaction: UnsignedTransaction | null;
+  eip712: BatchedSafeOperationsResponseOutput | null;
+};
+
+/** @internal */
+export const EarnSwapResponse$inboundSchema: z.ZodType<
+  EarnSwapResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction: z.nullable(UnsignedTransaction$inboundSchema),
+  eip_712: z.nullable(BatchedSafeOperationsResponseOutput$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "eip_712": "eip712",
+  });
+});
+
+export function earnSwapResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EarnSwapResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EarnSwapResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EarnSwapResponse' from JSON`,
+  );
+}

package/src/models/components/earntransferrequest.ts

@@ -48,7 +48,7 @@ export type EarnTransferRequest = {
    */
   action: EarnTransferRequestAction;
   /**
-   * Optionally request gas sponsorship. If set to `true`, EIP-712 signature data will be returned that must be signed by the `owner` and submitted to the `/sponsor_gas` endpoint.
+   * Optionally request gas sponsorship. If set to `true`, EIP-712 signature data will be returned that must be signed by the `owner` and submitted to the `/gas_sponsorship/prepare` endpoint.
    */
   gasSponsorship?: boolean | undefined;
   /**

package/src/models/components/index.ts

@@ -83,6 +83,8 @@ export * from "./earnmanagerequest.js";
 export * from "./earnmanageresponse.js";
 export * from "./earnpositionresponse.js";
 export * from "./earnpositionsresponse.js";
+export * from "./earnswaprequest.js";
+export * from "./earnswapresponse.js";
 export * from "./earntransferrequest.js";
 export * from "./earntransferresponse.js";
 export * from "./eip712domainfield.js";

package/src/sdk/earn.ts

@@ -7,6 +7,7 @@ import { earnEarnCreateAccount } from "../funcs/earnEarnCreateAccount.js";
 import { earnEarnManage } from "../funcs/earnEarnManage.js";
 import { earnEarnPositions } from "../funcs/earnEarnPositions.js";
 import { earnEarnPositionsPositionId } from "../funcs/earnEarnPositionsPositionId.js";
+import { earnEarnSwap } from "../funcs/earnEarnSwap.js";
 import { earnEarnTransfer } from "../funcs/earnEarnTransfer.js";
 import { earnEarnVaults } from "../funcs/earnEarnVaults.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -164,4 +165,21 @@ export class Earn extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Swap tokens within Earn Account
+   *
+   * @remarks
+   * Swap tokens within an Earn Account.
+   */
+  async earnSwap(
+    request: components.EarnSwapRequest,
+    options?: RequestOptions,
+  ): Promise<components.EarnSwapResponse> {
+    return unwrapAsync(earnEarnSwap(
+      this,
+      request,
+      options,
+    ));
+  }
 }