@compass-labs/api-sdk 2.2.40-rc.0 → 2.2.40

package/src/models/components/creditfee.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit).
+ */
+export type CreditFeeAmount = number | string;
+
+/**
+ * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the borrow amount), or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).
+ */
+export const CreditFeeDenomination = {
+  Percentage: "PERCENTAGE",
+  Fixed: "FIXED",
+} as const;
+/**
+ * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the borrow amount), or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).
+ */
+export type CreditFeeDenomination = ClosedEnum<typeof CreditFeeDenomination>;
+
+/**
+ * Fee configuration for credit-product actions.
+ *
+ * @remarks
+ *
+ * Same shape as `Fee`, but narrows `denomination` to the values supported by
+ * credit borrows. PERFORMANCE is not supported because realized-profit fees
+ * are not meaningful for debt positions.
+ */
+export type CreditFee = {
+  /**
+   * The wallet address that will receive the fee.
+   */
+  recipient: string;
+  /**
+   * The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit).
+   */
+  amount: number | string;
+  /**
+   * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the borrow amount), or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).
+   */
+  denomination?: CreditFeeDenomination | undefined;
+};
+
+/** @internal */
+export type CreditFeeAmount$Outbound = number | string;
+
+/** @internal */
+export const CreditFeeAmount$outboundSchema: z.ZodType<
+  CreditFeeAmount$Outbound,
+  z.ZodTypeDef,
+  CreditFeeAmount
+> = z.union([z.number(), z.string()]);
+
+export function creditFeeAmountToJSON(
+  creditFeeAmount: CreditFeeAmount,
+): string {
+  return JSON.stringify(CreditFeeAmount$outboundSchema.parse(creditFeeAmount));
+}
+
+/** @internal */
+export const CreditFeeDenomination$outboundSchema: z.ZodNativeEnum<
+  typeof CreditFeeDenomination
+> = z.nativeEnum(CreditFeeDenomination);
+
+/** @internal */
+export type CreditFee$Outbound = {
+  recipient: string;
+  amount: number | string;
+  denomination?: string | undefined;
+};
+
+/** @internal */
+export const CreditFee$outboundSchema: z.ZodType<
+  CreditFee$Outbound,
+  z.ZodTypeDef,
+  CreditFee
+> = z.object({
+  recipient: z.string(),
+  amount: z.union([z.number(), z.string()]),
+  denomination: CreditFeeDenomination$outboundSchema.optional(),
+});
+
+export function creditFeeToJSON(creditFee: CreditFee): string {
+  return JSON.stringify(CreditFee$outboundSchema.parse(creditFee));
+}

package/src/models/components/fee.ts

@@ -13,7 +13,7 @@ export type FeeAmount = number | string;
 /**
  * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit).
  */
-export const Denomination = {
+export const FeeDenomination = {
   Percentage: "PERCENTAGE",
   Fixed: "FIXED",
   Performance: "PERFORMANCE",
@@ -21,7 +21,7 @@ export const Denomination = {
 /**
  * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit).
  */
-export type Denomination = ClosedEnum<typeof Denomination>;
+export type FeeDenomination = ClosedEnum<typeof FeeDenomination>;
 
 export type Fee = {
   /**
@@ -35,7 +35,7 @@ export type Fee = {
   /**
    * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit).
    */
-  denomination?: Denomination | undefined;
+  denomination?: FeeDenomination | undefined;
 };
 
 /** @internal */
@@ -53,8 +53,9 @@ export function feeAmountToJSON(feeAmount: FeeAmount): string {
 }
 
 /** @internal */
-export const Denomination$outboundSchema: z.ZodNativeEnum<typeof Denomination> =
-  z.nativeEnum(Denomination);
+export const FeeDenomination$outboundSchema: z.ZodNativeEnum<
+  typeof FeeDenomination
+> = z.nativeEnum(FeeDenomination);
 
 /** @internal */
 export type Fee$Outbound = {
@@ -68,7 +69,7 @@ export const Fee$outboundSchema: z.ZodType<Fee$Outbound, z.ZodTypeDef, Fee> = z
   .object({
     recipient: z.string(),
     amount: z.union([z.number(), z.string()]),
-    denomination: Denomination$outboundSchema.optional(),
+    denomination: FeeDenomination$outboundSchema.optional(),
   });
 
 export function feeToJSON(fee: Fee): string {

package/src/models/components/index.ts

@@ -93,6 +93,7 @@ export * from "./creditbundlerequest.js";
 export * from "./creditbundleresponse.js";
 export * from "./creditenablecollateralparams.js";
 export * from "./creditevent.js";
+export * from "./creditfee.js";
 export * from "./creditpositionsresponse.js";
 export * from "./creditrepayparams.js";
 export * from "./creditrepayrequest.js";