@privy-io/api-types 0.14.0 → 0.16.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.
- package/CHANGELOG.md +119 -0
- package/api-promise.d.mts +1 -0
- package/api-promise.d.mts.map +1 -1
- package/api-promise.d.ts +1 -0
- package/api-promise.d.ts.map +1 -1
- package/api-promise.mjs +1 -0
- package/api-promise.mjs.map +1 -1
- package/client.d.mts +33 -27
- package/client.d.mts.map +1 -1
- package/client.d.ts +33 -27
- package/client.d.ts.map +1 -1
- package/client.js +17 -3
- package/client.js.map +1 -1
- package/client.mjs +17 -3
- package/client.mjs.map +1 -1
- package/core/api-promise.d.mts.map +1 -1
- package/core/api-promise.d.ts.map +1 -1
- package/core/api-promise.mjs.map +1 -1
- package/core/error.mjs.map +1 -1
- package/core/pagination.d.mts.map +1 -1
- package/core/pagination.d.ts.map +1 -1
- package/core/pagination.mjs.map +1 -1
- package/core/resource.d.mts.map +1 -1
- package/core/resource.d.ts.map +1 -1
- package/core/uploads.d.mts.map +1 -1
- package/core/uploads.d.ts.map +1 -1
- package/core/uploads.mjs.map +1 -1
- package/error.d.mts +1 -0
- package/error.d.mts.map +1 -1
- package/error.d.ts +1 -0
- package/error.d.ts.map +1 -1
- package/error.mjs +1 -0
- package/error.mjs.map +1 -1
- package/index.d.mts.map +1 -1
- package/index.d.ts.map +1 -1
- package/index.mjs.map +1 -1
- package/internal/detect-platform.mjs.map +1 -1
- package/internal/headers.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.mjs.map +1 -1
- package/internal/qs/formats.d.mts.map +1 -1
- package/internal/qs/formats.d.ts.map +1 -1
- package/internal/qs/index.d.mts +2 -2
- package/internal/qs/index.d.mts.map +1 -1
- package/internal/qs/index.d.ts +2 -2
- package/internal/qs/index.d.ts.map +1 -1
- package/internal/qs/index.mjs.map +1 -1
- package/internal/qs/stringify.d.mts.map +1 -1
- package/internal/qs/stringify.d.ts.map +1 -1
- package/internal/qs/stringify.mjs.map +1 -1
- package/internal/qs/utils.d.mts.map +1 -1
- package/internal/qs/utils.d.ts.map +1 -1
- package/internal/qs/utils.mjs.map +1 -1
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts.map +1 -1
- package/internal/shims.d.mts +6 -0
- package/internal/shims.d.mts.map +1 -1
- package/internal/shims.d.ts +6 -0
- package/internal/shims.d.ts.map +1 -1
- package/internal/to-file.d.mts.map +1 -1
- package/internal/to-file.d.ts.map +1 -1
- package/internal/to-file.mjs.map +1 -1
- package/internal/types.d.mts +4 -4
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +4 -4
- package/internal/types.d.ts.map +1 -1
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.mjs.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/query.mjs.map +1 -1
- package/internal/utils/values.mjs.map +1 -1
- package/internal/utils.d.mts.map +1 -1
- package/internal/utils.d.ts.map +1 -1
- package/internal/utils.mjs.map +1 -1
- package/package.json +1 -1
- package/pagination.d.mts +1 -0
- package/pagination.d.mts.map +1 -1
- package/pagination.d.ts +1 -0
- package/pagination.d.ts.map +1 -1
- package/pagination.mjs +1 -0
- package/pagination.mjs.map +1 -1
- package/resource.d.mts +1 -0
- package/resource.d.mts.map +1 -1
- package/resource.d.ts +1 -0
- package/resource.d.ts.map +1 -1
- package/resource.mjs +1 -0
- package/resource.mjs.map +1 -1
- package/resources/accounts.d.mts +6 -2
- package/resources/accounts.d.mts.map +1 -1
- package/resources/accounts.d.ts +6 -2
- package/resources/accounts.d.ts.map +1 -1
- package/resources/accounts.mjs.map +1 -1
- package/resources/aggregations.d.mts +14 -4
- package/resources/aggregations.d.mts.map +1 -1
- package/resources/aggregations.d.ts +14 -4
- package/resources/aggregations.d.ts.map +1 -1
- package/resources/aggregations.mjs.map +1 -1
- package/resources/analytics.d.mts +1 -1
- package/resources/analytics.d.mts.map +1 -1
- package/resources/analytics.d.ts +1 -1
- package/resources/analytics.d.ts.map +1 -1
- package/resources/analytics.mjs.map +1 -1
- package/resources/apps.d.mts +42 -37
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +42 -37
- package/resources/apps.d.ts.map +1 -1
- package/resources/apps.mjs.map +1 -1
- package/resources/client-auth.d.mts +176 -217
- package/resources/client-auth.d.mts.map +1 -1
- package/resources/client-auth.d.ts +176 -217
- package/resources/client-auth.d.ts.map +1 -1
- package/resources/client-auth.js.map +1 -1
- package/resources/client-auth.mjs.map +1 -1
- package/resources/cross-app.d.mts.map +1 -1
- package/resources/cross-app.d.ts.map +1 -1
- package/resources/cross-app.mjs.map +1 -1
- package/resources/embedded-wallets.d.mts.map +1 -1
- package/resources/embedded-wallets.d.ts.map +1 -1
- package/resources/embedded-wallets.mjs.map +1 -1
- package/resources/fiat.d.mts.map +1 -1
- package/resources/fiat.d.ts.map +1 -1
- package/resources/fiat.mjs.map +1 -1
- package/resources/funding.d.mts.map +1 -1
- package/resources/funding.d.ts.map +1 -1
- package/resources/funding.mjs.map +1 -1
- package/resources/index.d.mts +15 -13
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +15 -13
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -0
- package/resources/index.mjs.map +1 -1
- package/resources/intents.d.mts +112 -79
- package/resources/intents.d.mts.map +1 -1
- package/resources/intents.d.ts +112 -79
- package/resources/intents.d.ts.map +1 -1
- package/resources/intents.js.map +1 -1
- package/resources/intents.mjs.map +1 -1
- package/resources/key-quorums.d.mts +9 -8
- package/resources/key-quorums.d.mts.map +1 -1
- package/resources/key-quorums.d.ts +9 -8
- package/resources/key-quorums.d.ts.map +1 -1
- package/resources/key-quorums.mjs.map +1 -1
- package/resources/kraken-embed.d.mts +252 -154
- package/resources/kraken-embed.d.mts.map +1 -1
- package/resources/kraken-embed.d.ts +252 -154
- package/resources/kraken-embed.d.ts.map +1 -1
- package/resources/kraken-embed.js.map +1 -1
- package/resources/kraken-embed.mjs.map +1 -1
- package/resources/oauth.d.mts +77 -0
- package/resources/oauth.d.mts.map +1 -0
- package/resources/oauth.d.ts +77 -0
- package/resources/oauth.d.ts.map +1 -0
- package/resources/oauth.js +9 -0
- package/resources/oauth.js.map +1 -0
- package/resources/oauth.mjs +5 -0
- package/resources/oauth.mjs.map +1 -0
- package/resources/onramps.d.mts +458 -0
- package/resources/onramps.d.mts.map +1 -0
- package/resources/onramps.d.ts +458 -0
- package/resources/onramps.d.ts.map +1 -0
- package/resources/onramps.js +9 -0
- package/resources/onramps.js.map +1 -0
- package/resources/onramps.mjs +5 -0
- package/resources/onramps.mjs.map +1 -0
- package/resources/organizations.d.mts.map +1 -1
- package/resources/organizations.d.ts.map +1 -1
- package/resources/organizations.mjs.map +1 -1
- package/resources/policies.d.mts +73 -18
- package/resources/policies.d.mts.map +1 -1
- package/resources/policies.d.ts +73 -18
- package/resources/policies.d.ts.map +1 -1
- package/resources/policies.mjs.map +1 -1
- package/resources/shared.d.mts +38 -1
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +38 -1
- package/resources/shared.d.ts.map +1 -1
- package/resources/shared.mjs.map +1 -1
- package/resources/swaps.d.mts +44 -5
- package/resources/swaps.d.mts.map +1 -1
- package/resources/swaps.d.ts +44 -5
- package/resources/swaps.d.ts.map +1 -1
- package/resources/swaps.mjs.map +1 -1
- package/resources/transactions.d.mts.map +1 -1
- package/resources/transactions.d.ts.map +1 -1
- package/resources/transactions.mjs.map +1 -1
- package/resources/users.d.mts +3 -0
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +3 -0
- package/resources/users.d.ts.map +1 -1
- package/resources/users.mjs.map +1 -1
- package/resources/wallet-actions.d.mts +207 -9
- package/resources/wallet-actions.d.mts.map +1 -1
- package/resources/wallet-actions.d.ts +207 -9
- package/resources/wallet-actions.d.ts.map +1 -1
- package/resources/wallet-actions.js.map +1 -1
- package/resources/wallet-actions.mjs.map +1 -1
- package/resources/wallets/balance.d.mts +8 -4
- package/resources/wallets/balance.d.mts.map +1 -1
- package/resources/wallets/balance.d.ts +8 -4
- package/resources/wallets/balance.d.ts.map +1 -1
- package/resources/wallets/balance.mjs.map +1 -1
- package/resources/wallets/index.d.mts +1 -1
- package/resources/wallets/index.d.mts.map +1 -1
- package/resources/wallets/index.d.ts +1 -1
- package/resources/wallets/index.d.ts.map +1 -1
- package/resources/wallets/index.js.map +1 -1
- package/resources/wallets/index.mjs.map +1 -1
- package/resources/wallets/transactions.d.mts +5 -1
- package/resources/wallets/transactions.d.mts.map +1 -1
- package/resources/wallets/transactions.d.ts +5 -1
- package/resources/wallets/transactions.d.ts.map +1 -1
- package/resources/wallets/transactions.mjs.map +1 -1
- package/resources/wallets/wallets.d.mts +749 -84
- package/resources/wallets/wallets.d.mts.map +1 -1
- package/resources/wallets/wallets.d.ts +749 -84
- package/resources/wallets/wallets.d.ts.map +1 -1
- package/resources/wallets/wallets.js +15 -2
- package/resources/wallets/wallets.js.map +1 -1
- package/resources/wallets/wallets.mjs +15 -2
- package/resources/wallets/wallets.mjs.map +1 -1
- package/resources/wallets.d.mts.map +1 -1
- package/resources/wallets.d.ts.map +1 -1
- package/resources/wallets.mjs.map +1 -1
- package/resources/webhooks.d.mts +314 -54
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +314 -54
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs.map +1 -1
- package/resources/yield.d.mts +26 -27
- package/resources/yield.d.mts.map +1 -1
- package/resources/yield.d.ts +26 -27
- package/resources/yield.d.ts.map +1 -1
- package/resources/yield.mjs.map +1 -1
- package/resources.d.mts.map +1 -1
- package/resources.d.ts.map +1 -1
- package/resources.mjs.map +1 -1
- package/src/client.ts +389 -65
- package/src/resources/accounts.ts +7 -1
- package/src/resources/aggregations.ts +16 -3
- package/src/resources/analytics.ts +1 -1
- package/src/resources/apps.ts +57 -51
- package/src/resources/client-auth.ts +215 -308
- package/src/resources/index.ts +180 -25
- package/src/resources/intents.ts +132 -91
- package/src/resources/key-quorums.ts +11 -9
- package/src/resources/kraken-embed.ts +591 -432
- package/src/resources/oauth.ts +96 -0
- package/src/resources/onramps.ts +652 -0
- package/src/resources/policies.ts +106 -16
- package/src/resources/shared.ts +53 -0
- package/src/resources/swaps.ts +52 -5
- package/src/resources/users.ts +3 -0
- package/src/resources/wallet-actions.ts +274 -8
- package/src/resources/wallets/balance.ts +13 -1
- package/src/resources/wallets/index.ts +43 -0
- package/src/resources/wallets/transactions.ts +6 -0
- package/src/resources/wallets/wallets.ts +969 -93
- package/src/resources/webhooks.ts +383 -57
- package/src/resources/yield.ts +29 -30
- package/src/version.ts +1 -1
- package/uploads.d.mts +1 -0
- package/uploads.d.mts.map +1 -1
- package/uploads.d.ts +1 -0
- package/uploads.d.ts.map +1 -1
- package/uploads.mjs +1 -0
- package/uploads.mjs.map +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.js";
|
|
2
|
-
import * as KrakenEmbedAPI from "./kraken-embed.js";
|
|
3
2
|
export declare class KrakenEmbed extends APIResource {
|
|
4
3
|
}
|
|
5
4
|
/**
|
|
@@ -21,17 +20,10 @@ export interface KrakenEmbedCancelCustomOrderResponse {
|
|
|
21
20
|
/**
|
|
22
21
|
* Result payload for cancel custom order response.
|
|
23
22
|
*/
|
|
24
|
-
result:
|
|
23
|
+
result: KrakenEmbedCancelCustomOrderResult | null;
|
|
25
24
|
error?: Array<unknown>;
|
|
26
25
|
errors?: Array<unknown>;
|
|
27
26
|
}
|
|
28
|
-
export declare namespace KrakenEmbedCancelCustomOrderResponse {
|
|
29
|
-
/**
|
|
30
|
-
* Result payload for cancel custom order response.
|
|
31
|
-
*/
|
|
32
|
-
interface Result extends KrakenEmbedAPI.KrakenEmbedCancelCustomOrderResult {
|
|
33
|
-
}
|
|
34
|
-
}
|
|
35
27
|
/**
|
|
36
28
|
* Result payload for cancel custom order response.
|
|
37
29
|
*/
|
|
@@ -64,17 +56,10 @@ export interface KrakenEmbedCreateCustomOrderResponse {
|
|
|
64
56
|
/**
|
|
65
57
|
* Result payload for create custom order response.
|
|
66
58
|
*/
|
|
67
|
-
result:
|
|
59
|
+
result: KrakenEmbedCreateCustomOrderResult | null;
|
|
68
60
|
error?: Array<unknown>;
|
|
69
61
|
errors?: Array<unknown>;
|
|
70
62
|
}
|
|
71
|
-
export declare namespace KrakenEmbedCreateCustomOrderResponse {
|
|
72
|
-
/**
|
|
73
|
-
* Result payload for create custom order response.
|
|
74
|
-
*/
|
|
75
|
-
interface Result extends KrakenEmbedAPI.KrakenEmbedCreateCustomOrderResult {
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
63
|
/**
|
|
79
64
|
* Result payload for create custom order response.
|
|
80
65
|
*/
|
|
@@ -153,17 +138,10 @@ export interface KrakenEmbedCustomOrderOccurrence {
|
|
|
153
138
|
/**
|
|
154
139
|
* Executed action details for a custom order occurrence.
|
|
155
140
|
*/
|
|
156
|
-
executed_action?:
|
|
141
|
+
executed_action?: KrakenEmbedCustomOrderOccurrenceExecutedAction | null;
|
|
157
142
|
failure_reason?: string;
|
|
158
143
|
skip_reason?: string;
|
|
159
144
|
}
|
|
160
|
-
export declare namespace KrakenEmbedCustomOrderOccurrence {
|
|
161
|
-
/**
|
|
162
|
-
* Executed action details for a custom order occurrence.
|
|
163
|
-
*/
|
|
164
|
-
interface ExecutedAction extends KrakenEmbedAPI.KrakenEmbedCustomOrderOccurrenceExecutedAction {
|
|
165
|
-
}
|
|
166
|
-
}
|
|
167
145
|
/**
|
|
168
146
|
* Executed action details for a custom order occurrence.
|
|
169
147
|
*/
|
|
@@ -200,6 +178,55 @@ export interface KrakenEmbedCustomOrderTrigger {
|
|
|
200
178
|
target_price: string;
|
|
201
179
|
type: 'price';
|
|
202
180
|
}
|
|
181
|
+
/**
|
|
182
|
+
* An earn amount with native and converted values.
|
|
183
|
+
*/
|
|
184
|
+
export interface KrakenEmbedEarnAmount {
|
|
185
|
+
converted: string;
|
|
186
|
+
native: string;
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* Low and high estimate of the yield of an earn asset.
|
|
190
|
+
*/
|
|
191
|
+
export interface KrakenEmbedEarnAprEstimate {
|
|
192
|
+
high: string;
|
|
193
|
+
low: string;
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* A single asset that can yield rewards.
|
|
197
|
+
*/
|
|
198
|
+
export interface KrakenEmbedEarnAsset {
|
|
199
|
+
/**
|
|
200
|
+
* Low and high estimate of the yield of an earn asset.
|
|
201
|
+
*/
|
|
202
|
+
apr_estimate: KrakenEmbedEarnAprEstimate | null;
|
|
203
|
+
/**
|
|
204
|
+
* User allocation for an earn asset.
|
|
205
|
+
*/
|
|
206
|
+
user_allocation?: KrakenEmbedEarnUserAllocation | null;
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* User allocation for an earn asset.
|
|
210
|
+
*/
|
|
211
|
+
export interface KrakenEmbedEarnUserAllocation {
|
|
212
|
+
/**
|
|
213
|
+
* An earn amount with native and converted values.
|
|
214
|
+
*/
|
|
215
|
+
total_allocated: KrakenEmbedEarnAmount | null;
|
|
216
|
+
/**
|
|
217
|
+
* An earn amount with native and converted values.
|
|
218
|
+
*/
|
|
219
|
+
total_rewarded: KrakenEmbedEarnAmount | null;
|
|
220
|
+
upcoming_reward_date?: string | null;
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* User's full name including first, optional middle, and last name.
|
|
224
|
+
*/
|
|
225
|
+
export interface KrakenEmbedFullName {
|
|
226
|
+
first_name: string;
|
|
227
|
+
last_name: string;
|
|
228
|
+
middle_name?: string | null;
|
|
229
|
+
}
|
|
203
230
|
/**
|
|
204
231
|
* Query parameters for listing and filtering available assets.
|
|
205
232
|
*/
|
|
@@ -228,17 +255,10 @@ export interface KrakenEmbedGetCustomOrderHistoryResponse {
|
|
|
228
255
|
/**
|
|
229
256
|
* Result payload for custom order history response.
|
|
230
257
|
*/
|
|
231
|
-
result:
|
|
258
|
+
result: KrakenEmbedGetCustomOrderHistoryResult | null;
|
|
232
259
|
error?: Array<unknown>;
|
|
233
260
|
errors?: Array<unknown>;
|
|
234
261
|
}
|
|
235
|
-
export declare namespace KrakenEmbedGetCustomOrderHistoryResponse {
|
|
236
|
-
/**
|
|
237
|
-
* Result payload for custom order history response.
|
|
238
|
-
*/
|
|
239
|
-
interface Result extends KrakenEmbedAPI.KrakenEmbedGetCustomOrderHistoryResult {
|
|
240
|
-
}
|
|
241
|
-
}
|
|
242
262
|
/**
|
|
243
263
|
* Result payload for custom order history response.
|
|
244
264
|
*/
|
|
@@ -259,17 +279,10 @@ export interface KrakenEmbedGetCustomOrderResponse {
|
|
|
259
279
|
/**
|
|
260
280
|
* Result payload for get custom order response.
|
|
261
281
|
*/
|
|
262
|
-
result:
|
|
282
|
+
result: KrakenEmbedGetCustomOrderResult | null;
|
|
263
283
|
error?: Array<unknown>;
|
|
264
284
|
errors?: Array<unknown>;
|
|
265
285
|
}
|
|
266
|
-
export declare namespace KrakenEmbedGetCustomOrderResponse {
|
|
267
|
-
/**
|
|
268
|
-
* Result payload for get custom order response.
|
|
269
|
-
*/
|
|
270
|
-
interface Result extends KrakenEmbedAPI.KrakenEmbedGetCustomOrderResult {
|
|
271
|
-
}
|
|
272
|
-
}
|
|
273
286
|
/**
|
|
274
287
|
* Result payload for get custom order response.
|
|
275
288
|
*/
|
|
@@ -279,6 +292,83 @@ export interface KrakenEmbedGetCustomOrderResult {
|
|
|
279
292
|
*/
|
|
280
293
|
order: KrakenEmbedCustomOrder;
|
|
281
294
|
}
|
|
295
|
+
/**
|
|
296
|
+
* Kraken API response envelope for earn assets.
|
|
297
|
+
*/
|
|
298
|
+
export interface KrakenEmbedGetEarnAssetsKrakenResponse {
|
|
299
|
+
/**
|
|
300
|
+
* Result payload for earn assets response.
|
|
301
|
+
*/
|
|
302
|
+
result: KrakenEmbedGetEarnAssetsResult | null;
|
|
303
|
+
error?: Array<unknown>;
|
|
304
|
+
errors?: Array<unknown>;
|
|
305
|
+
}
|
|
306
|
+
/**
|
|
307
|
+
* Query parameters for listing earn assets.
|
|
308
|
+
*/
|
|
309
|
+
export interface KrakenEmbedGetEarnAssetsQueryParams {
|
|
310
|
+
assets?: Array<string>;
|
|
311
|
+
currency?: string;
|
|
312
|
+
user?: string;
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* List of earn assets with APR estimates and optional user allocations.
|
|
316
|
+
*/
|
|
317
|
+
export interface KrakenEmbedGetEarnAssetsResponse {
|
|
318
|
+
/**
|
|
319
|
+
* Kraken API response envelope for earn assets.
|
|
320
|
+
*/
|
|
321
|
+
data: KrakenEmbedGetEarnAssetsKrakenResponse;
|
|
322
|
+
}
|
|
323
|
+
/**
|
|
324
|
+
* Result payload for earn assets response.
|
|
325
|
+
*/
|
|
326
|
+
export interface KrakenEmbedGetEarnAssetsResult {
|
|
327
|
+
assets: {
|
|
328
|
+
[key: string]: KrakenEmbedEarnAsset;
|
|
329
|
+
};
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* Kraken API response envelope for earn summary.
|
|
333
|
+
*/
|
|
334
|
+
export interface KrakenEmbedGetEarnSummaryKrakenResponse {
|
|
335
|
+
/**
|
|
336
|
+
* Result payload for earn summary response.
|
|
337
|
+
*/
|
|
338
|
+
result: KrakenEmbedGetEarnSummaryResult | null;
|
|
339
|
+
error?: Array<unknown>;
|
|
340
|
+
errors?: Array<unknown>;
|
|
341
|
+
}
|
|
342
|
+
/**
|
|
343
|
+
* Query parameters for getting an earn summary.
|
|
344
|
+
*/
|
|
345
|
+
export interface KrakenEmbedGetEarnSummaryQueryParams {
|
|
346
|
+
currency: string;
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* Earn summary for a user including Auto-Earn status, total rewards, and upcoming
|
|
350
|
+
* payouts.
|
|
351
|
+
*/
|
|
352
|
+
export interface KrakenEmbedGetEarnSummaryResponse {
|
|
353
|
+
/**
|
|
354
|
+
* Kraken API response envelope for earn summary.
|
|
355
|
+
*/
|
|
356
|
+
data: KrakenEmbedGetEarnSummaryKrakenResponse;
|
|
357
|
+
}
|
|
358
|
+
/**
|
|
359
|
+
* Result payload for earn summary response.
|
|
360
|
+
*/
|
|
361
|
+
export interface KrakenEmbedGetEarnSummaryResult {
|
|
362
|
+
auto_earn_eligible: boolean;
|
|
363
|
+
auto_earn_enabled: boolean;
|
|
364
|
+
num_earning_assets: number;
|
|
365
|
+
payout_period: string;
|
|
366
|
+
total_allocated_converted: string;
|
|
367
|
+
total_rewarded_converted_current_rate: string;
|
|
368
|
+
total_rewarded_converted_true_rates: string;
|
|
369
|
+
upcoming_rewards: Array<KrakenEmbedUpcomingReward>;
|
|
370
|
+
auto_earn_last_changed?: string | null;
|
|
371
|
+
}
|
|
282
372
|
/**
|
|
283
373
|
* Query parameters for portfolio details endpoint.
|
|
284
374
|
*/
|
|
@@ -297,31 +387,24 @@ export interface KrakenEmbedGetPortfolioSummaryQueryParams {
|
|
|
297
387
|
* balance, and unrealized P&L.
|
|
298
388
|
*/
|
|
299
389
|
export interface KrakenEmbedGetPortfolioSummaryResponse {
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
* Current day profit and loss for a portfolio, calculated from the most recent
|
|
319
|
-
* available balance.
|
|
320
|
-
*/
|
|
321
|
-
current_day_pnl?: KrakenEmbedAPI.KrakenEmbedCurrentDayPnl | null;
|
|
322
|
-
lots_upnl?: string | null;
|
|
323
|
-
}
|
|
324
|
-
}
|
|
390
|
+
/**
|
|
391
|
+
* Kraken API response envelope for portfolio summary, containing optional errors
|
|
392
|
+
* and the result payload.
|
|
393
|
+
*/
|
|
394
|
+
data: KrakenEmbedGetPortfolioSummaryResult;
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
* Kraken API response envelope for portfolio summary, containing optional errors
|
|
398
|
+
* and the result payload.
|
|
399
|
+
*/
|
|
400
|
+
export interface KrakenEmbedGetPortfolioSummaryResult {
|
|
401
|
+
/**
|
|
402
|
+
* Portfolio summary payload containing balances, value, and profit/loss
|
|
403
|
+
* information.
|
|
404
|
+
*/
|
|
405
|
+
result: KrakenEmbedPortfolioSummaryPayload | null;
|
|
406
|
+
error?: Array<string>;
|
|
407
|
+
errors?: Array<string>;
|
|
325
408
|
}
|
|
326
409
|
/**
|
|
327
410
|
* Query parameters for filtering and paginating portfolio transactions.
|
|
@@ -333,18 +416,12 @@ export interface KrakenEmbedGetPortfolioTransactionsQueryParamsSchema {
|
|
|
333
416
|
ids?: Array<string>;
|
|
334
417
|
page_size?: number;
|
|
335
418
|
quote?: string;
|
|
336
|
-
ref_ids?: Array<
|
|
419
|
+
ref_ids?: Array<KrakenEmbedPortfolioTransactionRefID>;
|
|
337
420
|
sorting?: 'descending' | 'ascending';
|
|
338
421
|
statuses?: Array<'unspecified' | 'in_progress' | 'successful' | 'failed'>;
|
|
339
422
|
types?: Array<'simple_order' | 'simple_order_failed' | 'earn_reward'>;
|
|
340
423
|
until_time?: string;
|
|
341
424
|
}
|
|
342
|
-
export declare namespace KrakenEmbedGetPortfolioTransactionsQueryParamsSchema {
|
|
343
|
-
interface RefID {
|
|
344
|
-
ref_id: string;
|
|
345
|
-
type: 'simple_order_quote' | 'simple_order_quote_failed';
|
|
346
|
-
}
|
|
347
|
-
}
|
|
348
425
|
/**
|
|
349
426
|
* Query parameters for getting a quote status.
|
|
350
427
|
*/
|
|
@@ -369,42 +446,75 @@ export interface KrakenEmbedListCustomOrdersResponse {
|
|
|
369
446
|
/**
|
|
370
447
|
* Result payload for list custom orders response.
|
|
371
448
|
*/
|
|
372
|
-
result:
|
|
449
|
+
result: KrakenEmbedListCustomOrdersResult | null;
|
|
373
450
|
error?: Array<unknown>;
|
|
374
451
|
errors?: Array<unknown>;
|
|
375
452
|
}
|
|
376
|
-
export declare namespace KrakenEmbedListCustomOrdersResponse {
|
|
377
|
-
/**
|
|
378
|
-
* Result payload for list custom orders response.
|
|
379
|
-
*/
|
|
380
|
-
interface Result extends KrakenEmbedAPI.KrakenEmbedListCustomOrdersResult {
|
|
381
|
-
}
|
|
382
|
-
}
|
|
383
453
|
/**
|
|
384
454
|
* Result payload for list custom orders response.
|
|
385
455
|
*/
|
|
386
456
|
export interface KrakenEmbedListCustomOrdersResult {
|
|
387
457
|
orders: Array<KrakenEmbedCustomOrder>;
|
|
388
458
|
}
|
|
459
|
+
/**
|
|
460
|
+
* Portfolio summary payload containing balances, value, and profit/loss
|
|
461
|
+
* information.
|
|
462
|
+
*/
|
|
463
|
+
export interface KrakenEmbedPortfolioSummaryPayload {
|
|
464
|
+
available_balance: string;
|
|
465
|
+
currency: string;
|
|
466
|
+
open_orders: string;
|
|
467
|
+
portfolio_value: string;
|
|
468
|
+
timestamp: string;
|
|
469
|
+
withheld_value: string;
|
|
470
|
+
cost_basis?: string | null;
|
|
471
|
+
/**
|
|
472
|
+
* Current day profit and loss for a portfolio, calculated from the most recent
|
|
473
|
+
* available balance.
|
|
474
|
+
*/
|
|
475
|
+
current_day_pnl?: KrakenEmbedCurrentDayPnl | null;
|
|
476
|
+
lots_upnl?: string | null;
|
|
477
|
+
}
|
|
478
|
+
/**
|
|
479
|
+
* A reference ID filter for portfolio transaction queries, identifying a
|
|
480
|
+
* transaction by type and reference identifier.
|
|
481
|
+
*/
|
|
482
|
+
export interface KrakenEmbedPortfolioTransactionRefID {
|
|
483
|
+
ref_id: string;
|
|
484
|
+
/**
|
|
485
|
+
* The type of reference ID used to filter portfolio transactions by quote or
|
|
486
|
+
* failed quote references.
|
|
487
|
+
*/
|
|
488
|
+
type: KrakenEmbedPortfolioTransactionRefIDType;
|
|
489
|
+
}
|
|
490
|
+
/**
|
|
491
|
+
* The type of reference ID used to filter portfolio transactions by quote or
|
|
492
|
+
* failed quote references.
|
|
493
|
+
*/
|
|
494
|
+
export type KrakenEmbedPortfolioTransactionRefIDType = 'simple_order_quote' | 'simple_order_quote_failed';
|
|
495
|
+
/**
|
|
496
|
+
* User's residential address including street, city, postal code, and country.
|
|
497
|
+
*/
|
|
498
|
+
export interface KrakenEmbedResidence {
|
|
499
|
+
city: string;
|
|
500
|
+
country: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'AC' | 'AN' | 'AP' | 'CP' | 'DG' | 'EA' | 'EU' | 'IC' | 'JX' | 'TA' | 'QO' | 'XK' | '0C';
|
|
501
|
+
line1: string;
|
|
502
|
+
postal_code: string;
|
|
503
|
+
line2?: string | null;
|
|
504
|
+
province?: string | null;
|
|
505
|
+
}
|
|
389
506
|
/**
|
|
390
507
|
* Optional best-effort metadata hints for proof of address verification.
|
|
391
508
|
*/
|
|
392
509
|
export interface KrakenEmbedStartAddressMetadata {
|
|
393
|
-
|
|
510
|
+
/**
|
|
511
|
+
* User's residential address including street, city, postal code, and country.
|
|
512
|
+
*/
|
|
513
|
+
address?: KrakenEmbedResidence | null;
|
|
394
514
|
document_number?: string | null;
|
|
395
515
|
document_type?: 'bank_statement' | 'credit_card_statement' | 'employer_letter_or_work_contract' | 'government_issued_document' | 'home_or_rental_insurance' | 'internet_or_cable_bill' | 'mobile_phone_bill' | 'mortgage_statement' | 'official_government_letter' | 'passport_address_page' | 'rental_or_lease_agreement' | 'residence_certificate' | 'social_insurance_payment_receipt' | 'tax_receipt' | 'tax_return' | 'utility_bill' | 'other' | null;
|
|
396
516
|
expiration_date?: string | null;
|
|
397
517
|
}
|
|
398
|
-
export declare namespace KrakenEmbedStartAddressMetadata {
|
|
399
|
-
interface Address {
|
|
400
|
-
city: string;
|
|
401
|
-
country: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'AC' | 'AN' | 'AP' | 'CP' | 'DG' | 'EA' | 'EU' | 'IC' | 'JX' | 'TA' | 'QO' | 'XK' | '0C';
|
|
402
|
-
line1: string;
|
|
403
|
-
postal_code: string;
|
|
404
|
-
line2?: string | null;
|
|
405
|
-
province?: string | null;
|
|
406
|
-
}
|
|
407
|
-
}
|
|
408
518
|
/**
|
|
409
519
|
* Input payload for starting proof of address verification via URL.
|
|
410
520
|
*/
|
|
@@ -414,23 +524,11 @@ export interface KrakenEmbedStartAddressVerificationURLInput {
|
|
|
414
524
|
/**
|
|
415
525
|
* Debug options for start verification. Only works in non-production environments.
|
|
416
526
|
*/
|
|
417
|
-
debug?:
|
|
418
|
-
/**
|
|
419
|
-
* Optional best-effort metadata hints for proof of address verification.
|
|
420
|
-
*/
|
|
421
|
-
metadata?: KrakenEmbedStartAddressVerificationURLInput.Metadata;
|
|
422
|
-
}
|
|
423
|
-
export declare namespace KrakenEmbedStartAddressVerificationURLInput {
|
|
424
|
-
/**
|
|
425
|
-
* Debug options for start verification. Only works in non-production environments.
|
|
426
|
-
*/
|
|
427
|
-
interface Debug extends KrakenEmbedAPI.KrakenEmbedStartVerificationDebug {
|
|
428
|
-
}
|
|
527
|
+
debug?: KrakenEmbedStartVerificationDebug | null;
|
|
429
528
|
/**
|
|
430
529
|
* Optional best-effort metadata hints for proof of address verification.
|
|
431
530
|
*/
|
|
432
|
-
|
|
433
|
-
}
|
|
531
|
+
metadata?: KrakenEmbedStartAddressMetadata | null;
|
|
434
532
|
}
|
|
435
533
|
/**
|
|
436
534
|
* Identity information hints including full name and date of birth for proof of
|
|
@@ -438,14 +536,10 @@ export declare namespace KrakenEmbedStartAddressVerificationURLInput {
|
|
|
438
536
|
*/
|
|
439
537
|
export interface KrakenEmbedStartIdentityInfo {
|
|
440
538
|
date_of_birth?: string | null;
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
first_name: string;
|
|
446
|
-
last_name: string;
|
|
447
|
-
middle_name?: string | null;
|
|
448
|
-
}
|
|
539
|
+
/**
|
|
540
|
+
* User's full name including first, optional middle, and last name.
|
|
541
|
+
*/
|
|
542
|
+
full_name?: KrakenEmbedFullName | null;
|
|
449
543
|
}
|
|
450
544
|
/**
|
|
451
545
|
* Optional best-effort metadata hints for proof of identity verification.
|
|
@@ -458,18 +552,10 @@ export interface KrakenEmbedStartIdentityMetadata {
|
|
|
458
552
|
* Identity information hints including full name and date of birth for proof of
|
|
459
553
|
* identity verification.
|
|
460
554
|
*/
|
|
461
|
-
identity?:
|
|
555
|
+
identity?: KrakenEmbedStartIdentityInfo | null;
|
|
462
556
|
issuing_country?: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'AC' | 'AN' | 'AP' | 'CP' | 'DG' | 'EA' | 'EU' | 'IC' | 'JX' | 'TA' | 'QO' | 'XK' | '0C' | null;
|
|
463
557
|
nationality?: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'AC' | 'AN' | 'AP' | 'CP' | 'DG' | 'EA' | 'EU' | 'IC' | 'JX' | 'TA' | 'QO' | 'XK' | '0C' | null;
|
|
464
558
|
}
|
|
465
|
-
export declare namespace KrakenEmbedStartIdentityMetadata {
|
|
466
|
-
/**
|
|
467
|
-
* Identity information hints including full name and date of birth for proof of
|
|
468
|
-
* identity verification.
|
|
469
|
-
*/
|
|
470
|
-
interface Identity extends KrakenEmbedAPI.KrakenEmbedStartIdentityInfo {
|
|
471
|
-
}
|
|
472
|
-
}
|
|
473
559
|
/**
|
|
474
560
|
* Input payload for starting proof of identity verification via URLs.
|
|
475
561
|
*/
|
|
@@ -480,23 +566,11 @@ export interface KrakenEmbedStartIdentityVerificationURLInput {
|
|
|
480
566
|
/**
|
|
481
567
|
* Debug options for start verification. Only works in non-production environments.
|
|
482
568
|
*/
|
|
483
|
-
debug?:
|
|
484
|
-
/**
|
|
485
|
-
* Optional best-effort metadata hints for proof of identity verification.
|
|
486
|
-
*/
|
|
487
|
-
metadata?: KrakenEmbedStartIdentityVerificationURLInput.Metadata;
|
|
488
|
-
}
|
|
489
|
-
export declare namespace KrakenEmbedStartIdentityVerificationURLInput {
|
|
490
|
-
/**
|
|
491
|
-
* Debug options for start verification. Only works in non-production environments.
|
|
492
|
-
*/
|
|
493
|
-
interface Debug extends KrakenEmbedAPI.KrakenEmbedStartVerificationDebug {
|
|
494
|
-
}
|
|
569
|
+
debug?: KrakenEmbedStartVerificationDebug | null;
|
|
495
570
|
/**
|
|
496
571
|
* Optional best-effort metadata hints for proof of identity verification.
|
|
497
572
|
*/
|
|
498
|
-
|
|
499
|
-
}
|
|
573
|
+
metadata?: KrakenEmbedStartIdentityMetadata | null;
|
|
500
574
|
}
|
|
501
575
|
/**
|
|
502
576
|
* Input payload for starting proof of liveness verification via URLs.
|
|
@@ -509,14 +583,7 @@ export interface KrakenEmbedStartLivenessVerificationURLInput {
|
|
|
509
583
|
/**
|
|
510
584
|
* Debug options for start verification. Only works in non-production environments.
|
|
511
585
|
*/
|
|
512
|
-
debug?:
|
|
513
|
-
}
|
|
514
|
-
export declare namespace KrakenEmbedStartLivenessVerificationURLInput {
|
|
515
|
-
/**
|
|
516
|
-
* Debug options for start verification. Only works in non-production environments.
|
|
517
|
-
*/
|
|
518
|
-
interface Debug extends KrakenEmbedAPI.KrakenEmbedStartVerificationDebug {
|
|
519
|
-
}
|
|
586
|
+
debug?: KrakenEmbedStartVerificationDebug | null;
|
|
520
587
|
}
|
|
521
588
|
/**
|
|
522
589
|
* Debug options for start verification. Only works in non-production environments.
|
|
@@ -535,14 +602,7 @@ export interface KrakenEmbedStartVerificationURLResponse {
|
|
|
535
602
|
/**
|
|
536
603
|
* Result payload for start verification URL response.
|
|
537
604
|
*/
|
|
538
|
-
result:
|
|
539
|
-
}
|
|
540
|
-
export declare namespace KrakenEmbedStartVerificationURLResponse {
|
|
541
|
-
/**
|
|
542
|
-
* Result payload for start verification URL response.
|
|
543
|
-
*/
|
|
544
|
-
interface Result extends KrakenEmbedAPI.KrakenEmbedStartVerificationURLResult {
|
|
545
|
-
}
|
|
605
|
+
result: KrakenEmbedStartVerificationURLResult | null;
|
|
546
606
|
}
|
|
547
607
|
/**
|
|
548
608
|
* Result payload for start verification URL response.
|
|
@@ -550,7 +610,45 @@ export declare namespace KrakenEmbedStartVerificationURLResponse {
|
|
|
550
610
|
export interface KrakenEmbedStartVerificationURLResult {
|
|
551
611
|
verification_id: string;
|
|
552
612
|
}
|
|
613
|
+
/**
|
|
614
|
+
* Kraken API response envelope for toggle auto-earn. Result is null on success.
|
|
615
|
+
*/
|
|
616
|
+
export interface KrakenEmbedToggleAutoEarnKrakenResponse {
|
|
617
|
+
error?: Array<unknown>;
|
|
618
|
+
errors?: Array<unknown>;
|
|
619
|
+
result?: null;
|
|
620
|
+
}
|
|
621
|
+
/**
|
|
622
|
+
* Query parameters for toggling Auto-Earn.
|
|
623
|
+
*/
|
|
624
|
+
export interface KrakenEmbedToggleAutoEarnQueryParams {
|
|
625
|
+
want_enabled: boolean;
|
|
626
|
+
}
|
|
627
|
+
/**
|
|
628
|
+
* Response from toggling Auto-Earn. The response body is empty on success.
|
|
629
|
+
*/
|
|
630
|
+
export interface KrakenEmbedToggleAutoEarnResponse {
|
|
631
|
+
/**
|
|
632
|
+
* Kraken API response envelope for toggle auto-earn. Result is null on success.
|
|
633
|
+
*/
|
|
634
|
+
data: KrakenEmbedToggleAutoEarnKrakenResponse;
|
|
635
|
+
}
|
|
636
|
+
/**
|
|
637
|
+
* An upcoming earn reward for a specific asset.
|
|
638
|
+
*/
|
|
639
|
+
export interface KrakenEmbedUpcomingReward {
|
|
640
|
+
/**
|
|
641
|
+
* An earn amount with native and converted values.
|
|
642
|
+
*/
|
|
643
|
+
accumulated_amount: KrakenEmbedEarnAmount;
|
|
644
|
+
asset: string;
|
|
645
|
+
date: string;
|
|
646
|
+
/**
|
|
647
|
+
* An earn amount with native and converted values.
|
|
648
|
+
*/
|
|
649
|
+
estimated_pending_amount: KrakenEmbedEarnAmount | null;
|
|
650
|
+
}
|
|
553
651
|
export declare namespace KrakenEmbed {
|
|
554
|
-
export { type KrakenEmbedCancelCustomOrderInput as KrakenEmbedCancelCustomOrderInput, type KrakenEmbedCancelCustomOrderPath as KrakenEmbedCancelCustomOrderPath, type KrakenEmbedCancelCustomOrderResponse as KrakenEmbedCancelCustomOrderResponse, type KrakenEmbedCancelCustomOrderResult as KrakenEmbedCancelCustomOrderResult, type KrakenEmbedCreateCustomOrderInput as KrakenEmbedCreateCustomOrderInput, type KrakenEmbedCreateCustomOrderResponse as KrakenEmbedCreateCustomOrderResponse, type KrakenEmbedCreateCustomOrderResult as KrakenEmbedCreateCustomOrderResult, type KrakenEmbedCurrentDayPnl as KrakenEmbedCurrentDayPnl, type KrakenEmbedCustomOrder as KrakenEmbedCustomOrder, type KrakenEmbedCustomOrderAction as KrakenEmbedCustomOrderAction, type KrakenEmbedCustomOrderAmount as KrakenEmbedCustomOrderAmount, type KrakenEmbedCustomOrderOccurrence as KrakenEmbedCustomOrderOccurrence, type KrakenEmbedCustomOrderOccurrenceExecutedAction as KrakenEmbedCustomOrderOccurrenceExecutedAction, type KrakenEmbedCustomOrderOccurrenceTrigger as KrakenEmbedCustomOrderOccurrenceTrigger, type KrakenEmbedCustomOrderQuoteAsset as KrakenEmbedCustomOrderQuoteAsset, type KrakenEmbedCustomOrderStatus as KrakenEmbedCustomOrderStatus, type KrakenEmbedCustomOrderTrigger as KrakenEmbedCustomOrderTrigger, type KrakenEmbedGetAssetListQueryParamsSchema as KrakenEmbedGetAssetListQueryParamsSchema, type KrakenEmbedGetCustomOrderHistoryQueryParams as KrakenEmbedGetCustomOrderHistoryQueryParams, type KrakenEmbedGetCustomOrderHistoryResponse as KrakenEmbedGetCustomOrderHistoryResponse, type KrakenEmbedGetCustomOrderHistoryResult as KrakenEmbedGetCustomOrderHistoryResult, type KrakenEmbedGetCustomOrderQueryParams as KrakenEmbedGetCustomOrderQueryParams, type KrakenEmbedGetCustomOrderResponse as KrakenEmbedGetCustomOrderResponse, type KrakenEmbedGetCustomOrderResult as KrakenEmbedGetCustomOrderResult, type KrakenEmbedGetPortfolioDetailsQueryParamsSchema as KrakenEmbedGetPortfolioDetailsQueryParamsSchema, type KrakenEmbedGetPortfolioSummaryQueryParams as KrakenEmbedGetPortfolioSummaryQueryParams, type KrakenEmbedGetPortfolioSummaryResponse as KrakenEmbedGetPortfolioSummaryResponse, type KrakenEmbedGetPortfolioTransactionsQueryParamsSchema as KrakenEmbedGetPortfolioTransactionsQueryParamsSchema, type KrakenEmbedGetQuoteQueryParams as KrakenEmbedGetQuoteQueryParams, type KrakenEmbedListCustomOrdersQueryParams as KrakenEmbedListCustomOrdersQueryParams, type KrakenEmbedListCustomOrdersResponse as KrakenEmbedListCustomOrdersResponse, type KrakenEmbedListCustomOrdersResult as KrakenEmbedListCustomOrdersResult, type KrakenEmbedStartAddressMetadata as KrakenEmbedStartAddressMetadata, type KrakenEmbedStartAddressVerificationURLInput as KrakenEmbedStartAddressVerificationURLInput, type KrakenEmbedStartIdentityInfo as KrakenEmbedStartIdentityInfo, type KrakenEmbedStartIdentityMetadata as KrakenEmbedStartIdentityMetadata, type KrakenEmbedStartIdentityVerificationURLInput as KrakenEmbedStartIdentityVerificationURLInput, type KrakenEmbedStartLivenessVerificationURLInput as KrakenEmbedStartLivenessVerificationURLInput, type KrakenEmbedStartVerificationDebug as KrakenEmbedStartVerificationDebug, type KrakenEmbedStartVerificationURLInput as KrakenEmbedStartVerificationURLInput, type KrakenEmbedStartVerificationURLResponse as KrakenEmbedStartVerificationURLResponse, type KrakenEmbedStartVerificationURLResult as KrakenEmbedStartVerificationURLResult, };
|
|
652
|
+
export { type KrakenEmbedCancelCustomOrderInput as KrakenEmbedCancelCustomOrderInput, type KrakenEmbedCancelCustomOrderPath as KrakenEmbedCancelCustomOrderPath, type KrakenEmbedCancelCustomOrderResponse as KrakenEmbedCancelCustomOrderResponse, type KrakenEmbedCancelCustomOrderResult as KrakenEmbedCancelCustomOrderResult, type KrakenEmbedCreateCustomOrderInput as KrakenEmbedCreateCustomOrderInput, type KrakenEmbedCreateCustomOrderResponse as KrakenEmbedCreateCustomOrderResponse, type KrakenEmbedCreateCustomOrderResult as KrakenEmbedCreateCustomOrderResult, type KrakenEmbedCurrentDayPnl as KrakenEmbedCurrentDayPnl, type KrakenEmbedCustomOrder as KrakenEmbedCustomOrder, type KrakenEmbedCustomOrderAction as KrakenEmbedCustomOrderAction, type KrakenEmbedCustomOrderAmount as KrakenEmbedCustomOrderAmount, type KrakenEmbedCustomOrderOccurrence as KrakenEmbedCustomOrderOccurrence, type KrakenEmbedCustomOrderOccurrenceExecutedAction as KrakenEmbedCustomOrderOccurrenceExecutedAction, type KrakenEmbedCustomOrderOccurrenceTrigger as KrakenEmbedCustomOrderOccurrenceTrigger, type KrakenEmbedCustomOrderQuoteAsset as KrakenEmbedCustomOrderQuoteAsset, type KrakenEmbedCustomOrderStatus as KrakenEmbedCustomOrderStatus, type KrakenEmbedCustomOrderTrigger as KrakenEmbedCustomOrderTrigger, type KrakenEmbedEarnAmount as KrakenEmbedEarnAmount, type KrakenEmbedEarnAprEstimate as KrakenEmbedEarnAprEstimate, type KrakenEmbedEarnAsset as KrakenEmbedEarnAsset, type KrakenEmbedEarnUserAllocation as KrakenEmbedEarnUserAllocation, type KrakenEmbedFullName as KrakenEmbedFullName, type KrakenEmbedGetAssetListQueryParamsSchema as KrakenEmbedGetAssetListQueryParamsSchema, type KrakenEmbedGetCustomOrderHistoryQueryParams as KrakenEmbedGetCustomOrderHistoryQueryParams, type KrakenEmbedGetCustomOrderHistoryResponse as KrakenEmbedGetCustomOrderHistoryResponse, type KrakenEmbedGetCustomOrderHistoryResult as KrakenEmbedGetCustomOrderHistoryResult, type KrakenEmbedGetCustomOrderQueryParams as KrakenEmbedGetCustomOrderQueryParams, type KrakenEmbedGetCustomOrderResponse as KrakenEmbedGetCustomOrderResponse, type KrakenEmbedGetCustomOrderResult as KrakenEmbedGetCustomOrderResult, type KrakenEmbedGetEarnAssetsKrakenResponse as KrakenEmbedGetEarnAssetsKrakenResponse, type KrakenEmbedGetEarnAssetsQueryParams as KrakenEmbedGetEarnAssetsQueryParams, type KrakenEmbedGetEarnAssetsResponse as KrakenEmbedGetEarnAssetsResponse, type KrakenEmbedGetEarnAssetsResult as KrakenEmbedGetEarnAssetsResult, type KrakenEmbedGetEarnSummaryKrakenResponse as KrakenEmbedGetEarnSummaryKrakenResponse, type KrakenEmbedGetEarnSummaryQueryParams as KrakenEmbedGetEarnSummaryQueryParams, type KrakenEmbedGetEarnSummaryResponse as KrakenEmbedGetEarnSummaryResponse, type KrakenEmbedGetEarnSummaryResult as KrakenEmbedGetEarnSummaryResult, type KrakenEmbedGetPortfolioDetailsQueryParamsSchema as KrakenEmbedGetPortfolioDetailsQueryParamsSchema, type KrakenEmbedGetPortfolioSummaryQueryParams as KrakenEmbedGetPortfolioSummaryQueryParams, type KrakenEmbedGetPortfolioSummaryResponse as KrakenEmbedGetPortfolioSummaryResponse, type KrakenEmbedGetPortfolioSummaryResult as KrakenEmbedGetPortfolioSummaryResult, type KrakenEmbedGetPortfolioTransactionsQueryParamsSchema as KrakenEmbedGetPortfolioTransactionsQueryParamsSchema, type KrakenEmbedGetQuoteQueryParams as KrakenEmbedGetQuoteQueryParams, type KrakenEmbedListCustomOrdersQueryParams as KrakenEmbedListCustomOrdersQueryParams, type KrakenEmbedListCustomOrdersResponse as KrakenEmbedListCustomOrdersResponse, type KrakenEmbedListCustomOrdersResult as KrakenEmbedListCustomOrdersResult, type KrakenEmbedPortfolioSummaryPayload as KrakenEmbedPortfolioSummaryPayload, type KrakenEmbedPortfolioTransactionRefID as KrakenEmbedPortfolioTransactionRefID, type KrakenEmbedPortfolioTransactionRefIDType as KrakenEmbedPortfolioTransactionRefIDType, type KrakenEmbedResidence as KrakenEmbedResidence, type KrakenEmbedStartAddressMetadata as KrakenEmbedStartAddressMetadata, type KrakenEmbedStartAddressVerificationURLInput as KrakenEmbedStartAddressVerificationURLInput, type KrakenEmbedStartIdentityInfo as KrakenEmbedStartIdentityInfo, type KrakenEmbedStartIdentityMetadata as KrakenEmbedStartIdentityMetadata, type KrakenEmbedStartIdentityVerificationURLInput as KrakenEmbedStartIdentityVerificationURLInput, type KrakenEmbedStartLivenessVerificationURLInput as KrakenEmbedStartLivenessVerificationURLInput, type KrakenEmbedStartVerificationDebug as KrakenEmbedStartVerificationDebug, type KrakenEmbedStartVerificationURLInput as KrakenEmbedStartVerificationURLInput, type KrakenEmbedStartVerificationURLResponse as KrakenEmbedStartVerificationURLResponse, type KrakenEmbedStartVerificationURLResult as KrakenEmbedStartVerificationURLResult, type KrakenEmbedToggleAutoEarnKrakenResponse as KrakenEmbedToggleAutoEarnKrakenResponse, type KrakenEmbedToggleAutoEarnQueryParams as KrakenEmbedToggleAutoEarnQueryParams, type KrakenEmbedToggleAutoEarnResponse as KrakenEmbedToggleAutoEarnResponse, type KrakenEmbedUpcomingReward as KrakenEmbedUpcomingReward, };
|
|
555
653
|
}
|
|
556
654
|
//# sourceMappingURL=kraken-embed.d.ts.map
|