@privy-io/api-types 0.22.0 → 0.24.0

package/src/resources/webhooks.ts

@@ -216,6 +216,18 @@ export interface DepositFailedData {
   source: DepositStartedSource;
 }
 
+/**
+ * Metadata identifying a refunded wallet deposit.
+ */
+export interface DepositMetadata {
+  /**
+   * Relay details for a refunded wallet deposit.
+   */
+  details: RefundDetails;
+
+  type: 'refund';
+}
+
 /**
  * Details of a fiat deposit that has begun processing into a deposit account.
  */
@@ -336,6 +348,11 @@ export interface FundsDepositedWebhookPayload {
    */
   bridge_metadata?: BridgeMetadata;
 
+  /**
+   * Metadata identifying a refunded wallet deposit.
+   */
+  deposit_metadata?: DepositMetadata;
+
   /**
    * The transaction fee paid, as a stringified bigint in the chain's native token.
    */
@@ -1009,6 +1026,58 @@ export interface PrivateKeyExportWebhookPayload {
   export_source?: WalletsAPI.ExportType;
 }
 
+/**
+ * Relay details for a refunded wallet deposit.
+ */
+export interface RefundDetails {
+  /**
+   * The transaction hash of the transfer that was refunded.
+   */
+  original_transaction_hash: string;
+
+  /**
+   * The provider that handled the refund.
+   */
+  provider: 'relay';
+
+  /**
+   * The Privy wallet action ID of the transfer that was refunded.
+   */
+  wallet_action_id: string;
+}
+
+/**
+ * Metadata identifying a refunded wallet deposit.
+ */
+export interface RefundMetadata {
+  /**
+   * Relay details for a refunded wallet deposit.
+   */
+  details: RefundDetails;
+
+  type: 'refund';
+}
+
+/**
+ * Relay details for a refunded wallet deposit.
+ */
+export interface RelayRefundDetails {
+  /**
+   * The transaction hash of the transfer that was refunded.
+   */
+  original_transaction_hash: string;
+
+  /**
+   * The provider that handled the refund.
+   */
+  provider: 'relay';
+
+  /**
+   * The Privy wallet action ID of the transfer that was refunded.
+   */
+  wallet_action_id: string;
+}
+
 /**
  * Payload for the wallet.seed_phrase_export webhook event.
  */
@@ -1306,10 +1375,10 @@ export interface TransactionStillPendingWebhookPayload {
 }
 
 /**
- * Payload for the usage.cross_chain_fee.recorded webhook event (Privy fee on a
- * cross-chain transfer or swap).
+ * Payload for the usage.gas_sponsorship.recorded webhook event (sponsored network
+ * gas).
  */
-export interface UsageCrossChainFeeRecordedWebhookPayload {
+export interface UsageGasSponsorshipRecordedWebhookPayload {
   amount_usd: string;
 
   /**
@@ -1330,14 +1399,19 @@ export interface UsageCrossChainFeeRecordedWebhookPayload {
   /**
    * The type of webhook event.
    */
-  type: 'usage.cross_chain_fee.recorded';
+  type: 'usage.gas_sponsorship.recorded';
 }
 
 /**
- * Payload for the usage.gas_sponsorship.recorded webhook event (sponsored network
- * gas).
+ * The type of operation that incurred a usage charge.
  */
-export interface UsageGasSponsorshipRecordedWebhookPayload {
+export type UsageSourceType = 'wallet-action-transfer' | 'wallet-action-swap' | 'rpc';
+
+/**
+ * Payload for the usage.swap_provider_fee.recorded webhook event (swap provider
+ * fee on a cross-chain transfer or swap).
+ */
+export interface UsageSwapProviderFeeRecordedWebhookPayload {
   amount_usd: string;
 
   /**
@@ -1358,14 +1432,9 @@ export interface UsageGasSponsorshipRecordedWebhookPayload {
   /**
    * The type of webhook event.
    */
-  type: 'usage.gas_sponsorship.recorded';
+  type: 'usage.swap_provider_fee.recorded';
 }
 
-/**
- * The type of operation that incurred a usage charge.
- */
-export type UsageSourceType = 'wallet-action-transfer' | 'wallet-action-swap' | 'rpc';
-
 /**
  * Payload for the user.authenticated webhook event.
  */
@@ -1441,6 +1510,11 @@ export interface UserKYCUpdatedData {
    * Terms of service status in a KYC update event.
    */
   tos: UserKYCUpdatedTosData;
+
+  /**
+   * Stripe Issuing cardholder ID assigned by Bridge for this user.
+   */
+  stripe_cardholder_id?: string;
 }
 
 /**
@@ -4230,7 +4304,7 @@ export type WebhookPayload =
   | YieldClaimConfirmedWebhookPayload
   | UserOperationCompletedWebhookPayload
   | UsageGasSponsorshipRecordedWebhookPayload
-  | UsageCrossChainFeeRecordedWebhookPayload
+  | UsageSwapProviderFeeRecordedWebhookPayload
   | IntentCreatedWebhookPayload
   | IntentAuthorizedWebhookPayload
   | IntentRejectedWebhookPayload
@@ -4355,6 +4429,7 @@ export declare namespace Webhooks {
     type DepositCompletedData as DepositCompletedData,
     type DepositCompletedDestination as DepositCompletedDestination,
     type DepositFailedData as DepositFailedData,
+    type DepositMetadata as DepositMetadata,
     type DepositStartedData as DepositStartedData,
     type DepositStartedDestination as DepositStartedDestination,
     type DepositStartedSource as DepositStartedSource,
@@ -4381,6 +4456,9 @@ export declare namespace Webhooks {
     type OrganizationKYBUpdatedKYBData as OrganizationKYBUpdatedKYBData,
     type OrganizationKYBUpdatedTosData as OrganizationKYBUpdatedTosData,
     type PrivateKeyExportWebhookPayload as PrivateKeyExportWebhookPayload,
+    type RefundDetails as RefundDetails,
+    type RefundMetadata as RefundMetadata,
+    type RelayRefundDetails as RelayRefundDetails,
     type SeedPhraseExportWebhookPayload as SeedPhraseExportWebhookPayload,
     type TransactionBroadcastedWebhookPayload as TransactionBroadcastedWebhookPayload,
     type TransactionConfirmedWebhookPayload as TransactionConfirmedWebhookPayload,
@@ -4389,9 +4467,9 @@ export declare namespace Webhooks {
     type TransactionProviderErrorWebhookPayload as TransactionProviderErrorWebhookPayload,
     type TransactionReplacedWebhookPayload as TransactionReplacedWebhookPayload,
     type TransactionStillPendingWebhookPayload as TransactionStillPendingWebhookPayload,
-    type UsageCrossChainFeeRecordedWebhookPayload as UsageCrossChainFeeRecordedWebhookPayload,
     type UsageGasSponsorshipRecordedWebhookPayload as UsageGasSponsorshipRecordedWebhookPayload,
     type UsageSourceType as UsageSourceType,
+    type UsageSwapProviderFeeRecordedWebhookPayload as UsageSwapProviderFeeRecordedWebhookPayload,
     type UserAuthenticatedWebhookPayload as UserAuthenticatedWebhookPayload,
     type UserCreatedWebhookPayload as UserCreatedWebhookPayload,
     type UserDeletedWebhookPayload as UserDeletedWebhookPayload,

package/src/resources/yield.ts

@@ -25,8 +25,8 @@ export interface EthereumVaultDetailsResponse {
   id: string;
 
   /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points. Null when APY data is unavailable.
+   * Annual percentage yield earned by the app from vault fees, in basis points. Null
+   * when APY data is unavailable.
    */
   app_apy: number | null;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.22.0'; // x-release-please-version
+export const VERSION = '0.24.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.js

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

package/version.mjs

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