@privy-io/api-types 0.14.0 → 0.16.0

package/src/resources/webhooks.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as AppsAPI from './apps';
 import * as IntentsAPI from './intents';
 import * as UsersAPI from './users';
 import * as WalletActionsAPI from './wallet-actions';
@@ -8,6 +9,21 @@ import * as WalletsAPI from './wallets/wallets';
 
 export class Webhooks extends APIResource {}
 
+/**
+ * Block metadata for a wallet transfer event.
+ */
+export interface BlockInfo {
+  /**
+   * The block number.
+   */
+  number: number;
+
+  /**
+   * The block timestamp.
+   */
+  timestamp: number;
+}
+
 /**
  * Bridge metadata for a crypto deposit via liquidation address.
  */
@@ -144,7 +160,10 @@ export interface FundsDepositedWebhookPayload {
    */
   asset: WalletFundsAsset;
 
-  block: FundsDepositedWebhookPayload.Block;
+  /**
+   * Block metadata for a wallet transfer event.
+   */
+  block: BlockInfo;
 
   /**
    * The CAIP-2 chain identifier.
@@ -192,20 +211,6 @@ export interface FundsDepositedWebhookPayload {
   transaction_fee?: string;
 }
 
-export namespace FundsDepositedWebhookPayload {
-  export interface Block {
-    /**
-     * The block number.
-     */
-    number: number;
-
-    /**
-     * The block timestamp.
-     */
-    timestamp: number;
-  }
-}
-
 /**
  * Payload for the wallet.funds_withdrawn webhook event.
  */
@@ -220,7 +225,10 @@ export interface FundsWithdrawnWebhookPayload {
    */
   asset: WalletFundsAsset;
 
-  block: FundsWithdrawnWebhookPayload.Block;
+  /**
+   * Block metadata for a wallet transfer event.
+   */
+  block: BlockInfo;
 
   /**
    * The CAIP-2 chain identifier.
@@ -263,20 +271,6 @@ export interface FundsWithdrawnWebhookPayload {
   transaction_fee?: string;
 }
 
-export namespace FundsWithdrawnWebhookPayload {
-  export interface Block {
-    /**
-     * The block number.
-     */
-    number: number;
-
-    /**
-     * The block timestamp.
-     */
-    timestamp: number;
-  }
-}
-
 /**
  * Payload for the intent.authorized webhook event.
  */
@@ -532,6 +526,93 @@ export interface IntentRejectedWebhookPayload {
   created_by_id?: string;
 }
 
+/**
+ * Payload for the kraken_embed.custom_order.cancelled webhook event.
+ */
+export interface KrakenEmbedCustomOrderCancelledWebhookPayload {
+  /**
+   * ISO 8601 timestamp of when the custom order was cancelled.
+   */
+  cancelled_at: string;
+
+  /**
+   * The ID of the cancelled custom order.
+   */
+  custom_order_id: string;
+
+  /**
+   * A human-readable description of why the custom order was cancelled. Intended for
+   * display and logging purposes only.
+   */
+  reason: string;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'kraken_embed.custom_order.cancelled';
+
+  /**
+   * The ID of the user.
+   */
+  user_id: string;
+}
+
+/**
+ * Payload for the kraken_embed.custom_order.executed webhook event.
+ */
+export interface KrakenEmbedCustomOrderExecutedWebhookPayload {
+  /**
+   * The ID of the executed custom order.
+   */
+  custom_order_id: string;
+
+  /**
+   * ISO 8601 timestamp of when the custom order was executed.
+   */
+  executed_at: string;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'kraken_embed.custom_order.executed';
+
+  /**
+   * The ID of the user.
+   */
+  user_id: string;
+}
+
+/**
+ * Payload for the kraken_embed.custom_order.execution_failed webhook event.
+ */
+export interface KrakenEmbedCustomOrderExecutionFailedWebhookPayload {
+  /**
+   * The ID of the custom order that failed to execute.
+   */
+  custom_order_id: string;
+
+  /**
+   * ISO 8601 timestamp of when the custom order execution failed.
+   */
+  failed_at: string;
+
+  /**
+   * A human-readable description of why the custom order execution failed. Intended
+   * for display and logging purposes only.
+   */
+  reason: string;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'kraken_embed.custom_order.execution_failed';
+
+  /**
+   * The ID of the user.
+   */
+  user_id: string;
+}
+
 /**
  * Payload for the kraken_embed.quote.cancelled webhook event.
  */
