@privy-io/api-types 0.15.0 → 0.17.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 (158) hide show
  1. package/CHANGELOG.md +141 -0
  2. package/client.d.mts +30 -33
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +30 -33
  5. package/client.d.ts.map +1 -1
  6. package/client.js +9 -4
  7. package/client.js.map +1 -1
  8. package/client.mjs +9 -4
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/accounts.d.mts +6 -2
  12. package/resources/accounts.d.mts.map +1 -1
  13. package/resources/accounts.d.ts +6 -2
  14. package/resources/accounts.d.ts.map +1 -1
  15. package/resources/aggregations.d.mts +14 -4
  16. package/resources/aggregations.d.mts.map +1 -1
  17. package/resources/aggregations.d.ts +14 -4
  18. package/resources/aggregations.d.ts.map +1 -1
  19. package/resources/apps.d.mts +44 -23
  20. package/resources/apps.d.mts.map +1 -1
  21. package/resources/apps.d.ts +44 -23
  22. package/resources/apps.d.ts.map +1 -1
  23. package/resources/client-auth.d.mts +32 -8
  24. package/resources/client-auth.d.mts.map +1 -1
  25. package/resources/client-auth.d.ts +32 -8
  26. package/resources/client-auth.d.ts.map +1 -1
  27. package/resources/embedded-wallets.d.mts +6 -0
  28. package/resources/embedded-wallets.d.mts.map +1 -1
  29. package/resources/embedded-wallets.d.ts +6 -0
  30. package/resources/embedded-wallets.d.ts.map +1 -1
  31. package/resources/index.d.mts +15 -16
  32. package/resources/index.d.mts.map +1 -1
  33. package/resources/index.d.ts +15 -16
  34. package/resources/index.d.ts.map +1 -1
  35. package/resources/index.js +1 -3
  36. package/resources/index.js.map +1 -1
  37. package/resources/index.mjs +0 -1
  38. package/resources/index.mjs.map +1 -1
  39. package/resources/intents.d.mts +65 -79
  40. package/resources/intents.d.mts.map +1 -1
  41. package/resources/intents.d.ts +65 -79
  42. package/resources/intents.d.ts.map +1 -1
  43. package/resources/intents.js.map +1 -1
  44. package/resources/intents.mjs.map +1 -1
  45. package/resources/key-quorums.d.mts +9 -8
  46. package/resources/key-quorums.d.mts.map +1 -1
  47. package/resources/key-quorums.d.ts +9 -8
  48. package/resources/key-quorums.d.ts.map +1 -1
  49. package/resources/kraken-embed.d.mts +208 -218
  50. package/resources/kraken-embed.d.mts.map +1 -1
  51. package/resources/kraken-embed.d.ts +208 -218
  52. package/resources/kraken-embed.d.ts.map +1 -1
  53. package/resources/kraken-embed.js.map +1 -1
  54. package/resources/kraken-embed.mjs.map +1 -1
  55. package/resources/onramps.d.mts +50 -48
  56. package/resources/onramps.d.mts.map +1 -1
  57. package/resources/onramps.d.ts +50 -48
  58. package/resources/onramps.d.ts.map +1 -1
  59. package/resources/policies.d.mts +93 -24
  60. package/resources/policies.d.mts.map +1 -1
  61. package/resources/policies.d.ts +93 -24
  62. package/resources/policies.d.ts.map +1 -1
  63. package/resources/shared.d.mts +15 -3
  64. package/resources/shared.d.mts.map +1 -1
  65. package/resources/shared.d.ts +15 -3
  66. package/resources/shared.d.ts.map +1 -1
  67. package/resources/swaps.d.mts +3 -2
  68. package/resources/swaps.d.mts.map +1 -1
  69. package/resources/swaps.d.ts +3 -2
  70. package/resources/swaps.d.ts.map +1 -1
  71. package/resources/transactions.d.mts +9 -2
  72. package/resources/transactions.d.mts.map +1 -1
  73. package/resources/transactions.d.ts +9 -2
  74. package/resources/transactions.d.ts.map +1 -1
  75. package/resources/users.d.mts +33 -7
  76. package/resources/users.d.mts.map +1 -1
  77. package/resources/users.d.ts +33 -7
  78. package/resources/users.d.ts.map +1 -1
  79. package/resources/{wallet-actions.d.ts → wallets/actions.d.mts} +383 -68
  80. package/resources/wallets/actions.d.mts.map +1 -0
  81. package/resources/{wallet-actions.d.mts → wallets/actions.d.ts} +383 -68
  82. package/resources/wallets/actions.d.ts.map +1 -0
  83. package/resources/wallets/actions.js +9 -0
  84. package/resources/wallets/actions.js.map +1 -0
  85. package/resources/wallets/actions.mjs +5 -0
  86. package/resources/wallets/actions.mjs.map +1 -0
  87. package/resources/wallets/balance.d.mts +11 -4
  88. package/resources/wallets/balance.d.mts.map +1 -1
  89. package/resources/wallets/balance.d.ts +11 -4
  90. package/resources/wallets/balance.d.ts.map +1 -1
  91. package/resources/wallets/index.d.mts +2 -1
  92. package/resources/wallets/index.d.mts.map +1 -1
  93. package/resources/wallets/index.d.ts +2 -1
  94. package/resources/wallets/index.d.ts.map +1 -1
  95. package/resources/wallets/index.js +3 -1
  96. package/resources/wallets/index.js.map +1 -1
  97. package/resources/wallets/index.mjs +1 -0
  98. package/resources/wallets/index.mjs.map +1 -1
  99. package/resources/wallets/transactions.d.mts +14 -3
  100. package/resources/wallets/transactions.d.mts.map +1 -1
  101. package/resources/wallets/transactions.d.ts +14 -3
  102. package/resources/wallets/transactions.d.ts.map +1 -1
  103. package/resources/wallets/transactions.js.map +1 -1
  104. package/resources/wallets/transactions.mjs.map +1 -1
  105. package/resources/wallets/wallets.d.mts +846 -97
  106. package/resources/wallets/wallets.d.mts.map +1 -1
  107. package/resources/wallets/wallets.d.ts +846 -97
  108. package/resources/wallets/wallets.d.ts.map +1 -1
  109. package/resources/wallets/wallets.js +19 -2
  110. package/resources/wallets/wallets.js.map +1 -1
  111. package/resources/wallets/wallets.mjs +19 -2
  112. package/resources/wallets/wallets.mjs.map +1 -1
  113. package/resources/webhooks.d.mts +596 -108
  114. package/resources/webhooks.d.mts.map +1 -1
  115. package/resources/webhooks.d.ts +596 -108
  116. package/resources/webhooks.d.ts.map +1 -1
  117. package/resources/webhooks.js.map +1 -1
  118. package/resources/webhooks.mjs.map +1 -1
  119. package/resources/yield.d.mts +30 -30
  120. package/resources/yield.d.mts.map +1 -1
  121. package/resources/yield.d.ts +30 -30
  122. package/resources/yield.d.ts.map +1 -1
  123. package/resources/yield.js.map +1 -1
  124. package/resources/yield.mjs.map +1 -1
  125. package/src/client.ts +223 -76
  126. package/src/resources/accounts.ts +7 -1
  127. package/src/resources/aggregations.ts +16 -3
  128. package/src/resources/apps.ts +60 -30
  129. package/src/resources/client-auth.ts +41 -7
  130. package/src/resources/embedded-wallets.ts +7 -0
  131. package/src/resources/index.ts +107 -36
  132. package/src/resources/intents.ts +73 -91
  133. package/src/resources/key-quorums.ts +11 -9
  134. package/src/resources/kraken-embed.ts +560 -1065
  135. package/src/resources/onramps.ts +69 -54
  136. package/src/resources/policies.ts +162 -52
  137. package/src/resources/shared.ts +18 -2
  138. package/src/resources/swaps.ts +3 -2
  139. package/src/resources/transactions.ts +18 -9
  140. package/src/resources/users.ts +38 -6
  141. package/src/resources/{wallet-actions.ts → wallets/actions.ts} +496 -78
  142. package/src/resources/wallets/balance.ts +26 -56
  143. package/src/resources/wallets/index.ts +93 -0
  144. package/src/resources/wallets/transactions.ts +17 -10
  145. package/src/resources/wallets/wallets.ts +1312 -177
  146. package/src/resources/webhooks.ts +729 -118
  147. package/src/resources/yield.ts +33 -41
  148. package/src/version.ts +1 -1
  149. package/version.d.mts +1 -1
  150. package/version.d.ts +1 -1
  151. package/version.js +1 -1
  152. package/version.mjs +1 -1
  153. package/resources/wallet-actions.d.mts.map +0 -1
  154. package/resources/wallet-actions.d.ts.map +0 -1
  155. package/resources/wallet-actions.js +0 -9
  156. package/resources/wallet-actions.js.map +0 -1
  157. package/resources/wallet-actions.mjs +0 -5
  158. package/resources/wallet-actions.mjs.map +0 -1
