@compass-labs/api-sdk 2.2.19 → 2.2.20-rc.0

package/src/funcs/creditCreditRepay.ts

@@ -0,0 +1,177 @@
+/*
+ * 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";
+
+/**
+ * Repay debt and withdraw collateral
+ *
+ * @remarks
+ * Repay an Aave debt and withdraw collateral from a Credit Account.
+ *
+ * Bundles repayment, collateral withdrawal, and an optional swap into a single atomic Safe transaction.
+ *
+ * - If `token_out` is None or equals `withdraw_token`, the withdrawn collateral is kept as-is.
+ * - If `token_out` differs from `withdraw_token`, a swap is performed after withdrawal via 1inch.
+ *
+ * The Credit Account must already have a borrow position created via `/v2/credit/borrow`.
+ * The repay_token must be available in the Credit Account (or pulled from EOA via Permit2).
+ */
+export function creditCreditRepay(
+  client: CompassApiSDKCore,
+  request: components.CreditRepayRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.CreditRepayResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.CreditRepayRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.CreditRepayResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.CreditRepayRequest$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/credit/repay")();
+
+  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_credit_repay",
+    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.CreditRepayResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.CreditRepayResponse$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/funcs/creditCreditTransfer.ts

@@ -0,0 +1,178 @@
+/*
+ * 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";
+
+/**
+ * Get Permit2 signature data for Credit Account transfer
+ *
+ * @remarks
+ * Generate Permit2 EIP-712 typed data for transferring tokens from the owner's EOA
+ * to a Credit Account.
+ *
+ * The owner signs the returned EIP-712 data, then includes the signature in a `/v2/credit/borrow`
+ * or `/v2/credit/repay` request to atomically pull tokens from their EOA as part of the bundle.
+ *
+ * **Flow:**
+ * 1. Call this endpoint to get the Permit2 typed data
+ * 2. Sign the typed data with the owner's wallet
+ * 3. Call `/v2/credit/borrow` or `/v2/credit/repay` with the `permit2_signature`, `permit2_nonce`, and `permit2_deadline` fields
+ */
+export function creditCreditTransfer(
+  client: CompassApiSDKCore,
+  request: components.CreditTransferRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.CreditTransferResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.CreditTransferRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.CreditTransferResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.CreditTransferRequest$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/credit/transfer")();
+
+  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_credit_transfer",
+    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.CreditTransferResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.CreditTransferResponse$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.835.2",
+  genVersion: "2.836.5",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.835.2 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.836.5 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/models/components/accountsummary.ts

@@ -0,0 +1,77 @@
+/*
+ * 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";
+
+/**
+ * Aave account-level summary from getUserAccountData().
+ */
+export type AccountSummary = {
+  /**
+   * Health factor. Above 1 is safe; below 1 risks liquidation.
+   */
+  healthFactor: string;
+  /**
+   * Total collateral value in USD.
+   */
+  totalCollateralUsd: string;
+  /**
+   * Total debt value in USD.
+   */
+  totalDebtUsd: string;
+  /**
+   * Available borrow capacity in USD.
+   */
+  availableBorrowsUsd: string;
+  /**
+   * Current loan-to-value ratio.
+   */
+  ltv: string;
+  /**
+   * E-Mode category ID. 0 = disabled. E-Mode gives higher LTV when collateral and debt are price-correlated (e.g. stablecoin-to-stablecoin or ETH-to-ETH-derivative).
+   */
+  emodeCategoryId?: number | undefined;
+  /**
+   * Human-readable E-Mode category name (e.g. 'Stablecoins', 'ETH correlated'). Null when E-Mode is disabled (category 0).
+   */
+  emodeLabel?: string | null | undefined;
+};
+
+/** @internal */
+export const AccountSummary$inboundSchema: z.ZodType<
+  AccountSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  health_factor: z.string(),
+  total_collateral_usd: z.string(),
+  total_debt_usd: z.string(),
+  available_borrows_usd: z.string(),
+  ltv: z.string(),
+  emode_category_id: z.number().int().optional(),
+  emode_label: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "health_factor": "healthFactor",
+    "total_collateral_usd": "totalCollateralUsd",
+    "total_debt_usd": "totalDebtUsd",
+    "available_borrows_usd": "availableBorrowsUsd",
+    "emode_category_id": "emodeCategoryId",
+    "emode_label": "emodeLabel",
+  });
+});
+
+export function accountSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<AccountSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccountSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccountSummary' from JSON`,
+  );
+}

package/src/models/components/borrowabletoken.ts

