@privy-io/api-types 0.17.0 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/client.d.mts +6 -6
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +6 -6
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/accounts.d.mts +1 -1
  10. package/resources/accounts.d.ts +1 -1
  11. package/resources/apps.d.mts +4 -3
  12. package/resources/apps.d.mts.map +1 -1
  13. package/resources/apps.d.ts +4 -3
  14. package/resources/apps.d.ts.map +1 -1
  15. package/resources/client-auth.d.mts +32 -2
  16. package/resources/client-auth.d.mts.map +1 -1
  17. package/resources/client-auth.d.ts +32 -2
  18. package/resources/client-auth.d.ts.map +1 -1
  19. package/resources/index.d.mts +3 -3
  20. package/resources/index.d.mts.map +1 -1
  21. package/resources/index.d.ts +3 -3
  22. package/resources/index.d.ts.map +1 -1
  23. package/resources/index.js.map +1 -1
  24. package/resources/index.mjs.map +1 -1
  25. package/resources/onramps.d.mts +4 -4
  26. package/resources/onramps.d.ts +4 -4
  27. package/resources/swaps.d.mts +2 -1
  28. package/resources/swaps.d.mts.map +1 -1
  29. package/resources/swaps.d.ts +2 -1
  30. package/resources/swaps.d.ts.map +1 -1
  31. package/resources/users.d.mts +9 -2
  32. package/resources/users.d.mts.map +1 -1
  33. package/resources/users.d.ts +9 -2
  34. package/resources/users.d.ts.map +1 -1
  35. package/resources/wallets/actions.d.mts +8 -8
  36. package/resources/wallets/actions.d.ts +8 -8
  37. package/resources/wallets/balance.d.mts +4 -4
  38. package/resources/wallets/balance.d.mts.map +1 -1
  39. package/resources/wallets/balance.d.ts +4 -4
  40. package/resources/wallets/balance.d.ts.map +1 -1
  41. package/resources/wallets/index.d.mts +1 -1
  42. package/resources/wallets/index.d.mts.map +1 -1
  43. package/resources/wallets/index.d.ts +1 -1
  44. package/resources/wallets/index.d.ts.map +1 -1
  45. package/resources/wallets/index.js.map +1 -1
  46. package/resources/wallets/index.mjs.map +1 -1
  47. package/resources/wallets/transactions.d.mts +1 -1
  48. package/resources/wallets/transactions.d.mts.map +1 -1
  49. package/resources/wallets/transactions.d.ts +1 -1
  50. package/resources/wallets/transactions.d.ts.map +1 -1
  51. package/resources/wallets/wallets.d.mts +149 -57
  52. package/resources/wallets/wallets.d.mts.map +1 -1
  53. package/resources/wallets/wallets.d.ts +149 -57
  54. package/resources/wallets/wallets.d.ts.map +1 -1
  55. package/resources/wallets/wallets.js.map +1 -1
  56. package/resources/wallets/wallets.mjs.map +1 -1
  57. package/resources/webhooks.d.mts +22 -15
  58. package/resources/webhooks.d.mts.map +1 -1
  59. package/resources/webhooks.d.ts +22 -15
  60. package/resources/webhooks.d.ts.map +1 -1
  61. package/resources/yield.d.mts +7 -4
  62. package/resources/yield.d.mts.map +1 -1
  63. package/resources/yield.d.ts +7 -4
  64. package/resources/yield.d.ts.map +1 -1
  65. package/src/client.ts +18 -0
  66. package/src/resources/accounts.ts +1 -1
  67. package/src/resources/apps.ts +5 -3
  68. package/src/resources/client-auth.ts +43 -1
  69. package/src/resources/index.ts +9 -0
  70. package/src/resources/onramps.ts +4 -4
  71. package/src/resources/swaps.ts +2 -1
  72. package/src/resources/users.ts +11 -1
  73. package/src/resources/wallets/actions.ts +8 -8
  74. package/src/resources/wallets/balance.ts +4 -2
  75. package/src/resources/wallets/index.ts +3 -0
  76. package/src/resources/wallets/transactions.ts +1 -0
  77. package/src/resources/wallets/wallets.ts +169 -51
  78. package/src/resources/webhooks.ts +22 -15
  79. package/src/resources/yield.ts +7 -4
  80. package/src/version.ts +1 -1
  81. package/version.d.mts +1 -1
  82. package/version.d.ts +1 -1
  83. package/version.js +1 -1
  84. package/version.mjs +1 -1
