@compass-labs/api-sdk 0.0.28 → 0.0.29

package/src/models/components/aaveavgrateresponse.ts

@@ -0,0 +1,123 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+
+export type AaveAvgRateResponse = {
+  /**
+   * Variable rate APY for deposits.
+   */
+  supplyApyVariableRate: number;
+  /**
+   * Variable rate APR for deposits.
+   */
+  supplyAprVariableRate: number;
+  /**
+   * Variable rate APY for loans.
+   */
+  borrowApyVariableRate: number;
+  /**
+   * Variable rate APR for loans.
+   */
+  borrowAprVariableRate: number;
+  /**
+   * Fixed rate APY for loans.
+   */
+  borrowApyFixedRate: number;
+  /**
+   * Fixed rate APR for loans.
+   */
+  borrowAprFixedRate: number;
+};
+
+/** @internal */
+export const AaveAvgRateResponse$inboundSchema: z.ZodType<
+  AaveAvgRateResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  supply_apy_variable_rate: z.number(),
+  supply_apr_variable_rate: z.number(),
+  borrow_apy_variable_rate: z.number(),
+  borrow_apr_variable_rate: z.number(),
+  borrow_apy_fixed_rate: z.number(),
+  borrow_apr_fixed_rate: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "supply_apy_variable_rate": "supplyApyVariableRate",
+    "supply_apr_variable_rate": "supplyAprVariableRate",
+    "borrow_apy_variable_rate": "borrowApyVariableRate",
+    "borrow_apr_variable_rate": "borrowAprVariableRate",
+    "borrow_apy_fixed_rate": "borrowApyFixedRate",
+    "borrow_apr_fixed_rate": "borrowAprFixedRate",
+  });
+});
+
+/** @internal */
+export type AaveAvgRateResponse$Outbound = {
+  supply_apy_variable_rate: number;
+  supply_apr_variable_rate: number;
+  borrow_apy_variable_rate: number;
+  borrow_apr_variable_rate: number;
+  borrow_apy_fixed_rate: number;
+  borrow_apr_fixed_rate: number;
+};
+
+/** @internal */
+export const AaveAvgRateResponse$outboundSchema: z.ZodType<
+  AaveAvgRateResponse$Outbound,
+  z.ZodTypeDef,
+  AaveAvgRateResponse
+> = z.object({
+  supplyApyVariableRate: z.number(),
+  supplyAprVariableRate: z.number(),
+  borrowApyVariableRate: z.number(),
+  borrowAprVariableRate: z.number(),
+  borrowApyFixedRate: z.number(),
+  borrowAprFixedRate: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    supplyApyVariableRate: "supply_apy_variable_rate",
+    supplyAprVariableRate: "supply_apr_variable_rate",
+    borrowApyVariableRate: "borrow_apy_variable_rate",
+    borrowAprVariableRate: "borrow_apr_variable_rate",
+    borrowApyFixedRate: "borrow_apy_fixed_rate",
+    borrowAprFixedRate: "borrow_apr_fixed_rate",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveAvgRateResponse$ {
+  /** @deprecated use `AaveAvgRateResponse$inboundSchema` instead. */
+  export const inboundSchema = AaveAvgRateResponse$inboundSchema;
+  /** @deprecated use `AaveAvgRateResponse$outboundSchema` instead. */
+  export const outboundSchema = AaveAvgRateResponse$outboundSchema;
+  /** @deprecated use `AaveAvgRateResponse$Outbound` instead. */
+  export type Outbound = AaveAvgRateResponse$Outbound;
+}
+
+export function aaveAvgRateResponseToJSON(
+  aaveAvgRateResponse: AaveAvgRateResponse,
+): string {
+  return JSON.stringify(
+    AaveAvgRateResponse$outboundSchema.parse(aaveAvgRateResponse),
+  );
+}
+
+export function aaveAvgRateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveAvgRateResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveAvgRateResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveAvgRateResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./aaveavgrateresponse.js";
 export * from "./aaveborrowparams.js";
 export * from "./aaveborrowrequest.js";
 export * from "./aavehistoricaltransactionsresponse.js";

package/src/models/operations/aaveavgrate.ts

@@ -0,0 +1,203 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The chain to use.
+ */
+export const AaveAvgRateChain = {
+  BaseMainnet: "base:mainnet",
+  EthereumMainnet: "ethereum:mainnet",
+  ArbitrumMainnet: "arbitrum:mainnet",
+} as const;
+/**
+ * The chain to use.
+ */
+export type AaveAvgRateChain = ClosedEnum<typeof AaveAvgRateChain>;
+
+/**
+ * A class representing the token.
+ *
+ * @remarks
+ *
+ * This class is used to represent the token in the system. Notice individual
+ * endpoints' documentation where per chain tokens are presented.
+ */
+export const AaveAvgRateToken = {
+  OneINCH: "1INCH",
+  Aave: "AAVE",
+  Bal: "BAL",
+  CbBTC: "cbBTC",
+  CbETH: "cbETH",
+  Crv: "CRV",
+  CrvUSD: "crvUSD",
+  Dai: "DAI",
+  Ens: "ENS",
+  ETHx: "ETHx",
+  Frax: "FRAX",
+  Fxs: "FXS",
+  Gho: "GHO",
+  Knc: "KNC",
+  Ldo: "LDO",
+  Link: "LINK",
+  Lusd: "LUSD",
+  Mkr: "MKR",
+  OsETH: "osETH",
+  Pyusd: "PYUSD",
+  RETH: "rETH",
+  Rpl: "RPL",
+  RsETH: "rsETH",
+  SDAI: "sDAI",
+  Snx: "SNX",
+  Stg: "STG",
+  SUSDe: "sUSDe",
+  TBTC: "tBTC",
+  Uni: "UNI",
+  Usdc: "USDC",
+  USDe: "USDe",
+  Usds: "USDS",
+  Usdt: "USDT",
+  Wbtc: "WBTC",
+  WeETH: "weETH",
+  Weth: "WETH",
+  WstETH: "wstETH",
+  Arb: "ARB",
+  Eurs: "EURS",
+  Mai: "MAI",
+  USDCe: "USDCe",
+  Aero: "AERO",
+  Eur: "EUR",
+  Virtual: "VIRTUAL",
+} as const;
+/**
+ * A class representing the token.
+ *
+ * @remarks
+ *
+ * This class is used to represent the token in the system. Notice individual
+ * endpoints' documentation where per chain tokens are presented.
+ */
+export type AaveAvgRateToken = ClosedEnum<typeof AaveAvgRateToken>;
+
+export type AaveAvgRateRequest = {
+  /**
+   * The chain to use.
+   */
+  chain?: AaveAvgRateChain | undefined;
+  /**
+   * The symbol of the asset to fetch the user's position on..
+   */
+  token?: AaveAvgRateToken | undefined;
+  /**
+   * The number of days to fetch the user's position on.
+   */
+  days?: number | undefined;
+};
+
+/** @internal */
+export const AaveAvgRateChain$inboundSchema: z.ZodNativeEnum<
+  typeof AaveAvgRateChain
+> = z.nativeEnum(AaveAvgRateChain);
+
+/** @internal */
+export const AaveAvgRateChain$outboundSchema: z.ZodNativeEnum<
+  typeof AaveAvgRateChain
+> = AaveAvgRateChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveAvgRateChain$ {
+  /** @deprecated use `AaveAvgRateChain$inboundSchema` instead. */
+  export const inboundSchema = AaveAvgRateChain$inboundSchema;
+  /** @deprecated use `AaveAvgRateChain$outboundSchema` instead. */
+  export const outboundSchema = AaveAvgRateChain$outboundSchema;
+}
+
+/** @internal */
+export const AaveAvgRateToken$inboundSchema: z.ZodNativeEnum<
+  typeof AaveAvgRateToken
+> = z.nativeEnum(AaveAvgRateToken);
+
+/** @internal */
+export const AaveAvgRateToken$outboundSchema: z.ZodNativeEnum<
+  typeof AaveAvgRateToken
+> = AaveAvgRateToken$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveAvgRateToken$ {
+  /** @deprecated use `AaveAvgRateToken$inboundSchema` instead. */
+  export const inboundSchema = AaveAvgRateToken$inboundSchema;
+  /** @deprecated use `AaveAvgRateToken$outboundSchema` instead. */
+  export const outboundSchema = AaveAvgRateToken$outboundSchema;
+}
+
+/** @internal */
+export const AaveAvgRateRequest$inboundSchema: z.ZodType<
+  AaveAvgRateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chain: AaveAvgRateChain$inboundSchema.default("ethereum:mainnet"),
+  token: AaveAvgRateToken$inboundSchema.default("USDC"),
+  days: z.number().int().default(7),
+});
+
+/** @internal */
+export type AaveAvgRateRequest$Outbound = {
+  chain: string;
+  token: string;
+  days: number;
+};
+
+/** @internal */
+export const AaveAvgRateRequest$outboundSchema: z.ZodType<
+  AaveAvgRateRequest$Outbound,
+  z.ZodTypeDef,
+  AaveAvgRateRequest
+> = z.object({
+  chain: AaveAvgRateChain$outboundSchema.default("ethereum:mainnet"),
+  token: AaveAvgRateToken$outboundSchema.default("USDC"),
+  days: z.number().int().default(7),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveAvgRateRequest$ {
+  /** @deprecated use `AaveAvgRateRequest$inboundSchema` instead. */
+  export const inboundSchema = AaveAvgRateRequest$inboundSchema;
+  /** @deprecated use `AaveAvgRateRequest$outboundSchema` instead. */
+  export const outboundSchema = AaveAvgRateRequest$outboundSchema;
+  /** @deprecated use `AaveAvgRateRequest$Outbound` instead. */
+  export type Outbound = AaveAvgRateRequest$Outbound;
+}
+
+export function aaveAvgRateRequestToJSON(
+  aaveAvgRateRequest: AaveAvgRateRequest,
+): string {
+  return JSON.stringify(
+    AaveAvgRateRequest$outboundSchema.parse(aaveAvgRateRequest),
+  );
+}
+
+export function aaveAvgRateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveAvgRateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveAvgRateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveAvgRateRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./aaveavgrate.js";
 export * from "./aavehistoricaltransactions.js";
 export * from "./aaveliquiditychange.js";
 export * from "./aaverate.js";

package/src/sdk/aavev3.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { aaveV3AvgRate } from "../funcs/aaveV3AvgRate.js";
 import { aaveV3Borrow } from "../funcs/aaveV3Borrow.js";
 import { aaveV3HistoricalTransactions } from "../funcs/aaveV3HistoricalTransactions.js";
 import { aaveV3LiquidityChange } from "../funcs/aaveV3LiquidityChange.js";
@@ -19,6 +20,23 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class AaveV3 extends ClientSDK {
+  /**
+   * Average interest rates
+   *
+   * @remarks
+   * Returns time averaged Interest Rates for Aave Reserves:
+   */
+  async avgRate(
+    request: operations.AaveAvgRateRequest,
+    options?: RequestOptions,
+  ): Promise<components.AaveAvgRateResponse> {
+    return unwrapAsync(aaveV3AvgRate(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Reserve overview
    *