@compass-labs/api-sdk 1.5.1 → 1.5.2

package/src/models/components/{compassapibackendv2modelsgaslesstransferpermittypeddataeip712types.ts → compassapibackendv2modelsgassponsorshippermittypeddataeip712types.ts}

@@ -23,7 +23,7 @@ import {
 /**
  * The type definitions for EIP-712 structured data (ERC-20 Permit).
  */
-export type CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types =
+export type CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types =
   {
     /**
      * EIP712Domain type definition
@@ -36,9 +36,9 @@ export type CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types =
   };
 
 /** @internal */
-export const CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types$inboundSchema:
+export const CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types$inboundSchema:
   z.ZodType<
-    CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types,
+    CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types,
     z.ZodTypeDef,
     unknown
   > = z.object({
@@ -51,18 +51,18 @@ export const CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types$
     });
   });
 /** @internal */
-export type CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types$Outbound =
+export type CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types$Outbound =
   {
     EIP712Domain: Array<Eip712DomainField$Outbound>;
     Permit: Array<PermitField$Outbound>;
   };
 
 /** @internal */
-export const CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types$outboundSchema:
+export const CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types$outboundSchema:
   z.ZodType<
-    CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types$Outbound,
+    CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types$Outbound,
     z.ZodTypeDef,
-    CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types
+    CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types
   > = z.object({
     eip712Domain: z.array(Eip712DomainField$outboundSchema),
     permit: z.array(PermitField$outboundSchema),
@@ -73,28 +73,26 @@ export const CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types$
     });
   });
 
-export function compassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712TypesToJSON(
-  compassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types:
-    CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types,
+export function compassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712TypesToJSON(
+  compassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types:
+    CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types,
 ): string {
   return JSON.stringify(
-    CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types$outboundSchema
-      .parse(
-        compassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types,
-      ),
+    CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types$outboundSchema
+      .parse(compassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types),
   );
 }
-export function compassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712TypesFromJSON(
+export function compassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712TypesFromJSON(
   jsonString: string,
 ): SafeParseResult<
-  CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types,
+  CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types,
   SDKValidationError
 > {
   return safeParse(
     jsonString,
     (x) =>
-      CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types$inboundSchema
+      CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types$inboundSchema
         .parse(JSON.parse(x)),
-    `Failed to parse 'CompassApiBackendV2ModelsGaslessTransferPermitTypedDataEip712Types' from JSON`,
+    `Failed to parse 'CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types' from JSON`,
   );
 }

package/src/models/components/createaccountresponse.ts

@@ -15,14 +15,14 @@ import {
 } from "./unsignedtransaction.js";
 
 /**
- * Response containing unsigned transaction to create compass account.
+ * Response containing unsigned transaction to create compass Earn account.
  */
 export type CreateAccountResponse = {
   transaction: UnsignedTransaction;
   /**
-   * Predicted address of the compass account that will be deployed
+   * Predicted address of the compass earn account that will be deployed
    */
-  predictedSafeAddress: string;
+  earnAccountAddress: string;
 };
 
 /** @internal */
@@ -32,16 +32,16 @@ export const CreateAccountResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   transaction: UnsignedTransaction$inboundSchema,
-  predicted_safe_address: z.string(),
+  earn_account_address: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    "predicted_safe_address": "predictedSafeAddress",
+    "earn_account_address": "earnAccountAddress",
   });
 });
 /** @internal */
 export type CreateAccountResponse$Outbound = {
   transaction: UnsignedTransaction$Outbound;
-  predicted_safe_address: string;
+  earn_account_address: string;
 };
 
 /** @internal */
@@ -51,10 +51,10 @@ export const CreateAccountResponse$outboundSchema: z.ZodType<
   CreateAccountResponse
 > = z.object({
   transaction: UnsignedTransaction$outboundSchema,
-  predictedSafeAddress: z.string(),
+  earnAccountAddress: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    predictedSafeAddress: "predicted_safe_address",
+    earnAccountAddress: "earn_account_address",
   });
 });
 

package/src/models/components/earnmanagerequest.ts