@@ -201,7 +201,7 @@ export interface BalanceAssetByChain {
201
201
  amount: string;
202
202
 
203
203
  /**
204
- * The CAIP-2 chain identifier (e.g. eip155:8453).
204
+ * The CAIP-2 chain identifier (e.g. eip155:4217 for Tempo, eip155:8453 for Base).
205
205
  */
206
206
  chain_id: string;
207
207
 
@@ -203,10 +203,12 @@ export interface AppResponse {
203
203
  * Configuration for Telegram authentication.
204
204
  */
205
205
  telegram_auth_config?: TelegramAuthConfigSchema;
206
+
207
+ telegram_seamless_auth_enabled?: boolean;
206
208
  }
207
209
 
208
210
  /**
209
- * A valid CAIP-2 chain ID (e.g. 'eip155:1').
211
+ * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
210
212
  */
211
213
  export type Caip2 = string;
212
214
 
@@ -220,7 +222,7 @@ export type CaptchaProvider = 'turnstile' | 'hcaptcha';
220
222
  */
221
223
  export interface Currency {
222
224
  /**
223
- * A valid CAIP-2 chain ID (e.g. 'eip155:1').
225
+ * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
224
226
  */
225
227
  chain: Caip2;
226
228
 
@@ -399,7 +401,7 @@ export interface GasSpendResponseBody {
399
401
  /**
400
402
  * A multi-factor authentication method supported by the app.
401
403
  */
402
- export type MfaMethod = 'sms' | 'totp' | 'passkey';
404
+ export type MfaMethod = 'sms' | 'totp' | 'passkey' | 'email';
403
405
 
404
406
  /**
405
407
  * Allowlist invite input for a phone number.
@@ -703,6 +703,43 @@ export interface LinkJwtInput {
703
703
  token?: string;
704
704
  }
705
705
 
706
+ /**
707
+ * The request body for enrolling an email MFA code.
708
+ */
709
+ export interface MfaEmailEnrollRequestBody {
710
+ code: string;
711
+
712
+ email_address: string;
713
+ }
714
+
715
+ /**
716
+ * Input for enrolling email MFA.
717
+ */
718
+ export interface MfaEmailInitEnrollInput {
719
+ action: 'enroll';
720
+
721
+ email_address: string;
722
+ }
723
+
724
+ /**
725
+ * The request body for initiating an email MFA flow.
726
+ */
727
+ export type MfaEmailInitRequestBody = MfaEmailInitVerifyInput | MfaEmailInitEnrollInput;
728
+
729
+ /**
730
+ * Input for verifying email MFA.
731
+ */
732
+ export interface MfaEmailInitVerifyInput {
733
+ action: 'verify';
734
+ }
735
+
736
+ /**
737
+ * The request body for verifying an email MFA code.
738
+ */
739
+ export interface MfaEmailVerifyRequestBody {
740
+ code: string;
741
+ }
742
+
706
743
  /**
707
744
  * The request body for enrolling a passkey MFA flow.
708
745
  */
@@ -1813,7 +1850,7 @@ export interface TelegramAuthResult {
1813
1850
 
1814
1851
  first_name: string;
1815
1852
 
1816
- hash: string;
1853
+ hash?: string;
1817
1854
 
1818
1855
  last_name?: string;
1819
1856
 
@@ -2058,6 +2095,11 @@ export declare namespace ClientAuth {
2058
2095
  type FiatVirtualAccountResponse as FiatVirtualAccountResponse,
2059
2096
  type GuestAuthenticateRequestBody as GuestAuthenticateRequestBody,
2060
2097
  type LinkJwtInput as LinkJwtInput,
2098
+ type MfaEmailEnrollRequestBody as MfaEmailEnrollRequestBody,
2099
+ type MfaEmailInitEnrollInput as MfaEmailInitEnrollInput,
2100
+ type MfaEmailInitRequestBody as MfaEmailInitRequestBody,
2101
+ type MfaEmailInitVerifyInput as MfaEmailInitVerifyInput,
2102
+ type MfaEmailVerifyRequestBody as MfaEmailVerifyRequestBody,
2061
2103
  type MfaPasskeyEnrollmentRequestBody as MfaPasskeyEnrollmentRequestBody,
2062
2104
  type MfaPasskeyInitRequestBody as MfaPasskeyInitRequestBody,
2063
2105
  type MfaPasskeyInitResponseBody as MfaPasskeyInitResponseBody,
@@ -130,6 +130,11 @@ export {
130
130
  type FiatVirtualAccountResponse,
131
131
  type GuestAuthenticateRequestBody,
132
132
  type LinkJwtInput,
133
+ type MfaEmailEnrollRequestBody,
134
+ type MfaEmailInitEnrollInput,
135
+ type MfaEmailInitRequestBody,
136
+ type MfaEmailInitVerifyInput,
137
+ type MfaEmailVerifyRequestBody,
133
138
  type MfaPasskeyEnrollmentRequestBody,
134
139
  type MfaPasskeyInitRequestBody,
135
140
  type MfaPasskeyInitResponseBody,
@@ -599,6 +604,7 @@ export {
599
604
  type CrossAppEmbeddedWallet,
600
605
  type CrossAppSmartWallet,
601
606
  type CustomMetadata,
607
+ type EmailMfaMethod,
602
608
  type EmbeddedWalletRecoveryMethod,
603
609
  type LinkedAccount,
604
610
  type LinkedAccountAppleInput,
@@ -765,6 +771,8 @@ export {
765
771
  type RawWalletAuthenticateResponse,
766
772
  type RecipientPublicKey,
767
773
  type RelayerFee,
774
+ type RpcSponsorAsset,
775
+ type RpcSponsorOptions,
768
776
  type SeedPhraseExportInput,
769
777
  type SeedPhraseExportResponse,
770
778
  type SignatureOptions,
@@ -900,6 +908,7 @@ export {
900
908
  type WalletChainType,
901
909
  type WalletCreateWalletsWithRecoveryResponse,
902
910
  type WalletCustodian,
911
+ type WalletEntity,
903
912
  type WalletEntropyType,
904
913
  type WalletEthereumAsset,
905
914
  type WalletExportRequestBody,
@@ -51,8 +51,8 @@ export interface BridgeSandboxFiatCustomerResponse {
51
51
  }
52
52
 
53
53
  /**
54
- * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
55
- * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
54
+ * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:4217" for
55
+ * Tempo or "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
56
56
  */
57
57
  export type Caip2ChainID = string;
58
58
 
@@ -173,8 +173,8 @@ export interface FiatOnrampDestination {
173
173
  asset: SharedAPI.TokenIdentifier;
174
174
 
175
175
  /**
176
- * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
177
- * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
176
+ * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:4217" for
177
+ * Tempo or "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
178
178
  */
179
179
  chain: Caip2ChainID;
180
180
  }
@@ -195,7 +195,8 @@ export interface SwapSource {
195
195
  asset_address: string;
196
196
 
197
197
  /**
198
- * CAIP-2 chain identifier (e.g., "eip155:1").
198
+ * CAIP-2 chain identifier (e.g., "eip155:4217" for Tempo, "eip155:1" for
199
+ * Ethereum).
199
200
  */
200
201
  caip2: string;
201
202
  }
@@ -62,6 +62,15 @@ export interface CrossAppSmartWallet {
62
62
  */
63
63
  export type CustomMetadata = { [key: string]: string | number | boolean };
64
64
 
65
+ /**
66
+ * An Email MFA method.
67
+ */
68
+ export interface EmailMfaMethod {
69
+ type: 'email';
70
+
71
+ verified_at: number;
72
+ }
73
+
65
74
  /**
66
75
  * The method used to recover an embedded wallet account.
67
76
  */
@@ -1175,7 +1184,7 @@ export interface LinkedAccountWalletInput {
1175
1184
  /**
1176
1185
  * A multi-factor authentication method linked to the user.
1177
1186
  */
1178
- export type LinkedMfaMethod = SMSMfaMethod | TotpMfaMethod | PasskeyMfaMethod;
1187
+ export type LinkedMfaMethod = SMSMfaMethod | TotpMfaMethod | PasskeyMfaMethod | EmailMfaMethod;
1179
1188
 
1180
1189
  /**
1181
1190
  * OAuth tokens associated with the user.
@@ -1316,6 +1325,7 @@ export declare namespace Users {
1316
1325
  type CrossAppEmbeddedWallet as CrossAppEmbeddedWallet,
1317
1326
  type CrossAppSmartWallet as CrossAppSmartWallet,
1318
1327
  type CustomMetadata as CustomMetadata,
1328
+ type EmailMfaMethod as EmailMfaMethod,
1319
1329
  type EmbeddedWalletRecoveryMethod as EmbeddedWalletRecoveryMethod,
1320
1330
  type LinkedAccount as LinkedAccount,
1321
1331
  type LinkedAccountAppleInput as LinkedAccountAppleInput,
@@ -46,7 +46,7 @@ export interface AaveVaultDetails {
46
46
  available_liquidity_usd: number | null;
47
47
 
48
48
  /**
49
- * CAIP-2 chain identifier (e.g. "eip155:8453").
49
+ * CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:8453" for Base).
50
50
  */
51
51
  caip2: string;
52
52
 
@@ -442,7 +442,7 @@ export interface EarnIncentiveClaimActionResponse {
442
442
  id: string;
443
443
 
444
444
  /**
445
- * EVM chain name (e.g. "base", "ethereum").
445
+ * EVM chain name (e.g. "tempo", "base").
446
446
  */
447
447
  chain: string;
448
448
 
@@ -485,8 +485,8 @@ export interface EarnIncentiveClaimActionResponse {
485
485
  export interface EarnIncentiveClaimRequestBody {
486
486
  /**
487
487
  * The blockchain network on which to perform the incentive claim. Supported chains
488
- * include: 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and more, along
489
- * with their respective testnets.
488
+ * include: 'tempo', 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and more,
489
+ * along with their respective testnets.
490
490
  */
491
491
  chain: string;
492
492
  }
@@ -526,7 +526,7 @@ export interface EarnIncentiveRewardEntry {
526
526
  */
527
527
  export interface EarnIncentiveRewardsQuery {
528
528
  /**
529
- * Chain name to fetch rewards for (e.g. "base", "ethereum").
529
+ * Chain name to fetch rewards for (e.g. "tempo", "base").
530
530
  */
531
531
  chain: string;
532
532
  }
@@ -834,7 +834,7 @@ export interface MorphoVaultDetails {
834
834
  available_liquidity_usd: number | null;
835
835
 
836
836
  /**
837
- * CAIP-2 chain identifier (e.g. "eip155:8453").
837
+ * CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:8453" for Base).
838
838
  */
839
839
  caip2: string;
840
840
 
@@ -1081,7 +1081,7 @@ export interface TransferActionResponse {
1081
1081
  destination_amount: string | null;
1082
1082
 
1083
1083
  /**
1084
- * Chain name (e.g. "base", "ethereum").
1084
+ * Chain name (e.g. "tempo", "base").
1085
1085
  */
1086
1086
  source_chain: string;
1087
1087
 
@@ -1207,7 +1207,7 @@ export interface VedaVaultDetails {
1207
1207
  available_liquidity_usd: number | null;
1208
1208
 
1209
1209
  /**
1210
- * CAIP-2 chain identifier (e.g. "eip155:8453").
1210
+ * CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:8453" for Base).
1211
1211
  */
1212
1212
  caip2: string;
1213
1213
 
@@ -45,6 +45,7 @@ export namespace BalanceGetResponse {
45
45
  | 'usdt'
46
46
  | 'eurc'
47
47
  | 'usdb'
48
+ | 'pathusd'
48
49
  | 'sol'
49
50
  | 'trx'
50
51
  | (string & {});
@@ -65,7 +66,7 @@ export namespace BalanceGetResponse {
65
66
  export interface BalanceGetParams {
66
67
  /**
67
68
  * The token contract address(es) to query in format "chain:address" (e.g.,
68
- * "base:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" or
69
+ * "tempo:0x20c000000000000000000000b9537d11c60e8b50" or
69
70
  * "solana:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"). Cannot be used together
70
71
  * with `asset`/`chain` or with `include_currency`.
71
72
  */
@@ -85,12 +86,13 @@ export interface BalanceGetParams {
85
86
  | 'usdt'
86
87
  | 'eurc'
87
88
  | 'usdb'
89
+ | 'pathusd'
88
90
  | 'sol'
89
91
  | 'trx'
90
92
  | Array<WalletsAPI.WalletAsset>;
91
93
 
92
94
  /**
93
- * Chain(s) to query named assets on (e.g. `base`, `ethereum`). Use together with
95
+ * Chain(s) to query named assets on (e.g. `tempo`, `base`). Use together with
94
96
  * `asset`. Cannot be used with `token`.
95
97
  */
96
98
  chain?: WalletsAPI.WalletAssetChainNameInput | Array<WalletsAPI.WalletAssetChainNameInput>;
@@ -149,6 +149,8 @@ export {
149
149
  type RawWalletAuthenticateResponse,
150
150
  type RecipientPublicKey,
151
151
  type RelayerFee,
152
+ type RpcSponsorAsset,
153
+ type RpcSponsorOptions,
152
154
  type SeedPhraseExportInput,
153
155
  type SeedPhraseExportResponse,
154
156
  type SignatureOptions,
@@ -284,6 +286,7 @@ export {
284
286
  type WalletChainType,
285
287
  type WalletCreateWalletsWithRecoveryResponse,
286
288
  type WalletCustodian,
289
+ type WalletEntity,
287
290
  type WalletEntropyType,
288
291
  type WalletEthereumAsset,
289
292
  type WalletExportRequestBody,
@@ -98,6 +98,7 @@ export interface TransactionGetParams {
98
98
  | 'usdt'
99
99
  | 'eurc'
100
100
  | 'usdb'
101
+ | 'pathusd'
101
102
  | 'sol'
102
103
  | 'trx'
103
104
  | Array<WalletsAPI.WalletAsset>;