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

package/src/funcs/creditCreditRepay.ts

@@ -1,177 +0,0 @@
-/*
- * 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

@@ -1,178 +0,0 @@
-/*
- * 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/models/components/accountsummary.ts

@@ -1,77 +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";
-
-/**
- * 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/collateralposition.ts

@@ -1,94 +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 { 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

@@ -1,72 +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 { 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),
-  );
-}

package/src/models/components/createcreditaccountresponse.ts

@@ -1,51 +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 {
-  UnsignedTransaction,
-  UnsignedTransaction$inboundSchema,
-} from "./unsignedtransaction.js";
-
-/**
- * Response containing unsigned transaction to create compass Credit account.
- */
-export type CreateCreditAccountResponse = {
-  /**
-   * Transaction to create compass credit account
-   */
-  transaction: UnsignedTransaction | null;
-  /**
-   * Predicted address of the compass credit account that will be deployed
-   */
-  creditAccountAddress: string;
-};
-
-/** @internal */
-export const CreateCreditAccountResponse$inboundSchema: z.ZodType<
-  CreateCreditAccountResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  transaction: z.nullable(UnsignedTransaction$inboundSchema),
-  credit_account_address: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    "credit_account_address": "creditAccountAddress",
-  });
-});
-
-export function createCreditAccountResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<CreateCreditAccountResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CreateCreditAccountResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CreateCreditAccountResponse' from JSON`,
-  );
-}