@compass-labs/api-sdk 2.1.18-rc.1 → 2.1.18

package/docs/models/operations/v2earnaavetokenratesrequest.md

@@ -1,17 +0,0 @@
-# V2EarnAaveTokenRatesRequest
-
-## Example Usage
-
-```typescript
-import { V2EarnAaveTokenRatesRequest } from "@compass-labs/api-sdk/models/operations";
-
-let value: V2EarnAaveTokenRatesRequest = {
-  token: "USDC",
-};
-```
-
-## Fields
-
-| Field                                                  | Type                                                   | Required                                               | Description                                            | Example                                                |
-| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
-| `token`                                                | *string*                                               | :heavy_check_mark:                                     | The symbol or address of the token to fetch rates for. | USDC                                                   |

package/src/funcs/earnEarnAaveTokenRates.ts

@@ -1,175 +0,0 @@
-/*
- * 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";
-
-/**
- * Get token rates on Aave
- *
- * @remarks
- * This endpoint fetches token rates on Aave across Ethereum, Base, and Arbitrum.
- */
-export function earnEarnAaveTokenRates(
-  client: CompassApiSDKCore,
-  request: operations.V2EarnAaveTokenRatesRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    components.AaveUsdcRatesResponse,
-    | errors.HTTPValidationError
-    | CompassAPISDKError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: CompassApiSDKCore,
-  request: operations.V2EarnAaveTokenRatesRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      components.AaveUsdcRatesResponse,
-      | errors.HTTPValidationError
-      | CompassAPISDKError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) =>
-      operations.V2EarnAaveTokenRatesRequest$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/aave_token_rates")();
-
-  const query = encodeFormQuery({
-    "token": payload.token,
-  });
-
-  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_aave_token_rates",
-    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.AaveUsdcRatesResponse,
-    | errors.HTTPValidationError
-    | CompassAPISDKError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, components.AaveUsdcRatesResponse$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/models/components/aaveusdcratesresponse.ts

@@ -1,62 +0,0 @@
-/*
- * 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 { ChainRateData, ChainRateData$inboundSchema } from "./chainratedata.js";
-import {
-  MaxSupplyApyData,
-  MaxSupplyApyData$inboundSchema,
-} from "./maxsupplyapydata.js";
-
-/**
- * Response containing token rates on Aave for Ethereum, Base, and Arbitrum.
- */
-export type AaveUsdcRatesResponse = {
-  /**
-   * Rate data for a specific chain.
-   */
-  ethereum: ChainRateData;
-  /**
-   * Rate data for a specific chain.
-   */
-  base: ChainRateData;
-  /**
-   * Rate data for a specific chain.
-   */
-  arbitrum: ChainRateData;
-  /**
-   * Data for the chain with the highest supply APY.
-   */
-  supplyApyMax: MaxSupplyApyData;
-};
-
-/** @internal */
-export const AaveUsdcRatesResponse$inboundSchema: z.ZodType<
-  AaveUsdcRatesResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  ethereum: ChainRateData$inboundSchema,
-  base: ChainRateData$inboundSchema,
-  arbitrum: ChainRateData$inboundSchema,
-  supply_apy_max: MaxSupplyApyData$inboundSchema,
-}).transform((v) => {
-  return remap$(v, {
-    "supply_apy_max": "supplyApyMax",
-  });
-});
-
-export function aaveUsdcRatesResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<AaveUsdcRatesResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AaveUsdcRatesResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AaveUsdcRatesResponse' from JSON`,
-  );
-}

package/src/models/components/chainaavemarkets.ts

@@ -1,46 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  AaveMarketInfo,
-  AaveMarketInfo$inboundSchema,
-} from "./aavemarketinfo.js";
-
-/**
- * Aave market data for a specific chain.
- */
-export type ChainAaveMarkets = {
-  /**
-   * Chain name (ethereum, base, or arbitrum).
-   */
-  chain: string;
-  /**
-   * List of all Aave markets with their rates on this chain.
-   */
-  markets: Array<AaveMarketInfo>;
-};
-
-/** @internal */
-export const ChainAaveMarkets$inboundSchema: z.ZodType<
-  ChainAaveMarkets,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  chain: z.string(),
-  markets: z.array(AaveMarketInfo$inboundSchema),
-});
-
-export function chainAaveMarketsFromJSON(
-  jsonString: string,
-): SafeParseResult<ChainAaveMarkets, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ChainAaveMarkets$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ChainAaveMarkets' from JSON`,
-  );
-}

