@privy-io/api-types 0.8.0 → 0.10.0

package/src/resources/yield.ts

@@ -5,126 +5,111 @@ import { APIResource } from '../core/resource';
 export class Yield extends APIResource {}
 
 /**
- * An EVM CAIP-2 chain identifier (e.g., "eip155:8453" for Base).
- */
-export type EvmCaip2ChainID = string;
-
-/**
- * Supported yield/lending protocol providers.
- */
-export type EthereumYieldProvider = 'morpho' | 'aave';
-
-/**
- * Type of yield sweep.
- */
-export type EthereumYieldSweepType = 'deposit' | 'withdraw';
-
-/**
- * Status of a yield sweep.
+ * Input for fetching vault details.
  */
-export type EthereumYieldSweepStatus = 'pending' | 'confirmed' | 'failed';
+export interface EthereumVaultDetailsInput {
+  /**
+   * The Privy vault ID.
+   */
+  vault_id: string;
+}
 
 /**
- * Input for depositing assets into an ERC-4626 vault.
+ * Detailed vault information including current APY and liquidity.
  */
-export interface EthereumYieldDepositInput {
+export interface EthereumVaultDetailsResponse {
   /**
-   * The amount of the underlying asset to deposit, in the smallest unit (e.g., wei
-   * for ETH, 6 decimals for USDC). Must be a non-negative integer string.
+   * Vault identifier.
    */
-  asset_amount: string;
+  id: string;
 
   /**
-   * The ID of the vault to deposit into.
+   * Annual percentage yield earned by the app from fee wrapper fees, in basis
+   * points. Null when APY data is unavailable.
    */
-  vault_id: string;
-}
+  app_apy: number | null;
 
-/**
- * Input for withdrawing assets from an ERC-4626 vault.
- */
-export interface EthereumYieldWithdrawInput {
   /**
-   * The amount of the underlying asset to withdraw, in the smallest unit (e.g., wei
-   * for ETH, 6 decimals for USDC). Must be a non-negative integer string.
+   * Underlying asset token address.
    */
-  asset_amount: string;
+  asset_address: string;
 
   /**
-   * The ID of the vault to withdraw from.
+   * Assets available for instant withdrawal in USD.
    */
-  vault_id: string;
-}
+  available_liquidity_usd: number | null;
 
-/**
- * A yield sweep record representing a deposit or withdrawal.
- */
-export interface EthereumYieldSweepResponse {
   /**
-   * Unique identifier for the yield sweep.
+   * Chain identifier (e.g., eip155:8453).
    */
-  id: string;
+  caip2: string;
 
   /**
-   * The amount of underlying assets involved. Set after the sweep is confirmed
-   * on-chain.
+   * Human-readable vault name from the yield provider.
    */
-  asset_amount: string | null;
+  name: string;
 
   /**
-   * Unix timestamp of when the sweep was created, in milliseconds.
+   * Supported yield/lending protocol providers.
    */
-  created_at: number;
+  provider: EthereumYieldProvider;
 
   /**
-   * The amount of vault shares involved. Set after the sweep is confirmed on-chain.
+   * Total value locked in USD.
    */
-  share_amount: string | null;
+  tvl_usd: number | null;
 
   /**
-   * Status of a yield sweep.
+   * Current annual percentage yield in basis points (e.g., 500 for 5%). 1 basis
+   * point = 0.01%.
    */
-  status: EthereumYieldSweepStatus;
+  user_apy: number | null;
 
   /**
-   * Type of yield sweep.
+   * On-chain vault contract address.
    */
-  type: EthereumYieldSweepType;
+  vault_address: string;
+}
+
+/**
+ * A user's position in a DeFi vault.
+ */
+export interface EthereumVaultPosition {
+  asset: EthereumVaultPosition.Asset;
 
   /**
-   * Unix timestamp of when the sweep was last updated, in milliseconds.
+   * Current asset value in the vault (realtime from ERC4626), in smallest unit.
    */
-  updated_at: number;
+  assets_in_vault: string;
 
   /**
-   * The ID of the vault involved in the sweep.
+   * Current vault shares held (realtime from ERC4626).
    */
-  vault_id: string;
+  shares_in_vault: string;
 
   /**
-   * The ID of the wallet involved in the sweep.
+   * Total amount deposited into the vault, in smallest unit.
    */
-  wallet_id: string;
-}
+  total_deposited: string;
 
-/**
- * Input for fetching vault details.
- */
-export interface EthereumVaultDetailsInput {
   /**
-   * The Privy vault ID.
+   * Total amount withdrawn from the vault, in smallest unit.
    */
-  vault_id: string;
+  total_withdrawn: string;
 }
 
-/**
- * Input for fetching a yield sweep by ID.
- */
-export interface EthereumYieldSweepIDInput {
-  /**
-   * The yield sweep ID.
-   */
-  id: string;
+export namespace EthereumVaultPosition {
+  export interface Asset {
+    /**
+     * Token contract address.
+     */
+    address: string;
+
+    /**
+     * Token symbol (e.g., "USDC").
+     */
+    symbol: string;
+  }
 }
 
 /**
@@ -169,111 +154,102 @@ export interface EthereumVaultResponse {
 }
 
 /**
- * Detailed vault information including current APY and liquidity.
+ * Input for fetching a yield reward claim by ID.
  */
-export interface EthereumVaultDetailsResponse {
+export interface EthereumYieldClaimIDInput {
   /**
-   * Vault identifier.
+   * The yield claim transaction ID.
    */
   id: string;
+}
 
+/**
+ * Input for claiming incentive rewards from vault participation.
+ */
+export interface EthereumYieldClaimInput {
   /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points. Null when APY data is unavailable.
-   */
-  app_apy: number | null;
-
-  /**
-   * Underlying asset token address.
-   */
-  asset_address: string;
-
-  /**
-   * Assets available for instant withdrawal in USD.
+   * An EVM CAIP-2 chain identifier (e.g., "eip155:8453" for Base).
    */
-  available_liquidity_usd: number | null;
+  caip2: EvmCaip2ChainID;
+}
 
+/**
+ * Response from a yield reward claim operation.
+ */
+export interface EthereumYieldClaimResponse {
   /**
-   * Chain identifier (e.g., eip155:8453).
+   * Privy transaction record ID for the claim operation.
    */
-  caip2: string;
+  id: string;
 
   /**
-   * Human-readable vault name from the yield provider.
+   * An EVM CAIP-2 chain identifier (e.g., "eip155:8453" for Base).
    */
-  name: string;
+  caip2: EvmCaip2ChainID;
 
   /**
-   * Supported yield/lending protocol providers.
+   * Unix timestamp of when the claim was created, in milliseconds.
    */
-  provider: EthereumYieldProvider;
+  created_at: number;
 
   /**
-   * Total value locked in USD.
+   * List of reward tokens claimed.
    */
-  tvl_usd: number | null;
+  rewards: Array<EthereumYieldClaimReward>;
 
   /**
-   * Current annual percentage yield in basis points (e.g., 500 for 5%). 1 basis
-   * point = 0.01%.
+   * The current status of the claim transaction.
    */
-  user_apy: number | null;
+  status:
+    | 'broadcasted'
+    | 'confirmed'
+    | 'execution_reverted'
+    | 'failed'
+    | 'replaced'
+    | 'finalized'
+    | 'provider_error'
+    | 'pending';
 
   /**
-   * On-chain vault contract address.
+   * Unix timestamp of when the claim was last updated, in milliseconds.
    */
-  vault_address: string;
+  updated_at: number;
 }
 
 /**
- * Input for fetching yield positions.
+ * A single reward token claimed from vault participation.
  */
-export interface EthereumYieldPositionsInput {
+export interface EthereumYieldClaimReward {
   /**
-   * The vault ID to get position for.
+   * Amount claimed in the smallest unit.
    */
-  vault_id: string;
-}
-
-/**
- * A user's position in a DeFi vault.
- */
-export interface EthereumVaultPosition {
-  asset: EthereumVaultPosition.Asset;
+  amount: string;
 
   /**
-   * Current asset value in the vault (realtime from ERC4626), in smallest unit.
+   * Reward token contract address.
    */
-  assets_in_vault: string;
+  token_address: string;
 
   /**
-   * Current vault shares held (realtime from ERC4626).
+   * Reward token symbol (e.g., "MORPHO").
    */
-  shares_in_vault: string;
+  token_symbol: string;
+}
 
+/**
+ * Input for depositing assets into an ERC-4626 vault.
+ */
+export interface EthereumYieldDepositInput {
   /**
-   * Total amount deposited into the vault, in smallest unit.
+   * The amount of the underlying asset to deposit, in the smallest unit (e.g., wei
+   * for ETH, 6 decimals for USDC). Must be a non-negative integer string.
    */
-  total_deposited: string;
+  asset_amount: string;
 
   /**
-   * Total amount withdrawn from the vault, in smallest unit.
+   * The ID of the vault to deposit into.
    */
-  total_withdrawn: string;
-}
-
-export namespace EthereumVaultPosition {
-  export interface Asset {
-    /**
-     * Token contract address.
-     */
-    address: string;
-
-    /**
-     * Token symbol (e.g., "USDC").
-     */
-    symbol: string;
-  }
+  vault_id: string;
 }
 
 /**
@@ -318,88 +294,112 @@ export namespace EthereumYieldPositionResponse {
 }
 
 /**
- * Input for claiming incentive rewards from vault participation.
+ * Input for fetching yield positions.
  */
-export interface EthereumYieldClaimInput {
+export interface EthereumYieldPositionsInput {
   /**
-   * An EVM CAIP-2 chain identifier (e.g., "eip155:8453" for Base).
+   * The vault ID to get position for.
    */
-  caip2: EvmCaip2ChainID;
+  vault_id: string;
 }
 
 /**
- * A single reward token claimed from vault participation.
+ * Supported yield/lending protocol providers.
  */
-export interface EthereumYieldClaimReward {
-  /**
-   * Amount claimed in the smallest unit.
-   */
-  amount: string;
-
-  /**
-   * Reward token contract address.
-   */
-  token_address: string;
+export type EthereumYieldProvider = 'morpho' | 'aave';
 
+/**
+ * Input for fetching a yield sweep by ID.
+ */
+export interface EthereumYieldSweepIDInput {
   /**
-   * Reward token symbol (e.g., "MORPHO").
+   * The yield sweep ID.
    */
-  token_symbol: string;
+  id: string;
 }
 
 /**
- * Response from a yield reward claim operation.
+ * A yield sweep record representing a deposit or withdrawal.
  */
-export interface EthereumYieldClaimResponse {
+export interface EthereumYieldSweepResponse {
   /**
-   * Privy transaction record ID for the claim operation.
+   * Unique identifier for the yield sweep.
    */
   id: string;
 
   /**
-   * An EVM CAIP-2 chain identifier (e.g., "eip155:8453" for Base).
+   * The amount of underlying assets involved. Set after the sweep is confirmed
+   * on-chain.
    */
-  caip2: EvmCaip2ChainID;
+  asset_amount: string | null;
 
   /**
-   * Unix timestamp of when the claim was created, in milliseconds.
+   * Unix timestamp of when the sweep was created, in milliseconds.
    */
   created_at: number;
 
   /**
-   * List of reward tokens claimed.
+   * The amount of vault shares involved. Set after the sweep is confirmed on-chain.
    */
-  rewards: Array<EthereumYieldClaimReward>;
+  share_amount: string | null;
 
   /**
-   * The current status of the claim transaction.
+   * Status of a yield sweep.
    */
-  status:
-    | 'broadcasted'
-    | 'confirmed'
-    | 'execution_reverted'
-    | 'failed'
-    | 'replaced'
-    | 'finalized'
-    | 'provider_error'
-    | 'pending';
+  status: EthereumYieldSweepStatus;
 
   /**
-   * Unix timestamp of when the claim was last updated, in milliseconds.
+   * Type of yield sweep.
+   */
+  type: EthereumYieldSweepType;
+
+  /**
+   * Unix timestamp of when the sweep was last updated, in milliseconds.
    */
   updated_at: number;
+
+  /**
+   * The ID of the vault involved in the sweep.
+   */
+  vault_id: string;
+
+  /**
+   * The ID of the wallet involved in the sweep.
+   */
+  wallet_id: string;
 }
 
 /**
- * Input for fetching a yield reward claim by ID.
+ * Status of a yield sweep.
  */
-export interface EthereumYieldClaimIDInput {
+export type EthereumYieldSweepStatus = 'pending' | 'confirmed' | 'failed';
+
+/**
+ * Type of yield sweep.
+ */
+export type EthereumYieldSweepType = 'deposit' | 'withdraw';
+
+/**
+ * Input for withdrawing assets from an ERC-4626 vault.
+ */
+export interface EthereumYieldWithdrawInput {
   /**
-   * The yield claim transaction ID.
+   * The amount of the underlying asset to withdraw, in the smallest unit (e.g., wei
+   * for ETH, 6 decimals for USDC). Must be a non-negative integer string.
    */
-  id: string;
+  asset_amount: string;
+
+  /**
+   * The ID of the vault to withdraw from.
+   */
+  vault_id: string;
 }
 
+/**
+ * An EVM CAIP-2 chain identifier (e.g., "eip155:8453" for Base).
+ */
+export type EvmCaip2ChainID = string;
+
 /**
  * Headers required to authorize yield operations.
  */
@@ -424,24 +424,24 @@ export interface YieldAuthorizationHeaders {
 
 export declare namespace Yield {
   export {
-    type EvmCaip2ChainID as EvmCaip2ChainID,
-    type EthereumYieldProvider as EthereumYieldProvider,
-    type EthereumYieldSweepType as EthereumYieldSweepType,
-    type EthereumYieldSweepStatus as EthereumYieldSweepStatus,
-    type EthereumYieldDepositInput as EthereumYieldDepositInput,
-    type EthereumYieldWithdrawInput as EthereumYieldWithdrawInput,
-    type EthereumYieldSweepResponse as EthereumYieldSweepResponse,
     type EthereumVaultDetailsInput as EthereumVaultDetailsInput,
-    type EthereumYieldSweepIDInput as EthereumYieldSweepIDInput,
-    type EthereumVaultResponse as EthereumVaultResponse,
     type EthereumVaultDetailsResponse as EthereumVaultDetailsResponse,
-    type EthereumYieldPositionsInput as EthereumYieldPositionsInput,
     type EthereumVaultPosition as EthereumVaultPosition,
-    type EthereumYieldPositionResponse as EthereumYieldPositionResponse,
+    type EthereumVaultResponse as EthereumVaultResponse,
+    type EthereumYieldClaimIDInput as EthereumYieldClaimIDInput,
     type EthereumYieldClaimInput as EthereumYieldClaimInput,
-    type EthereumYieldClaimReward as EthereumYieldClaimReward,
     type EthereumYieldClaimResponse as EthereumYieldClaimResponse,
-    type EthereumYieldClaimIDInput as EthereumYieldClaimIDInput,
+    type EthereumYieldClaimReward as EthereumYieldClaimReward,
+    type EthereumYieldDepositInput as EthereumYieldDepositInput,
+    type EthereumYieldPositionResponse as EthereumYieldPositionResponse,
+    type EthereumYieldPositionsInput as EthereumYieldPositionsInput,
+    type EthereumYieldProvider as EthereumYieldProvider,
+    type EthereumYieldSweepIDInput as EthereumYieldSweepIDInput,
+    type EthereumYieldSweepResponse as EthereumYieldSweepResponse,
+    type EthereumYieldSweepStatus as EthereumYieldSweepStatus,
+    type EthereumYieldSweepType as EthereumYieldSweepType,
+    type EthereumYieldWithdrawInput as EthereumYieldWithdrawInput,
+    type EvmCaip2ChainID as EvmCaip2ChainID,
     type YieldAuthorizationHeaders as YieldAuthorizationHeaders,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.8.0'; // x-release-please-version
+export const VERSION = '0.10.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.8.0";
+export declare const VERSION = "0.10.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.8.0";
+export declare const VERSION = "0.10.0";
 //# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.8.0'; // x-release-please-version
+exports.VERSION = '0.10.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.8.0'; // x-release-please-version
+export const VERSION = '0.10.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}