@@ -684,9 +765,9 @@ export interface KrakenEmbedUserVerifiedWebhookPayload {
  */
 export interface MfaDisabledWebhookPayload {
   /**
-   * The MFA method that was disabled.
+   * A multi-factor authentication method supported by the app.
    */
-  method: 'sms' | 'totp' | 'passkey';
+  method: AppsAPI.MfaMethod;
 
   /**
    * The type of webhook event.
@@ -704,9 +785,9 @@ export interface MfaDisabledWebhookPayload {
  */
 export interface MfaEnabledWebhookPayload {
   /**
-   * The MFA method that was enabled.
+   * A multi-factor authentication method supported by the app.
    */
-  method: 'sms' | 'totp' | 'passkey';
+  method: AppsAPI.MfaMethod;
 
   /**
    * The type of webhook event.
@@ -1118,6 +1199,13 @@ export interface UserOperationCompletedWebhookPayload {
   user_op_hash: string;
 }
 
+/**
+ * A reference to a user by their unique identifier.
+ */
+export interface UserReference {
+  id: string;
+}
+
 /**
  * Payload for the user.transferred_account webhook event.
  */
@@ -1129,7 +1217,10 @@ export interface UserTransferredAccountWebhookPayload {
 
   deletedUser: true;
 
-  fromUser: UserTransferredAccountWebhookPayload.FromUser;
+  /**
+   * A reference to a user by their unique identifier.
+   */
+  fromUser: UserReference;
 
   /**
    * A Privy user object.
@@ -1142,12 +1233,6 @@ export interface UserTransferredAccountWebhookPayload {
   type: 'user.transferred_account';
 }
 
-export namespace UserTransferredAccountWebhookPayload {
-  export interface FromUser {
-    id: string;
-  }
-}
-
 /**
  * Payload for the user.unlinked_account webhook event.
  */
@@ -1227,6 +1312,11 @@ export interface WalletActionEarnDepositCreatedWebhookPayload {
    */
   caip2: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * Base-unit amount of asset deposited (e.g. "1500000").
    */
@@ -1300,6 +1390,16 @@ export interface WalletActionEarnDepositFailedWebhookPayload {
    */
   caip2: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action failed.
+   */
+  failed_at: string;
+
   /**
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
@@ -1384,6 +1484,11 @@ export interface WalletActionEarnDepositRejectedWebhookPayload {
    */
   caip2: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
@@ -1394,6 +1499,11 @@ export interface WalletActionEarnDepositRejectedWebhookPayload {
    */
   raw_amount: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was rejected.
+   */
+  rejected_at: string;
+
   /**
    * The status of the wallet action.
    */
@@ -1467,6 +1577,16 @@ export interface WalletActionEarnDepositSucceededWebhookPayload {
    */
   caip2: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action completed successfully.
+   */
+  completed_at: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * Base-unit amount of asset deposited (e.g. "1500000").
    */
@@ -1545,6 +1665,11 @@ export interface WalletActionEarnIncentiveClaimCreatedWebhookPayload {
    */
   chain: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * Claimed reward tokens. Populated after the preparation step fetches from Merkl.
    */
@@ -1585,6 +1710,16 @@ export interface WalletActionEarnIncentiveClaimFailedWebhookPayload {
    */
   chain: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action failed.
+   */
+  failed_at: string;
+
   /**
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
@@ -1636,11 +1771,21 @@ export interface WalletActionEarnIncentiveClaimRejectedWebhookPayload {
    */
   chain: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
   failure_reason: WalletActionsAPI.FailureReason;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was rejected.
+   */
+  rejected_at: string;
+
   /**
    * Claimed reward tokens. Populated after the preparation step fetches from Merkl.
    */
@@ -1686,6 +1831,16 @@ export interface WalletActionEarnIncentiveClaimSucceededWebhookPayload {
    */
   chain: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action completed successfully.
+   */
+  completed_at: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * Claimed reward tokens. Populated after the preparation step fetches from Merkl.
    */
@@ -1736,6 +1891,11 @@ export interface WalletActionEarnWithdrawCreatedWebhookPayload {
    */
   caip2: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * Base-unit amount of asset withdrawn (e.g. "1500000").
    */
@@ -1809,6 +1969,16 @@ export interface WalletActionEarnWithdrawFailedWebhookPayload {
    */
   caip2: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action failed.
+   */
+  failed_at: string;
+
   /**
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
@@ -1893,6 +2063,11 @@ export interface WalletActionEarnWithdrawRejectedWebhookPayload {
    */
   caip2: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
@@ -1903,6 +2078,11 @@ export interface WalletActionEarnWithdrawRejectedWebhookPayload {
    */
   raw_amount: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was rejected.
+   */
+  rejected_at: string;
+
   /**
    * The status of the wallet action.
    */
@@ -1976,6 +2156,16 @@ export interface WalletActionEarnWithdrawSucceededWebhookPayload {
    */
   caip2: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action completed successfully.
+   */
+  completed_at: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * Base-unit amount of asset withdrawn (e.g. "1500000").
    */
@@ -2055,7 +2245,12 @@ export interface WalletActionSwapCreatedWebhookPayload {
   caip2: string;
 
   /**
-   * Amount of input token in base units. Populated after on-chain confirmation.
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * Amount of input token in base units. Populated after onchain confirmation.
    */
   input_amount: string | null;
 
@@ -2104,13 +2299,23 @@ export interface WalletActionSwapFailedWebhookPayload {
    */
   caip2: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action failed.
+   */
+  failed_at: string;
+
   /**
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
   failure_reason: WalletActionsAPI.FailureReason;
 
   /**
-   * Amount of input token in base units. Populated after on-chain confirmation.
+   * Amount of input token in base units. Populated after onchain confirmation.
    */
   input_amount: string | null;
 
@@ -2165,13 +2370,18 @@ export interface WalletActionSwapRejectedWebhookPayload {
    */
   caip2: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
   failure_reason: WalletActionsAPI.FailureReason;
 
   /**
-   * Amount of input token in base units. Populated after on-chain confirmation.
+   * Amount of input token in base units. Populated after onchain confirmation.
    */
   input_amount: string | null;
 
@@ -2185,6 +2395,11 @@ export interface WalletActionSwapRejectedWebhookPayload {
    */
   output_token: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was rejected.
+   */
+  rejected_at: string;
+
   /**
    * The status of the wallet action.
    */
@@ -2226,7 +2441,17 @@ export interface WalletActionSwapSucceededWebhookPayload {
   caip2: string;
 
   /**
-   * Amount of input token in base units. Populated after on-chain confirmation.
+   * ISO 8601 timestamp of when the wallet action completed successfully.
+   */
+  completed_at: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * Amount of input token in base units. Populated after onchain confirmation.
    */
   input_amount: string | null;
 
@@ -2236,7 +2461,7 @@ export interface WalletActionSwapSucceededWebhookPayload {
   input_token: string;
 
   /**
-   * Amount of output token received, in base units. Populated after on-chain
+   * Amount of output token received, in base units. Populated after onchain
    * confirmation.
    */
   output_amount: string | null;
@@ -2281,6 +2506,11 @@ export interface WalletActionTransferCreatedWebhookPayload {
    */
   action_type: WalletActionsAPI.WalletActionType;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * Recipient address.
    */
@@ -2331,7 +2561,7 @@ export interface WalletActionTransferCreatedWebhookPayload {
 
   /**
    * Number of decimals for the transferred token. Present when the transfer was
-   * initiated with `asset_address` and the decimals were resolved on-chain.
+   * initiated with `asset_address` and the decimals were resolved onchain.
    */
   source_asset_decimals?: number;
 }
@@ -2345,11 +2575,21 @@ export interface WalletActionTransferFailedWebhookPayload {
    */
   action_type: WalletActionsAPI.WalletActionType;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * Recipient address.
    */
   destination_address: string;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action failed.
+   */
+  failed_at: string;
+
   /**
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
@@ -2406,7 +2646,7 @@ export interface WalletActionTransferFailedWebhookPayload {
 
   /**
    * Number of decimals for the transferred token. Present when the transfer was
-   * initiated with `asset_address` and the decimals were resolved on-chain.
+   * initiated with `asset_address` and the decimals were resolved onchain.
    */
   source_asset_decimals?: number;
 }
@@ -2420,6 +2660,11 @@ export interface WalletActionTransferRejectedWebhookPayload {
    */
   action_type: WalletActionsAPI.WalletActionType;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * Recipient address.
    */
@@ -2430,6 +2675,11 @@ export interface WalletActionTransferRejectedWebhookPayload {
    */
   failure_reason: WalletActionsAPI.FailureReason;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action was rejected.
+   */
+  rejected_at: string;
+
   /**
    * Chain name (e.g. "base", "ethereum").
    */
@@ -2480,7 +2730,7 @@ export interface WalletActionTransferRejectedWebhookPayload {
 
   /**
    * Number of decimals for the transferred token. Present when the transfer was
-   * initiated with `asset_address` and the decimals were resolved on-chain.
+   * initiated with `asset_address` and the decimals were resolved onchain.
    */
   source_asset_decimals?: number;
 }
@@ -2494,6 +2744,16 @@ export interface WalletActionTransferSucceededWebhookPayload {
    */
   action_type: WalletActionsAPI.WalletActionType;
 
+  /**
+   * ISO 8601 timestamp of when the wallet action completed successfully.
+   */
+  completed_at: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
   /**
    * Recipient address.
    */
@@ -2549,11 +2809,41 @@ export interface WalletActionTransferSucceededWebhookPayload {
 
   /**
    * Number of decimals for the transferred token. Present when the transfer was
-   * initiated with `asset_address` and the decimals were resolved on-chain.
+   * initiated with `asset_address` and the decimals were resolved onchain.
    */
   source_asset_decimals?: number;
 }
 
+/**
+ * Payload for the wallet.archived webhook event.
+ */
+export interface WalletArchivedWebhookPayload {
+  /**
+   * Unix timestamp of when the wallet was archived.
+   */
+  archived_at: number;
+
+  /**
+   * The chain type of the archived wallet.
+   */
+  chain_type: string;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet.archived';
+
+  /**
+   * The address of the archived wallet.
+   */
+  wallet_address: string;
+
+  /**
+   * The ID of the archived wallet.
+   */
+  wallet_id: string;
+}
+
 /**
  * An asset involved in a wallet transfer.
  */
@@ -2660,6 +2950,31 @@ export interface WalletRecoverySetupWebhookPayload {
   wallet_id: string;
 }
 
+/**
+ * Payload for the wallet.restored webhook event.
+ */
+export interface WalletRestoredWebhookPayload {
+  /**
+   * The chain type of the restored wallet.
+   */
+  chain_type: string;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet.restored';
+
+  /**
+   * The address of the restored wallet.
+   */
+  wallet_address: string;
+
+  /**
+   * The ID of the restored wallet.
+   */
+  wallet_id: string;
+}
+
 /**
  * Union of all webhook payload schemas.
  */
@@ -2684,6 +2999,8 @@ export type WebhookPayload =
   | SeedPhraseExportWebhookPayload
   | WalletRecoverySetupWebhookPayload
   | WalletRecoveredWebhookPayload
+  | WalletArchivedWebhookPayload
+  | WalletRestoredWebhookPayload
   | MfaEnabledWebhookPayload
   | MfaDisabledWebhookPayload
   | YieldDepositConfirmedWebhookPayload
@@ -2722,7 +3039,7 @@ export type WebhookPayload =
 export interface YieldClaimConfirmedWebhookPayload {
   caip2: string;
 
-  rewards: Array<YieldClaimConfirmedWebhookPayload.Reward>;
+  rewards: Array<YieldClaimReward>;
 
   transaction_id: string;
 
@@ -2734,14 +3051,15 @@ export interface YieldClaimConfirmedWebhookPayload {
   wallet_id: string;
 }
 
-export namespace YieldClaimConfirmedWebhookPayload {
-  export interface Reward {
-    amount: string;
+/**
+ * A single reward token claimed from a yield vault.
+ */
+export interface YieldClaimReward {
+  amount: string;
 
-    token_address: string;
+  token_address: string;
 
-    token_symbol: string;
-  }
+  token_symbol: string;
 }
 
 /**
@@ -2792,6 +3110,7 @@ export interface YieldWithdrawConfirmedWebhookPayload {
 
 export declare namespace Webhooks {
   export {
+    type BlockInfo as BlockInfo,
     type BridgeCryptoDepositMetadata as BridgeCryptoDepositMetadata,
     type BridgeCryptoTransferMetadata as BridgeCryptoTransferMetadata,
     type BridgeFiatDepositMetadata as BridgeFiatDepositMetadata,
@@ -2807,6 +3126,9 @@ export declare namespace Webhooks {
     type IntentExecutedWebhookPayload as IntentExecutedWebhookPayload,
     type IntentFailedWebhookPayload as IntentFailedWebhookPayload,
     type IntentRejectedWebhookPayload as IntentRejectedWebhookPayload,
+    type KrakenEmbedCustomOrderCancelledWebhookPayload as KrakenEmbedCustomOrderCancelledWebhookPayload,
+    type KrakenEmbedCustomOrderExecutedWebhookPayload as KrakenEmbedCustomOrderExecutedWebhookPayload,
+    type KrakenEmbedCustomOrderExecutionFailedWebhookPayload as KrakenEmbedCustomOrderExecutionFailedWebhookPayload,
     type KrakenEmbedQuoteCancelledWebhookPayload as KrakenEmbedQuoteCancelledWebhookPayload,
     type KrakenEmbedQuoteExecutedWebhookPayload as KrakenEmbedQuoteExecutedWebhookPayload,
     type KrakenEmbedQuoteExecutionFailedWebhookPayload as KrakenEmbedQuoteExecutionFailedWebhookPayload,
@@ -2828,6 +3150,7 @@ export declare namespace Webhooks {
     type UserCreatedWebhookPayload as UserCreatedWebhookPayload,
     type UserLinkedAccountWebhookPayload as UserLinkedAccountWebhookPayload,
     type UserOperationCompletedWebhookPayload as UserOperationCompletedWebhookPayload,
+    type UserReference as UserReference,
     type UserTransferredAccountWebhookPayload as UserTransferredAccountWebhookPayload,
     type UserUnlinkedAccountWebhookPayload as UserUnlinkedAccountWebhookPayload,
     type UserUpdatedAccountWebhookPayload as UserUpdatedAccountWebhookPayload,
@@ -2852,6 +3175,7 @@ export declare namespace Webhooks {
     type WalletActionTransferFailedWebhookPayload as WalletActionTransferFailedWebhookPayload,
     type WalletActionTransferRejectedWebhookPayload as WalletActionTransferRejectedWebhookPayload,
     type WalletActionTransferSucceededWebhookPayload as WalletActionTransferSucceededWebhookPayload,
+    type WalletArchivedWebhookPayload as WalletArchivedWebhookPayload,
     type WalletFundsAsset as WalletFundsAsset,
     type WalletFundsErc20Asset as WalletFundsErc20Asset,
     type WalletFundsNativeTokenAsset as WalletFundsNativeTokenAsset,
@@ -2859,8 +3183,10 @@ export declare namespace Webhooks {
     type WalletFundsSplAsset as WalletFundsSplAsset,
     type WalletRecoveredWebhookPayload as WalletRecoveredWebhookPayload,
     type WalletRecoverySetupWebhookPayload as WalletRecoverySetupWebhookPayload,
+    type WalletRestoredWebhookPayload as WalletRestoredWebhookPayload,
     type WebhookPayload as WebhookPayload,
     type YieldClaimConfirmedWebhookPayload as YieldClaimConfirmedWebhookPayload,
+    type YieldClaimReward as YieldClaimReward,
     type YieldDepositConfirmedWebhookPayload as YieldDepositConfirmedWebhookPayload,
     type YieldWithdrawConfirmedWebhookPayload as YieldWithdrawConfirmedWebhookPayload,
   };