@compass-labs/api-sdk 0.0.27 → 0.0.29

package/src/models/components/skysellparams.ts

@@ -0,0 +1,168 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
+ */
+export const SkySellParamsTokenOut = {
+  Dai: "DAI",
+  Usdc: "USDC",
+} as const;
+/**
+ * The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
+ */
+export type SkySellParamsTokenOut = ClosedEnum<typeof SkySellParamsTokenOut>;
+
+/**
+ * The amount of USDS you would like to sell 1:1 for 'token_out'.
+ */
+export type SkySellParamsAmount = number | string;
+
+export type SkySellParams = {
+  /**
+   * The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
+   */
+  tokenOut: SkySellParamsTokenOut;
+  /**
+   * The amount of USDS you would like to sell 1:1 for 'token_out'.
+   */
+  amount: number | string;
+};
+
+/** @internal */
+export const SkySellParamsTokenOut$inboundSchema: z.ZodNativeEnum<
+  typeof SkySellParamsTokenOut
+> = z.nativeEnum(SkySellParamsTokenOut);
+
+/** @internal */
+export const SkySellParamsTokenOut$outboundSchema: z.ZodNativeEnum<
+  typeof SkySellParamsTokenOut
+> = SkySellParamsTokenOut$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SkySellParamsTokenOut$ {
+  /** @deprecated use `SkySellParamsTokenOut$inboundSchema` instead. */
+  export const inboundSchema = SkySellParamsTokenOut$inboundSchema;
+  /** @deprecated use `SkySellParamsTokenOut$outboundSchema` instead. */
+  export const outboundSchema = SkySellParamsTokenOut$outboundSchema;
+}
+
+/** @internal */
+export const SkySellParamsAmount$inboundSchema: z.ZodType<
+  SkySellParamsAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type SkySellParamsAmount$Outbound = number | string;
+
+/** @internal */
+export const SkySellParamsAmount$outboundSchema: z.ZodType<
+  SkySellParamsAmount$Outbound,
+  z.ZodTypeDef,
+  SkySellParamsAmount
+> = z.union([z.number(), z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SkySellParamsAmount$ {
+  /** @deprecated use `SkySellParamsAmount$inboundSchema` instead. */
+  export const inboundSchema = SkySellParamsAmount$inboundSchema;
+  /** @deprecated use `SkySellParamsAmount$outboundSchema` instead. */
+  export const outboundSchema = SkySellParamsAmount$outboundSchema;
+  /** @deprecated use `SkySellParamsAmount$Outbound` instead. */
+  export type Outbound = SkySellParamsAmount$Outbound;
+}
+
+export function skySellParamsAmountToJSON(
+  skySellParamsAmount: SkySellParamsAmount,
+): string {
+  return JSON.stringify(
+    SkySellParamsAmount$outboundSchema.parse(skySellParamsAmount),
+  );
+}
+
+export function skySellParamsAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<SkySellParamsAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SkySellParamsAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SkySellParamsAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const SkySellParams$inboundSchema: z.ZodType<
+  SkySellParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token_out: SkySellParamsTokenOut$inboundSchema,
+  amount: z.union([z.number(), z.string()]),
+}).transform((v) => {
+  return remap$(v, {
+    "token_out": "tokenOut",
+  });
+});
+
+/** @internal */
+export type SkySellParams$Outbound = {
+  token_out: string;
+  amount: number | string;
+};
+
+/** @internal */
+export const SkySellParams$outboundSchema: z.ZodType<
+  SkySellParams$Outbound,
+  z.ZodTypeDef,
+  SkySellParams
+> = z.object({
+  tokenOut: SkySellParamsTokenOut$outboundSchema,
+  amount: z.union([z.number(), z.string()]),
+}).transform((v) => {
+  return remap$(v, {
+    tokenOut: "token_out",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SkySellParams$ {
+  /** @deprecated use `SkySellParams$inboundSchema` instead. */
+  export const inboundSchema = SkySellParams$inboundSchema;
+  /** @deprecated use `SkySellParams$outboundSchema` instead. */
+  export const outboundSchema = SkySellParams$outboundSchema;
+  /** @deprecated use `SkySellParams$Outbound` instead. */
+  export type Outbound = SkySellParams$Outbound;
+}
+
+export function skySellParamsToJSON(skySellParams: SkySellParams): string {
+  return JSON.stringify(SkySellParams$outboundSchema.parse(skySellParams));
+}
+
+export function skySellParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<SkySellParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SkySellParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SkySellParams' from JSON`,
+  );
+}

package/src/models/components/skysellrequest.ts

@@ -12,14 +12,14 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
  */
-export const TokenOut = {
+export const SkySellRequestTokenOut = {
   Dai: "DAI",
   Usdc: "USDC",
 } as const;
 /**
  * The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
  */
-export type TokenOut = ClosedEnum<typeof TokenOut>;
+export type SkySellRequestTokenOut = ClosedEnum<typeof SkySellRequestTokenOut>;
 
 /**
  * The amount of USDS you would like to sell 1:1 for 'token_out'.
@@ -30,7 +30,7 @@ export type SkySellRequest = {
   /**
    * The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
    */
-  tokenOut: TokenOut;
+  tokenOut: SkySellRequestTokenOut;
   /**
    * The amount of USDS you would like to sell 1:1 for 'token_out'.
    */
@@ -43,22 +43,24 @@ export type SkySellRequest = {
 };
 
 /** @internal */
-export const TokenOut$inboundSchema: z.ZodNativeEnum<typeof TokenOut> = z
-  .nativeEnum(TokenOut);
+export const SkySellRequestTokenOut$inboundSchema: z.ZodNativeEnum<
+  typeof SkySellRequestTokenOut
+> = z.nativeEnum(SkySellRequestTokenOut);
 
 /** @internal */
-export const TokenOut$outboundSchema: z.ZodNativeEnum<typeof TokenOut> =
-  TokenOut$inboundSchema;
+export const SkySellRequestTokenOut$outboundSchema: z.ZodNativeEnum<
+  typeof SkySellRequestTokenOut
+> = SkySellRequestTokenOut$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace TokenOut$ {
-  /** @deprecated use `TokenOut$inboundSchema` instead. */
-  export const inboundSchema = TokenOut$inboundSchema;
-  /** @deprecated use `TokenOut$outboundSchema` instead. */
-  export const outboundSchema = TokenOut$outboundSchema;
+export namespace SkySellRequestTokenOut$ {
+  /** @deprecated use `SkySellRequestTokenOut$inboundSchema` instead. */
+  export const inboundSchema = SkySellRequestTokenOut$inboundSchema;
+  /** @deprecated use `SkySellRequestTokenOut$outboundSchema` instead. */
+  export const outboundSchema = SkySellRequestTokenOut$outboundSchema;
 }
 
 /** @internal */
@@ -115,7 +117,7 @@ export const SkySellRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  token_out: TokenOut$inboundSchema,
+  token_out: SkySellRequestTokenOut$inboundSchema,
   amount: z.union([z.number(), z.string()]),
   chain: z.literal("ethereum:mainnet").default("ethereum:mainnet"),
   sender: z.string(),
@@ -139,7 +141,7 @@ export const SkySellRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SkySellRequest
 > = z.object({
-  tokenOut: TokenOut$outboundSchema,
+  tokenOut: SkySellRequestTokenOut$outboundSchema,
   amount: z.union([z.number(), z.string()]),
   chain: z.literal("ethereum:mainnet").default("ethereum:mainnet" as const),
   sender: z.string(),

package/src/models/components/skywithdrawparams.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SkyWithdrawParams = {
+  /**
+   * The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.
+   */
+  amount?: any | undefined;
+  /**
+   * The address which will receive the withdrawn USDS. Defaults to the sender.
+   */
+  receiver?: string | null | undefined;
+};
+
+/** @internal */
+export const SkyWithdrawParams$inboundSchema: z.ZodType<
+  SkyWithdrawParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: z.any().optional(),
+  receiver: z.nullable(z.string()).optional(),
+});
+
+/** @internal */
+export type SkyWithdrawParams$Outbound = {
+  amount?: any | undefined;
+  receiver?: string | null | undefined;
+};
+
+/** @internal */
+export const SkyWithdrawParams$outboundSchema: z.ZodType<
+  SkyWithdrawParams$Outbound,
+  z.ZodTypeDef,
+  SkyWithdrawParams
+> = z.object({
+  amount: z.any().optional(),
+  receiver: z.nullable(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SkyWithdrawParams$ {
+  /** @deprecated use `SkyWithdrawParams$inboundSchema` instead. */
+  export const inboundSchema = SkyWithdrawParams$inboundSchema;
+  /** @deprecated use `SkyWithdrawParams$outboundSchema` instead. */
+  export const outboundSchema = SkyWithdrawParams$outboundSchema;
+  /** @deprecated use `SkyWithdrawParams$Outbound` instead. */
+  export type Outbound = SkyWithdrawParams$Outbound;
+}
+
+export function skyWithdrawParamsToJSON(
+  skyWithdrawParams: SkyWithdrawParams,
+): string {
+  return JSON.stringify(
+    SkyWithdrawParams$outboundSchema.parse(skyWithdrawParams),
+  );
+}
+
+export function skyWithdrawParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<SkyWithdrawParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SkyWithdrawParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SkyWithdrawParams' from JSON`,
+  );
+}

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
    *