@@ -35,26 +35,24 @@ export interface BalanceGetResponse {
35
35
 
36
36
  export namespace BalanceGetResponse {
37
37
  export interface Balance {
38
- asset: 'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
38
+ asset:
39
+ | 'usdc'
40
+ | 'usdc.e'
41
+ | 'eth'
42
+ | 'avax'
43
+ | 'pol'
44
+ | 'bnb'
45
+ | 'usdt'
46
+ | 'eurc'
47
+ | 'usdb'
48
+ | 'sol'
49
+ | 'trx'
50
+ | (string & {});
39
51
 
40
- chain:
41
- | 'ethereum'
42
- | 'arbitrum'
43
- | 'base'
44
- | 'tempo'
45
- | 'linea'
46
- | 'optimism'
47
- | 'polygon'
48
- | 'solana'
49
- | 'zksync_era'
50
- | 'sepolia'
51
- | 'arbitrum_sepolia'
52
- | 'base_sepolia'
53
- | 'linea_testnet'
54
- | 'optimism_sepolia'
55
- | 'polygon_amoy'
56
- | 'solana_devnet'
57
- | 'solana_testnet';
52
+ /**
53
+ * Supported blockchain network names for wallet balance and transaction queries.
54
+ */
55
+ chain: WalletsAPI.WalletAssetChainNameInput;
58
56
 
59
57
  display_values: { [key: string]: string };
60
58
 
@@ -81,54 +79,26 @@ export interface BalanceGetParams {
81
79
  | 'usdc'
82
80
  | 'usdc.e'
83
81
  | 'eth'
82
+ | 'avax'
84
83
  | 'pol'
84
+ | 'bnb'
85
85
  | 'usdt'
86
86
  | 'eurc'
87
87
  | 'usdb'
88
88
  | 'sol'
89
+ | 'trx'
89
90
  | Array<WalletsAPI.WalletAsset>;
90
91
 
91
92
  /**
92
93
  * Chain(s) to query named assets on (e.g. `base`, `ethereum`). Use together with
93
94
  * `asset`. Cannot be used with `token`.
94
95
  */
95
- chain?:
96
- | 'ethereum'
97
- | 'arbitrum'
98
- | 'base'
99
- | 'tempo'
100
- | 'linea'
101
- | 'optimism'
102
- | 'polygon'
103
- | 'solana'
104
- | 'zksync_era'
105
- | 'sepolia'
106
- | 'arbitrum_sepolia'
107
- | 'base_sepolia'
108
- | 'linea_testnet'
109
- | 'optimism_sepolia'
110
- | 'polygon_amoy'
111
- | 'solana_devnet'
112
- | 'solana_testnet'
113
- | Array<
114
- | 'ethereum'
115
- | 'arbitrum'
116
- | 'base'
117
- | 'tempo'
118
- | 'linea'
119
- | 'optimism'
120
- | 'polygon'
121
- | 'solana'
122
- | 'zksync_era'
123
- | 'sepolia'
124
- | 'arbitrum_sepolia'
125
- | 'base_sepolia'
126
- | 'linea_testnet'
127
- | 'optimism_sepolia'
128
- | 'polygon_amoy'
129
- | 'solana_devnet'
130
- | 'solana_testnet'
131
- >;
96
+ chain?: WalletsAPI.WalletAssetChainNameInput | Array<WalletsAPI.WalletAssetChainNameInput>;
97
+
98
+ /**
99
+ * Include archived wallets in lookup. Defaults to false.
100
+ */
101
+ include_archived?: boolean;
132
102
 
133
103
  /**
134
104
  * If set, balances are converted to the specified fiat currency. Not supported
@@ -1,12 +1,62 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
+ export {
4
+ Actions,
5
+ type AaveVaultDetails,
6
+ type CustodianTransactionWalletActionStep,
7
+ type CustodianTransactionWalletActionStepStatus,
8
+ type EvmTransactionWalletActionStep,
9
+ type EvmUserOperationEntrypointVersion,
10
+ type EvmUserOperationWalletActionStep,
11
+ type EvmWalletActionStepStatus,
12
+ type EarnAsset,
13
+ type EarnDepositActionResponse,
14
+ type EarnDepositRequestBody,
15
+ type EarnFeeCollectActionResponse,
16
+ type EarnFeeCollectRequestBody,
17
+ type EarnIncentiveClaimActionResponse,
18
+ type EarnIncentiveClaimRequestBody,
19
+ type EarnIncentiveRewardEntry,
20
+ type EarnIncentiveRewardsQuery,
21
+ type EarnIncentiveRewardsResponse,
22
+ type EarnIncetiveClaimRewardEntry,
23
+ type EarnWithdrawActionResponse,
24
+ type EarnWithdrawRequestBody,
25
+ type EthereumEarnPositionQuery,
26
+ type EthereumEarnPositionResponse,
27
+ type EthereumEarnProvider,
28
+ type EthereumEarnVaultDetailsResponse,
29
+ type ExternalTransactionWalletActionStep,
30
+ type ExternalTransactionWalletActionStepStatus,
31
+ type FailureReason,
32
+ type ListWalletActionsQuery,
33
+ type ListWalletActionsResponse,
34
+ type MorphoVaultDetails,
35
+ type SvmTransactionWalletActionStep,
36
+ type SvmWalletActionStepStatus,
37
+ type SwapActionResponse,
38
+ type TvmTransactionWalletActionStep,
39
+ type TvmWalletActionStepStatus,
40
+ type TransferActionResponse,
41
+ type VedaVaultDetails,
42
+ type WalletActionInclude,
43
+ type WalletActionResponse,
44
+ type WalletActionStatus,
45
+ type WalletActionStep,
46
+ type WalletActionStepType,
47
+ type WalletActionType,
48
+ } from './actions';
3
49
  export { Balance, type BalanceGetResponse, type BalanceGetParams } from './balance';
4
50
  export { Transactions, type TransactionGetResponse, type TransactionGetParams } from './transactions';
5
51
  export {
6
52
  Wallets,
53
+ type AccessListEntry,
7
54
  type AdditionalSignerInput,
8
55
  type AdditionalSignerItemInput,
9
56
  type Address,
57
+ type AdvancedSwapPlatformFee,
58
+ type AdvancedSwapRequestBody,
59
+ type AdvancedSwapResponse,
10
60
  type AmountType,
11
61
  type AuthorizationKeyDashboardResponse,
12
62
  type AuthorizationKeyResponse,
@@ -19,6 +69,9 @@ export {
19
69
  type CustodialWalletProvider,
20
70
  type CustomTokenTransferSource,
21
71
  type DeveloperFee,
72
+ type EncryptedAuthorizationKey,
73
+ type EncryptedBoundAuthenticateResponse,
74
+ type EncryptedWalletAuthenticateResponse,
22
75
  type EthereumPersonalSignRpcInput,
23
76
  type EthereumPersonalSignRpcInputParams,
24
77
  type EthereumPersonalSignRpcResponse,
@@ -74,6 +127,7 @@ export {
74
127
  type HpkeEncryption,
75
128
  type HpkeImportConfig,
76
129
  type Hex,
130
+ type IntentBinding,
77
131
  type NamedTokenTransferSource,
78
132
  type OutputWithPreviousTransactionData,
79
133
  type PolicyInput,
@@ -83,6 +137,7 @@ export {
83
137
  type PrivateKeySubmitInput,
84
138
  type PrivyFee,
85
139
  type Quantity,
140
+ type RawBoundAuthenticateResponse,
86
141
  type RawSignBytesEncoding,
87
142
  type RawSignBytesHashFunction,
88
143
  type RawSignBytesParams,
@@ -91,10 +146,13 @@ export {
91
146
  type RawSignInputParams,
92
147
  type RawSignResponse,
93
148
  type RawSignResponseData,
149
+ type RawWalletAuthenticateResponse,
94
150
  type RecipientPublicKey,
95
151
  type RelayerFee,
96
152
  type SeedPhraseExportInput,
97
153
  type SeedPhraseExportResponse,
154
+ type SignatureOptions,
155
+ type SignatureType,
98
156
  type SigningAlgorithm,
99
157
  type SolanaRpcInput,
100
158
  type SolanaRpcResponse,
@@ -116,9 +174,13 @@ export {
116
174
  type SparkClaimStaticDepositRpcInputParams,
117
175
  type SparkClaimStaticDepositRpcResponse,
118
176
  type SparkClaimStaticDepositRpcResponseData,
177
+ type SparkCoopExitFeeQuote,
178
+ type SparkCoopExitRequest,
119
179
  type SparkCreateLightningInvoiceRpcInput,
120
180
  type SparkCreateLightningInvoiceRpcInputParams,
121
181
  type SparkCreateLightningInvoiceRpcResponse,
182
+ type SparkCurrencyAmount,
183
+ type SparkExitSpeed,
122
184
  type SparkGetBalanceRpcInput,
123
185
  type SparkGetBalanceRpcResponse,
124
186
  type SparkGetClaimStaticDepositQuoteRpcInput,
@@ -128,6 +190,9 @@ export {
128
190
  type SparkGetStaticDepositAddressRpcInput,
129
191
  type SparkGetStaticDepositAddressRpcResponse,
130
192
  type SparkGetStaticDepositAddressRpcResponseData,
193
+ type SparkGetWithdrawalFeeQuoteRpcInput,
194
+ type SparkGetWithdrawalFeeQuoteRpcInputParams,
195
+ type SparkGetWithdrawalFeeQuoteRpcResponse,
131
196
  type SparkLightningFee,
132
197
  type SparkLightningReceiveRequest,
133
198
  type SparkLightningSendRequest,
@@ -155,7 +220,11 @@ export {
155
220
  type SparkTransferTokensRpcResponseData,
156
221
  type SparkUserTokenMetadata,
157
222
  type SparkWalletLeaf,
223
+ type SparkWithdrawRpcInput,
224
+ type SparkWithdrawRpcInputParams,
225
+ type SparkWithdrawRpcResponse,
158
226
  type SuiCommandName,
227
+ type SwapSubmissionStatus,
159
228
  type TempoAaAuthorization,
160
229
  type TempoCall,
161
230
  type TempoFeePayerSignature,
@@ -163,6 +232,7 @@ export {
163
232
  type TokenTransferDestination,
164
233
  type TokenTransferSource,
165
234
  type TotalFeeConfigurationBps,
235
+ type TransactionChainNameInput,
166
236
  type TransactionDetail,
167
237
  type TransactionTokenAddressInput,
168
238
  type TransferQuoteRequestBody,
@@ -170,6 +240,21 @@ export {
170
240
  type TransferReceivedTransactionDetail,
171
241
  type TransferRequestBody,
172
242
  type TransferSentTransactionDetail,
243
+ type TronContract,
244
+ type TronRawDataForSend,
245
+ type TronRawDataForSign,
246
+ type TronRpcInput,
247
+ type TronRpcResponse,
248
+ type TronSendTransactionRpcInput,
249
+ type TronSendTransactionRpcInputParams,
250
+ type TronSendTransactionRpcResponse,
251
+ type TronSendTransactionRpcResponseData,
252
+ type TronSignTransactionRpcInput,
253
+ type TronSignTransactionRpcInputParams,
254
+ type TronSignTransactionRpcResponse,
255
+ type TronSignTransactionRpcResponseData,
256
+ type TronTransferContract,
257
+ type TronTriggerSmartContract,
173
258
  type TypedDataDomainInputParams,
174
259
  type TypedDataTypeFieldInput,
175
260
  type TypedDataTypesInputParams,
@@ -177,12 +262,18 @@ export {
177
262
  type UnsignedStandardEthereumTransaction,
178
263
  type UnsignedTempoTransaction,
179
264
  type UserOperationInput,
265
+ type UserSigningKeyBinding,
180
266
  type Wallet,
181
267
  type WalletAdditionalSigner,
182
268
  type WalletAdditionalSignerItem,
183
269
  type WalletAPIRegisterAuthorizationKeyInput,
184
270
  type WalletAPIRevokeAuthorizationKeyInput,
185
271
  type WalletAsset,
272
+ type WalletAssetChainNameInput,
273
+ type WalletAuthenticateBoundEncryptedRequestBody,
274
+ type WalletAuthenticateBoundRequestBody,
275
+ type WalletAuthenticateBoundUnencryptedRequestBody,
276
+ type WalletAuthenticateIntentsResponse,
186
277
  type WalletAuthenticateRequestBody,
187
278
  type WalletAuthenticateWithJwtResponse,
188
279
  type WalletAuthorizationHeaders,
@@ -204,11 +295,13 @@ export {
204
295
  type WalletRpcRequestBody,
205
296
  type WalletRpcResponse,
206
297
  type WalletSolanaAsset,
298
+ type WalletTronAsset,
207
299
  type WalletUpdateRequestBody,
208
300
  type WalletCreateParams,
209
301
  type WalletUpdateParams,
210
302
  type WalletListParams,
211
303
  type WalletExportParams,
304
+ type WalletGetParams,
212
305
  type WalletRawSignParams,
213
306
  type WalletRpcParams,
214
307
  type WalletsCursor,
@@ -1,6 +1,7 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  import { APIResource } from '../../core/resource';
4
+ import * as TransactionsAPI from '../transactions';
4
5
  import * as WalletsAPI from './wallets';
5
6
  import { APIPromise } from '../../core/api-promise';
6
7
  import { RequestOptions } from '../../internal/request-options';
@@ -49,15 +50,10 @@ export namespace TransactionGetResponse {
49
50
 
50
51
  privy_transaction_id: string;
51
52
 
52
- status:
53
- | 'broadcasted'
54
- | 'confirmed'
55
- | 'execution_reverted'
56
- | 'failed'
57
- | 'replaced'
58
- | 'finalized'
59
- | 'provider_error'
60
- | 'pending';
53
+ /**
54
+ * Status of a blockchain transaction submitted by Privy.
55
+ */
56
+ status: TransactionsAPI.BlockchainTransactionStatus;
61
57
 
62
58
  transaction_hash: string | null;
63
59
 
@@ -77,7 +73,10 @@ export namespace TransactionGetResponse {
77
73
  }
78
74
 
79
75
  export interface TransactionGetParams {
80
- chain: 'ethereum' | 'arbitrum' | 'base' | 'tempo' | 'linea' | 'optimism' | 'polygon' | 'solana' | 'sepolia';
76
+ /**
77
+ * Chains supported for transaction history queries.
78
+ */
79
+ chain: WalletsAPI.TransactionChainNameInput;
81
80
 
82
81
  /**
83
82
  * Exactly one of `token` or `asset` is required. Cannot be used together with
@@ -93,15 +92,23 @@ export interface TransactionGetParams {
93
92
  | 'usdc'
94
93
  | 'usdc.e'
95
94
  | 'eth'
95
+ | 'avax'
96
96
  | 'pol'
97
+ | 'bnb'
97
98
  | 'usdt'
98
99
  | 'eurc'
99
100
  | 'usdb'
100
101
  | 'sol'
102
+ | 'trx'
101
103
  | Array<WalletsAPI.WalletAsset>;
102
104
 
103
105
  cursor?: string;
104
106
 
107
+ /**
108
+ * Include archived wallets in lookup. Defaults to false.
109
+ */
110
+ include_archived?: boolean;
111
+
105
112
  limit?: number | null;
106
113
 
107
114
  tx_hash?: string;