package/src/models/components/chainratedata.ts

@@ -1,48 +0,0 @@
-/*
- * 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";
-
-/**
- * Rate data for a specific chain.
- */
-export type ChainRateData = {
-  /**
-   * Variable rate APY for deposits.
-   */
-  supplyApyVariableRate: string;
-  /**
-   * Variable rate APY for loans.
-   */
-  borrowApyVariableRate: string;
-};
-
-/** @internal */
-export const ChainRateData$inboundSchema: z.ZodType<
-  ChainRateData,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  supply_apy_variable_rate: z.string(),
-  borrow_apy_variable_rate: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    "supply_apy_variable_rate": "supplyApyVariableRate",
-    "borrow_apy_variable_rate": "borrowApyVariableRate",
-  });
-});
-
-export function chainRateDataFromJSON(
-  jsonString: string,
-): SafeParseResult<ChainRateData, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ChainRateData$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ChainRateData' from JSON`,
-  );
-}

package/src/models/components/maxsupplyapydata.ts

@@ -1,43 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import { ChainRateData, ChainRateData$inboundSchema } from "./chainratedata.js";
-
-/**
- * Data for the chain with the highest supply APY.
- */
-export type MaxSupplyApyData = {
-  /**
-   * Name of the chain with the highest supply APY (ethereum, base, or arbitrum).
-   */
-  chain: string;
-  /**
-   * Rate data for a specific chain.
-   */
-  rates: ChainRateData;
-};
-
-/** @internal */
-export const MaxSupplyApyData$inboundSchema: z.ZodType<
-  MaxSupplyApyData,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  chain: z.string(),
-  rates: ChainRateData$inboundSchema,
-});
-
-export function maxSupplyApyDataFromJSON(
-  jsonString: string,
-): SafeParseResult<MaxSupplyApyData, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => MaxSupplyApyData$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'MaxSupplyApyData' from JSON`,
-  );
-}

package/src/models/components/maxsupplyapymarket.ts

@@ -1,46 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  AaveMarketInfo,
-  AaveMarketInfo$inboundSchema,
-} from "./aavemarketinfo.js";
-
-/**
- * Information about the market with the highest supply APY.
- */
-export type MaxSupplyApyMarket = {
-  /**
-   * Chain name where this market exists.
-   */
-  chain: string;
-  /**
-   * Rate information for a single token on Aave.
-   */
-  market: AaveMarketInfo;
-};
-
-/** @internal */
-export const MaxSupplyApyMarket$inboundSchema: z.ZodType<
-  MaxSupplyApyMarket,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  chain: z.string(),
-  market: AaveMarketInfo$inboundSchema,
-});
-
-export function maxSupplyApyMarketFromJSON(
-  jsonString: string,
-): SafeParseResult<MaxSupplyApyMarket, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => MaxSupplyApyMarket$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'MaxSupplyApyMarket' from JSON`,
-  );
-}

package/src/models/operations/v2earnaavetokenrates.ts

@@ -1,36 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-
-export type V2EarnAaveTokenRatesRequest = {
-  /**
-   * The symbol or address of the token to fetch rates for.
-   */
-  token: string;
-};
-
-/** @internal */
-export type V2EarnAaveTokenRatesRequest$Outbound = {
-  token: string;
-};
-
-/** @internal */
-export const V2EarnAaveTokenRatesRequest$outboundSchema: z.ZodType<
-  V2EarnAaveTokenRatesRequest$Outbound,
-  z.ZodTypeDef,
-  V2EarnAaveTokenRatesRequest
-> = z.object({
-  token: z.string(),
-});
-
-export function v2EarnAaveTokenRatesRequestToJSON(
-  v2EarnAaveTokenRatesRequest: V2EarnAaveTokenRatesRequest,
-): string {
-  return JSON.stringify(
-    V2EarnAaveTokenRatesRequest$outboundSchema.parse(
-      v2EarnAaveTokenRatesRequest,
-    ),
-  );
-}