@privy-io/api-types 0.7.0 → 0.8.0

package/src/resources/webhooks.ts

@@ -3,6 +3,8 @@
 import { APIResource } from '../core/resource';
 import * as IntentsAPI from './intents';
 import * as UsersAPI from './users';
+import * as WalletActionsAPI from './wallet-actions';
+import * as WalletsAPI from './wallets/wallets';
 
 export class Webhooks extends APIResource {}
 
@@ -279,6 +281,12 @@ export interface TransactionBroadcastedWebhookPayload {
    * The ID of the wallet that initiated the transaction.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID for transaction reconciliation, if one was
+   * provided.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -309,6 +317,12 @@ export interface TransactionConfirmedWebhookPayload {
    * The ID of the wallet that initiated the transaction.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID for transaction reconciliation, if one was
+   * provided.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -339,6 +353,12 @@ export interface TransactionExecutionRevertedWebhookPayload {
    * The ID of the wallet that initiated the transaction.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID for transaction reconciliation, if one was
+   * provided.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -361,9 +381,9 @@ export interface TransactionStillPendingWebhookPayload {
   transaction_id: string;
 
   /**
-   * The original transaction request that is still pending.
+   * An unsigned Ethereum transaction object.
    */
-  transaction_request: TransactionStillPendingWebhookPayload.TransactionRequest;
+  transaction_request: WalletsAPI.UnsignedEthereumTransaction;
 
   /**
    * The type of webhook event.
@@ -374,53 +394,12 @@ export interface TransactionStillPendingWebhookPayload {
    * The ID of the wallet that initiated the transaction.
    */
   wallet_id: string;
-}
 
-export namespace TransactionStillPendingWebhookPayload {
   /**
-   * The original transaction request that is still pending.
+   * Developer-provided reference ID for transaction reconciliation, if one was
+   * provided.
    */
-  export interface TransactionRequest {
-    authorization_list?: Array<TransactionRequest.AuthorizationList>;
-
-    chain_id?: string | number;
-
-    data?: string;
-
-    from?: string;
-
-    gas_limit?: string | number;
-
-    gas_price?: string | number;
-
-    max_fee_per_gas?: string | number;
-
-    max_priority_fee_per_gas?: string | number;
-
-    nonce?: string | number;
-
-    to?: string;
-
-    type?: 0 | 1 | 2 | 4;
-
-    value?: string | number;
-  }
-
-  export namespace TransactionRequest {
-    export interface AuthorizationList {
-      chain_id: string | number;
-
-      contract: string;
-
-      nonce: string | number;
-
-      r: string;
-
-      s: string;
-
-      y_parity: number;
-    }
-  }
+  reference_id?: string | null;
 }
 
 /**
@@ -451,6 +430,12 @@ export interface TransactionFailedWebhookPayload {
    * The ID of the wallet that initiated the transaction.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID for transaction reconciliation, if one was
+   * provided.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -481,6 +466,12 @@ export interface TransactionReplacedWebhookPayload {
    * The ID of the wallet that initiated the transaction.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID for transaction reconciliation, if one was
+   * provided.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -511,6 +502,12 @@ export interface TransactionProviderErrorWebhookPayload {
    * The ID of the wallet that initiated the transaction.
    */
   wallet_id: string;
+
+  /**
+   * Developer-provided reference ID for transaction reconciliation, if one was
+   * provided.
+   */
+  reference_id?: string | null;
 }
 
 /**
@@ -690,6 +687,464 @@ export interface UserWalletCreatedWebhookPayload {
   wallet: UsersAPI.LinkedAccountBaseWallet;
 }
 
+/**
+ * Payload for the wallet_action.swap.created webhook event.
+ */
+export interface WalletActionSwapCreatedWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: WalletActionsAPI.WalletActionType;
+
+  /**
+   * Chain identifier.
+   */
+  caip2: string;
+
+  /**
+   * Amount of input token in base units. Populated after on-chain confirmation.
+   */
+  input_amount: string | null;
+
+  /**
+   * Token address being sold.
+   */
+  input_token: string;
+
+  /**
+   * Token address being bought.
+   */
+  output_token: string;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionsAPI.WalletActionStatus;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.swap.created';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+}
+
+/**
+ * Payload for the wallet_action.swap.succeeded webhook event.
+ */
+export interface WalletActionSwapSucceededWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: WalletActionsAPI.WalletActionType;
+
+  /**
+   * Chain identifier.
+   */
+  caip2: string;
+
+  /**
+   * Amount of input token in base units. Populated after on-chain confirmation.
+   */
+  input_amount: string | null;
+
+  /**
+   * Token address being sold.
+   */
+  input_token: string;
+
+  /**
+   * Amount of output token received, in base units. Populated after on-chain
+   * confirmation.
+   */
+  output_amount: string | null;
+
+  /**
+   * Token address being bought.
+   */
+  output_token: string;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionsAPI.WalletActionStatus;
+
+  /**
+   * The steps of the wallet action, including transaction hashes.
+   */
+  steps: Array<WalletActionsAPI.WalletActionStep>;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.swap.succeeded';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+}
+
+/**
+ * Payload for the wallet_action.swap.rejected webhook event.
+ */
+export interface WalletActionSwapRejectedWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: WalletActionsAPI.WalletActionType;
+
+  /**
+   * Chain identifier.
+   */
+  caip2: 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.
+   */
+  input_amount: string | null;
+
+  /**
+   * Token address being sold.
+   */
+  input_token: string;
+
+  /**
+   * Token address being bought.
+   */
+  output_token: string;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionsAPI.WalletActionStatus;
+
+  /**
+   * The steps of the wallet action at the time of rejection.
+   */
+  steps: Array<WalletActionsAPI.WalletActionStep>;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.swap.rejected';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+}
+
+/**
+ * Payload for the wallet_action.swap.failed webhook event.
+ */
+export interface WalletActionSwapFailedWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: WalletActionsAPI.WalletActionType;
+
+  /**
+   * Chain identifier.
+   */
+  caip2: 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.
+   */
+  input_amount: string | null;
+
+  /**
+   * Token address being sold.
+   */
+  input_token: string;
+
+  /**
+   * Token address being bought.
+   */
+  output_token: string;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionsAPI.WalletActionStatus;
+
+  /**
+   * The steps of the wallet action. Completed steps will have transaction hashes;
+   * the failing step will have a failure_reason.
+   */
+  steps: Array<WalletActionsAPI.WalletActionStep>;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.swap.failed';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+}
+
+/**
+ * Payload for the wallet_action.transfer.created webhook event.
+ */
+export interface WalletActionTransferCreatedWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: WalletActionsAPI.WalletActionType;
+
+  /**
+   * Recipient address.
+   */
+  destination_address: string;
+
+  /**
+   * Decimal amount as provided by the user (e.g. "1.5").
+   */
+  source_amount: string;
+
+  /**
+   * Asset identifier (e.g. "usdc", "eth").
+   */
+  source_asset: string;
+
+  /**
+   * Chain name (e.g. "base", "ethereum").
+   */
+  source_chain: string;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionsAPI.WalletActionStatus;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.transfer.created';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+}
+
+/**
+ * Payload for the wallet_action.transfer.succeeded webhook event.
+ */
+export interface WalletActionTransferSucceededWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: WalletActionsAPI.WalletActionType;
+
+  /**
+   * Recipient address.
+   */
+  destination_address: string;
+
+  /**
+   * Decimal amount as provided by the user (e.g. "1.5").
+   */
+  source_amount: string;
+
+  /**
+   * Asset identifier (e.g. "usdc", "eth").
+   */
+  source_asset: string;
+
+  /**
+   * Chain name (e.g. "base", "ethereum").
+   */
+  source_chain: string;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionsAPI.WalletActionStatus;
+
+  /**
+   * The steps of the wallet action, including transaction hashes.
+   */
+  steps: Array<WalletActionsAPI.WalletActionStep>;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.transfer.succeeded';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+}
+
+/**
+ * Payload for the wallet_action.transfer.rejected webhook event.
+ */
+export interface WalletActionTransferRejectedWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: WalletActionsAPI.WalletActionType;
+
+  /**
+   * Recipient address.
+   */
+  destination_address: string;
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason: WalletActionsAPI.FailureReason;
+
+  /**
+   * Decimal amount as provided by the user (e.g. "1.5").
+   */
+  source_amount: string;
+
+  /**
+   * Asset identifier (e.g. "usdc", "eth").
+   */
+  source_asset: string;
+
+  /**
+   * Chain name (e.g. "base", "ethereum").
+   */
+  source_chain: string;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionsAPI.WalletActionStatus;
+
+  /**
+   * The steps of the wallet action at the time of rejection.
+   */
+  steps: Array<WalletActionsAPI.WalletActionStep>;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.transfer.rejected';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+}
+
+/**
+ * Payload for the wallet_action.transfer.failed webhook event.
+ */
+export interface WalletActionTransferFailedWebhookPayload {
+  /**
+   * Type of wallet action
+   */
+  action_type: WalletActionsAPI.WalletActionType;
+
+  /**
+   * Recipient address.
+   */
+  destination_address: string;
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason: WalletActionsAPI.FailureReason;
+
+  /**
+   * Decimal amount as provided by the user (e.g. "1.5").
+   */
+  source_amount: string;
+
+  /**
+   * Asset identifier (e.g. "usdc", "eth").
+   */
+  source_asset: string;
+
+  /**
+   * Chain name (e.g. "base", "ethereum").
+   */
+  source_chain: string;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionsAPI.WalletActionStatus;
+
+  /**
+   * The steps of the wallet action. Completed steps will have transaction hashes;
+   * the failing step will have a failure_reason.
+   */
+  steps: Array<WalletActionsAPI.WalletActionStep>;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet_action.transfer.failed';
+
+  /**
+   * The ID of the wallet action.
+   */
+  wallet_action_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+}
+
 /**
  * Payload for the wallet.funds_deposited webhook event.
  */
@@ -1005,6 +1460,33 @@ export interface PrivateKeyExportWebhookPayload {
   export_source?: 'display' | 'client';
 }
 
+/**
+ * Payload for the wallet.seed_phrase_export webhook event.
+ */
+export interface SeedPhraseExportWebhookPayload {
+  /**
+   * The type of webhook event.
+   */
+  type: 'wallet.seed_phrase_export';
+
+  /**
+   * The ID of the user who exported the seed phrase.
+   */
+  user_id: string;
+
+  /**
+   * The address of the wallet.
+   */
+  wallet_address: string;
+
+  /**
+   * The ID of the wallet.
+   */
+  wallet_id: string;
+
+  export_source?: 'display' | 'client';
+}
+
 /**
  * Payload for the wallet.recovery_setup webhook event.
  */
@@ -1161,6 +1643,7 @@ export type WebhookPayload =
   | FundsDepositedWebhookPayload
   | FundsWithdrawnWebhookPayload
   | PrivateKeyExportWebhookPayload
+  | SeedPhraseExportWebhookPayload
   | WalletRecoverySetupWebhookPayload
   | WalletRecoveredWebhookPayload
   | MfaEnabledWebhookPayload
@@ -1172,7 +1655,15 @@ export type WebhookPayload =
   | IntentCreatedWebhookPayload
   | IntentAuthorizedWebhookPayload
   | IntentExecutedWebhookPayload
-  | IntentFailedWebhookPayload;
+  | IntentFailedWebhookPayload
+  | WalletActionSwapCreatedWebhookPayload
+  | WalletActionSwapSucceededWebhookPayload
+  | WalletActionSwapRejectedWebhookPayload
+  | WalletActionSwapFailedWebhookPayload
+  | WalletActionTransferCreatedWebhookPayload
+  | WalletActionTransferSucceededWebhookPayload
+  | WalletActionTransferRejectedWebhookPayload
+  | WalletActionTransferFailedWebhookPayload;
 
 /**
  * Payload for the kraken_embed.quote_executed webhook event.
@@ -1344,9 +1835,18 @@ export declare namespace Webhooks {
     type UserUpdatedAccountWebhookPayload as UserUpdatedAccountWebhookPayload,
     type UserTransferredAccountWebhookPayload as UserTransferredAccountWebhookPayload,
     type UserWalletCreatedWebhookPayload as UserWalletCreatedWebhookPayload,
+    type WalletActionSwapCreatedWebhookPayload as WalletActionSwapCreatedWebhookPayload,
+    type WalletActionSwapSucceededWebhookPayload as WalletActionSwapSucceededWebhookPayload,
+    type WalletActionSwapRejectedWebhookPayload as WalletActionSwapRejectedWebhookPayload,
+    type WalletActionSwapFailedWebhookPayload as WalletActionSwapFailedWebhookPayload,
+    type WalletActionTransferCreatedWebhookPayload as WalletActionTransferCreatedWebhookPayload,
+    type WalletActionTransferSucceededWebhookPayload as WalletActionTransferSucceededWebhookPayload,
+    type WalletActionTransferRejectedWebhookPayload as WalletActionTransferRejectedWebhookPayload,
+    type WalletActionTransferFailedWebhookPayload as WalletActionTransferFailedWebhookPayload,
     type FundsDepositedWebhookPayload as FundsDepositedWebhookPayload,
     type FundsWithdrawnWebhookPayload as FundsWithdrawnWebhookPayload,
     type PrivateKeyExportWebhookPayload as PrivateKeyExportWebhookPayload,
+    type SeedPhraseExportWebhookPayload as SeedPhraseExportWebhookPayload,
     type WalletRecoverySetupWebhookPayload as WalletRecoverySetupWebhookPayload,
     type WalletRecoveredWebhookPayload as WalletRecoveredWebhookPayload,
     type YieldDepositConfirmedWebhookPayload as YieldDepositConfirmedWebhookPayload,