@@ -0,0 +1,224 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AaveMarket,
+  AaveMarket$inboundSchema,
+  AaveMarket$Outbound,
+  AaveMarket$outboundSchema,
+} from "./aavemarket.js";
+import { Chain, Chain$inboundSchema, Chain$outboundSchema } from "./chain.js";
+import {
+  Fee,
+  Fee$inboundSchema,
+  Fee$Outbound,
+  Fee$outboundSchema,
+} from "./fee.js";
+import {
+  VaultMarket,
+  VaultMarket$inboundSchema,
+  VaultMarket$Outbound,
+  VaultMarket$outboundSchema,
+} from "./vaultmarket.js";
+
+/**
+ * The earn market.
+ */
+export type MarketUnion =
+  | (AaveMarket & { type: "AAVE" })
+  | (VaultMarket & { type: "VAULT" });
+
+/**
+ * Whether you are depositing into or withdrawing from the given Earn `market`.
+ */
+export const EarnManageRequestAction = {
+  Deposit: "DEPOSIT",
+  Withdraw: "WITHDRAW",
+} as const;
+/**
+ * Whether you are depositing into or withdrawing from the given Earn `market`.
+ */
+export type EarnManageRequestAction = ClosedEnum<
+  typeof EarnManageRequestAction
+>;
+
+export type EarnManageRequest = {
+  /**
+   * The owner's wallet address.
+   */
+  owner: string;
+  /**
+   * The chain to use.
+   */
+  chain: Chain;
+  /**
+   * The earn market.
+   */
+  market: (AaveMarket & { type: "AAVE" }) | (VaultMarket & { type: "VAULT" });
+  /**
+   * Whether you are depositing into or withdrawing from the given Earn `market`.
+   */
+  action: EarnManageRequestAction;
+  /**
+   * Amount of the underlying asset to act on (deposit or withdraw). For VAULT, this is the vault’s underlying token; for AAVE, this is the Aave reserve asset. Provide as a decimal in token units (not wei); must be > 0.
+   */
+  amount?: any | undefined;
+  /**
+   * Optionally request gas sponsorship. If set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
+   */
+  gasSponsorship?: boolean | undefined;
+  /**
+   * Optional fee configuration. If provided, a fee will be applied to the transaction amount and sent to the specified recipient address. The fee can be specified as a percentage of the transaction amount or as a fixed token amount.
+   */
+  fee?: Fee | null | undefined;
+};
+
+/** @internal */
+export const MarketUnion$inboundSchema: z.ZodType<
+  MarketUnion,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  AaveMarket$inboundSchema.and(
+    z.object({ type: z.literal("AAVE") }).transform((v) => ({ type: v.type })),
+  ),
+  VaultMarket$inboundSchema.and(
+    z.object({ type: z.literal("VAULT") }).transform((v) => ({ type: v.type })),
+  ),
+]);
+/** @internal */
+export type MarketUnion$Outbound =
+  | (AaveMarket$Outbound & { type: "AAVE" })
+  | (VaultMarket$Outbound & { type: "VAULT" });
+
+/** @internal */
+export const MarketUnion$outboundSchema: z.ZodType<
+  MarketUnion$Outbound,
+  z.ZodTypeDef,
+  MarketUnion
+> = z.union([
+  AaveMarket$outboundSchema.and(
+    z.object({ type: z.literal("AAVE") }).transform((v) => ({ type: v.type })),
+  ),
+  VaultMarket$outboundSchema.and(
+    z.object({ type: z.literal("VAULT") }).transform((v) => ({ type: v.type })),
+  ),
+]);
+
+export function marketUnionToJSON(marketUnion: MarketUnion): string {
+  return JSON.stringify(MarketUnion$outboundSchema.parse(marketUnion));
+}
+export function marketUnionFromJSON(
+  jsonString: string,
+): SafeParseResult<MarketUnion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MarketUnion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MarketUnion' from JSON`,
+  );
+}
+
+/** @internal */
+export const EarnManageRequestAction$inboundSchema: z.ZodNativeEnum<
+  typeof EarnManageRequestAction
+> = z.nativeEnum(EarnManageRequestAction);
+/** @internal */
+export const EarnManageRequestAction$outboundSchema: z.ZodNativeEnum<
+  typeof EarnManageRequestAction
+> = EarnManageRequestAction$inboundSchema;
+
+/** @internal */
+export const EarnManageRequest$inboundSchema: z.ZodType<
+  EarnManageRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  owner: z.string(),
+  chain: Chain$inboundSchema,
+  market: z.union([
+    AaveMarket$inboundSchema.and(
+      z.object({ type: z.literal("AAVE") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    VaultMarket$inboundSchema.and(
+      z.object({ type: z.literal("VAULT") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]),
+  action: EarnManageRequestAction$inboundSchema,
+  amount: z.any().optional(),
+  gas_sponsorship: z.boolean().optional(),
+  fee: z.nullable(Fee$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "gas_sponsorship": "gasSponsorship",
+  });
+});
+/** @internal */
+export type EarnManageRequest$Outbound = {
+  owner: string;
+  chain: string;
+  market:
+    | (AaveMarket$Outbound & { type: "AAVE" })
+    | (VaultMarket$Outbound & { type: "VAULT" });
+  action: string;
+  amount?: any | undefined;
+  gas_sponsorship?: boolean | undefined;
+  fee?: Fee$Outbound | null | undefined;
+};
+
+/** @internal */
+export const EarnManageRequest$outboundSchema: z.ZodType<
+  EarnManageRequest$Outbound,
+  z.ZodTypeDef,
+  EarnManageRequest
+> = z.object({
+  owner: z.string(),
+  chain: Chain$outboundSchema,
+  market: z.union([
+    AaveMarket$outboundSchema.and(
+      z.object({ type: z.literal("AAVE") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    VaultMarket$outboundSchema.and(
+      z.object({ type: z.literal("VAULT") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]),
+  action: EarnManageRequestAction$outboundSchema,
+  amount: z.any().optional(),
+  gasSponsorship: z.boolean().optional(),
+  fee: z.nullable(Fee$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    gasSponsorship: "gas_sponsorship",
+  });
+});
+
+export function earnManageRequestToJSON(
+  earnManageRequest: EarnManageRequest,
+): string {
+  return JSON.stringify(
+    EarnManageRequest$outboundSchema.parse(earnManageRequest),
+  );
+}
+export function earnManageRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<EarnManageRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EarnManageRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EarnManageRequest' from JSON`,
+  );
+}

package/src/models/components/{earndepositresponse.ts → earnmanageresponse.ts}

@@ -20,14 +20,14 @@ import {
   UnsignedTransaction$outboundSchema,
 } from "./unsignedtransaction.js";
 
-export type EarnDepositResponse = {
+export type EarnManageResponse = {
   transaction: UnsignedTransaction | null;
   eip712: BatchedSafeOperationsResponseOutput | null;
 };
 
 /** @internal */
-export const EarnDepositResponse$inboundSchema: z.ZodType<
-  EarnDepositResponse,
+export const EarnManageResponse$inboundSchema: z.ZodType<
+  EarnManageResponse,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -39,16 +39,16 @@ export const EarnDepositResponse$inboundSchema: z.ZodType<
   });
 });
 /** @internal */
-export type EarnDepositResponse$Outbound = {
+export type EarnManageResponse$Outbound = {
   transaction: UnsignedTransaction$Outbound | null;
   eip_712: BatchedSafeOperationsResponseOutput$Outbound | null;
 };
 
 /** @internal */
-export const EarnDepositResponse$outboundSchema: z.ZodType<
-  EarnDepositResponse$Outbound,
+export const EarnManageResponse$outboundSchema: z.ZodType<
+  EarnManageResponse$Outbound,
   z.ZodTypeDef,
-  EarnDepositResponse
+  EarnManageResponse
 > = z.object({
   transaction: z.nullable(UnsignedTransaction$outboundSchema),
   eip712: z.nullable(BatchedSafeOperationsResponseOutput$outboundSchema),
@@ -58,19 +58,19 @@ export const EarnDepositResponse$outboundSchema: z.ZodType<
   });
 });
 
-export function earnDepositResponseToJSON(
-  earnDepositResponse: EarnDepositResponse,
+export function earnManageResponseToJSON(
+  earnManageResponse: EarnManageResponse,
 ): string {
   return JSON.stringify(
-    EarnDepositResponse$outboundSchema.parse(earnDepositResponse),
+    EarnManageResponse$outboundSchema.parse(earnManageResponse),
   );
 }
-export function earnDepositResponseFromJSON(
+export function earnManageResponseFromJSON(
   jsonString: string,
-): SafeParseResult<EarnDepositResponse, SDKValidationError> {
+): SafeParseResult<EarnManageResponse, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => EarnDepositResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'EarnDepositResponse' from JSON`,
+    (x) => EarnManageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EarnManageResponse' from JSON`,
   );
 }

package/src/models/components/earnpositionresponse.ts

@@ -0,0 +1,165 @@
+/*
+ * 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 {
+  AavePosition,
+  AavePosition$inboundSchema,
+  AavePosition$Outbound,
+  AavePosition$outboundSchema,
+} from "./aaveposition.js";
+import {
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition,
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema,
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$Outbound,
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$outboundSchema,
+} from "./compassapibackendv2modelsearnreadresponsepositionsvaultposition.js";
+
+/**
+ * The user's earn position.
+ */
+export type PositionUnion =
+  | (CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition & {
+    type: "VAULT";
+  })
+  | (AavePosition & { type: "AAVE" });
+
+/**
+ * Response model for a single earn position.
+ */
+export type EarnPositionResponse = {
+  /**
+   * The user's earn position.
+   */
+  position:
+    | (CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition & {
+      type: "VAULT";
+    })
+    | (AavePosition & { type: "AAVE" });
+};
+
+/** @internal */
+export const PositionUnion$inboundSchema: z.ZodType<
+  PositionUnion,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema
+    .and(
+      z.object({ type: z.literal("VAULT") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  AavePosition$inboundSchema.and(
+    z.object({ type: z.literal("AAVE") }).transform((v) => ({ type: v.type })),
+  ),
+]);
+/** @internal */
+export type PositionUnion$Outbound =
+  | (
+    & CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$Outbound
+    & { type: "VAULT" }
+  )
+  | (AavePosition$Outbound & { type: "AAVE" });
+
+/** @internal */
+export const PositionUnion$outboundSchema: z.ZodType<
+  PositionUnion$Outbound,
+  z.ZodTypeDef,
+  PositionUnion
+> = z.union([
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$outboundSchema
+    .and(
+      z.object({ type: z.literal("VAULT") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  AavePosition$outboundSchema.and(
+    z.object({ type: z.literal("AAVE") }).transform((v) => ({ type: v.type })),
+  ),
+]);
+
+export function positionUnionToJSON(positionUnion: PositionUnion): string {
+  return JSON.stringify(PositionUnion$outboundSchema.parse(positionUnion));
+}
+export function positionUnionFromJSON(
+  jsonString: string,
+): SafeParseResult<PositionUnion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PositionUnion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PositionUnion' from JSON`,
+  );
+}
+
+/** @internal */
+export const EarnPositionResponse$inboundSchema: z.ZodType<
+  EarnPositionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  position: z.union([
+    CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema
+      .and(
+        z.object({ type: z.literal("VAULT") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+    AavePosition$inboundSchema.and(
+      z.object({ type: z.literal("AAVE") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]),
+});
+/** @internal */
+export type EarnPositionResponse$Outbound = {
+  position:
+    | (
+      & CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$Outbound
+      & { type: "VAULT" }
+    )
+    | (AavePosition$Outbound & { type: "AAVE" });
+};
+
+/** @internal */
+export const EarnPositionResponse$outboundSchema: z.ZodType<
+  EarnPositionResponse$Outbound,
+  z.ZodTypeDef,
+  EarnPositionResponse
+> = z.object({
+  position: z.union([
+    CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$outboundSchema
+      .and(
+        z.object({ type: z.literal("VAULT") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+    AavePosition$outboundSchema.and(
+      z.object({ type: z.literal("AAVE") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]),
+});
+
+export function earnPositionResponseToJSON(
+  earnPositionResponse: EarnPositionResponse,
+): string {
+  return JSON.stringify(
+    EarnPositionResponse$outboundSchema.parse(earnPositionResponse),
+  );
+}
+export function earnPositionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EarnPositionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EarnPositionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EarnPositionResponse' from JSON`,
+  );
+}

package/src/models/components/earntransferrequest.ts

@@ -16,14 +16,14 @@ import { Chain, Chain$inboundSchema, Chain$outboundSchema } from "./chain.js";
 export type EarnTransferRequestAmount = number | string;
 
 /**
- * Whether you are funding or withdrawing from your earn account.
+ * Whether you are depositing to or withdrawing from your earn account.
  */
 export const EarnTransferRequestAction = {
-  Fund: "FUND",
+  Deposit: "DEPOSIT",
   Withdraw: "WITHDRAW",
 } as const;
 /**
- * Whether you are funding or withdrawing from your earn account.
+ * Whether you are depositing to or withdrawing from your earn account.
  */
 export type EarnTransferRequestAction = ClosedEnum<
   typeof EarnTransferRequestAction
@@ -47,7 +47,7 @@ export type EarnTransferRequest = {
    */
   amount: number | string;
   /**
-   * Whether you are funding or withdrawing from your earn account.
+   * Whether you are depositing to or withdrawing from your earn account.
    */
   action: EarnTransferRequestAction;
   /**
@@ -55,7 +55,7 @@ export type EarnTransferRequest = {
    */
   gasSponsorship?: boolean | undefined;
   /**
-   * The address of the wallet which will send the transaction. This only needs to be set when 'action' is 'FUND' and `gas_sponsorship` is `true`.
+   * The address of the wallet which will send the transaction. This only needs to be set when `action` is 'DEPOSIT' and `gas_sponsorship` is `true`.
    */
   spender?: string | null | undefined;
 };