@compass-labs/api-sdk 0.0.21 → 0.0.23

package/FUNCTIONS.md

@@ -20,7 +20,7 @@ specific category of applications.
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { aaveV3Rate } from "@compass-labs/api-sdk/funcs/aaveV3Rate.js";
+import { aaveV3ReserveOverview } from "@compass-labs/api-sdk/funcs/aaveV3ReserveOverview.js";
 import { SDKValidationError } from "@compass-labs/api-sdk/models/errors/sdkvalidationerror.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
@@ -30,7 +30,7 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await aaveV3Rate(compassApiSDK, {
+  const res = await aaveV3ReserveOverview(compassApiSDK, {
     chain: "arbitrum:mainnet",
     token: "USDC",
   });

package/README.md

@@ -175,7 +175,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.rate({
+  const result = await compassApiSDK.aaveV3.reserveOverview({
     chain: "arbitrum:mainnet",
     token: "USDC",
   });
@@ -209,7 +209,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.rate({
+  const result = await compassApiSDK.aaveV3.reserveOverview({
     chain: "arbitrum:mainnet",
     token: "USDC",
   });
@@ -231,6 +231,7 @@ run();
 
 ### [aaveV3](docs/sdks/aavev3/README.md)
 
+* [reserveOverview](docs/sdks/aavev3/README.md#reserveoverview) - Reserve overview
 * [rate](docs/sdks/aavev3/README.md#rate) - Interest rates
 * [tokenPrice](docs/sdks/aavev3/README.md#tokenprice) - Token prices
 * [liquidityChange](docs/sdks/aavev3/README.md#liquiditychange) - Liquidity index
@@ -334,6 +335,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`aaveV3LiquidityChange`](docs/sdks/aavev3/README.md#liquiditychange) - Liquidity index
 - [`aaveV3Rate`](docs/sdks/aavev3/README.md#rate) - Interest rates
 - [`aaveV3Repay`](docs/sdks/aavev3/README.md#repay) - Repay loans
+- [`aaveV3ReserveOverview`](docs/sdks/aavev3/README.md#reserveoverview) - Reserve overview
 - [`aaveV3Supply`](docs/sdks/aavev3/README.md#supply) - Supply/Lend
 - [`aaveV3TokenPrice`](docs/sdks/aavev3/README.md#tokenprice) - Token prices
 - [`aaveV3UserPositionPerToken`](docs/sdks/aavev3/README.md#userpositionpertoken) - Positions - per token
@@ -404,7 +406,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.rate({
+  const result = await compassApiSDK.aaveV3.reserveOverview({
     chain: "arbitrum:mainnet",
     token: "USDC",
   }, {
@@ -447,7 +449,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.rate({
+  const result = await compassApiSDK.aaveV3.reserveOverview({
     chain: "arbitrum:mainnet",
     token: "USDC",
   });
@@ -464,7 +466,7 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `rate` method may throw the following errors:
+Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `reserveOverview` method may throw the following errors:
 
 | Error Type                 | Status Code | Content Type     |
 | -------------------------- | ----------- | ---------------- |
@@ -487,7 +489,7 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   let result;
   try {
-    result = await compassApiSDK.aaveV3.rate({
+    result = await compassApiSDK.aaveV3.reserveOverview({
       chain: "arbitrum:mainnet",
       token: "USDC",
     });
@@ -549,7 +551,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.rate({
+  const result = await compassApiSDK.aaveV3.reserveOverview({
     chain: "arbitrum:mainnet",
     token: "USDC",
   });