@@ -0,0 +1,58 @@
+/*
+ * 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";
+
+/**
+ * A token available for borrowing with the maximum borrowable amount.
+ */
+export type BorrowableToken = {
+  /**
+   * Address of the borrowable token.
+   */
+  token: string;
+  /**
+   * Symbol of the borrowable token (e.g. WETH).
+   */
+  symbol: string;
+  /**
+   * Maximum amount that can be borrowed based on available borrow capacity and token price.
+   */
+  maxBorrowableAmount: string;
+  /**
+   * Current variable borrow APY in percentage (e.g. 4.5 means 4.5%).
+   */
+  borrowApy: string;
+};
+
+/** @internal */
+export const BorrowableToken$inboundSchema: z.ZodType<
+  BorrowableToken,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token: z.string(),
+  symbol: z.string(),
+  max_borrowable_amount: z.string(),
+  borrow_apy: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "max_borrowable_amount": "maxBorrowableAmount",
+    "borrow_apy": "borrowApy",
+  });
+});
+
+export function borrowableTokenFromJSON(
+  jsonString: string,
+): SafeParseResult<BorrowableToken, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BorrowableToken$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BorrowableToken' from JSON`,
+  );
+}

package/src/models/components/collateralposition.ts

@@ -0,0 +1,94 @@
+/*
+ * 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 { CreditEvent, CreditEvent$inboundSchema } from "./creditevent.js";
+
+/**
+ * A per-reserve collateral position.
+ */
+export type CollateralPosition = {
+  /**
+   * Address of the collateral token.
+   */
+  token: string;
+  /**
+   * Symbol of the collateral token (e.g. USDC).
+   */
+  symbol: string;
+  /**
+   * Current on-chain aToken balance for the collateral.
+   */
+  amountSupplied: string | null;
+  /**
+   * Collateral value in USD.
+   */
+  usdValue?: string | null | undefined;
+  /**
+   * Current supply APY in percentage (e.g. 4.5 means 4.5%).
+   */
+  supplyApy?: string | null | undefined;
+  /**
+   * Total collateral deposited over all time.
+   */
+  totalDeposited?: string | null | undefined;
+  /**
+   * Total collateral withdrawn over all time.
+   */
+  totalWithdrawn?: string | null | undefined;
+  /**
+   * Interest earned on collateral: on_chain_balance + total_withdrawn - total_deposited.
+   */
+  interestEarned?: string | null | undefined;
+  /**
+   * Maximum loan-to-value ratio for this collateral in percentage (e.g. 80 means 80%).
+   */
+  maxLtv?: string | null | undefined;
+  /**
+   * All historical events for this collateral reserve.
+   */
+  events?: Array<CreditEvent> | undefined;
+};
+
+/** @internal */
+export const CollateralPosition$inboundSchema: z.ZodType<
+  CollateralPosition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token: z.string(),
+  symbol: z.string(),
+  amount_supplied: z.nullable(z.string()),
+  usd_value: z.nullable(z.string()).optional(),
+  supply_apy: z.nullable(z.string()).optional(),
+  total_deposited: z.nullable(z.string()).optional(),
+  total_withdrawn: z.nullable(z.string()).optional(),
+  interest_earned: z.nullable(z.string()).optional(),
+  max_ltv: z.nullable(z.string()).optional(),
+  events: z.array(CreditEvent$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "amount_supplied": "amountSupplied",
+    "usd_value": "usdValue",
+    "supply_apy": "supplyApy",
+    "total_deposited": "totalDeposited",
+    "total_withdrawn": "totalWithdrawn",
+    "interest_earned": "interestEarned",
+    "max_ltv": "maxLtv",
+  });
+});
+
+export function collateralPositionFromJSON(
+  jsonString: string,
+): SafeParseResult<CollateralPosition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CollateralPosition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CollateralPosition' from JSON`,
+  );
+}

package/src/models/components/createcreditaccountrequest.ts

@@ -0,0 +1,72 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+
+export const CreateCreditAccountRequestChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Ethereum: "ethereum",
+} as const;
+export type CreateCreditAccountRequestChain = ClosedEnum<
+  typeof CreateCreditAccountRequestChain
+>;
+
+/**
+ * Request to create a compass credit account.
+ */
+export type CreateCreditAccountRequest = {
+  chain: CreateCreditAccountRequestChain;
+  /**
+   * The address of the transaction sender.
+   */
+  sender: string;
+  /**
+   * Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
+   */
+  estimateGas?: boolean | undefined;
+  /**
+   * The address that will own and control the compass credit account
+   */
+  owner: string;
+};
+
+/** @internal */
+export const CreateCreditAccountRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof CreateCreditAccountRequestChain
+> = z.nativeEnum(CreateCreditAccountRequestChain);
+
+/** @internal */
+export type CreateCreditAccountRequest$Outbound = {
+  chain: string;
+  sender: string;
+  estimate_gas?: boolean | undefined;
+  owner: string;
+};
+
+/** @internal */
+export const CreateCreditAccountRequest$outboundSchema: z.ZodType<
+  CreateCreditAccountRequest$Outbound,
+  z.ZodTypeDef,
+  CreateCreditAccountRequest
+> = z.object({
+  chain: CreateCreditAccountRequestChain$outboundSchema,
+  sender: z.string(),
+  estimateGas: z.boolean().optional(),
+  owner: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    estimateGas: "estimate_gas",
+  });
+});
+
+export function createCreditAccountRequestToJSON(
+  createCreditAccountRequest: CreateCreditAccountRequest,
+): string {
+  return JSON.stringify(
+    CreateCreditAccountRequest$outboundSchema.parse(createCreditAccountRequest),
+  );
+}