@imtbl/sdk 1.4.1-alpha.1 → 1.4.1-alpha.2

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 (36) hide show
  1. package/dist/blockchain_data.js +2 -2
  2. package/dist/browser/checkout/sdk.js +4 -4
  3. package/dist/browser/checkout/widgets.js +872 -1
  4. package/dist/checkout.d.ts +1417 -1417
  5. package/dist/checkout.js +4 -4
  6. package/dist/config.js +1 -1
  7. package/dist/index.browser.js +6 -6
  8. package/dist/index.browser.js.map +1 -1
  9. package/dist/index.cjs +61 -30
  10. package/dist/index.d.ts +1 -1
  11. package/dist/index.js +61 -30
  12. package/dist/orderbook.js +1 -1
  13. package/dist/passport.d.ts +1417 -1417
  14. package/dist/passport.js +58 -27
  15. package/dist/x.js +2 -2
  16. package/package.json +1 -1
  17. package/dist/browser/checkout/BridgeWidget-cf957c15.js +0 -1
  18. package/dist/browser/checkout/OnRampWidget-83d73134.js +0 -1
  19. package/dist/browser/checkout/SaleWidget-ad8b7642.js +0 -2
  20. package/dist/browser/checkout/SpendingCapHero-0a0f9fd0.js +0 -1
  21. package/dist/browser/checkout/SwapWidget-7c0a1017.js +0 -1
  22. package/dist/browser/checkout/TopUpView-3b2e045d.js +0 -1
  23. package/dist/browser/checkout/WalletWidget-381ddb8f.js +0 -1
  24. package/dist/browser/checkout/auto-track-8b6baf69.js +0 -1
  25. package/dist/browser/checkout/balance-1493691b.js +0 -1
  26. package/dist/browser/checkout/index-1c33f972.js +0 -1
  27. package/dist/browser/checkout/index-287f0ec7.js +0 -1
  28. package/dist/browser/checkout/index-531bae54.js +0 -1
  29. package/dist/browser/checkout/index-696631eb.js +0 -773
  30. package/dist/browser/checkout/index-b7b99467.js +0 -1
  31. package/dist/browser/checkout/index-e7272f1c.js +0 -90
  32. package/dist/browser/checkout/index-feece362.js +0 -1
  33. package/dist/browser/checkout/index.umd-bcb0582f.js +0 -1
  34. package/dist/browser/checkout/is-plan-event-enabled-80f76ce6.js +0 -1
  35. package/dist/browser/checkout/retry-86e4cf9a.js +0 -1
  36. package/dist/browser/checkout/useTransakEvents-a01463cc.js +0 -2
@@ -10125,358 +10125,6 @@ interface ModuleConfiguration<T> {
10125
10125
  overrides?: T;
10126
10126
  }
10127
10127
 
10128
- interface ImxOverrides {
10129
- immutableXConfig: ImmutableXConfiguration;
10130
- }
10131
- interface ImxModuleConfiguration extends ModuleConfiguration<ImxOverrides> {
10132
- }
10133
-
10134
- declare class IMXClient {
10135
- private immutableX;
10136
- depositsApi: DepositsApi$1;
10137
- mintsApi: MintsApi$1;
10138
- ordersApi: OrdersApi$1;
10139
- tokensApi: TokensApi$1;
10140
- tradesApi: TradesApi$1;
10141
- transfersApi: TransfersApi$1;
10142
- exchangeApi: ExchangesApi$1;
10143
- nftCheckoutPrimaryApi: NftCheckoutPrimaryApi$1;
10144
- usersApi: UsersApi$1;
10145
- withdrawalsApi: WithdrawalsApi$1;
10146
- balanceApi: BalancesApi$1;
10147
- assetApi: AssetsApi$1;
10148
- collectionApi: CollectionsApi$1;
10149
- metadataApi: MetadataApi$1;
10150
- metadataRefreshesApi: MetadataRefreshesApi$1;
10151
- projectsApi: ProjectsApi$1;
10152
- constructor(config: ImxModuleConfiguration);
10153
- /**
10154
- * Get details of a Deposit with the given ID
10155
- * @param request - the request object containing the parameters to be provided in the API request
10156
- * @returns a promise that resolves with the requested Deposit
10157
- * @throws {@link index.IMXError}
10158
- */
10159
- getDeposit(request: DepositsApiGetDepositRequest$1): Promise<Deposit$1>;
10160
- /**
10161
- * Get a list of Deposits
10162
- * @param request - optional object containing the parameters to be provided in the API request
10163
- * @returns a promise that resolves with the requested list of Deposits
10164
- * @throws {@link index.IMXError}
10165
- */
10166
- listDeposits(request?: DepositsApiListDepositsRequest$1): Promise<ListDepositsResponse$1>;
10167
- /**
10168
- * Get Stark keys for a registered User
10169
- * @param ethAddress - the eth address of the User
10170
- * @returns a promise that resolves with the requested User
10171
- * @throws {@link index.IMXError}
10172
- */
10173
- getUser(ethAddress: string): Promise<GetUsersApiResponse$1>;
10174
- /**
10175
- * Get details of an Asset
10176
- * @param request - the request object containing the parameters to be provided in the API request
10177
- * @returns a promise that resolves with the requested Asset
10178
- * @throws {@link index.IMXError}
10179
- */
10180
- getAsset(request: AssetsApiGetAssetRequest$1): Promise<Asset$1>;
10181
- /**
10182
- * Get a list of Assets
10183
- * @param request - optional object containing the parameters to be provided in the API request
10184
- * @returns a promise that resolves with the requested list of Assets
10185
- * @throws {@link index.IMXError}
10186
- */
10187
- listAssets(request?: AssetsApiListAssetsRequest$1): Promise<ListAssetsResponse$1>;
10188
- /**
10189
- * Create a Collection
10190
- * @param ethSigner - the L1 signer
10191
- * @param request - the request object to be provided in the API request
10192
- * @returns a promise that resolves with the created Collection
10193
- * @throws {@link index.IMXError}
10194
- */
10195
- createCollection(ethSigner: Signer, request: CreateCollectionRequest$1): Promise<Collection$1>;
10196
- /**
10197
- * Get details of a Collection at the given address
10198
- * @param request - the request object containing the parameters to be provided in the API request
10199
- * @returns a promise that resolves with the requested Collection
10200
- * @throws {@link index.IMXError}
10201
- */
10202
- getCollection(request: CollectionsApiGetCollectionRequest$1): Promise<Collection$1>;
10203
- /**
10204
- * Get a list of Collection filters
10205
- * @param request - the request object containing the parameters to be provided in the API request
10206
- * @returns a promise that resolves with the requested list of Collection Filters
10207
- * @throws {@link index.IMXError}
10208
- */
10209
- listCollectionFilters(request: CollectionsApiListCollectionFiltersRequest$1): Promise<CollectionFilter$1>;
10210
- /**
10211
- * Get a list of Collections
10212
- * @param request - optional object containing the parameters to be provided in the API request
10213
- * @returns a promise that resolves with the requested list of Collections
10214
- * @throws {@link index.IMXError}
10215
- */
10216
- listCollections(request?: CollectionsApiListCollectionsRequest$1): Promise<ListCollectionsResponse$1>;
10217
- /**
10218
- * Update a Collection
10219
- * @param ethSigner - the L1 signer
10220
- * @param collectionAddress - the Collection contract address
10221
- * @param request - the request object containing the parameters to be provided in the API request
10222
- * @returns a promise that resolves with the updated Collection
10223
- * @throws {@link index.IMXError}
10224
- */
10225
- updateCollection(ethSigner: Signer, collectionAddress: string, request: UpdateCollectionRequest$1): Promise<Collection$1>;
10226
- /**
10227
- * Add metadata schema to Collection
10228
- * @param ethSigner - the L1 signer
10229
- * @param collectionAddress - the Collection contract address
10230
- * @param request - the request object containing the parameters to be provided in the API request
10231
- * @returns a promise that resolves with the SuccessResponse if successful
10232
- * @throws {@link index.IMXError}
10233
- */
10234
- addMetadataSchemaToCollection(ethSigner: Signer, collectionAddress: string, request: AddMetadataSchemaToCollectionRequest$1): Promise<SuccessResponse$1>;
10235
- /**
10236
- * Get Metadata schema
10237
- * @param request - the request object containing the parameters to be provided in the API request
10238
- * @returns a promise that resolves with the requested Metadata schema
10239
- * @throws {@link index.IMXError}
10240
- */
10241
- getMetadataSchema(request: MetadataApiGetMetadataSchemaRequest$1): Promise<MetadataSchemaProperty$1[]>;
10242
- /**
10243
- * Update metadata schema by name
10244
- * @param ethSigner - the L1 signer
10245
- * @param collectionAddress - the Collection contract address
10246
- * @param name - the Metadata schema name
10247
- * @param request - the request object containing the parameters to be provided in the API request
10248
- * @returns a promise that resolves with the SuccessResponse if successful
10249
- * @throws {@link index.IMXError}
10250
- */
10251
- updateMetadataSchemaByName(ethSigner: Signer, collectionAddress: string, name: string, request: MetadataSchemaRequest$1): Promise<SuccessResponse$1>;
10252
- /**
10253
- * Get a list of metadata refreshes
10254
- * @param ethSigner - the L1 signer
10255
- * @param collectionAddress - the Collection contract address
10256
- * @param pageSize - the page size of the result
10257
- * @param cursor - the cursor
10258
- * @returns a promise that resolves with the requested metadata refreshes
10259
- * @throws {@link index.IMXError}
10260
- */
10261
- listMetadataRefreshes(ethSigner: Signer, collectionAddress?: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshes$1>;
10262
- /**
10263
- * Get a list of metadata refresh errors
10264
- * @param ethSigner - the L1 signer
10265
- * @param refreshId - the metadata refresh ID
10266
- * @param pageSize - the page size of the result
10267
- * @param cursor - the cursor
10268
- * @returns a promise that resolves with the requested metadata refresh errors
10269
- * @throws {@link index.IMXError}
10270
- */
10271
- getMetadataRefreshErrors(ethSigner: Signer, refreshId: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshErrorsResponse$1>;
10272
- /**
10273
- * Get a list of metadata refresh results
10274
- * @param ethSigner - the L1 signer
10275
- * @param refreshId - the metadata refresh ID
10276
- * @returns a promise that resolves with the requested metadata refresh results
10277
- * @throws {@link index.IMXError}
10278
- */
10279
- getMetadataRefreshResults(ethSigner: Signer, refreshId: string): Promise<GetMetadataRefreshResponse$1>;
10280
- /**
10281
- * Request a metadata refresh
10282
- * @param ethSigner - the L1 signer
10283
- * @param request the request object containing the parameters to be provided in the API request
10284
- * @returns a promise that resolves with the requested metadata refresh
10285
- * @throws {@link index.IMXError}
10286
- */
10287
- createMetadataRefresh(ethSigner: Signer, request: CreateMetadataRefreshRequest$1): Promise<CreateMetadataRefreshResponse$1>;
10288
- /**
10289
- * Create a Project
10290
- * @param ethSigner - the L1 signer
10291
- * @param request - the request object containing the parameters to be provided in the API request
10292
- * @returns a promise that resolves with the created Project
10293
- * @throws {@link index.IMXError}
10294
- */
10295
- createProject(ethSigner: Signer, request: CreateProjectRequest$1): Promise<CreateProjectResponse$1>;
10296
- /**
10297
- * Get a Project
10298
- * @param ethSigner - the L1 signer
10299
- * @param id - the Project ID
10300
- * @returns a promise that resolves with the requested Project
10301
- * @throws {@link index.IMXError}
10302
- */
10303
- getProject(ethSigner: Signer, id: string): Promise<Project$1>;
10304
- /**
10305
- * Get Projects owned by the given User
10306
- * @param ethSigner - the L1 signer
10307
- * @param pageSize - the page size of the result
10308
- * @param cursor - the cursor
10309
- * @param orderBy - the property to sort by
10310
- * @param direction - direction to sort (asc/desc)
10311
- * @returns a promise that resolves with the requested Projects
10312
- * @throws {@link index.IMXError}
10313
- */
10314
- getProjects(ethSigner: Signer, pageSize?: number, cursor?: string, orderBy?: string, direction?: string): Promise<GetProjectsResponse$1>;
10315
- /**
10316
- * Get the token Balances of the User
10317
- * @param request - the request object containing the parameters to be provided in the API request
10318
- * @returns a promise that resolves with the requested Balance
10319
- * @throws {@link index.IMXError}
10320
- */
10321
- getBalance(request: BalancesApiGetBalanceRequest$1): Promise<Balance$1>;
10322
- /**
10323
- * Get a list of Balances for given User
10324
- * @param request the request object containing the parameters to be provided in the API request
10325
- * @returns a promise that resolves with the requested list of Balances
10326
- * @throws {@link index.IMXError}
10327
- */
10328
- listBalances(request: BalancesApiListBalancesRequest$1): Promise<ListBalancesResponse$1>;
10329
- /**
10330
- * Get details of a Mint with the given ID
10331
- * @param request the request object containing the parameters to be provided in the API request
10332
- * @returns a promise that resolves with the requested Mint
10333
- * @throws {@link index.IMXError}
10334
- */
10335
- getMint(request: MintsApiGetMintRequest$1): Promise<Mint$1[]>;
10336
- /**
10337
- * Get a list of Mints
10338
- * @param request optional object containing the parameters to be provided in the API request
10339
- * @returns a promise that resolves with the requested list of Mints
10340
- * @throws {@link index.IMXError}
10341
- */
10342
- listMints(request?: MintsApiListMintsRequest$1): Promise<ListMintsResponse$1>;
10343
- /**
10344
- * Mint tokens in a batch with fees
10345
- * @param ethSigner - the L1 signer
10346
- * @param request - the request object to be provided in the API request
10347
- * @returns a promise that resolves with the minted tokens
10348
- * @throws {@link index.IMXError}
10349
- */
10350
- mint(ethSigner: Signer, request: UnsignedMintRequest): Promise<MintTokensResponse$1>;
10351
- /**
10352
- * Get a list of Withdrawals
10353
- * @param request - optional object containing the parameters to be provided in the API request
10354
- * @returns a promise that resolves with the requested list of Withdrawals
10355
- * @throws {@link index.IMXError}
10356
- */
10357
- listWithdrawals(request?: WithdrawalsApiListWithdrawalsRequest$1): Promise<ListWithdrawalsResponse$1>;
10358
- /**
10359
- * Get details of Withdrawal with the given ID
10360
- * @param request - the request object containing the parameters to be provided in the API request
10361
- * @returns a promise that resolves with the requested Withdrawal
10362
- * @throws {@link index.IMXError}
10363
- */
10364
- getWithdrawal(request: WithdrawalsApiGetWithdrawalRequest$1): Promise<Withdrawal$1>;
10365
- /**
10366
- * Get details of an Order with the given ID
10367
- * @param request - the request object containing the parameters to be provided in the API request
10368
- * @returns a promise that resolves with the requested Order
10369
- * @throws {@link index.IMXError}
10370
- */
10371
- getOrder(request: OrdersApiGetOrderV3Request$1): Promise<OrderV3$1>;
10372
- /**
10373
- * Get a list of Orders
10374
- * @param request - optional object containing the parameters to be provided in the API request
10375
- * @returns a promise that resolves with the requested list of Orders
10376
- * @throws {@link index.IMXError}
10377
- */
10378
- listOrders(request?: OrdersApiListOrdersV3Request$1): Promise<ListOrdersResponseV3$1>;
10379
- /**
10380
- * Get details of a Trade with the given ID
10381
- * @param request - the request object containing the parameters to be provided in the API request
10382
- * @returns a promise that resolves with the requested Trade
10383
- * @throws {@link index.IMXError}
10384
- */
10385
- getTrade(request: TradesApiGetTradeV3Request$1): Promise<Trade$1>;
10386
- /**
10387
- * Get a list of Trades
10388
- * @param request - optional object containing the parameters to be provided in the API request
10389
- * @returns a promise that resolves with the requested list of Trades
10390
- * @throws {@link index.IMXError}
10391
- */
10392
- listTrades(request?: TradesApiListTradesV3Request$1): Promise<ListTradesResponse$1>;
10393
- /**
10394
- * Get details of a Token
10395
- * @param request - the request object containing the parameters to be provided in the API request
10396
- * @returns a promise that resolves with the requested Token
10397
- * @throws {@link index.IMXError}
10398
- */
10399
- getToken(request: TokensApiGetTokenRequest$1): Promise<TokenDetails$1>;
10400
- /**
10401
- * Get a list of Tokens
10402
- * @param request - optional object containing the parameters to be provided in the API request
10403
- * @returns a promise that resolves with the requested list of Tokens
10404
- * @throws {@link index.IMXError}
10405
- */
10406
- listTokens(request?: TokensApiListTokensRequest$1): Promise<ListTokensResponse$1>;
10407
- /**
10408
- * Get details of a Transfer with the given ID
10409
- * @param request - the request object containing the parameters to be provided in the API request
10410
- * @returns a promise that resolves with the requested Transfer
10411
- * @throws {@link index.IMXError}
10412
- */
10413
- getTransfer(request: TransfersApiGetTransferRequest$1): Promise<Transfer$1>;
10414
- /**
10415
- * Get a list of Transfers
10416
- * @param request - optional object containing the parameters to be provided in the API request
10417
- * @returns a promise that resolves with the requested list of Transfers
10418
- * @throws {@link index.IMXError}
10419
- */
10420
- listTransfers(request?: TransfersApiListTransfersRequest$1): Promise<ListTransfersResponse$1>;
10421
- /**
10422
- * Create a new Exchange transaction
10423
- * @param request - the request object to be provided in the API request
10424
- * @returns a promise that resolves with the created Exchange Transaction
10425
- * @throws {@link index.IMXError}
10426
- */
10427
- createExchange(request: ExchangesApiCreateExchangeRequest$1): Promise<ExchangeCreateExchangeAndURLResponse$1>;
10428
- /**
10429
- * Get an Exchange transaction
10430
- * @param request - the request object to be provided in the API request
10431
- * @returns a promise that resolves with the Exchange Transaction
10432
- * @throws {@link index.IMXError}
10433
- */
10434
- getExchange(request: ExchangesApiGetExchangeRequest$1): Promise<Exchange$1>;
10435
- /**
10436
- * Get Exchange transactions
10437
- * @param request - the request object to be provided in the API request
10438
- * @returns a promise that resolves with Exchange Transactions
10439
- * @throws {@link index.IMXError}
10440
- */
10441
- getExchanges(request: ExchangesApiGetExchangesRequest$1): Promise<GetTransactionsResponse$1>;
10442
- /**
10443
- * Create a new Transfer request
10444
- * @param walletConnection - the pair of Eth/Stark signers
10445
- * @param request - the request object to be provided in the API request
10446
- * @returns a promise that resolves with the created Exchange Transfer
10447
- * @throws {@link index.IMXError}
10448
- */
10449
- exchangeTransfer(walletConnection: WalletConnection, request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1$1>;
10450
- /**
10451
- * Create a new nft primary transaction
10452
- * @param request - the request object to be provided in the API request
10453
- * @returns a promise that resolves with the created nft primary Transaction
10454
- * @throws {@link index.IMXError}
10455
- */
10456
- createNftPrimary(request: NftCheckoutPrimaryApiCreateNftPrimaryRequest$1): Promise<NftprimarytransactionCreateResponse$1>;
10457
- /**
10458
- * Get nft primary supported currencies and their limits
10459
- * @param request - the request object to be provided in the API request
10460
- * @returns a promise that resolves with nft primary Currencies
10461
- * @throws {@link index.IMXError}
10462
- */
10463
- getCurrenciesNFTCheckoutPrimary(request: NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest$1): Promise<CurrencyWithLimits$1>;
10464
- /**
10465
- * Get nft primary transaction by transaction id
10466
- * @param request - the request object to be provided in the API request
10467
- * @returns a promise that resolves with nft primary transaction
10468
- * @throws {@link index.IMXError}
10469
- */
10470
- getNftPrimaryTransaction(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest$1): Promise<NftprimarytransactionGetResponse$1>;
10471
- /**
10472
- * Get list of nft primary transactions
10473
- * @param request - the request object to be provided in the API request
10474
- * @returns a promise that resolves with nft primary transaction
10475
- * @throws {@link index.IMXError}
10476
- */
10477
- getNftPrimaryTransactions(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest$1): Promise<NftprimarytransactionListTransactionsResponse$1>;
10478
- }
10479
-
10480
10128
  // TypeScript Version: 4.7
10481
10129
  type AxiosHeaderValue = AxiosHeaders | string | string[] | number | boolean | null;
10482
10130
 
@@ -19422,1820 +19070,2172 @@ interface OrdersApiGetSignableOrderRequest {
19422
19070
  * @type {GetSignableOrderRequestV3}
19423
19071
  * @memberof OrdersApiGetSignableOrder
19424
19072
  */
19425
- readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
19073
+ readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
19074
+ }
19075
+ /**
19076
+ * Request parameters for listOrders operation in OrdersApi.
19077
+ * @export
19078
+ * @interface OrdersApiListOrdersRequest
19079
+ */
19080
+ interface OrdersApiListOrdersRequest {
19081
+ /**
19082
+ * Page size of the result
19083
+ * @type {number}
19084
+ * @memberof OrdersApiListOrders
19085
+ */
19086
+ readonly pageSize?: number;
19087
+ /**
19088
+ * Cursor
19089
+ * @type {string}
19090
+ * @memberof OrdersApiListOrders
19091
+ */
19092
+ readonly cursor?: string;
19093
+ /**
19094
+ * Property to sort by
19095
+ * @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
19096
+ * @memberof OrdersApiListOrders
19097
+ */
19098
+ readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
19099
+ /**
19100
+ * Direction to sort (asc/desc)
19101
+ * @type {string}
19102
+ * @memberof OrdersApiListOrders
19103
+ */
19104
+ readonly direction?: string;
19105
+ /**
19106
+ * Ethereum address of the user who submitted this order
19107
+ * @type {string}
19108
+ * @memberof OrdersApiListOrders
19109
+ */
19110
+ readonly user?: string;
19111
+ /**
19112
+ * Status of this order
19113
+ * @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
19114
+ * @memberof OrdersApiListOrders
19115
+ */
19116
+ readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
19117
+ /**
19118
+ * Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19119
+ * @type {string}
19120
+ * @memberof OrdersApiListOrders
19121
+ */
19122
+ readonly minTimestamp?: string;
19123
+ /**
19124
+ * Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19125
+ * @type {string}
19126
+ * @memberof OrdersApiListOrders
19127
+ */
19128
+ readonly maxTimestamp?: string;
19129
+ /**
19130
+ * Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19131
+ * @type {string}
19132
+ * @memberof OrdersApiListOrders
19133
+ */
19134
+ readonly updatedMinTimestamp?: string;
19135
+ /**
19136
+ * Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19137
+ * @type {string}
19138
+ * @memberof OrdersApiListOrders
19139
+ */
19140
+ readonly updatedMaxTimestamp?: string;
19141
+ /**
19142
+ * Token type of the asset this order buys
19143
+ * @type {string}
19144
+ * @memberof OrdersApiListOrders
19145
+ */
19146
+ readonly buyTokenType?: string;
19147
+ /**
19148
+ * ERC721 Token ID of the asset this order buys
19149
+ * @type {string}
19150
+ * @memberof OrdersApiListOrders
19151
+ */
19152
+ readonly buyTokenId?: string;
19153
+ /**
19154
+ * Internal IMX ID of the asset this order buys
19155
+ * @type {string}
19156
+ * @memberof OrdersApiListOrders
19157
+ */
19158
+ readonly buyAssetId?: string;
19159
+ /**
19160
+ * Token address of the asset this order buys
19161
+ * @type {string}
19162
+ * @memberof OrdersApiListOrders
19163
+ */
19164
+ readonly buyTokenAddress?: string;
19165
+ /**
19166
+ * Token name of the asset this order buys
19167
+ * @type {string}
19168
+ * @memberof OrdersApiListOrders
19169
+ */
19170
+ readonly buyTokenName?: string;
19171
+ /**
19172
+ * Min quantity for the asset this order buys
19173
+ * @type {string}
19174
+ * @memberof OrdersApiListOrders
19175
+ */
19176
+ readonly buyMinQuantity?: string;
19177
+ /**
19178
+ * Max quantity for the asset this order buys
19179
+ * @type {string}
19180
+ * @memberof OrdersApiListOrders
19181
+ */
19182
+ readonly buyMaxQuantity?: string;
19183
+ /**
19184
+ * JSON-encoded metadata filters for the asset this order buys
19185
+ * @type {string}
19186
+ * @memberof OrdersApiListOrders
19187
+ */
19188
+ readonly buyMetadata?: string;
19189
+ /**
19190
+ * Token type of the asset this order sells
19191
+ * @type {string}
19192
+ * @memberof OrdersApiListOrders
19193
+ */
19194
+ readonly sellTokenType?: string;
19195
+ /**
19196
+ * ERC721 Token ID of the asset this order sells
19197
+ * @type {string}
19198
+ * @memberof OrdersApiListOrders
19199
+ */
19200
+ readonly sellTokenId?: string;
19201
+ /**
19202
+ * Internal IMX ID of the asset this order sells
19203
+ * @type {string}
19204
+ * @memberof OrdersApiListOrders
19205
+ */
19206
+ readonly sellAssetId?: string;
19207
+ /**
19208
+ * Token address of the asset this order sells
19209
+ * @type {string}
19210
+ * @memberof OrdersApiListOrders
19211
+ */
19212
+ readonly sellTokenAddress?: string;
19213
+ /**
19214
+ * Token name of the asset this order sells
19215
+ * @type {string}
19216
+ * @memberof OrdersApiListOrders
19217
+ */
19218
+ readonly sellTokenName?: string;
19219
+ /**
19220
+ * Min quantity for the asset this order sells
19221
+ * @type {string}
19222
+ * @memberof OrdersApiListOrders
19223
+ */
19224
+ readonly sellMinQuantity?: string;
19225
+ /**
19226
+ * Max quantity for the asset this order sells
19227
+ * @type {string}
19228
+ * @memberof OrdersApiListOrders
19229
+ */
19230
+ readonly sellMaxQuantity?: string;
19231
+ /**
19232
+ * JSON-encoded metadata filters for the asset this order sells
19233
+ * @type {string}
19234
+ * @memberof OrdersApiListOrders
19235
+ */
19236
+ readonly sellMetadata?: string;
19237
+ /**
19238
+ * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
19239
+ * @type {string}
19240
+ * @memberof OrdersApiListOrders
19241
+ */
19242
+ readonly auxiliaryFeePercentages?: string;
19243
+ /**
19244
+ * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
19245
+ * @type {string}
19246
+ * @memberof OrdersApiListOrders
19247
+ */
19248
+ readonly auxiliaryFeeRecipients?: string;
19249
+ /**
19250
+ * Set flag to true to include fee object for orders
19251
+ * @type {boolean}
19252
+ * @memberof OrdersApiListOrders
19253
+ */
19254
+ readonly includeFees?: boolean;
19426
19255
  }
19427
19256
  /**
19428
- * Request parameters for listOrders operation in OrdersApi.
19257
+ * Request parameters for listOrdersV3 operation in OrdersApi.
19429
19258
  * @export
19430
- * @interface OrdersApiListOrdersRequest
19259
+ * @interface OrdersApiListOrdersV3Request
19431
19260
  */
19432
- interface OrdersApiListOrdersRequest {
19261
+ interface OrdersApiListOrdersV3Request {
19433
19262
  /**
19434
19263
  * Page size of the result
19435
19264
  * @type {number}
19436
- * @memberof OrdersApiListOrders
19265
+ * @memberof OrdersApiListOrdersV3
19437
19266
  */
19438
19267
  readonly pageSize?: number;
19439
19268
  /**
19440
19269
  * Cursor
19441
19270
  * @type {string}
19442
- * @memberof OrdersApiListOrders
19271
+ * @memberof OrdersApiListOrdersV3
19443
19272
  */
19444
19273
  readonly cursor?: string;
19445
19274
  /**
19446
19275
  * Property to sort by
19447
19276
  * @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
19448
- * @memberof OrdersApiListOrders
19277
+ * @memberof OrdersApiListOrdersV3
19449
19278
  */
19450
19279
  readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
19451
19280
  /**
19452
19281
  * Direction to sort (asc/desc)
19453
19282
  * @type {string}
19454
- * @memberof OrdersApiListOrders
19283
+ * @memberof OrdersApiListOrdersV3
19455
19284
  */
19456
19285
  readonly direction?: string;
19457
19286
  /**
19458
19287
  * Ethereum address of the user who submitted this order
19459
19288
  * @type {string}
19460
- * @memberof OrdersApiListOrders
19289
+ * @memberof OrdersApiListOrdersV3
19461
19290
  */
19462
19291
  readonly user?: string;
19463
19292
  /**
19464
19293
  * Status of this order
19465
19294
  * @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
19466
- * @memberof OrdersApiListOrders
19295
+ * @memberof OrdersApiListOrdersV3
19467
19296
  */
19468
19297
  readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
19469
19298
  /**
19470
19299
  * Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19471
19300
  * @type {string}
19472
- * @memberof OrdersApiListOrders
19301
+ * @memberof OrdersApiListOrdersV3
19473
19302
  */
19474
19303
  readonly minTimestamp?: string;
19475
19304
  /**
19476
19305
  * Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19477
19306
  * @type {string}
19478
- * @memberof OrdersApiListOrders
19307
+ * @memberof OrdersApiListOrdersV3
19479
19308
  */
19480
19309
  readonly maxTimestamp?: string;
19481
19310
  /**
19482
19311
  * Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19483
19312
  * @type {string}
19484
- * @memberof OrdersApiListOrders
19313
+ * @memberof OrdersApiListOrdersV3
19485
19314
  */
19486
19315
  readonly updatedMinTimestamp?: string;
19487
19316
  /**
19488
19317
  * Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19489
19318
  * @type {string}
19490
- * @memberof OrdersApiListOrders
19319
+ * @memberof OrdersApiListOrdersV3
19491
19320
  */
19492
19321
  readonly updatedMaxTimestamp?: string;
19493
19322
  /**
19494
19323
  * Token type of the asset this order buys
19495
19324
  * @type {string}
19496
- * @memberof OrdersApiListOrders
19325
+ * @memberof OrdersApiListOrdersV3
19497
19326
  */
19498
19327
  readonly buyTokenType?: string;
19499
19328
  /**
19500
19329
  * ERC721 Token ID of the asset this order buys
19501
19330
  * @type {string}
19502
- * @memberof OrdersApiListOrders
19331
+ * @memberof OrdersApiListOrdersV3
19503
19332
  */
19504
19333
  readonly buyTokenId?: string;
19505
19334
  /**
19506
19335
  * Internal IMX ID of the asset this order buys
19507
19336
  * @type {string}
19508
- * @memberof OrdersApiListOrders
19337
+ * @memberof OrdersApiListOrdersV3
19509
19338
  */
19510
19339
  readonly buyAssetId?: string;
19511
19340
  /**
19512
19341
  * Token address of the asset this order buys
19513
19342
  * @type {string}
19514
- * @memberof OrdersApiListOrders
19343
+ * @memberof OrdersApiListOrdersV3
19515
19344
  */
19516
19345
  readonly buyTokenAddress?: string;
19517
19346
  /**
19518
19347
  * Token name of the asset this order buys
19519
19348
  * @type {string}
19520
- * @memberof OrdersApiListOrders
19349
+ * @memberof OrdersApiListOrdersV3
19521
19350
  */
19522
19351
  readonly buyTokenName?: string;
19523
19352
  /**
19524
19353
  * Min quantity for the asset this order buys
19525
19354
  * @type {string}
19526
- * @memberof OrdersApiListOrders
19355
+ * @memberof OrdersApiListOrdersV3
19527
19356
  */
19528
19357
  readonly buyMinQuantity?: string;
19529
19358
  /**
19530
19359
  * Max quantity for the asset this order buys
19531
19360
  * @type {string}
19532
- * @memberof OrdersApiListOrders
19361
+ * @memberof OrdersApiListOrdersV3
19533
19362
  */
19534
19363
  readonly buyMaxQuantity?: string;
19535
19364
  /**
19536
19365
  * JSON-encoded metadata filters for the asset this order buys
19537
19366
  * @type {string}
19538
- * @memberof OrdersApiListOrders
19367
+ * @memberof OrdersApiListOrdersV3
19539
19368
  */
19540
19369
  readonly buyMetadata?: string;
19541
19370
  /**
19542
19371
  * Token type of the asset this order sells
19543
19372
  * @type {string}
19544
- * @memberof OrdersApiListOrders
19373
+ * @memberof OrdersApiListOrdersV3
19545
19374
  */
19546
19375
  readonly sellTokenType?: string;
19547
19376
  /**
19548
19377
  * ERC721 Token ID of the asset this order sells
19549
19378
  * @type {string}
19550
- * @memberof OrdersApiListOrders
19379
+ * @memberof OrdersApiListOrdersV3
19551
19380
  */
19552
19381
  readonly sellTokenId?: string;
19553
19382
  /**
19554
19383
  * Internal IMX ID of the asset this order sells
19555
19384
  * @type {string}
19556
- * @memberof OrdersApiListOrders
19385
+ * @memberof OrdersApiListOrdersV3
19557
19386
  */
19558
19387
  readonly sellAssetId?: string;
19559
19388
  /**
19560
19389
  * Token address of the asset this order sells
19561
19390
  * @type {string}
19562
- * @memberof OrdersApiListOrders
19391
+ * @memberof OrdersApiListOrdersV3
19563
19392
  */
19564
19393
  readonly sellTokenAddress?: string;
19565
19394
  /**
19566
19395
  * Token name of the asset this order sells
19567
19396
  * @type {string}
19568
- * @memberof OrdersApiListOrders
19397
+ * @memberof OrdersApiListOrdersV3
19569
19398
  */
19570
19399
  readonly sellTokenName?: string;
19571
19400
  /**
19572
19401
  * Min quantity for the asset this order sells
19573
19402
  * @type {string}
19574
- * @memberof OrdersApiListOrders
19403
+ * @memberof OrdersApiListOrdersV3
19575
19404
  */
19576
19405
  readonly sellMinQuantity?: string;
19577
19406
  /**
19578
19407
  * Max quantity for the asset this order sells
19579
19408
  * @type {string}
19580
- * @memberof OrdersApiListOrders
19409
+ * @memberof OrdersApiListOrdersV3
19581
19410
  */
19582
19411
  readonly sellMaxQuantity?: string;
19583
19412
  /**
19584
19413
  * JSON-encoded metadata filters for the asset this order sells
19585
19414
  * @type {string}
19586
- * @memberof OrdersApiListOrders
19415
+ * @memberof OrdersApiListOrdersV3
19587
19416
  */
19588
19417
  readonly sellMetadata?: string;
19589
19418
  /**
19590
19419
  * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
19591
19420
  * @type {string}
19592
- * @memberof OrdersApiListOrders
19421
+ * @memberof OrdersApiListOrdersV3
19593
19422
  */
19594
19423
  readonly auxiliaryFeePercentages?: string;
19595
19424
  /**
19596
19425
  * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
19597
19426
  * @type {string}
19598
- * @memberof OrdersApiListOrders
19427
+ * @memberof OrdersApiListOrdersV3
19599
19428
  */
19600
19429
  readonly auxiliaryFeeRecipients?: string;
19601
19430
  /**
19602
19431
  * Set flag to true to include fee object for orders
19603
19432
  * @type {boolean}
19604
- * @memberof OrdersApiListOrders
19433
+ * @memberof OrdersApiListOrdersV3
19605
19434
  */
19606
19435
  readonly includeFees?: boolean;
19607
19436
  }
19608
19437
  /**
19609
- * Request parameters for listOrdersV3 operation in OrdersApi.
19438
+ * OrdersApi - object-oriented interface
19610
19439
  * @export
19611
- * @interface OrdersApiListOrdersV3Request
19440
+ * @class OrdersApi
19441
+ * @extends {BaseAPI}
19612
19442
  */
19613
- interface OrdersApiListOrdersV3Request {
19443
+ declare class OrdersApi extends BaseAPI {
19614
19444
  /**
19615
- * Page size of the result
19616
- * @type {number}
19617
- * @memberof OrdersApiListOrdersV3
19445
+ * Cancel an order. Use https://docs.x.immutable.com/reference#/operations/getSignableCancelOrder to get request body params. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/cancelOrderV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
19446
+ * @summary Cancel an order
19447
+ * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
19448
+ * @param {*} [options] Override http request option.
19449
+ * @deprecated
19450
+ * @throws {RequiredError}
19451
+ * @memberof OrdersApi
19618
19452
  */
19619
- readonly pageSize?: number;
19453
+ cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
19620
19454
  /**
19621
- * Cursor
19622
- * @type {string}
19623
- * @memberof OrdersApiListOrdersV3
19455
+ * Cancel an order (V3)
19456
+ * @summary Cancel an order (V3)
19457
+ * @param {OrdersApiCancelOrderV3Request} requestParameters Request parameters.
19458
+ * @param {*} [options] Override http request option.
19459
+ * @throws {RequiredError}
19460
+ * @memberof OrdersApi
19624
19461
  */
19625
- readonly cursor?: string;
19462
+ cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
19626
19463
  /**
19627
- * Property to sort by
19628
- * @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
19629
- * @memberof OrdersApiListOrdersV3
19464
+ * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createOrderV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
19465
+ * @summary Create an order
19466
+ * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
19467
+ * @param {*} [options] Override http request option.
19468
+ * @deprecated
19469
+ * @throws {RequiredError}
19470
+ * @memberof OrdersApi
19630
19471
  */
19631
- readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
19472
+ createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
19632
19473
  /**
19633
- * Direction to sort (asc/desc)
19634
- * @type {string}
19635
- * @memberof OrdersApiListOrdersV3
19474
+ * Create an order using the v3 orderbook. Currently only buy NFT orders are supported.
19475
+ * @summary Create an order (V3)
19476
+ * @param {OrdersApiCreateOrderV3Request} requestParameters Request parameters.
19477
+ * @param {*} [options] Override http request option.
19478
+ * @throws {RequiredError}
19479
+ * @memberof OrdersApi
19636
19480
  */
19637
- readonly direction?: string;
19481
+ createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
19638
19482
  /**
19639
- * Ethereum address of the user who submitted this order
19640
- * @type {string}
19641
- * @memberof OrdersApiListOrdersV3
19483
+ * Get an order. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/getOrderV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
19484
+ * @summary Get an order
19485
+ * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
19486
+ * @param {*} [options] Override http request option.
19487
+ * @deprecated
19488
+ * @throws {RequiredError}
19489
+ * @memberof OrdersApi
19642
19490
  */
19643
- readonly user?: string;
19491
+ getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order, any>>;
19644
19492
  /**
19645
- * Status of this order
19646
- * @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
19647
- * @memberof OrdersApiListOrdersV3
19493
+ * Get an order (V3)
19494
+ * @summary Get an order (V3)
19495
+ * @param {OrdersApiGetOrderV3Request} requestParameters Request parameters.
19496
+ * @param {*} [options] Override http request option.
19497
+ * @throws {RequiredError}
19498
+ * @memberof OrdersApi
19648
19499
  */
19649
- readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
19500
+ getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
19650
19501
  /**
19651
- * Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19652
- * @type {string}
19653
- * @memberof OrdersApiListOrdersV3
19502
+ * Sign cancel order message. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/getSignableCancelOrderV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
19503
+ * @summary Sign cancel order message
19504
+ * @param {OrdersApiGetSignableCancelOrderRequest} requestParameters Request parameters.
19505
+ * @param {*} [options] Override http request option.
19506
+ * @deprecated
19507
+ * @throws {RequiredError}
19508
+ * @memberof OrdersApi
19654
19509
  */
19655
- readonly minTimestamp?: string;
19510
+ getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
19656
19511
  /**
19657
- * Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19658
- * @type {string}
19659
- * @memberof OrdersApiListOrdersV3
19512
+ * Generate a signable cancel order message (V3)
19513
+ * @summary Generate a signable cancel order message (V3)
19514
+ * @param {OrdersApiGetSignableCancelOrderV3Request} requestParameters Request parameters.
19515
+ * @param {*} [options] Override http request option.
19516
+ * @throws {RequiredError}
19517
+ * @memberof OrdersApi
19660
19518
  */
19661
- readonly maxTimestamp?: string;
19519
+ getSignableCancelOrderV3(requestParameters: OrdersApiGetSignableCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
19662
19520
  /**
19663
- * Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19664
- * @type {string}
19665
- * @memberof OrdersApiListOrdersV3
19521
+ * Generate a signable order request (V3)
19522
+ * @summary Generate a signable order request (V3)
19523
+ * @param {OrdersApiGetSignableOrderRequest} requestParameters Request parameters.
19524
+ * @param {*} [options] Override http request option.
19525
+ * @throws {RequiredError}
19526
+ * @memberof OrdersApi
19666
19527
  */
19667
- readonly updatedMinTimestamp?: string;
19528
+ getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableOrderResponse, any>>;
19668
19529
  /**
19669
- * Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
19530
+ * Get a list of orders This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/listOrdersV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
19531
+ * @summary Get a list of orders.
19532
+ * @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
19533
+ * @param {*} [options] Override http request option.
19534
+ * @deprecated
19535
+ * @throws {RequiredError}
19536
+ * @memberof OrdersApi
19537
+ */
19538
+ listOrders(requestParameters?: OrdersApiListOrdersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponse, any>>;
19539
+ /**
19540
+ * Get a list of orders (V3)
19541
+ * @summary Get a list of orders (V3)
19542
+ * @param {OrdersApiListOrdersV3Request} requestParameters Request parameters.
19543
+ * @param {*} [options] Override http request option.
19544
+ * @throws {RequiredError}
19545
+ * @memberof OrdersApi
19546
+ */
19547
+ listOrdersV3(requestParameters?: OrdersApiListOrdersV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponseV3, any>>;
19548
+ }
19549
+
19550
+ /**
19551
+ * Request parameters for createProject operation in ProjectsApi.
19552
+ * @export
19553
+ * @interface ProjectsApiCreateProjectRequest
19554
+ */
19555
+ interface ProjectsApiCreateProjectRequest {
19556
+ /**
19557
+ * String created by signing wallet address and timestamp
19670
19558
  * @type {string}
19671
- * @memberof OrdersApiListOrdersV3
19559
+ * @memberof ProjectsApiCreateProject
19672
19560
  */
19673
- readonly updatedMaxTimestamp?: string;
19561
+ readonly iMXSignature: string;
19674
19562
  /**
19675
- * Token type of the asset this order buys
19563
+ * Unix Epoc timestamp
19676
19564
  * @type {string}
19677
- * @memberof OrdersApiListOrdersV3
19565
+ * @memberof ProjectsApiCreateProject
19678
19566
  */
19679
- readonly buyTokenType?: string;
19567
+ readonly iMXTimestamp: string;
19680
19568
  /**
19681
- * ERC721 Token ID of the asset this order buys
19569
+ * create a project
19570
+ * @type {CreateProjectRequest}
19571
+ * @memberof ProjectsApiCreateProject
19572
+ */
19573
+ readonly createProjectRequest: CreateProjectRequest;
19574
+ }
19575
+ /**
19576
+ * Request parameters for createProjectAPIKey operation in ProjectsApi.
19577
+ * @export
19578
+ * @interface ProjectsApiCreateProjectAPIKeyRequest
19579
+ */
19580
+ interface ProjectsApiCreateProjectAPIKeyRequest {
19581
+ /**
19582
+ * Project ID
19682
19583
  * @type {string}
19683
- * @memberof OrdersApiListOrdersV3
19584
+ * @memberof ProjectsApiCreateProjectAPIKey
19684
19585
  */
19685
- readonly buyTokenId?: string;
19586
+ readonly id: string;
19587
+ }
19588
+ /**
19589
+ * Request parameters for createProjectGroup operation in ProjectsApi.
19590
+ * @export
19591
+ * @interface ProjectsApiCreateProjectGroupRequest
19592
+ */
19593
+ interface ProjectsApiCreateProjectGroupRequest {
19594
+ /**
19595
+ * create a project group
19596
+ * @type {CreateProjectGroupRequest}
19597
+ * @memberof ProjectsApiCreateProjectGroup
19598
+ */
19599
+ readonly createProjectGroupRequest: CreateProjectGroupRequest;
19600
+ }
19601
+ /**
19602
+ * Request parameters for getProject operation in ProjectsApi.
19603
+ * @export
19604
+ * @interface ProjectsApiGetProjectRequest
19605
+ */
19606
+ interface ProjectsApiGetProjectRequest {
19686
19607
  /**
19687
- * Internal IMX ID of the asset this order buys
19608
+ * Project ID
19688
19609
  * @type {string}
19689
- * @memberof OrdersApiListOrdersV3
19610
+ * @memberof ProjectsApiGetProject
19690
19611
  */
19691
- readonly buyAssetId?: string;
19612
+ readonly id: string;
19692
19613
  /**
19693
- * Token address of the asset this order buys
19614
+ * String created by signing wallet address and timestamp
19694
19615
  * @type {string}
19695
- * @memberof OrdersApiListOrdersV3
19616
+ * @memberof ProjectsApiGetProject
19696
19617
  */
19697
- readonly buyTokenAddress?: string;
19618
+ readonly iMXSignature: string;
19698
19619
  /**
19699
- * Token name of the asset this order buys
19620
+ * Unix Epoc timestamp
19700
19621
  * @type {string}
19701
- * @memberof OrdersApiListOrdersV3
19622
+ * @memberof ProjectsApiGetProject
19702
19623
  */
19703
- readonly buyTokenName?: string;
19624
+ readonly iMXTimestamp: string;
19625
+ }
19626
+ /**
19627
+ * Request parameters for getProjectGroup operation in ProjectsApi.
19628
+ * @export
19629
+ * @interface ProjectsApiGetProjectGroupRequest
19630
+ */
19631
+ interface ProjectsApiGetProjectGroupRequest {
19704
19632
  /**
19705
- * Min quantity for the asset this order buys
19633
+ * Project group ID
19706
19634
  * @type {string}
19707
- * @memberof OrdersApiListOrdersV3
19635
+ * @memberof ProjectsApiGetProjectGroup
19708
19636
  */
19709
- readonly buyMinQuantity?: string;
19637
+ readonly id: string;
19638
+ }
19639
+ /**
19640
+ * Request parameters for getProjectGroups operation in ProjectsApi.
19641
+ * @export
19642
+ * @interface ProjectsApiGetProjectGroupsRequest
19643
+ */
19644
+ interface ProjectsApiGetProjectGroupsRequest {
19710
19645
  /**
19711
- * Max quantity for the asset this order buys
19712
- * @type {string}
19713
- * @memberof OrdersApiListOrdersV3
19646
+ * Page size of the result
19647
+ * @type {number}
19648
+ * @memberof ProjectsApiGetProjectGroups
19714
19649
  */
19715
- readonly buyMaxQuantity?: string;
19650
+ readonly pageSize?: number;
19716
19651
  /**
19717
- * JSON-encoded metadata filters for the asset this order buys
19652
+ * Cursor
19718
19653
  * @type {string}
19719
- * @memberof OrdersApiListOrdersV3
19654
+ * @memberof ProjectsApiGetProjectGroups
19720
19655
  */
19721
- readonly buyMetadata?: string;
19656
+ readonly cursor?: string;
19722
19657
  /**
19723
- * Token type of the asset this order sells
19658
+ * Property to sort by
19724
19659
  * @type {string}
19725
- * @memberof OrdersApiListOrdersV3
19660
+ * @memberof ProjectsApiGetProjectGroups
19726
19661
  */
19727
- readonly sellTokenType?: string;
19662
+ readonly orderBy?: string;
19728
19663
  /**
19729
- * ERC721 Token ID of the asset this order sells
19664
+ * Direction to sort (asc/desc)
19730
19665
  * @type {string}
19731
- * @memberof OrdersApiListOrdersV3
19666
+ * @memberof ProjectsApiGetProjectGroups
19732
19667
  */
19733
- readonly sellTokenId?: string;
19668
+ readonly direction?: string;
19669
+ }
19670
+ /**
19671
+ * Request parameters for getProjects operation in ProjectsApi.
19672
+ * @export
19673
+ * @interface ProjectsApiGetProjectsRequest
19674
+ */
19675
+ interface ProjectsApiGetProjectsRequest {
19734
19676
  /**
19735
- * Internal IMX ID of the asset this order sells
19677
+ * String created by signing wallet address and timestamp
19736
19678
  * @type {string}
19737
- * @memberof OrdersApiListOrdersV3
19679
+ * @memberof ProjectsApiGetProjects
19738
19680
  */
19739
- readonly sellAssetId?: string;
19681
+ readonly iMXSignature: string;
19740
19682
  /**
19741
- * Token address of the asset this order sells
19683
+ * Unix Epoc timestamp
19742
19684
  * @type {string}
19743
- * @memberof OrdersApiListOrdersV3
19685
+ * @memberof ProjectsApiGetProjects
19744
19686
  */
19745
- readonly sellTokenAddress?: string;
19687
+ readonly iMXTimestamp: string;
19746
19688
  /**
19747
- * Token name of the asset this order sells
19748
- * @type {string}
19749
- * @memberof OrdersApiListOrdersV3
19689
+ * Page size of the result
19690
+ * @type {number}
19691
+ * @memberof ProjectsApiGetProjects
19750
19692
  */
19751
- readonly sellTokenName?: string;
19693
+ readonly pageSize?: number;
19752
19694
  /**
19753
- * Min quantity for the asset this order sells
19695
+ * Cursor
19754
19696
  * @type {string}
19755
- * @memberof OrdersApiListOrdersV3
19697
+ * @memberof ProjectsApiGetProjects
19756
19698
  */
19757
- readonly sellMinQuantity?: string;
19699
+ readonly cursor?: string;
19758
19700
  /**
19759
- * Max quantity for the asset this order sells
19701
+ * Property to sort by
19760
19702
  * @type {string}
19761
- * @memberof OrdersApiListOrdersV3
19703
+ * @memberof ProjectsApiGetProjects
19762
19704
  */
19763
- readonly sellMaxQuantity?: string;
19705
+ readonly orderBy?: string;
19764
19706
  /**
19765
- * JSON-encoded metadata filters for the asset this order sells
19707
+ * Direction to sort (asc/desc)
19766
19708
  * @type {string}
19767
- * @memberof OrdersApiListOrdersV3
19709
+ * @memberof ProjectsApiGetProjects
19768
19710
  */
19769
- readonly sellMetadata?: string;
19711
+ readonly direction?: string;
19712
+ }
19713
+ /**
19714
+ * Request parameters for getSdkVersion operation in ProjectsApi.
19715
+ * @export
19716
+ * @interface ProjectsApiGetSdkVersionRequest
19717
+ */
19718
+ interface ProjectsApiGetSdkVersionRequest {
19770
19719
  /**
19771
- * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
19720
+ * Runtime Details
19772
19721
  * @type {string}
19773
- * @memberof OrdersApiListOrdersV3
19722
+ * @memberof ProjectsApiGetSdkVersion
19774
19723
  */
19775
- readonly auxiliaryFeePercentages?: string;
19724
+ readonly details: string;
19776
19725
  /**
19777
- * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
19726
+ * SDK Version
19778
19727
  * @type {string}
19779
- * @memberof OrdersApiListOrdersV3
19728
+ * @memberof ProjectsApiGetSdkVersion
19780
19729
  */
19781
- readonly auxiliaryFeeRecipients?: string;
19730
+ readonly version?: string;
19782
19731
  /**
19783
- * Set flag to true to include fee object for orders
19784
- * @type {boolean}
19785
- * @memberof OrdersApiListOrdersV3
19732
+ * Runtime ID
19733
+ * @type {string}
19734
+ * @memberof ProjectsApiGetSdkVersion
19786
19735
  */
19787
- readonly includeFees?: boolean;
19736
+ readonly id?: string;
19788
19737
  }
19789
19738
  /**
19790
- * OrdersApi - object-oriented interface
19739
+ * ProjectsApi - object-oriented interface
19791
19740
  * @export
19792
- * @class OrdersApi
19741
+ * @class ProjectsApi
19793
19742
  * @extends {BaseAPI}
19794
19743
  */
19795
- declare class OrdersApi extends BaseAPI {
19744
+ declare class ProjectsApi extends BaseAPI {
19796
19745
  /**
19797
- * Cancel an order. Use https://docs.x.immutable.com/reference#/operations/getSignableCancelOrder to get request body params. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/cancelOrderV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
19798
- * @summary Cancel an order
19799
- * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
19746
+ * Create a project
19747
+ * @summary Create a project
19748
+ * @param {ProjectsApiCreateProjectRequest} requestParameters Request parameters.
19800
19749
  * @param {*} [options] Override http request option.
19801
19750
  * @deprecated
19802
19751
  * @throws {RequiredError}
19803
- * @memberof OrdersApi
19752
+ * @memberof ProjectsApi
19804
19753
  */
19805
- cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
19754
+ createProject(requestParameters: ProjectsApiCreateProjectRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectResponse, any>>;
19806
19755
  /**
19807
- * Cancel an order (V3)
19808
- * @summary Cancel an order (V3)
19809
- * @param {OrdersApiCancelOrderV3Request} requestParameters Request parameters.
19756
+ * Create a project api key
19757
+ * @summary A new API key will be generated every time this endpoint is called.
19758
+ * @param {ProjectsApiCreateProjectAPIKeyRequest} requestParameters Request parameters.
19810
19759
  * @param {*} [options] Override http request option.
19811
19760
  * @throws {RequiredError}
19812
- * @memberof OrdersApi
19761
+ * @memberof ProjectsApi
19813
19762
  */
19814
- cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
19763
+ createProjectAPIKey(requestParameters: ProjectsApiCreateProjectAPIKeyRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectAPIKeyResponse, any>>;
19815
19764
  /**
19816
- * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createOrderV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
19817
- * @summary Create an order
19818
- * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
19765
+ * Create a project group
19766
+ * @summary Create a project group
19767
+ * @param {ProjectsApiCreateProjectGroupRequest} requestParameters Request parameters.
19819
19768
  * @param {*} [options] Override http request option.
19820
- * @deprecated
19821
19769
  * @throws {RequiredError}
19822
- * @memberof OrdersApi
19770
+ * @memberof ProjectsApi
19823
19771
  */
19824
- createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
19772
+ createProjectGroup(requestParameters: ProjectsApiCreateProjectGroupRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectResponse, any>>;
19825
19773
  /**
19826
- * Create an order using the v3 orderbook. Currently only buy NFT orders are supported.
19827
- * @summary Create an order (V3)
19828
- * @param {OrdersApiCreateOrderV3Request} requestParameters Request parameters.
19774
+ * Get a project
19775
+ * @summary Get a project
19776
+ * @param {ProjectsApiGetProjectRequest} requestParameters Request parameters.
19829
19777
  * @param {*} [options] Override http request option.
19830
19778
  * @throws {RequiredError}
19831
- * @memberof OrdersApi
19779
+ * @memberof ProjectsApi
19832
19780
  */
19833
- createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
19781
+ getProject(requestParameters: ProjectsApiGetProjectRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Project, any>>;
19834
19782
  /**
19835
- * Get an order. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/getOrderV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
19836
- * @summary Get an order
19837
- * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
19783
+ * Get a project group
19784
+ * @summary Get a project group
19785
+ * @param {ProjectsApiGetProjectGroupRequest} requestParameters Request parameters.
19838
19786
  * @param {*} [options] Override http request option.
19839
- * @deprecated
19840
19787
  * @throws {RequiredError}
19841
- * @memberof OrdersApi
19788
+ * @memberof ProjectsApi
19842
19789
  */
19843
- getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order, any>>;
19790
+ getProjectGroup(requestParameters: ProjectsApiGetProjectGroupRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Project, any>>;
19844
19791
  /**
19845
- * Get an order (V3)
19846
- * @summary Get an order (V3)
19847
- * @param {OrdersApiGetOrderV3Request} requestParameters Request parameters.
19792
+ * Get project groups
19793
+ * @summary Get project groups
19794
+ * @param {ProjectsApiGetProjectGroupsRequest} requestParameters Request parameters.
19848
19795
  * @param {*} [options] Override http request option.
19849
19796
  * @throws {RequiredError}
19850
- * @memberof OrdersApi
19797
+ * @memberof ProjectsApi
19798
+ */
19799
+ getProjectGroups(requestParameters?: ProjectsApiGetProjectGroupsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetProjectsResponse, any>>;
19800
+ /**
19801
+ * Get projects
19802
+ * @summary Get projects
19803
+ * @param {ProjectsApiGetProjectsRequest} requestParameters Request parameters.
19804
+ * @param {*} [options] Override http request option.
19805
+ * @throws {RequiredError}
19806
+ * @memberof ProjectsApi
19807
+ */
19808
+ getProjects(requestParameters: ProjectsApiGetProjectsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetProjectsResponse, any>>;
19809
+ /**
19810
+ * Checks the SDK Version of caller against the current SDK Version and returns a message.
19811
+ * @summary Checks the SDK Version of caller against the current SDK Version
19812
+ * @param {ProjectsApiGetSdkVersionRequest} requestParameters Request parameters.
19813
+ * @param {*} [options] Override http request option.
19814
+ * @throws {RequiredError}
19815
+ * @memberof ProjectsApi
19816
+ */
19817
+ getSdkVersion(requestParameters: ProjectsApiGetSdkVersionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ApiSDKVersionCheckResponse, any>>;
19818
+ }
19819
+
19820
+ /**
19821
+ * Request parameters for getToken operation in TokensApi.
19822
+ * @export
19823
+ * @interface TokensApiGetTokenRequest
19824
+ */
19825
+ interface TokensApiGetTokenRequest {
19826
+ /**
19827
+ * Token Contract Address
19828
+ * @type {string}
19829
+ * @memberof TokensApiGetToken
19830
+ */
19831
+ readonly address: string;
19832
+ }
19833
+ /**
19834
+ * Request parameters for listTokens operation in TokensApi.
19835
+ * @export
19836
+ * @interface TokensApiListTokensRequest
19837
+ */
19838
+ interface TokensApiListTokensRequest {
19839
+ /**
19840
+ * Page size of the result
19841
+ * @type {number}
19842
+ * @memberof TokensApiListTokens
19843
+ */
19844
+ readonly pageSize?: number;
19845
+ /**
19846
+ * Cursor
19847
+ * @type {string}
19848
+ * @memberof TokensApiListTokens
19851
19849
  */
19852
- getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
19850
+ readonly cursor?: string;
19853
19851
  /**
19854
- * Sign cancel order message. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/getSignableCancelOrderV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
19855
- * @summary Sign cancel order message
19856
- * @param {OrdersApiGetSignableCancelOrderRequest} requestParameters Request parameters.
19857
- * @param {*} [options] Override http request option.
19858
- * @deprecated
19859
- * @throws {RequiredError}
19860
- * @memberof OrdersApi
19852
+ * Property to sort by
19853
+ * @type {'contract_address' | 'name' | 'symbol'}
19854
+ * @memberof TokensApiListTokens
19861
19855
  */
19862
- getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
19856
+ readonly orderBy?: 'contract_address' | 'name' | 'symbol';
19863
19857
  /**
19864
- * Generate a signable cancel order message (V3)
19865
- * @summary Generate a signable cancel order message (V3)
19866
- * @param {OrdersApiGetSignableCancelOrderV3Request} requestParameters Request parameters.
19867
- * @param {*} [options] Override http request option.
19868
- * @throws {RequiredError}
19869
- * @memberof OrdersApi
19858
+ * Direction to sort (asc/desc)
19859
+ * @type {string}
19860
+ * @memberof TokensApiListTokens
19870
19861
  */
19871
- getSignableCancelOrderV3(requestParameters: OrdersApiGetSignableCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
19862
+ readonly direction?: string;
19872
19863
  /**
19873
- * Generate a signable order request (V3)
19874
- * @summary Generate a signable order request (V3)
19875
- * @param {OrdersApiGetSignableOrderRequest} requestParameters Request parameters.
19876
- * @param {*} [options] Override http request option.
19877
- * @throws {RequiredError}
19878
- * @memberof OrdersApi
19864
+ * Contract address of the token
19865
+ * @type {string}
19866
+ * @memberof TokensApiListTokens
19879
19867
  */
19880
- getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableOrderResponse, any>>;
19868
+ readonly address?: string;
19881
19869
  /**
19882
- * Get a list of orders This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/listOrdersV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
19883
- * @summary Get a list of orders.
19884
- * @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
19870
+ * Token symbols for the token, e.g. ?symbols&#x3D;IMX,ETH
19871
+ * @type {string}
19872
+ * @memberof TokensApiListTokens
19873
+ */
19874
+ readonly symbols?: string;
19875
+ }
19876
+ /**
19877
+ * TokensApi - object-oriented interface
19878
+ * @export
19879
+ * @class TokensApi
19880
+ * @extends {BaseAPI}
19881
+ */
19882
+ declare class TokensApi extends BaseAPI {
19883
+ /**
19884
+ * Get details of a token
19885
+ * @summary Get details of a token
19886
+ * @param {TokensApiGetTokenRequest} requestParameters Request parameters.
19885
19887
  * @param {*} [options] Override http request option.
19886
- * @deprecated
19887
19888
  * @throws {RequiredError}
19888
- * @memberof OrdersApi
19889
+ * @memberof TokensApi
19889
19890
  */
19890
- listOrders(requestParameters?: OrdersApiListOrdersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponse, any>>;
19891
+ getToken(requestParameters: TokensApiGetTokenRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<TokenDetails, any>>;
19891
19892
  /**
19892
- * Get a list of orders (V3)
19893
- * @summary Get a list of orders (V3)
19894
- * @param {OrdersApiListOrdersV3Request} requestParameters Request parameters.
19893
+ * Get a list of tokens
19894
+ * @summary Get a list of tokens
19895
+ * @param {TokensApiListTokensRequest} requestParameters Request parameters.
19895
19896
  * @param {*} [options] Override http request option.
19896
19897
  * @throws {RequiredError}
19897
- * @memberof OrdersApi
19898
+ * @memberof TokensApi
19898
19899
  */
19899
- listOrdersV3(requestParameters?: OrdersApiListOrdersV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponseV3, any>>;
19900
+ listTokens(requestParameters?: TokensApiListTokensRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTokensResponse, any>>;
19900
19901
  }
19901
19902
 
19902
19903
  /**
19903
- * Request parameters for createProject operation in ProjectsApi.
19904
+ * Request parameters for createTrade operation in TradesApi.
19904
19905
  * @export
19905
- * @interface ProjectsApiCreateProjectRequest
19906
+ * @interface TradesApiCreateTradeRequest
19906
19907
  */
19907
- interface ProjectsApiCreateProjectRequest {
19908
+ interface TradesApiCreateTradeRequest {
19908
19909
  /**
19909
- * String created by signing wallet address and timestamp
19910
+ * create a trade
19911
+ * @type {CreateTradeRequestV1}
19912
+ * @memberof TradesApiCreateTrade
19913
+ */
19914
+ readonly createTradeRequest: CreateTradeRequestV1;
19915
+ /**
19916
+ * eth address
19910
19917
  * @type {string}
19911
- * @memberof ProjectsApiCreateProject
19918
+ * @memberof TradesApiCreateTrade
19912
19919
  */
19913
- readonly iMXSignature: string;
19920
+ readonly xImxEthAddress?: string;
19914
19921
  /**
19915
- * Unix Epoc timestamp
19922
+ * eth signature
19916
19923
  * @type {string}
19917
- * @memberof ProjectsApiCreateProject
19924
+ * @memberof TradesApiCreateTrade
19918
19925
  */
19919
- readonly iMXTimestamp: string;
19926
+ readonly xImxEthSignature?: string;
19920
19927
  /**
19921
- * create a project
19922
- * @type {CreateProjectRequest}
19923
- * @memberof ProjectsApiCreateProject
19928
+ * Authorization header
19929
+ * @type {string}
19930
+ * @memberof TradesApiCreateTrade
19924
19931
  */
19925
- readonly createProjectRequest: CreateProjectRequest;
19932
+ readonly authorization?: string;
19926
19933
  }
19927
19934
  /**
19928
- * Request parameters for createProjectAPIKey operation in ProjectsApi.
19935
+ * Request parameters for createTradeV3 operation in TradesApi.
19929
19936
  * @export
19930
- * @interface ProjectsApiCreateProjectAPIKeyRequest
19937
+ * @interface TradesApiCreateTradeV3Request
19931
19938
  */
19932
- interface ProjectsApiCreateProjectAPIKeyRequest {
19939
+ interface TradesApiCreateTradeV3Request {
19933
19940
  /**
19934
- * Project ID
19941
+ * create a trade
19942
+ * @type {TradesCreateTradeRequest}
19943
+ * @memberof TradesApiCreateTradeV3
19944
+ */
19945
+ readonly createTradeRequest: TradesCreateTradeRequest;
19946
+ /**
19947
+ * eth address
19935
19948
  * @type {string}
19936
- * @memberof ProjectsApiCreateProjectAPIKey
19949
+ * @memberof TradesApiCreateTradeV3
19937
19950
  */
19938
- readonly id: string;
19951
+ readonly xImxEthAddress?: string;
19952
+ /**
19953
+ * eth signature
19954
+ * @type {string}
19955
+ * @memberof TradesApiCreateTradeV3
19956
+ */
19957
+ readonly xImxEthSignature?: string;
19958
+ /**
19959
+ * Authorization header
19960
+ * @type {string}
19961
+ * @memberof TradesApiCreateTradeV3
19962
+ */
19963
+ readonly authorization?: string;
19939
19964
  }
19940
19965
  /**
19941
- * Request parameters for createProjectGroup operation in ProjectsApi.
19966
+ * Request parameters for getSignableTrade operation in TradesApi.
19942
19967
  * @export
19943
- * @interface ProjectsApiCreateProjectGroupRequest
19968
+ * @interface TradesApiGetSignableTradeRequest
19944
19969
  */
19945
- interface ProjectsApiCreateProjectGroupRequest {
19970
+ interface TradesApiGetSignableTradeRequest {
19946
19971
  /**
19947
- * create a project group
19948
- * @type {CreateProjectGroupRequest}
19949
- * @memberof ProjectsApiCreateProjectGroup
19972
+ * get a signable trade
19973
+ * @type {GetSignableTradeRequest}
19974
+ * @memberof TradesApiGetSignableTrade
19950
19975
  */
19951
- readonly createProjectGroupRequest: CreateProjectGroupRequest;
19976
+ readonly getSignableTradeRequest: GetSignableTradeRequest;
19952
19977
  }
19953
19978
  /**
19954
- * Request parameters for getProject operation in ProjectsApi.
19979
+ * Request parameters for getTrade operation in TradesApi.
19955
19980
  * @export
19956
- * @interface ProjectsApiGetProjectRequest
19981
+ * @interface TradesApiGetTradeRequest
19957
19982
  */
19958
- interface ProjectsApiGetProjectRequest {
19983
+ interface TradesApiGetTradeRequest {
19959
19984
  /**
19960
- * Project ID
19985
+ * Trade ID
19961
19986
  * @type {string}
19962
- * @memberof ProjectsApiGetProject
19987
+ * @memberof TradesApiGetTrade
19963
19988
  */
19964
19989
  readonly id: string;
19965
- /**
19966
- * String created by signing wallet address and timestamp
19967
- * @type {string}
19968
- * @memberof ProjectsApiGetProject
19969
- */
19970
- readonly iMXSignature: string;
19971
- /**
19972
- * Unix Epoc timestamp
19973
- * @type {string}
19974
- * @memberof ProjectsApiGetProject
19975
- */
19976
- readonly iMXTimestamp: string;
19977
19990
  }
19978
19991
  /**
19979
- * Request parameters for getProjectGroup operation in ProjectsApi.
19992
+ * Request parameters for getTradeV3 operation in TradesApi.
19980
19993
  * @export
19981
- * @interface ProjectsApiGetProjectGroupRequest
19994
+ * @interface TradesApiGetTradeV3Request
19982
19995
  */
19983
- interface ProjectsApiGetProjectGroupRequest {
19996
+ interface TradesApiGetTradeV3Request {
19984
19997
  /**
19985
- * Project group ID
19998
+ * Trade ID
19986
19999
  * @type {string}
19987
- * @memberof ProjectsApiGetProjectGroup
20000
+ * @memberof TradesApiGetTradeV3
19988
20001
  */
19989
20002
  readonly id: string;
19990
20003
  }
19991
20004
  /**
19992
- * Request parameters for getProjectGroups operation in ProjectsApi.
20005
+ * Request parameters for listTrades operation in TradesApi.
19993
20006
  * @export
19994
- * @interface ProjectsApiGetProjectGroupsRequest
20007
+ * @interface TradesApiListTradesRequest
19995
20008
  */
19996
- interface ProjectsApiGetProjectGroupsRequest {
20009
+ interface TradesApiListTradesRequest {
20010
+ /**
20011
+ * Party A\&#39;s (buy order) token type of currency used to buy
20012
+ * @type {string}
20013
+ * @memberof TradesApiListTrades
20014
+ */
20015
+ readonly partyATokenType?: string;
20016
+ /**
20017
+ * Party A\&#39;s (buy order) token address of currency used to buy
20018
+ * @type {string}
20019
+ * @memberof TradesApiListTrades
20020
+ */
20021
+ readonly partyATokenAddress?: string;
20022
+ /**
20023
+ * Party B\&#39;s (sell order) token type of NFT sold - always ERC721
20024
+ * @type {string}
20025
+ * @memberof TradesApiListTrades
20026
+ */
20027
+ readonly partyBTokenType?: string;
20028
+ /**
20029
+ * Party B\&#39;s (sell order) collection address of NFT sold
20030
+ * @type {string}
20031
+ * @memberof TradesApiListTrades
20032
+ */
20033
+ readonly partyBTokenAddress?: string;
20034
+ /**
20035
+ * Party B\&#39;s (sell order) token id of NFT sold
20036
+ * @type {string}
20037
+ * @memberof TradesApiListTrades
20038
+ */
20039
+ readonly partyBTokenId?: string;
19997
20040
  /**
19998
20041
  * Page size of the result
19999
20042
  * @type {number}
20000
- * @memberof ProjectsApiGetProjectGroups
20043
+ * @memberof TradesApiListTrades
20001
20044
  */
20002
20045
  readonly pageSize?: number;
20003
20046
  /**
20004
20047
  * Cursor
20005
20048
  * @type {string}
20006
- * @memberof ProjectsApiGetProjectGroups
20049
+ * @memberof TradesApiListTrades
20050
+ */
20051
+ readonly cursor?: string;
20052
+ /**
20053
+ * Property to sort by
20054
+ * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
20055
+ * @memberof TradesApiListTrades
20056
+ */
20057
+ readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
20058
+ /**
20059
+ * Direction to sort (asc/desc)
20060
+ * @type {string}
20061
+ * @memberof TradesApiListTrades
20062
+ */
20063
+ readonly direction?: string;
20064
+ /**
20065
+ * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20066
+ * @type {string}
20067
+ * @memberof TradesApiListTrades
20068
+ */
20069
+ readonly minTimestamp?: string;
20070
+ /**
20071
+ * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20072
+ * @type {string}
20073
+ * @memberof TradesApiListTrades
20074
+ */
20075
+ readonly maxTimestamp?: string;
20076
+ }
20077
+ /**
20078
+ * Request parameters for listTradesV3 operation in TradesApi.
20079
+ * @export
20080
+ * @interface TradesApiListTradesV3Request
20081
+ */
20082
+ interface TradesApiListTradesV3Request {
20083
+ /**
20084
+ * Party A\&#39;s (buy order) token type of currency used to buy
20085
+ * @type {string}
20086
+ * @memberof TradesApiListTradesV3
20007
20087
  */
20008
- readonly cursor?: string;
20088
+ readonly partyATokenType?: string;
20009
20089
  /**
20010
- * Property to sort by
20090
+ * Party A\&#39;s (buy order) token address of currency used to buy
20011
20091
  * @type {string}
20012
- * @memberof ProjectsApiGetProjectGroups
20092
+ * @memberof TradesApiListTradesV3
20013
20093
  */
20014
- readonly orderBy?: string;
20094
+ readonly partyATokenAddress?: string;
20015
20095
  /**
20016
- * Direction to sort (asc/desc)
20096
+ * Party B\&#39;s (sell order) token type of NFT sold - always ERC721
20017
20097
  * @type {string}
20018
- * @memberof ProjectsApiGetProjectGroups
20098
+ * @memberof TradesApiListTradesV3
20019
20099
  */
20020
- readonly direction?: string;
20021
- }
20022
- /**
20023
- * Request parameters for getProjects operation in ProjectsApi.
20024
- * @export
20025
- * @interface ProjectsApiGetProjectsRequest
20026
- */
20027
- interface ProjectsApiGetProjectsRequest {
20100
+ readonly partyBTokenType?: string;
20028
20101
  /**
20029
- * String created by signing wallet address and timestamp
20102
+ * Party B\&#39;s (sell order) collection address of NFT sold
20030
20103
  * @type {string}
20031
- * @memberof ProjectsApiGetProjects
20104
+ * @memberof TradesApiListTradesV3
20032
20105
  */
20033
- readonly iMXSignature: string;
20106
+ readonly partyBTokenAddress?: string;
20034
20107
  /**
20035
- * Unix Epoc timestamp
20108
+ * Party B\&#39;s (sell order) token id of NFT sold
20036
20109
  * @type {string}
20037
- * @memberof ProjectsApiGetProjects
20110
+ * @memberof TradesApiListTradesV3
20038
20111
  */
20039
- readonly iMXTimestamp: string;
20112
+ readonly partyBTokenId?: string;
20040
20113
  /**
20041
20114
  * Page size of the result
20042
20115
  * @type {number}
20043
- * @memberof ProjectsApiGetProjects
20116
+ * @memberof TradesApiListTradesV3
20044
20117
  */
20045
20118
  readonly pageSize?: number;
20046
20119
  /**
20047
20120
  * Cursor
20048
20121
  * @type {string}
20049
- * @memberof ProjectsApiGetProjects
20122
+ * @memberof TradesApiListTradesV3
20050
20123
  */
20051
20124
  readonly cursor?: string;
20052
20125
  /**
20053
20126
  * Property to sort by
20054
- * @type {string}
20055
- * @memberof ProjectsApiGetProjects
20127
+ * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp'}
20128
+ * @memberof TradesApiListTradesV3
20056
20129
  */
20057
- readonly orderBy?: string;
20130
+ readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp';
20058
20131
  /**
20059
20132
  * Direction to sort (asc/desc)
20060
20133
  * @type {string}
20061
- * @memberof ProjectsApiGetProjects
20134
+ * @memberof TradesApiListTradesV3
20062
20135
  */
20063
20136
  readonly direction?: string;
20064
- }
20065
- /**
20066
- * Request parameters for getSdkVersion operation in ProjectsApi.
20067
- * @export
20068
- * @interface ProjectsApiGetSdkVersionRequest
20069
- */
20070
- interface ProjectsApiGetSdkVersionRequest {
20071
- /**
20072
- * Runtime Details
20073
- * @type {string}
20074
- * @memberof ProjectsApiGetSdkVersion
20075
- */
20076
- readonly details: string;
20077
20137
  /**
20078
- * SDK Version
20138
+ * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20079
20139
  * @type {string}
20080
- * @memberof ProjectsApiGetSdkVersion
20140
+ * @memberof TradesApiListTradesV3
20081
20141
  */
20082
- readonly version?: string;
20142
+ readonly minTimestamp?: string;
20083
20143
  /**
20084
- * Runtime ID
20144
+ * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20085
20145
  * @type {string}
20086
- * @memberof ProjectsApiGetSdkVersion
20146
+ * @memberof TradesApiListTradesV3
20087
20147
  */
20088
- readonly id?: string;
20148
+ readonly maxTimestamp?: string;
20089
20149
  }
20090
20150
  /**
20091
- * ProjectsApi - object-oriented interface
20151
+ * TradesApi - object-oriented interface
20092
20152
  * @export
20093
- * @class ProjectsApi
20153
+ * @class TradesApi
20094
20154
  * @extends {BaseAPI}
20095
20155
  */
20096
- declare class ProjectsApi extends BaseAPI {
20156
+ declare class TradesApi extends BaseAPI {
20097
20157
  /**
20098
- * Create a project
20099
- * @summary Create a project
20100
- * @param {ProjectsApiCreateProjectRequest} requestParameters Request parameters.
20158
+ * Create a trade. Use https://docs.x.immutable.com/reference#/operations/getSignableTrade to get request body params. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createTradeV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
20159
+ * @summary Create a Trade between two parties
20160
+ * @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
20101
20161
  * @param {*} [options] Override http request option.
20102
20162
  * @deprecated
20103
20163
  * @throws {RequiredError}
20104
- * @memberof ProjectsApi
20105
- */
20106
- createProject(requestParameters: ProjectsApiCreateProjectRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectResponse, any>>;
20107
- /**
20108
- * Create a project api key
20109
- * @summary A new API key will be generated every time this endpoint is called.
20110
- * @param {ProjectsApiCreateProjectAPIKeyRequest} requestParameters Request parameters.
20111
- * @param {*} [options] Override http request option.
20112
- * @throws {RequiredError}
20113
- * @memberof ProjectsApi
20114
- */
20115
- createProjectAPIKey(requestParameters: ProjectsApiCreateProjectAPIKeyRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectAPIKeyResponse, any>>;
20116
- /**
20117
- * Create a project group
20118
- * @summary Create a project group
20119
- * @param {ProjectsApiCreateProjectGroupRequest} requestParameters Request parameters.
20120
- * @param {*} [options] Override http request option.
20121
- * @throws {RequiredError}
20122
- * @memberof ProjectsApi
20123
- */
20124
- createProjectGroup(requestParameters: ProjectsApiCreateProjectGroupRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectResponse, any>>;
20125
- /**
20126
- * Get a project
20127
- * @summary Get a project
20128
- * @param {ProjectsApiGetProjectRequest} requestParameters Request parameters.
20129
- * @param {*} [options] Override http request option.
20130
- * @throws {RequiredError}
20131
- * @memberof ProjectsApi
20164
+ * @memberof TradesApi
20132
20165
  */
20133
- getProject(requestParameters: ProjectsApiGetProjectRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Project, any>>;
20166
+ createTrade(requestParameters: TradesApiCreateTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
20134
20167
  /**
20135
- * Get a project group
20136
- * @summary Get a project group
20137
- * @param {ProjectsApiGetProjectGroupRequest} requestParameters Request parameters.
20168
+ * Create a Trade. Currently only buy order is supported.
20169
+ * @summary Create a Trade (V3)
20170
+ * @param {TradesApiCreateTradeV3Request} requestParameters Request parameters.
20138
20171
  * @param {*} [options] Override http request option.
20139
20172
  * @throws {RequiredError}
20140
- * @memberof ProjectsApi
20173
+ * @memberof TradesApi
20141
20174
  */
20142
- getProjectGroup(requestParameters: ProjectsApiGetProjectGroupRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Project, any>>;
20175
+ createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
20143
20176
  /**
20144
- * Get project groups
20145
- * @summary Get project groups
20146
- * @param {ProjectsApiGetProjectGroupsRequest} requestParameters Request parameters.
20177
+ * Generate a signable trade message (V3)
20178
+ * @summary Generate a signable trade message (V3)
20179
+ * @param {TradesApiGetSignableTradeRequest} requestParameters Request parameters.
20147
20180
  * @param {*} [options] Override http request option.
20148
20181
  * @throws {RequiredError}
20149
- * @memberof ProjectsApi
20182
+ * @memberof TradesApi
20150
20183
  */
20151
- getProjectGroups(requestParameters?: ProjectsApiGetProjectGroupsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetProjectsResponse, any>>;
20184
+ getSignableTrade(requestParameters: TradesApiGetSignableTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTradeResponse, any>>;
20152
20185
  /**
20153
- * Get projects
20154
- * @summary Get projects
20155
- * @param {ProjectsApiGetProjectsRequest} requestParameters Request parameters.
20186
+ * Get details of a trade with the given ID
20187
+ * @summary Get details of a trade with the given ID
20188
+ * @param {TradesApiGetTradeRequest} requestParameters Request parameters.
20156
20189
  * @param {*} [options] Override http request option.
20190
+ * @deprecated
20157
20191
  * @throws {RequiredError}
20158
- * @memberof ProjectsApi
20192
+ * @memberof TradesApi
20159
20193
  */
20160
- getProjects(requestParameters: ProjectsApiGetProjectsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetProjectsResponse, any>>;
20194
+ getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
20161
20195
  /**
20162
- * Checks the SDK Version of caller against the current SDK Version and returns a message.
20163
- * @summary Checks the SDK Version of caller against the current SDK Version
20164
- * @param {ProjectsApiGetSdkVersionRequest} requestParameters Request parameters.
20196
+ * Get details of a trade with the given ID
20197
+ * @summary Get details of a trade with the given ID
20198
+ * @param {TradesApiGetTradeV3Request} requestParameters Request parameters.
20165
20199
  * @param {*} [options] Override http request option.
20166
20200
  * @throws {RequiredError}
20167
- * @memberof ProjectsApi
20168
- */
20169
- getSdkVersion(requestParameters: ProjectsApiGetSdkVersionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ApiSDKVersionCheckResponse, any>>;
20170
- }
20171
-
20172
- /**
20173
- * Request parameters for getToken operation in TokensApi.
20174
- * @export
20175
- * @interface TokensApiGetTokenRequest
20176
- */
20177
- interface TokensApiGetTokenRequest {
20178
- /**
20179
- * Token Contract Address
20180
- * @type {string}
20181
- * @memberof TokensApiGetToken
20182
- */
20183
- readonly address: string;
20184
- }
20185
- /**
20186
- * Request parameters for listTokens operation in TokensApi.
20187
- * @export
20188
- * @interface TokensApiListTokensRequest
20189
- */
20190
- interface TokensApiListTokensRequest {
20191
- /**
20192
- * Page size of the result
20193
- * @type {number}
20194
- * @memberof TokensApiListTokens
20195
- */
20196
- readonly pageSize?: number;
20197
- /**
20198
- * Cursor
20199
- * @type {string}
20200
- * @memberof TokensApiListTokens
20201
- */
20202
- readonly cursor?: string;
20203
- /**
20204
- * Property to sort by
20205
- * @type {'contract_address' | 'name' | 'symbol'}
20206
- * @memberof TokensApiListTokens
20207
- */
20208
- readonly orderBy?: 'contract_address' | 'name' | 'symbol';
20209
- /**
20210
- * Direction to sort (asc/desc)
20211
- * @type {string}
20212
- * @memberof TokensApiListTokens
20213
- */
20214
- readonly direction?: string;
20215
- /**
20216
- * Contract address of the token
20217
- * @type {string}
20218
- * @memberof TokensApiListTokens
20219
- */
20220
- readonly address?: string;
20221
- /**
20222
- * Token symbols for the token, e.g. ?symbols&#x3D;IMX,ETH
20223
- * @type {string}
20224
- * @memberof TokensApiListTokens
20201
+ * @memberof TradesApi
20225
20202
  */
20226
- readonly symbols?: string;
20227
- }
20228
- /**
20229
- * TokensApi - object-oriented interface
20230
- * @export
20231
- * @class TokensApi
20232
- * @extends {BaseAPI}
20233
- */
20234
- declare class TokensApi extends BaseAPI {
20203
+ getTradeV3(requestParameters: TradesApiGetTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
20235
20204
  /**
20236
- * Get details of a token
20237
- * @summary Get details of a token
20238
- * @param {TokensApiGetTokenRequest} requestParameters Request parameters.
20205
+ * Get a list of trades. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/listTradesV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
20206
+ * @summary Get a list of trades
20207
+ * @param {TradesApiListTradesRequest} requestParameters Request parameters.
20239
20208
  * @param {*} [options] Override http request option.
20209
+ * @deprecated
20240
20210
  * @throws {RequiredError}
20241
- * @memberof TokensApi
20211
+ * @memberof TradesApi
20242
20212
  */
20243
- getToken(requestParameters: TokensApiGetTokenRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<TokenDetails, any>>;
20213
+ listTrades(requestParameters?: TradesApiListTradesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
20244
20214
  /**
20245
- * Get a list of tokens
20246
- * @summary Get a list of tokens
20247
- * @param {TokensApiListTokensRequest} requestParameters Request parameters.
20215
+ * Get a list of trades (V3)
20216
+ * @summary Get a list of trades (V3)
20217
+ * @param {TradesApiListTradesV3Request} requestParameters Request parameters.
20248
20218
  * @param {*} [options] Override http request option.
20249
20219
  * @throws {RequiredError}
20250
- * @memberof TokensApi
20220
+ * @memberof TradesApi
20251
20221
  */
20252
- listTokens(requestParameters?: TokensApiListTokensRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTokensResponse, any>>;
20222
+ listTradesV3(requestParameters?: TradesApiListTradesV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
20253
20223
  }
20254
20224
 
20255
20225
  /**
20256
- * Request parameters for createTrade operation in TradesApi.
20226
+ * Request parameters for createTransfer operation in TransfersApi.
20257
20227
  * @export
20258
- * @interface TradesApiCreateTradeRequest
20228
+ * @interface TransfersApiCreateTransferRequest
20259
20229
  */
20260
- interface TradesApiCreateTradeRequest {
20230
+ interface TransfersApiCreateTransferRequest {
20261
20231
  /**
20262
- * create a trade
20263
- * @type {CreateTradeRequestV1}
20264
- * @memberof TradesApiCreateTrade
20232
+ * Create transfer
20233
+ * @type {CreateTransferRequest}
20234
+ * @memberof TransfersApiCreateTransfer
20265
20235
  */
20266
- readonly createTradeRequest: CreateTradeRequestV1;
20236
+ readonly createTransferRequestV2: CreateTransferRequest;
20267
20237
  /**
20268
20238
  * eth address
20269
20239
  * @type {string}
20270
- * @memberof TradesApiCreateTrade
20240
+ * @memberof TransfersApiCreateTransfer
20271
20241
  */
20272
20242
  readonly xImxEthAddress?: string;
20273
20243
  /**
20274
20244
  * eth signature
20275
20245
  * @type {string}
20276
- * @memberof TradesApiCreateTrade
20246
+ * @memberof TransfersApiCreateTransfer
20277
20247
  */
20278
20248
  readonly xImxEthSignature?: string;
20279
20249
  /**
20280
20250
  * Authorization header
20281
20251
  * @type {string}
20282
- * @memberof TradesApiCreateTrade
20252
+ * @memberof TransfersApiCreateTransfer
20283
20253
  */
20284
20254
  readonly authorization?: string;
20285
20255
  }
20286
20256
  /**
20287
- * Request parameters for createTradeV3 operation in TradesApi.
20257
+ * Request parameters for createTransferV1 operation in TransfersApi.
20288
20258
  * @export
20289
- * @interface TradesApiCreateTradeV3Request
20259
+ * @interface TransfersApiCreateTransferV1Request
20290
20260
  */
20291
- interface TradesApiCreateTradeV3Request {
20261
+ interface TransfersApiCreateTransferV1Request {
20292
20262
  /**
20293
- * create a trade
20294
- * @type {TradesCreateTradeRequest}
20295
- * @memberof TradesApiCreateTradeV3
20263
+ * Create transfer
20264
+ * @type {CreateTransferRequestV1}
20265
+ * @memberof TransfersApiCreateTransferV1
20296
20266
  */
20297
- readonly createTradeRequest: TradesCreateTradeRequest;
20267
+ readonly createTransferRequest: CreateTransferRequestV1;
20298
20268
  /**
20299
20269
  * eth address
20300
20270
  * @type {string}
20301
- * @memberof TradesApiCreateTradeV3
20271
+ * @memberof TransfersApiCreateTransferV1
20302
20272
  */
20303
20273
  readonly xImxEthAddress?: string;
20304
20274
  /**
20305
20275
  * eth signature
20306
20276
  * @type {string}
20307
- * @memberof TradesApiCreateTradeV3
20277
+ * @memberof TransfersApiCreateTransferV1
20308
20278
  */
20309
20279
  readonly xImxEthSignature?: string;
20310
20280
  /**
20311
20281
  * Authorization header
20312
20282
  * @type {string}
20313
- * @memberof TradesApiCreateTradeV3
20283
+ * @memberof TransfersApiCreateTransferV1
20314
20284
  */
20315
20285
  readonly authorization?: string;
20316
20286
  }
20317
20287
  /**
20318
- * Request parameters for getSignableTrade operation in TradesApi.
20288
+ * Request parameters for getSignableTransfer operation in TransfersApi.
20319
20289
  * @export
20320
- * @interface TradesApiGetSignableTradeRequest
20290
+ * @interface TransfersApiGetSignableTransferRequest
20321
20291
  */
20322
- interface TradesApiGetSignableTradeRequest {
20292
+ interface TransfersApiGetSignableTransferRequest {
20323
20293
  /**
20324
- * get a signable trade
20325
- * @type {GetSignableTradeRequest}
20326
- * @memberof TradesApiGetSignableTrade
20294
+ * get details of signable transfer
20295
+ * @type {GetSignableTransferRequestV2}
20296
+ * @memberof TransfersApiGetSignableTransfer
20327
20297
  */
20328
- readonly getSignableTradeRequest: GetSignableTradeRequest;
20298
+ readonly getSignableTransferRequestV2: GetSignableTransferRequestV2;
20329
20299
  }
20330
20300
  /**
20331
- * Request parameters for getTrade operation in TradesApi.
20301
+ * Request parameters for getSignableTransferV1 operation in TransfersApi.
20332
20302
  * @export
20333
- * @interface TradesApiGetTradeRequest
20303
+ * @interface TransfersApiGetSignableTransferV1Request
20334
20304
  */
20335
- interface TradesApiGetTradeRequest {
20305
+ interface TransfersApiGetSignableTransferV1Request {
20336
20306
  /**
20337
- * Trade ID
20338
- * @type {string}
20339
- * @memberof TradesApiGetTrade
20307
+ * get details of signable transfer
20308
+ * @type {GetSignableTransferRequest}
20309
+ * @memberof TransfersApiGetSignableTransferV1
20340
20310
  */
20341
- readonly id: string;
20311
+ readonly getSignableTransferRequest: GetSignableTransferRequest;
20342
20312
  }
20343
20313
  /**
20344
- * Request parameters for getTradeV3 operation in TradesApi.
20314
+ * Request parameters for getTransfer operation in TransfersApi.
20345
20315
  * @export
20346
- * @interface TradesApiGetTradeV3Request
20316
+ * @interface TransfersApiGetTransferRequest
20347
20317
  */
20348
- interface TradesApiGetTradeV3Request {
20318
+ interface TransfersApiGetTransferRequest {
20349
20319
  /**
20350
- * Trade ID
20320
+ * Transfer ID
20351
20321
  * @type {string}
20352
- * @memberof TradesApiGetTradeV3
20322
+ * @memberof TransfersApiGetTransfer
20353
20323
  */
20354
20324
  readonly id: string;
20355
20325
  }
20356
20326
  /**
20357
- * Request parameters for listTrades operation in TradesApi.
20327
+ * Request parameters for listTransfers operation in TransfersApi.
20358
20328
  * @export
20359
- * @interface TradesApiListTradesRequest
20329
+ * @interface TransfersApiListTransfersRequest
20360
20330
  */
20361
- interface TradesApiListTradesRequest {
20331
+ interface TransfersApiListTransfersRequest {
20362
20332
  /**
20363
- * Party A\&#39;s (buy order) token type of currency used to buy
20333
+ * Page size of the result
20334
+ * @type {number}
20335
+ * @memberof TransfersApiListTransfers
20336
+ */
20337
+ readonly pageSize?: number;
20338
+ /**
20339
+ * Cursor
20364
20340
  * @type {string}
20365
- * @memberof TradesApiListTrades
20341
+ * @memberof TransfersApiListTransfers
20366
20342
  */
20367
- readonly partyATokenType?: string;
20343
+ readonly cursor?: string;
20368
20344
  /**
20369
- * Party A\&#39;s (buy order) token address of currency used to buy
20345
+ * Property to sort by
20346
+ * @type {'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key'}
20347
+ * @memberof TransfersApiListTransfers
20348
+ */
20349
+ readonly orderBy?: 'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key';
20350
+ /**
20351
+ * Direction to sort (asc/desc)
20370
20352
  * @type {string}
20371
- * @memberof TradesApiListTrades
20353
+ * @memberof TransfersApiListTransfers
20372
20354
  */
20373
- readonly partyATokenAddress?: string;
20355
+ readonly direction?: string;
20374
20356
  /**
20375
- * Party B\&#39;s (sell order) token type of NFT sold - always ERC721
20357
+ * Ethereum address of the user who submitted this transfer
20376
20358
  * @type {string}
20377
- * @memberof TradesApiListTrades
20359
+ * @memberof TransfersApiListTransfers
20378
20360
  */
20379
- readonly partyBTokenType?: string;
20361
+ readonly user?: string;
20380
20362
  /**
20381
- * Party B\&#39;s (sell order) collection address of NFT sold
20363
+ * Ethereum address of the user who received this transfer
20382
20364
  * @type {string}
20383
- * @memberof TradesApiListTrades
20365
+ * @memberof TransfersApiListTransfers
20384
20366
  */
20385
- readonly partyBTokenAddress?: string;
20367
+ readonly receiver?: string;
20386
20368
  /**
20387
- * Party B\&#39;s (sell order) token id of NFT sold
20369
+ * Status of this transfer
20370
+ * @type {'success' | 'failure'}
20371
+ * @memberof TransfersApiListTransfers
20372
+ */
20373
+ readonly status?: 'success' | 'failure';
20374
+ /**
20375
+ * Minimum timestamp for this transfer, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20388
20376
  * @type {string}
20389
- * @memberof TradesApiListTrades
20377
+ * @memberof TransfersApiListTransfers
20390
20378
  */
20391
- readonly partyBTokenId?: string;
20379
+ readonly minTimestamp?: string;
20392
20380
  /**
20393
- * Page size of the result
20394
- * @type {number}
20395
- * @memberof TradesApiListTrades
20381
+ * Maximum timestamp for this transfer, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20382
+ * @type {string}
20383
+ * @memberof TransfersApiListTransfers
20396
20384
  */
20397
- readonly pageSize?: number;
20385
+ readonly maxTimestamp?: string;
20398
20386
  /**
20399
- * Cursor
20387
+ * Token type of the transferred asset
20400
20388
  * @type {string}
20401
- * @memberof TradesApiListTrades
20389
+ * @memberof TransfersApiListTransfers
20402
20390
  */
20403
- readonly cursor?: string;
20391
+ readonly tokenType?: string;
20404
20392
  /**
20405
- * Property to sort by
20406
- * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
20407
- * @memberof TradesApiListTrades
20393
+ * ERC721 Token ID of the minted asset
20394
+ * @type {string}
20395
+ * @memberof TransfersApiListTransfers
20408
20396
  */
20409
- readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
20397
+ readonly tokenId?: string;
20410
20398
  /**
20411
- * Direction to sort (asc/desc)
20399
+ * Internal IMX ID of the minted asset
20412
20400
  * @type {string}
20413
- * @memberof TradesApiListTrades
20401
+ * @memberof TransfersApiListTransfers
20414
20402
  */
20415
- readonly direction?: string;
20403
+ readonly assetId?: string;
20416
20404
  /**
20417
- * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20405
+ * Token address of the transferred asset
20418
20406
  * @type {string}
20419
- * @memberof TradesApiListTrades
20407
+ * @memberof TransfersApiListTransfers
20420
20408
  */
20421
- readonly minTimestamp?: string;
20409
+ readonly tokenAddress?: string;
20422
20410
  /**
20423
- * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20411
+ * Token name of the transferred asset
20424
20412
  * @type {string}
20425
- * @memberof TradesApiListTrades
20413
+ * @memberof TransfersApiListTransfers
20414
+ */
20415
+ readonly tokenName?: string;
20416
+ /**
20417
+ * Max quantity for the transferred asset
20418
+ * @type {string}
20419
+ * @memberof TransfersApiListTransfers
20420
+ */
20421
+ readonly minQuantity?: string;
20422
+ /**
20423
+ * Max quantity for the transferred asset
20424
+ * @type {string}
20425
+ * @memberof TransfersApiListTransfers
20426
+ */
20427
+ readonly maxQuantity?: string;
20428
+ /**
20429
+ * JSON-encoded metadata filters for the transferred asset
20430
+ * @type {string}
20431
+ * @memberof TransfersApiListTransfers
20432
+ */
20433
+ readonly metadata?: string;
20434
+ }
20435
+ /**
20436
+ * TransfersApi - object-oriented interface
20437
+ * @export
20438
+ * @class TransfersApi
20439
+ * @extends {BaseAPI}
20440
+ */
20441
+ declare class TransfersApi extends BaseAPI {
20442
+ /**
20443
+ * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransfer to get request body params.
20444
+ * @summary Creates a transfer of multiple tokens between two parties
20445
+ * @param {TransfersApiCreateTransferRequest} requestParameters Request parameters.
20446
+ * @param {*} [options] Override http request option.
20447
+ * @throws {RequiredError}
20448
+ * @memberof TransfersApi
20449
+ */
20450
+ createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
20451
+ /**
20452
+ * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
20453
+ * @summary Creates a transfer of tokens between two parties
20454
+ * @param {TransfersApiCreateTransferV1Request} requestParameters Request parameters.
20455
+ * @param {*} [options] Override http request option.
20456
+ * @throws {RequiredError}
20457
+ * @memberof TransfersApi
20458
+ */
20459
+ createTransferV1(requestParameters: TransfersApiCreateTransferV1Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
20460
+ /**
20461
+ * Gets bulk details of a signable transfer
20462
+ * @summary Gets bulk details of a signable transfer
20463
+ * @param {TransfersApiGetSignableTransferRequest} requestParameters Request parameters.
20464
+ * @param {*} [options] Override http request option.
20465
+ * @throws {RequiredError}
20466
+ * @memberof TransfersApi
20467
+ */
20468
+ getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponse, any>>;
20469
+ /**
20470
+ * Gets details of a signable transfer
20471
+ * @summary Gets details of a signable transfer
20472
+ * @param {TransfersApiGetSignableTransferV1Request} requestParameters Request parameters.
20473
+ * @param {*} [options] Override http request option.
20474
+ * @throws {RequiredError}
20475
+ * @memberof TransfersApi
20476
+ */
20477
+ getSignableTransferV1(requestParameters: TransfersApiGetSignableTransferV1Request, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponse, any>>;
20478
+ /**
20479
+ * Get details of a transfer with the given ID
20480
+ * @summary Get details of a transfer with the given ID
20481
+ * @param {TransfersApiGetTransferRequest} requestParameters Request parameters.
20482
+ * @param {*} [options] Override http request option.
20483
+ * @throws {RequiredError}
20484
+ * @memberof TransfersApi
20485
+ */
20486
+ getTransfer(requestParameters: TransfersApiGetTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Transfer, any>>;
20487
+ /**
20488
+ * Get a list of transfers
20489
+ * @summary Get a list of transfers
20490
+ * @param {TransfersApiListTransfersRequest} requestParameters Request parameters.
20491
+ * @param {*} [options] Override http request option.
20492
+ * @throws {RequiredError}
20493
+ * @memberof TransfersApi
20494
+ */
20495
+ listTransfers(requestParameters?: TransfersApiListTransfersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTransfersResponse, any>>;
20496
+ }
20497
+
20498
+ /**
20499
+ * Request parameters for getSignableRegistration operation in UsersApi.
20500
+ * @export
20501
+ * @interface UsersApiGetSignableRegistrationRequest
20502
+ */
20503
+ interface UsersApiGetSignableRegistrationRequest {
20504
+ /**
20505
+ * Register User
20506
+ * @type {GetSignableRegistrationRequest}
20507
+ * @memberof UsersApiGetSignableRegistration
20508
+ */
20509
+ readonly getSignableRegistrationRequest: GetSignableRegistrationRequest;
20510
+ }
20511
+ /**
20512
+ * Request parameters for getSignableRegistrationOffchain operation in UsersApi.
20513
+ * @export
20514
+ * @interface UsersApiGetSignableRegistrationOffchainRequest
20515
+ */
20516
+ interface UsersApiGetSignableRegistrationOffchainRequest {
20517
+ /**
20518
+ * Register User Offchain
20519
+ * @type {GetSignableRegistrationRequest}
20520
+ * @memberof UsersApiGetSignableRegistrationOffchain
20426
20521
  */
20427
- readonly maxTimestamp?: string;
20522
+ readonly getSignableRegistrationRequest: GetSignableRegistrationRequest;
20428
20523
  }
20429
20524
  /**
20430
- * Request parameters for listTradesV3 operation in TradesApi.
20525
+ * Request parameters for getUsers operation in UsersApi.
20431
20526
  * @export
20432
- * @interface TradesApiListTradesV3Request
20527
+ * @interface UsersApiGetUsersRequest
20433
20528
  */
20434
- interface TradesApiListTradesV3Request {
20435
- /**
20436
- * Party A\&#39;s (buy order) token type of currency used to buy
20437
- * @type {string}
20438
- * @memberof TradesApiListTradesV3
20439
- */
20440
- readonly partyATokenType?: string;
20441
- /**
20442
- * Party A\&#39;s (buy order) token address of currency used to buy
20443
- * @type {string}
20444
- * @memberof TradesApiListTradesV3
20445
- */
20446
- readonly partyATokenAddress?: string;
20447
- /**
20448
- * Party B\&#39;s (sell order) token type of NFT sold - always ERC721
20449
- * @type {string}
20450
- * @memberof TradesApiListTradesV3
20451
- */
20452
- readonly partyBTokenType?: string;
20453
- /**
20454
- * Party B\&#39;s (sell order) collection address of NFT sold
20455
- * @type {string}
20456
- * @memberof TradesApiListTradesV3
20457
- */
20458
- readonly partyBTokenAddress?: string;
20529
+ interface UsersApiGetUsersRequest {
20459
20530
  /**
20460
- * Party B\&#39;s (sell order) token id of NFT sold
20531
+ * User
20461
20532
  * @type {string}
20462
- * @memberof TradesApiListTradesV3
20463
- */
20464
- readonly partyBTokenId?: string;
20465
- /**
20466
- * Page size of the result
20467
- * @type {number}
20468
- * @memberof TradesApiListTradesV3
20533
+ * @memberof UsersApiGetUsers
20469
20534
  */
20470
- readonly pageSize?: number;
20535
+ readonly user: string;
20536
+ }
20537
+ /**
20538
+ * Request parameters for registerPassportUser operation in UsersApi.
20539
+ * @export
20540
+ * @interface UsersApiRegisterPassportUserRequest
20541
+ */
20542
+ interface UsersApiRegisterPassportUserRequest {
20471
20543
  /**
20472
- * Cursor
20544
+ * Authorization header
20473
20545
  * @type {string}
20474
- * @memberof TradesApiListTradesV3
20546
+ * @memberof UsersApiRegisterPassportUser
20475
20547
  */
20476
- readonly cursor?: string;
20548
+ readonly authorization: string;
20477
20549
  /**
20478
- * Property to sort by
20479
- * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp'}
20480
- * @memberof TradesApiListTradesV3
20550
+ * Register Passport User
20551
+ * @type {ApiRegisterPassportUserRequest}
20552
+ * @memberof UsersApiRegisterPassportUser
20481
20553
  */
20482
- readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp';
20554
+ readonly registerPassportUserRequest: ApiRegisterPassportUserRequest;
20555
+ }
20556
+ /**
20557
+ * Request parameters for registerPassportUserV2 operation in UsersApi.
20558
+ * @export
20559
+ * @interface UsersApiRegisterPassportUserV2Request
20560
+ */
20561
+ interface UsersApiRegisterPassportUserV2Request {
20483
20562
  /**
20484
- * Direction to sort (asc/desc)
20563
+ * Authorization header
20485
20564
  * @type {string}
20486
- * @memberof TradesApiListTradesV3
20565
+ * @memberof UsersApiRegisterPassportUserV2
20487
20566
  */
20488
- readonly direction?: string;
20567
+ readonly authorization: string;
20489
20568
  /**
20490
- * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20491
- * @type {string}
20492
- * @memberof TradesApiListTradesV3
20569
+ * Register Passport User
20570
+ * @type {ApiRegisterPassportUserRequest}
20571
+ * @memberof UsersApiRegisterPassportUserV2
20493
20572
  */
20494
- readonly minTimestamp?: string;
20573
+ readonly registerPassportUserRequest: ApiRegisterPassportUserRequest;
20574
+ }
20575
+ /**
20576
+ * Request parameters for registerUser operation in UsersApi.
20577
+ * @export
20578
+ * @interface UsersApiRegisterUserRequest
20579
+ */
20580
+ interface UsersApiRegisterUserRequest {
20495
20581
  /**
20496
- * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20497
- * @type {string}
20498
- * @memberof TradesApiListTradesV3
20582
+ * Register User
20583
+ * @type {RegisterUserRequest}
20584
+ * @memberof UsersApiRegisterUser
20499
20585
  */
20500
- readonly maxTimestamp?: string;
20586
+ readonly registerUserRequest: RegisterUserRequest;
20501
20587
  }
20502
20588
  /**
20503
- * TradesApi - object-oriented interface
20589
+ * UsersApi - object-oriented interface
20504
20590
  * @export
20505
- * @class TradesApi
20591
+ * @class UsersApi
20506
20592
  * @extends {BaseAPI}
20507
20593
  */
20508
- declare class TradesApi extends BaseAPI {
20509
- /**
20510
- * Create a trade. Use https://docs.x.immutable.com/reference#/operations/getSignableTrade to get request body params. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createTradeV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
20511
- * @summary Create a Trade between two parties
20512
- * @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
20513
- * @param {*} [options] Override http request option.
20514
- * @deprecated
20515
- * @throws {RequiredError}
20516
- * @memberof TradesApi
20517
- */
20518
- createTrade(requestParameters: TradesApiCreateTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
20594
+ declare class UsersApi extends BaseAPI {
20519
20595
  /**
20520
- * Create a Trade. Currently only buy order is supported.
20521
- * @summary Create a Trade (V3)
20522
- * @param {TradesApiCreateTradeV3Request} requestParameters Request parameters.
20596
+ * Get operator signature to allow clients to register the user
20597
+ * @summary Get operator signature to allow clients to register the user
20598
+ * @param {UsersApiGetSignableRegistrationRequest} requestParameters Request parameters.
20523
20599
  * @param {*} [options] Override http request option.
20524
20600
  * @throws {RequiredError}
20525
- * @memberof TradesApi
20601
+ * @memberof UsersApi
20526
20602
  */
20527
- createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
20603
+ getSignableRegistration(requestParameters: UsersApiGetSignableRegistrationRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableRegistrationResponse, any>>;
20528
20604
  /**
20529
- * Generate a signable trade message (V3)
20530
- * @summary Generate a signable trade message (V3)
20531
- * @param {TradesApiGetSignableTradeRequest} requestParameters Request parameters.
20605
+ * Get encoded details to allow clients to register the user offchain
20606
+ * @summary Get encoded details to allow clients to register the user offchain
20607
+ * @param {UsersApiGetSignableRegistrationOffchainRequest} requestParameters Request parameters.
20532
20608
  * @param {*} [options] Override http request option.
20533
20609
  * @throws {RequiredError}
20534
- * @memberof TradesApi
20610
+ * @memberof UsersApi
20535
20611
  */
20536
- getSignableTrade(requestParameters: TradesApiGetSignableTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTradeResponse, any>>;
20612
+ getSignableRegistrationOffchain(requestParameters: UsersApiGetSignableRegistrationOffchainRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableRegistrationOffchainResponse, any>>;
20537
20613
  /**
20538
- * Get details of a trade with the given ID
20539
- * @summary Get details of a trade with the given ID
20540
- * @param {TradesApiGetTradeRequest} requestParameters Request parameters.
20614
+ * Get stark keys for a registered user
20615
+ * @summary Get stark keys for a registered user
20616
+ * @param {UsersApiGetUsersRequest} requestParameters Request parameters.
20541
20617
  * @param {*} [options] Override http request option.
20542
- * @deprecated
20543
20618
  * @throws {RequiredError}
20544
- * @memberof TradesApi
20619
+ * @memberof UsersApi
20545
20620
  */
20546
- getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
20621
+ getUsers(requestParameters: UsersApiGetUsersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetUsersApiResponse, any>>;
20547
20622
  /**
20548
- * Get details of a trade with the given ID
20549
- * @summary Get details of a trade with the given ID
20550
- * @param {TradesApiGetTradeV3Request} requestParameters Request parameters.
20623
+ * Registers a passport user
20624
+ * @summary Registers a passport user
20625
+ * @param {UsersApiRegisterPassportUserRequest} requestParameters Request parameters.
20551
20626
  * @param {*} [options] Override http request option.
20552
20627
  * @throws {RequiredError}
20553
- * @memberof TradesApi
20628
+ * @memberof UsersApi
20554
20629
  */
20555
- getTradeV3(requestParameters: TradesApiGetTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
20630
+ registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterPassportUserResult, any>>;
20556
20631
  /**
20557
- * Get a list of trades. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/listTradesV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
20558
- * @summary Get a list of trades
20559
- * @param {TradesApiListTradesRequest} requestParameters Request parameters.
20632
+ * Registers a passport user
20633
+ * @summary Registers a passport user
20634
+ * @param {UsersApiRegisterPassportUserV2Request} requestParameters Request parameters.
20560
20635
  * @param {*} [options] Override http request option.
20561
- * @deprecated
20562
20636
  * @throws {RequiredError}
20563
- * @memberof TradesApi
20637
+ * @memberof UsersApi
20564
20638
  */
20565
- listTrades(requestParameters?: TradesApiListTradesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
20639
+ registerPassportUserV2(requestParameters: UsersApiRegisterPassportUserV2Request, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterPassportUserResult, any>>;
20566
20640
  /**
20567
- * Get a list of trades (V3)
20568
- * @summary Get a list of trades (V3)
20569
- * @param {TradesApiListTradesV3Request} requestParameters Request parameters.
20641
+ * Registers a user
20642
+ * @summary Registers a user
20643
+ * @param {UsersApiRegisterUserRequest} requestParameters Request parameters.
20570
20644
  * @param {*} [options] Override http request option.
20571
20645
  * @throws {RequiredError}
20572
- * @memberof TradesApi
20646
+ * @memberof UsersApi
20573
20647
  */
20574
- listTradesV3(requestParameters?: TradesApiListTradesV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
20648
+ registerUser(requestParameters: UsersApiRegisterUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterUserResponse, any>>;
20575
20649
  }
20576
20650
 
20577
20651
  /**
20578
- * Request parameters for createTransfer operation in TransfersApi.
20579
- * @export
20580
- * @interface TransfersApiCreateTransferRequest
20581
- */
20582
- interface TransfersApiCreateTransferRequest {
20583
- /**
20584
- * Create transfer
20585
- * @type {CreateTransferRequest}
20586
- * @memberof TransfersApiCreateTransfer
20587
- */
20588
- readonly createTransferRequestV2: CreateTransferRequest;
20589
- /**
20590
- * eth address
20591
- * @type {string}
20592
- * @memberof TransfersApiCreateTransfer
20593
- */
20594
- readonly xImxEthAddress?: string;
20595
- /**
20596
- * eth signature
20597
- * @type {string}
20598
- * @memberof TransfersApiCreateTransfer
20599
- */
20600
- readonly xImxEthSignature?: string;
20601
- /**
20602
- * Authorization header
20603
- * @type {string}
20604
- * @memberof TransfersApiCreateTransfer
20605
- */
20606
- readonly authorization?: string;
20607
- }
20608
- /**
20609
- * Request parameters for createTransferV1 operation in TransfersApi.
20652
+ * Request parameters for createWithdrawal operation in WithdrawalsApi.
20610
20653
  * @export
20611
- * @interface TransfersApiCreateTransferV1Request
20654
+ * @interface WithdrawalsApiCreateWithdrawalRequest
20612
20655
  */
20613
- interface TransfersApiCreateTransferV1Request {
20614
- /**
20615
- * Create transfer
20616
- * @type {CreateTransferRequestV1}
20617
- * @memberof TransfersApiCreateTransferV1
20618
- */
20619
- readonly createTransferRequest: CreateTransferRequestV1;
20656
+ interface WithdrawalsApiCreateWithdrawalRequest {
20620
20657
  /**
20621
20658
  * eth address
20622
20659
  * @type {string}
20623
- * @memberof TransfersApiCreateTransferV1
20660
+ * @memberof WithdrawalsApiCreateWithdrawal
20624
20661
  */
20625
- readonly xImxEthAddress?: string;
20662
+ readonly xImxEthAddress: string;
20626
20663
  /**
20627
20664
  * eth signature
20628
20665
  * @type {string}
20629
- * @memberof TransfersApiCreateTransferV1
20630
- */
20631
- readonly xImxEthSignature?: string;
20632
- /**
20633
- * Authorization header
20634
- * @type {string}
20635
- * @memberof TransfersApiCreateTransferV1
20666
+ * @memberof WithdrawalsApiCreateWithdrawal
20636
20667
  */
20637
- readonly authorization?: string;
20638
- }
20639
- /**
20640
- * Request parameters for getSignableTransfer operation in TransfersApi.
20641
- * @export
20642
- * @interface TransfersApiGetSignableTransferRequest
20643
- */
20644
- interface TransfersApiGetSignableTransferRequest {
20668
+ readonly xImxEthSignature: string;
20645
20669
  /**
20646
- * get details of signable transfer
20647
- * @type {GetSignableTransferRequestV2}
20648
- * @memberof TransfersApiGetSignableTransfer
20670
+ * create a withdrawal
20671
+ * @type {CreateWithdrawalRequest}
20672
+ * @memberof WithdrawalsApiCreateWithdrawal
20649
20673
  */
20650
- readonly getSignableTransferRequestV2: GetSignableTransferRequestV2;
20674
+ readonly createWithdrawalRequest: CreateWithdrawalRequest;
20651
20675
  }
20652
20676
  /**
20653
- * Request parameters for getSignableTransferV1 operation in TransfersApi.
20677
+ * Request parameters for getSignableWithdrawal operation in WithdrawalsApi.
20654
20678
  * @export
20655
- * @interface TransfersApiGetSignableTransferV1Request
20679
+ * @interface WithdrawalsApiGetSignableWithdrawalRequest
20656
20680
  */
20657
- interface TransfersApiGetSignableTransferV1Request {
20681
+ interface WithdrawalsApiGetSignableWithdrawalRequest {
20658
20682
  /**
20659
- * get details of signable transfer
20660
- * @type {GetSignableTransferRequest}
20661
- * @memberof TransfersApiGetSignableTransferV1
20683
+ * get details of signable withdrawal
20684
+ * @type {GetSignableWithdrawalRequest}
20685
+ * @memberof WithdrawalsApiGetSignableWithdrawal
20662
20686
  */
20663
- readonly getSignableTransferRequest: GetSignableTransferRequest;
20687
+ readonly getSignableWithdrawalRequest: GetSignableWithdrawalRequest;
20664
20688
  }
20665
20689
  /**
20666
- * Request parameters for getTransfer operation in TransfersApi.
20690
+ * Request parameters for getWithdrawal operation in WithdrawalsApi.
20667
20691
  * @export
20668
- * @interface TransfersApiGetTransferRequest
20692
+ * @interface WithdrawalsApiGetWithdrawalRequest
20669
20693
  */
20670
- interface TransfersApiGetTransferRequest {
20694
+ interface WithdrawalsApiGetWithdrawalRequest {
20671
20695
  /**
20672
- * Transfer ID
20696
+ * Withdrawal ID
20673
20697
  * @type {string}
20674
- * @memberof TransfersApiGetTransfer
20698
+ * @memberof WithdrawalsApiGetWithdrawal
20675
20699
  */
20676
20700
  readonly id: string;
20677
20701
  }
20678
20702
  /**
20679
- * Request parameters for listTransfers operation in TransfersApi.
20703
+ * Request parameters for listWithdrawals operation in WithdrawalsApi.
20680
20704
  * @export
20681
- * @interface TransfersApiListTransfersRequest
20705
+ * @interface WithdrawalsApiListWithdrawalsRequest
20682
20706
  */
20683
- interface TransfersApiListTransfersRequest {
20707
+ interface WithdrawalsApiListWithdrawalsRequest {
20708
+ /**
20709
+ * Withdrawal has been transferred to user\&#39;s Layer 1 wallet
20710
+ * @type {boolean}
20711
+ * @memberof WithdrawalsApiListWithdrawals
20712
+ */
20713
+ readonly withdrawnToWallet?: boolean;
20714
+ /**
20715
+ * Status of the on-chain batch confirmation for this withdrawal
20716
+ * @type {string}
20717
+ * @memberof WithdrawalsApiListWithdrawals
20718
+ */
20719
+ readonly rollupStatus?: string;
20684
20720
  /**
20685
20721
  * Page size of the result
20686
20722
  * @type {number}
20687
- * @memberof TransfersApiListTransfers
20723
+ * @memberof WithdrawalsApiListWithdrawals
20688
20724
  */
20689
20725
  readonly pageSize?: number;
20690
20726
  /**
20691
20727
  * Cursor
20692
20728
  * @type {string}
20693
- * @memberof TransfersApiListTransfers
20729
+ * @memberof WithdrawalsApiListWithdrawals
20694
20730
  */
20695
20731
  readonly cursor?: string;
20696
20732
  /**
20697
20733
  * Property to sort by
20698
- * @type {'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key'}
20699
- * @memberof TransfersApiListTransfers
20734
+ * @type {string}
20735
+ * @memberof WithdrawalsApiListWithdrawals
20700
20736
  */
20701
- readonly orderBy?: 'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key';
20737
+ readonly orderBy?: string;
20702
20738
  /**
20703
20739
  * Direction to sort (asc/desc)
20704
20740
  * @type {string}
20705
- * @memberof TransfersApiListTransfers
20741
+ * @memberof WithdrawalsApiListWithdrawals
20706
20742
  */
20707
20743
  readonly direction?: string;
20708
20744
  /**
20709
- * Ethereum address of the user who submitted this transfer
20745
+ * Ethereum address of the user who submitted this withdrawal
20710
20746
  * @type {string}
20711
- * @memberof TransfersApiListTransfers
20747
+ * @memberof WithdrawalsApiListWithdrawals
20712
20748
  */
20713
20749
  readonly user?: string;
20714
20750
  /**
20715
- * Ethereum address of the user who received this transfer
20751
+ * Status of this withdrawal
20716
20752
  * @type {string}
20717
- * @memberof TransfersApiListTransfers
20718
- */
20719
- readonly receiver?: string;
20720
- /**
20721
- * Status of this transfer
20722
- * @type {'success' | 'failure'}
20723
- * @memberof TransfersApiListTransfers
20753
+ * @memberof WithdrawalsApiListWithdrawals
20724
20754
  */
20725
- readonly status?: 'success' | 'failure';
20755
+ readonly status?: string;
20726
20756
  /**
20727
- * Minimum timestamp for this transfer, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20757
+ * Minimum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20728
20758
  * @type {string}
20729
- * @memberof TransfersApiListTransfers
20759
+ * @memberof WithdrawalsApiListWithdrawals
20730
20760
  */
20731
20761
  readonly minTimestamp?: string;
20732
20762
  /**
20733
- * Maximum timestamp for this transfer, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20763
+ * Maximum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
20734
20764
  * @type {string}
20735
- * @memberof TransfersApiListTransfers
20765
+ * @memberof WithdrawalsApiListWithdrawals
20736
20766
  */
20737
20767
  readonly maxTimestamp?: string;
20738
20768
  /**
20739
- * Token type of the transferred asset
20769
+ * Token type of the withdrawn asset
20740
20770
  * @type {string}
20741
- * @memberof TransfersApiListTransfers
20771
+ * @memberof WithdrawalsApiListWithdrawals
20742
20772
  */
20743
20773
  readonly tokenType?: string;
20744
20774
  /**
20745
20775
  * ERC721 Token ID of the minted asset
20746
20776
  * @type {string}
20747
- * @memberof TransfersApiListTransfers
20777
+ * @memberof WithdrawalsApiListWithdrawals
20748
20778
  */
20749
20779
  readonly tokenId?: string;
20750
20780
  /**
20751
20781
  * Internal IMX ID of the minted asset
20752
20782
  * @type {string}
20753
- * @memberof TransfersApiListTransfers
20783
+ * @memberof WithdrawalsApiListWithdrawals
20754
20784
  */
20755
20785
  readonly assetId?: string;
20756
20786
  /**
20757
- * Token address of the transferred asset
20787
+ * Token address of the withdrawn asset
20758
20788
  * @type {string}
20759
- * @memberof TransfersApiListTransfers
20789
+ * @memberof WithdrawalsApiListWithdrawals
20760
20790
  */
20761
20791
  readonly tokenAddress?: string;
20762
20792
  /**
20763
- * Token name of the transferred asset
20793
+ * Token name of the withdrawn asset
20764
20794
  * @type {string}
20765
- * @memberof TransfersApiListTransfers
20795
+ * @memberof WithdrawalsApiListWithdrawals
20766
20796
  */
20767
20797
  readonly tokenName?: string;
20768
20798
  /**
20769
- * Max quantity for the transferred asset
20799
+ * Min quantity for the withdrawn asset
20770
20800
  * @type {string}
20771
- * @memberof TransfersApiListTransfers
20801
+ * @memberof WithdrawalsApiListWithdrawals
20772
20802
  */
20773
20803
  readonly minQuantity?: string;
20774
20804
  /**
20775
- * Max quantity for the transferred asset
20805
+ * Max quantity for the withdrawn asset
20776
20806
  * @type {string}
20777
- * @memberof TransfersApiListTransfers
20807
+ * @memberof WithdrawalsApiListWithdrawals
20778
20808
  */
20779
20809
  readonly maxQuantity?: string;
20780
20810
  /**
20781
- * JSON-encoded metadata filters for the transferred asset
20811
+ * JSON-encoded metadata filters for the withdrawn asset
20782
20812
  * @type {string}
20783
- * @memberof TransfersApiListTransfers
20813
+ * @memberof WithdrawalsApiListWithdrawals
20784
20814
  */
20785
20815
  readonly metadata?: string;
20786
20816
  }
20787
20817
  /**
20788
- * TransfersApi - object-oriented interface
20818
+ * WithdrawalsApi - object-oriented interface
20789
20819
  * @export
20790
- * @class TransfersApi
20820
+ * @class WithdrawalsApi
20791
20821
  * @extends {BaseAPI}
20792
20822
  */
20793
- declare class TransfersApi extends BaseAPI {
20794
- /**
20795
- * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransfer to get request body params.
20796
- * @summary Creates a transfer of multiple tokens between two parties
20797
- * @param {TransfersApiCreateTransferRequest} requestParameters Request parameters.
20798
- * @param {*} [options] Override http request option.
20799
- * @throws {RequiredError}
20800
- * @memberof TransfersApi
20801
- */
20802
- createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
20803
- /**
20804
- * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
20805
- * @summary Creates a transfer of tokens between two parties
20806
- * @param {TransfersApiCreateTransferV1Request} requestParameters Request parameters.
20807
- * @param {*} [options] Override http request option.
20808
- * @throws {RequiredError}
20809
- * @memberof TransfersApi
20810
- */
20811
- createTransferV1(requestParameters: TransfersApiCreateTransferV1Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
20823
+ declare class WithdrawalsApi extends BaseAPI {
20812
20824
  /**
20813
- * Gets bulk details of a signable transfer
20814
- * @summary Gets bulk details of a signable transfer
20815
- * @param {TransfersApiGetSignableTransferRequest} requestParameters Request parameters.
20825
+ * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
20826
+ * @summary Creates a withdrawal of a token
20827
+ * @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
20816
20828
  * @param {*} [options] Override http request option.
20817
20829
  * @throws {RequiredError}
20818
- * @memberof TransfersApi
20830
+ * @memberof WithdrawalsApi
20819
20831
  */
20820
- getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponse, any>>;
20832
+ createWithdrawal(requestParameters: WithdrawalsApiCreateWithdrawalRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateWithdrawalResponse, any>>;
20821
20833
  /**
20822
- * Gets details of a signable transfer
20823
- * @summary Gets details of a signable transfer
20824
- * @param {TransfersApiGetSignableTransferV1Request} requestParameters Request parameters.
20834
+ * Gets details of a signable withdrawal
20835
+ * @summary Gets details of a signable withdrawal
20836
+ * @param {WithdrawalsApiGetSignableWithdrawalRequest} requestParameters Request parameters.
20825
20837
  * @param {*} [options] Override http request option.
20826
20838
  * @throws {RequiredError}
20827
- * @memberof TransfersApi
20839
+ * @memberof WithdrawalsApi
20828
20840
  */
20829
- getSignableTransferV1(requestParameters: TransfersApiGetSignableTransferV1Request, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponse, any>>;
20841
+ getSignableWithdrawal(requestParameters: WithdrawalsApiGetSignableWithdrawalRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableWithdrawalResponse, any>>;
20830
20842
  /**
20831
- * Get details of a transfer with the given ID
20832
- * @summary Get details of a transfer with the given ID
20833
- * @param {TransfersApiGetTransferRequest} requestParameters Request parameters.
20843
+ * Gets details of withdrawal with the given ID
20844
+ * @summary Gets details of withdrawal with the given ID
20845
+ * @param {WithdrawalsApiGetWithdrawalRequest} requestParameters Request parameters.
20834
20846
  * @param {*} [options] Override http request option.
20835
20847
  * @throws {RequiredError}
20836
- * @memberof TransfersApi
20848
+ * @memberof WithdrawalsApi
20837
20849
  */
20838
- getTransfer(requestParameters: TransfersApiGetTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Transfer, any>>;
20850
+ getWithdrawal(requestParameters: WithdrawalsApiGetWithdrawalRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Withdrawal, any>>;
20839
20851
  /**
20840
- * Get a list of transfers
20841
- * @summary Get a list of transfers
20842
- * @param {TransfersApiListTransfersRequest} requestParameters Request parameters.
20852
+ * Get a list of withdrawals
20853
+ * @summary Get a list of withdrawals
20854
+ * @param {WithdrawalsApiListWithdrawalsRequest} requestParameters Request parameters.
20843
20855
  * @param {*} [options] Override http request option.
20844
20856
  * @throws {RequiredError}
20845
- * @memberof TransfersApi
20857
+ * @memberof WithdrawalsApi
20846
20858
  */
20847
- listTransfers(requestParameters?: TransfersApiListTransfersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTransfersResponse, any>>;
20859
+ listWithdrawals(requestParameters?: WithdrawalsApiListWithdrawalsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListWithdrawalsResponse, any>>;
20848
20860
  }
20849
20861
 
20850
20862
  /**
20851
- * Request parameters for getSignableRegistration operation in UsersApi.
20852
- * @export
20853
- * @interface UsersApiGetSignableRegistrationRequest
20863
+ * Configuration for generated clients
20854
20864
  */
20855
- interface UsersApiGetSignableRegistrationRequest {
20865
+ type ImmutableAPIConfiguration = Configuration;
20866
+
20867
+ declare class ImxApiClients {
20868
+ config: ImmutableAPIConfiguration;
20869
+ assetApi: AssetsApi;
20870
+ balanceApi: BalancesApi;
20871
+ collectionApi: CollectionsApi;
20872
+ depositsApi: DepositsApi;
20873
+ encodingApi: EncodingApi;
20874
+ exchangeApi: ExchangesApi;
20875
+ metadataApi: MetadataApi;
20876
+ metadataRefreshesApi: MetadataRefreshesApi;
20877
+ mintsApi: MintsApi;
20878
+ nftCheckoutPrimaryApi: NftCheckoutPrimaryApi;
20879
+ ordersApi: OrdersApi;
20880
+ projectsApi: ProjectsApi;
20881
+ tokensApi: TokensApi;
20882
+ tradesApi: TradesApi;
20883
+ transfersApi: TransfersApi;
20884
+ usersApi: UsersApi;
20885
+ withdrawalsApi: WithdrawalsApi;
20886
+ constructor(config: ImmutableAPIConfiguration);
20887
+ }
20888
+
20889
+ interface ImxOverrides {
20890
+ immutableXConfig: ImmutableXConfiguration;
20891
+ }
20892
+ interface ImxModuleConfiguration extends ModuleConfiguration<ImxOverrides> {
20893
+ }
20894
+
20895
+ declare class IMXClient {
20896
+ private immutableX;
20897
+ depositsApi: DepositsApi$1;
20898
+ mintsApi: MintsApi$1;
20899
+ ordersApi: OrdersApi$1;
20900
+ tokensApi: TokensApi$1;
20901
+ tradesApi: TradesApi$1;
20902
+ transfersApi: TransfersApi$1;
20903
+ exchangeApi: ExchangesApi$1;
20904
+ nftCheckoutPrimaryApi: NftCheckoutPrimaryApi$1;
20905
+ usersApi: UsersApi$1;
20906
+ withdrawalsApi: WithdrawalsApi$1;
20907
+ balanceApi: BalancesApi$1;
20908
+ assetApi: AssetsApi$1;
20909
+ collectionApi: CollectionsApi$1;
20910
+ metadataApi: MetadataApi$1;
20911
+ metadataRefreshesApi: MetadataRefreshesApi$1;
20912
+ projectsApi: ProjectsApi$1;
20913
+ constructor(config: ImxModuleConfiguration);
20856
20914
  /**
20857
- * Register User
20858
- * @type {GetSignableRegistrationRequest}
20859
- * @memberof UsersApiGetSignableRegistration
20915
+ * Get details of a Deposit with the given ID
20916
+ * @param request - the request object containing the parameters to be provided in the API request
20917
+ * @returns a promise that resolves with the requested Deposit
20918
+ * @throws {@link index.IMXError}
20860
20919
  */
20861
- readonly getSignableRegistrationRequest: GetSignableRegistrationRequest;
20862
- }
20863
- /**
20864
- * Request parameters for getSignableRegistrationOffchain operation in UsersApi.
20865
- * @export
20866
- * @interface UsersApiGetSignableRegistrationOffchainRequest
20867
- */
20868
- interface UsersApiGetSignableRegistrationOffchainRequest {
20920
+ getDeposit(request: DepositsApiGetDepositRequest$1): Promise<Deposit$1>;
20869
20921
  /**
20870
- * Register User Offchain
20871
- * @type {GetSignableRegistrationRequest}
20872
- * @memberof UsersApiGetSignableRegistrationOffchain
20922
+ * Get a list of Deposits
20923
+ * @param request - optional object containing the parameters to be provided in the API request
20924
+ * @returns a promise that resolves with the requested list of Deposits
20925
+ * @throws {@link index.IMXError}
20926
+ */
20927
+ listDeposits(request?: DepositsApiListDepositsRequest$1): Promise<ListDepositsResponse$1>;
20928
+ /**
20929
+ * Get Stark keys for a registered User
20930
+ * @param ethAddress - the eth address of the User
20931
+ * @returns a promise that resolves with the requested User
20932
+ * @throws {@link index.IMXError}
20933
+ */
20934
+ getUser(ethAddress: string): Promise<GetUsersApiResponse$1>;
20935
+ /**
20936
+ * Get details of an Asset
20937
+ * @param request - the request object containing the parameters to be provided in the API request
20938
+ * @returns a promise that resolves with the requested Asset
20939
+ * @throws {@link index.IMXError}
20873
20940
  */
20874
- readonly getSignableRegistrationRequest: GetSignableRegistrationRequest;
20875
- }
20876
- /**
20877
- * Request parameters for getUsers operation in UsersApi.
20878
- * @export
20879
- * @interface UsersApiGetUsersRequest
20880
- */
20881
- interface UsersApiGetUsersRequest {
20941
+ getAsset(request: AssetsApiGetAssetRequest$1): Promise<Asset$1>;
20882
20942
  /**
20883
- * User
20884
- * @type {string}
20885
- * @memberof UsersApiGetUsers
20943
+ * Get a list of Assets
20944
+ * @param request - optional object containing the parameters to be provided in the API request
20945
+ * @returns a promise that resolves with the requested list of Assets
20946
+ * @throws {@link index.IMXError}
20886
20947
  */
20887
- readonly user: string;
20888
- }
20889
- /**
20890
- * Request parameters for registerPassportUser operation in UsersApi.
20891
- * @export
20892
- * @interface UsersApiRegisterPassportUserRequest
20893
- */
20894
- interface UsersApiRegisterPassportUserRequest {
20948
+ listAssets(request?: AssetsApiListAssetsRequest$1): Promise<ListAssetsResponse$1>;
20895
20949
  /**
20896
- * Authorization header
20897
- * @type {string}
20898
- * @memberof UsersApiRegisterPassportUser
20950
+ * Create a Collection
20951
+ * @param ethSigner - the L1 signer
20952
+ * @param request - the request object to be provided in the API request
20953
+ * @returns a promise that resolves with the created Collection
20954
+ * @throws {@link index.IMXError}
20899
20955
  */
20900
- readonly authorization: string;
20956
+ createCollection(ethSigner: Signer, request: CreateCollectionRequest$1): Promise<Collection$1>;
20901
20957
  /**
20902
- * Register Passport User
20903
- * @type {ApiRegisterPassportUserRequest}
20904
- * @memberof UsersApiRegisterPassportUser
20958
+ * Get details of a Collection at the given address
20959
+ * @param request - the request object containing the parameters to be provided in the API request
20960
+ * @returns a promise that resolves with the requested Collection
20961
+ * @throws {@link index.IMXError}
20905
20962
  */
20906
- readonly registerPassportUserRequest: ApiRegisterPassportUserRequest;
20907
- }
20908
- /**
20909
- * Request parameters for registerPassportUserV2 operation in UsersApi.
20910
- * @export
20911
- * @interface UsersApiRegisterPassportUserV2Request
20912
- */
20913
- interface UsersApiRegisterPassportUserV2Request {
20963
+ getCollection(request: CollectionsApiGetCollectionRequest$1): Promise<Collection$1>;
20914
20964
  /**
20915
- * Authorization header
20916
- * @type {string}
20917
- * @memberof UsersApiRegisterPassportUserV2
20965
+ * Get a list of Collection filters
20966
+ * @param request - the request object containing the parameters to be provided in the API request
20967
+ * @returns a promise that resolves with the requested list of Collection Filters
20968
+ * @throws {@link index.IMXError}
20918
20969
  */
20919
- readonly authorization: string;
20970
+ listCollectionFilters(request: CollectionsApiListCollectionFiltersRequest$1): Promise<CollectionFilter$1>;
20920
20971
  /**
20921
- * Register Passport User
20922
- * @type {ApiRegisterPassportUserRequest}
20923
- * @memberof UsersApiRegisterPassportUserV2
20972
+ * Get a list of Collections
20973
+ * @param request - optional object containing the parameters to be provided in the API request
20974
+ * @returns a promise that resolves with the requested list of Collections
20975
+ * @throws {@link index.IMXError}
20924
20976
  */
20925
- readonly registerPassportUserRequest: ApiRegisterPassportUserRequest;
20926
- }
20927
- /**
20928
- * Request parameters for registerUser operation in UsersApi.
20929
- * @export
20930
- * @interface UsersApiRegisterUserRequest
20931
- */
20932
- interface UsersApiRegisterUserRequest {
20977
+ listCollections(request?: CollectionsApiListCollectionsRequest$1): Promise<ListCollectionsResponse$1>;
20933
20978
  /**
20934
- * Register User
20935
- * @type {RegisterUserRequest}
20936
- * @memberof UsersApiRegisterUser
20979
+ * Update a Collection
20980
+ * @param ethSigner - the L1 signer
20981
+ * @param collectionAddress - the Collection contract address
20982
+ * @param request - the request object containing the parameters to be provided in the API request
20983
+ * @returns a promise that resolves with the updated Collection
20984
+ * @throws {@link index.IMXError}
20937
20985
  */
20938
- readonly registerUserRequest: RegisterUserRequest;
20939
- }
20940
- /**
20941
- * UsersApi - object-oriented interface
20942
- * @export
20943
- * @class UsersApi
20944
- * @extends {BaseAPI}
20945
- */
20946
- declare class UsersApi extends BaseAPI {
20986
+ updateCollection(ethSigner: Signer, collectionAddress: string, request: UpdateCollectionRequest$1): Promise<Collection$1>;
20947
20987
  /**
20948
- * Get operator signature to allow clients to register the user
20949
- * @summary Get operator signature to allow clients to register the user
20950
- * @param {UsersApiGetSignableRegistrationRequest} requestParameters Request parameters.
20951
- * @param {*} [options] Override http request option.
20952
- * @throws {RequiredError}
20953
- * @memberof UsersApi
20988
+ * Add metadata schema to Collection
20989
+ * @param ethSigner - the L1 signer
20990
+ * @param collectionAddress - the Collection contract address
20991
+ * @param request - the request object containing the parameters to be provided in the API request
20992
+ * @returns a promise that resolves with the SuccessResponse if successful
20993
+ * @throws {@link index.IMXError}
20954
20994
  */
20955
- getSignableRegistration(requestParameters: UsersApiGetSignableRegistrationRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableRegistrationResponse, any>>;
20995
+ addMetadataSchemaToCollection(ethSigner: Signer, collectionAddress: string, request: AddMetadataSchemaToCollectionRequest$1): Promise<SuccessResponse$1>;
20956
20996
  /**
20957
- * Get encoded details to allow clients to register the user offchain
20958
- * @summary Get encoded details to allow clients to register the user offchain
20959
- * @param {UsersApiGetSignableRegistrationOffchainRequest} requestParameters Request parameters.
20960
- * @param {*} [options] Override http request option.
20961
- * @throws {RequiredError}
20962
- * @memberof UsersApi
20997
+ * Get Metadata schema
20998
+ * @param request - the request object containing the parameters to be provided in the API request
20999
+ * @returns a promise that resolves with the requested Metadata schema
21000
+ * @throws {@link index.IMXError}
20963
21001
  */
20964
- getSignableRegistrationOffchain(requestParameters: UsersApiGetSignableRegistrationOffchainRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableRegistrationOffchainResponse, any>>;
21002
+ getMetadataSchema(request: MetadataApiGetMetadataSchemaRequest$1): Promise<MetadataSchemaProperty$1[]>;
20965
21003
  /**
20966
- * Get stark keys for a registered user
20967
- * @summary Get stark keys for a registered user
20968
- * @param {UsersApiGetUsersRequest} requestParameters Request parameters.
20969
- * @param {*} [options] Override http request option.
20970
- * @throws {RequiredError}
20971
- * @memberof UsersApi
21004
+ * Update metadata schema by name
21005
+ * @param ethSigner - the L1 signer
21006
+ * @param collectionAddress - the Collection contract address
21007
+ * @param name - the Metadata schema name
21008
+ * @param request - the request object containing the parameters to be provided in the API request
21009
+ * @returns a promise that resolves with the SuccessResponse if successful
21010
+ * @throws {@link index.IMXError}
20972
21011
  */
20973
- getUsers(requestParameters: UsersApiGetUsersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetUsersApiResponse, any>>;
21012
+ updateMetadataSchemaByName(ethSigner: Signer, collectionAddress: string, name: string, request: MetadataSchemaRequest$1): Promise<SuccessResponse$1>;
20974
21013
  /**
20975
- * Registers a passport user
20976
- * @summary Registers a passport user
20977
- * @param {UsersApiRegisterPassportUserRequest} requestParameters Request parameters.
20978
- * @param {*} [options] Override http request option.
20979
- * @throws {RequiredError}
20980
- * @memberof UsersApi
21014
+ * Get a list of metadata refreshes
21015
+ * @param ethSigner - the L1 signer
21016
+ * @param collectionAddress - the Collection contract address
21017
+ * @param pageSize - the page size of the result
21018
+ * @param cursor - the cursor
21019
+ * @returns a promise that resolves with the requested metadata refreshes
21020
+ * @throws {@link index.IMXError}
20981
21021
  */
20982
- registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterPassportUserResult, any>>;
21022
+ listMetadataRefreshes(ethSigner: Signer, collectionAddress?: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshes$1>;
20983
21023
  /**
20984
- * Registers a passport user
20985
- * @summary Registers a passport user
20986
- * @param {UsersApiRegisterPassportUserV2Request} requestParameters Request parameters.
20987
- * @param {*} [options] Override http request option.
20988
- * @throws {RequiredError}
20989
- * @memberof UsersApi
21024
+ * Get a list of metadata refresh errors
21025
+ * @param ethSigner - the L1 signer
21026
+ * @param refreshId - the metadata refresh ID
21027
+ * @param pageSize - the page size of the result
21028
+ * @param cursor - the cursor
21029
+ * @returns a promise that resolves with the requested metadata refresh errors
21030
+ * @throws {@link index.IMXError}
20990
21031
  */
20991
- registerPassportUserV2(requestParameters: UsersApiRegisterPassportUserV2Request, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterPassportUserResult, any>>;
21032
+ getMetadataRefreshErrors(ethSigner: Signer, refreshId: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshErrorsResponse$1>;
20992
21033
  /**
20993
- * Registers a user
20994
- * @summary Registers a user
20995
- * @param {UsersApiRegisterUserRequest} requestParameters Request parameters.
20996
- * @param {*} [options] Override http request option.
20997
- * @throws {RequiredError}
20998
- * @memberof UsersApi
21034
+ * Get a list of metadata refresh results
21035
+ * @param ethSigner - the L1 signer
21036
+ * @param refreshId - the metadata refresh ID
21037
+ * @returns a promise that resolves with the requested metadata refresh results
21038
+ * @throws {@link index.IMXError}
20999
21039
  */
21000
- registerUser(requestParameters: UsersApiRegisterUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterUserResponse, any>>;
21001
- }
21002
-
21003
- /**
21004
- * Request parameters for createWithdrawal operation in WithdrawalsApi.
21005
- * @export
21006
- * @interface WithdrawalsApiCreateWithdrawalRequest
21007
- */
21008
- interface WithdrawalsApiCreateWithdrawalRequest {
21040
+ getMetadataRefreshResults(ethSigner: Signer, refreshId: string): Promise<GetMetadataRefreshResponse$1>;
21009
21041
  /**
21010
- * eth address
21011
- * @type {string}
21012
- * @memberof WithdrawalsApiCreateWithdrawal
21042
+ * Request a metadata refresh
21043
+ * @param ethSigner - the L1 signer
21044
+ * @param request the request object containing the parameters to be provided in the API request
21045
+ * @returns a promise that resolves with the requested metadata refresh
21046
+ * @throws {@link index.IMXError}
21013
21047
  */
21014
- readonly xImxEthAddress: string;
21048
+ createMetadataRefresh(ethSigner: Signer, request: CreateMetadataRefreshRequest$1): Promise<CreateMetadataRefreshResponse$1>;
21015
21049
  /**
21016
- * eth signature
21017
- * @type {string}
21018
- * @memberof WithdrawalsApiCreateWithdrawal
21050
+ * Create a Project
21051
+ * @param ethSigner - the L1 signer
21052
+ * @param request - the request object containing the parameters to be provided in the API request
21053
+ * @returns a promise that resolves with the created Project
21054
+ * @throws {@link index.IMXError}
21019
21055
  */
21020
- readonly xImxEthSignature: string;
21056
+ createProject(ethSigner: Signer, request: CreateProjectRequest$1): Promise<CreateProjectResponse$1>;
21021
21057
  /**
21022
- * create a withdrawal
21023
- * @type {CreateWithdrawalRequest}
21024
- * @memberof WithdrawalsApiCreateWithdrawal
21058
+ * Get a Project
21059
+ * @param ethSigner - the L1 signer
21060
+ * @param id - the Project ID
21061
+ * @returns a promise that resolves with the requested Project
21062
+ * @throws {@link index.IMXError}
21025
21063
  */
21026
- readonly createWithdrawalRequest: CreateWithdrawalRequest;
21027
- }
21028
- /**
21029
- * Request parameters for getSignableWithdrawal operation in WithdrawalsApi.
21030
- * @export
21031
- * @interface WithdrawalsApiGetSignableWithdrawalRequest
21032
- */
21033
- interface WithdrawalsApiGetSignableWithdrawalRequest {
21064
+ getProject(ethSigner: Signer, id: string): Promise<Project$1>;
21034
21065
  /**
21035
- * get details of signable withdrawal
21036
- * @type {GetSignableWithdrawalRequest}
21037
- * @memberof WithdrawalsApiGetSignableWithdrawal
21066
+ * Get Projects owned by the given User
21067
+ * @param ethSigner - the L1 signer
21068
+ * @param pageSize - the page size of the result
21069
+ * @param cursor - the cursor
21070
+ * @param orderBy - the property to sort by
21071
+ * @param direction - direction to sort (asc/desc)
21072
+ * @returns a promise that resolves with the requested Projects
21073
+ * @throws {@link index.IMXError}
21038
21074
  */
21039
- readonly getSignableWithdrawalRequest: GetSignableWithdrawalRequest;
21040
- }
21041
- /**
21042
- * Request parameters for getWithdrawal operation in WithdrawalsApi.
21043
- * @export
21044
- * @interface WithdrawalsApiGetWithdrawalRequest
21045
- */
21046
- interface WithdrawalsApiGetWithdrawalRequest {
21075
+ getProjects(ethSigner: Signer, pageSize?: number, cursor?: string, orderBy?: string, direction?: string): Promise<GetProjectsResponse$1>;
21047
21076
  /**
21048
- * Withdrawal ID
21049
- * @type {string}
21050
- * @memberof WithdrawalsApiGetWithdrawal
21077
+ * Get the token Balances of the User
21078
+ * @param request - the request object containing the parameters to be provided in the API request
21079
+ * @returns a promise that resolves with the requested Balance
21080
+ * @throws {@link index.IMXError}
21051
21081
  */
21052
- readonly id: string;
21053
- }
21054
- /**
21055
- * Request parameters for listWithdrawals operation in WithdrawalsApi.
21056
- * @export
21057
- * @interface WithdrawalsApiListWithdrawalsRequest
21058
- */
21059
- interface WithdrawalsApiListWithdrawalsRequest {
21082
+ getBalance(request: BalancesApiGetBalanceRequest$1): Promise<Balance$1>;
21060
21083
  /**
21061
- * Withdrawal has been transferred to user\&#39;s Layer 1 wallet
21062
- * @type {boolean}
21063
- * @memberof WithdrawalsApiListWithdrawals
21084
+ * Get a list of Balances for given User
21085
+ * @param request the request object containing the parameters to be provided in the API request
21086
+ * @returns a promise that resolves with the requested list of Balances
21087
+ * @throws {@link index.IMXError}
21064
21088
  */
21065
- readonly withdrawnToWallet?: boolean;
21089
+ listBalances(request: BalancesApiListBalancesRequest$1): Promise<ListBalancesResponse$1>;
21066
21090
  /**
21067
- * Status of the on-chain batch confirmation for this withdrawal
21068
- * @type {string}
21069
- * @memberof WithdrawalsApiListWithdrawals
21091
+ * Get details of a Mint with the given ID
21092
+ * @param request the request object containing the parameters to be provided in the API request
21093
+ * @returns a promise that resolves with the requested Mint
21094
+ * @throws {@link index.IMXError}
21070
21095
  */
21071
- readonly rollupStatus?: string;
21096
+ getMint(request: MintsApiGetMintRequest$1): Promise<Mint$1[]>;
21072
21097
  /**
21073
- * Page size of the result
21074
- * @type {number}
21075
- * @memberof WithdrawalsApiListWithdrawals
21098
+ * Get a list of Mints
21099
+ * @param request optional object containing the parameters to be provided in the API request
21100
+ * @returns a promise that resolves with the requested list of Mints
21101
+ * @throws {@link index.IMXError}
21076
21102
  */
21077
- readonly pageSize?: number;
21103
+ listMints(request?: MintsApiListMintsRequest$1): Promise<ListMintsResponse$1>;
21078
21104
  /**
21079
- * Cursor
21080
- * @type {string}
21081
- * @memberof WithdrawalsApiListWithdrawals
21105
+ * Mint tokens in a batch with fees
21106
+ * @param ethSigner - the L1 signer
21107
+ * @param request - the request object to be provided in the API request
21108
+ * @returns a promise that resolves with the minted tokens
21109
+ * @throws {@link index.IMXError}
21082
21110
  */
21083
- readonly cursor?: string;
21111
+ mint(ethSigner: Signer, request: UnsignedMintRequest): Promise<MintTokensResponse$1>;
21084
21112
  /**
21085
- * Property to sort by
21086
- * @type {string}
21087
- * @memberof WithdrawalsApiListWithdrawals
21113
+ * Get a list of Withdrawals
21114
+ * @param request - optional object containing the parameters to be provided in the API request
21115
+ * @returns a promise that resolves with the requested list of Withdrawals
21116
+ * @throws {@link index.IMXError}
21088
21117
  */
21089
- readonly orderBy?: string;
21118
+ listWithdrawals(request?: WithdrawalsApiListWithdrawalsRequest$1): Promise<ListWithdrawalsResponse$1>;
21090
21119
  /**
21091
- * Direction to sort (asc/desc)
21092
- * @type {string}
21093
- * @memberof WithdrawalsApiListWithdrawals
21120
+ * Get details of Withdrawal with the given ID
21121
+ * @param request - the request object containing the parameters to be provided in the API request
21122
+ * @returns a promise that resolves with the requested Withdrawal
21123
+ * @throws {@link index.IMXError}
21094
21124
  */
21095
- readonly direction?: string;
21125
+ getWithdrawal(request: WithdrawalsApiGetWithdrawalRequest$1): Promise<Withdrawal$1>;
21096
21126
  /**
21097
- * Ethereum address of the user who submitted this withdrawal
21098
- * @type {string}
21099
- * @memberof WithdrawalsApiListWithdrawals
21127
+ * Get details of an Order with the given ID
21128
+ * @param request - the request object containing the parameters to be provided in the API request
21129
+ * @returns a promise that resolves with the requested Order
21130
+ * @throws {@link index.IMXError}
21100
21131
  */
21101
- readonly user?: string;
21132
+ getOrder(request: OrdersApiGetOrderV3Request$1): Promise<OrderV3$1>;
21102
21133
  /**
21103
- * Status of this withdrawal
21104
- * @type {string}
21105
- * @memberof WithdrawalsApiListWithdrawals
21134
+ * Get a list of Orders
21135
+ * @param request - optional object containing the parameters to be provided in the API request
21136
+ * @returns a promise that resolves with the requested list of Orders
21137
+ * @throws {@link index.IMXError}
21106
21138
  */
21107
- readonly status?: string;
21139
+ listOrders(request?: OrdersApiListOrdersV3Request$1): Promise<ListOrdersResponseV3$1>;
21108
21140
  /**
21109
- * Minimum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
21110
- * @type {string}
21111
- * @memberof WithdrawalsApiListWithdrawals
21141
+ * Get details of a Trade with the given ID
21142
+ * @param request - the request object containing the parameters to be provided in the API request
21143
+ * @returns a promise that resolves with the requested Trade
21144
+ * @throws {@link index.IMXError}
21112
21145
  */
21113
- readonly minTimestamp?: string;
21146
+ getTrade(request: TradesApiGetTradeV3Request$1): Promise<Trade$1>;
21114
21147
  /**
21115
- * Maximum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
21116
- * @type {string}
21117
- * @memberof WithdrawalsApiListWithdrawals
21148
+ * Get a list of Trades
21149
+ * @param request - optional object containing the parameters to be provided in the API request
21150
+ * @returns a promise that resolves with the requested list of Trades
21151
+ * @throws {@link index.IMXError}
21118
21152
  */
21119
- readonly maxTimestamp?: string;
21153
+ listTrades(request?: TradesApiListTradesV3Request$1): Promise<ListTradesResponse$1>;
21120
21154
  /**
21121
- * Token type of the withdrawn asset
21122
- * @type {string}
21123
- * @memberof WithdrawalsApiListWithdrawals
21155
+ * Get details of a Token
21156
+ * @param request - the request object containing the parameters to be provided in the API request
21157
+ * @returns a promise that resolves with the requested Token
21158
+ * @throws {@link index.IMXError}
21124
21159
  */
21125
- readonly tokenType?: string;
21160
+ getToken(request: TokensApiGetTokenRequest$1): Promise<TokenDetails$1>;
21126
21161
  /**
21127
- * ERC721 Token ID of the minted asset
21128
- * @type {string}
21129
- * @memberof WithdrawalsApiListWithdrawals
21162
+ * Get a list of Tokens
21163
+ * @param request - optional object containing the parameters to be provided in the API request
21164
+ * @returns a promise that resolves with the requested list of Tokens
21165
+ * @throws {@link index.IMXError}
21130
21166
  */
21131
- readonly tokenId?: string;
21167
+ listTokens(request?: TokensApiListTokensRequest$1): Promise<ListTokensResponse$1>;
21132
21168
  /**
21133
- * Internal IMX ID of the minted asset
21134
- * @type {string}
21135
- * @memberof WithdrawalsApiListWithdrawals
21169
+ * Get details of a Transfer with the given ID
21170
+ * @param request - the request object containing the parameters to be provided in the API request
21171
+ * @returns a promise that resolves with the requested Transfer
21172
+ * @throws {@link index.IMXError}
21136
21173
  */
21137
- readonly assetId?: string;
21174
+ getTransfer(request: TransfersApiGetTransferRequest$1): Promise<Transfer$1>;
21138
21175
  /**
21139
- * Token address of the withdrawn asset
21140
- * @type {string}
21141
- * @memberof WithdrawalsApiListWithdrawals
21176
+ * Get a list of Transfers
21177
+ * @param request - optional object containing the parameters to be provided in the API request
21178
+ * @returns a promise that resolves with the requested list of Transfers
21179
+ * @throws {@link index.IMXError}
21142
21180
  */
21143
- readonly tokenAddress?: string;
21181
+ listTransfers(request?: TransfersApiListTransfersRequest$1): Promise<ListTransfersResponse$1>;
21144
21182
  /**
21145
- * Token name of the withdrawn asset
21146
- * @type {string}
21147
- * @memberof WithdrawalsApiListWithdrawals
21183
+ * Create a new Exchange transaction
21184
+ * @param request - the request object to be provided in the API request
21185
+ * @returns a promise that resolves with the created Exchange Transaction
21186
+ * @throws {@link index.IMXError}
21148
21187
  */
21149
- readonly tokenName?: string;
21188
+ createExchange(request: ExchangesApiCreateExchangeRequest$1): Promise<ExchangeCreateExchangeAndURLResponse$1>;
21150
21189
  /**
21151
- * Min quantity for the withdrawn asset
21152
- * @type {string}
21153
- * @memberof WithdrawalsApiListWithdrawals
21190
+ * Get an Exchange transaction
21191
+ * @param request - the request object to be provided in the API request
21192
+ * @returns a promise that resolves with the Exchange Transaction
21193
+ * @throws {@link index.IMXError}
21154
21194
  */
21155
- readonly minQuantity?: string;
21195
+ getExchange(request: ExchangesApiGetExchangeRequest$1): Promise<Exchange$1>;
21156
21196
  /**
21157
- * Max quantity for the withdrawn asset
21158
- * @type {string}
21159
- * @memberof WithdrawalsApiListWithdrawals
21197
+ * Get Exchange transactions
21198
+ * @param request - the request object to be provided in the API request
21199
+ * @returns a promise that resolves with Exchange Transactions
21200
+ * @throws {@link index.IMXError}
21160
21201
  */
21161
- readonly maxQuantity?: string;
21202
+ getExchanges(request: ExchangesApiGetExchangesRequest$1): Promise<GetTransactionsResponse$1>;
21162
21203
  /**
21163
- * JSON-encoded metadata filters for the withdrawn asset
21164
- * @type {string}
21165
- * @memberof WithdrawalsApiListWithdrawals
21204
+ * Create a new Transfer request
21205
+ * @param walletConnection - the pair of Eth/Stark signers
21206
+ * @param request - the request object to be provided in the API request
21207
+ * @returns a promise that resolves with the created Exchange Transfer
21208
+ * @throws {@link index.IMXError}
21166
21209
  */
21167
- readonly metadata?: string;
21168
- }
21169
- /**
21170
- * WithdrawalsApi - object-oriented interface
21171
- * @export
21172
- * @class WithdrawalsApi
21173
- * @extends {BaseAPI}
21174
- */
21175
- declare class WithdrawalsApi extends BaseAPI {
21210
+ exchangeTransfer(walletConnection: WalletConnection, request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1$1>;
21176
21211
  /**
21177
- * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
21178
- * @summary Creates a withdrawal of a token
21179
- * @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
21180
- * @param {*} [options] Override http request option.
21181
- * @throws {RequiredError}
21182
- * @memberof WithdrawalsApi
21212
+ * Create a new nft primary transaction
21213
+ * @param request - the request object to be provided in the API request
21214
+ * @returns a promise that resolves with the created nft primary Transaction
21215
+ * @throws {@link index.IMXError}
21183
21216
  */
21184
- createWithdrawal(requestParameters: WithdrawalsApiCreateWithdrawalRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateWithdrawalResponse, any>>;
21217
+ createNftPrimary(request: NftCheckoutPrimaryApiCreateNftPrimaryRequest$1): Promise<NftprimarytransactionCreateResponse$1>;
21185
21218
  /**
21186
- * Gets details of a signable withdrawal
21187
- * @summary Gets details of a signable withdrawal
21188
- * @param {WithdrawalsApiGetSignableWithdrawalRequest} requestParameters Request parameters.
21189
- * @param {*} [options] Override http request option.
21190
- * @throws {RequiredError}
21191
- * @memberof WithdrawalsApi
21219
+ * Get nft primary supported currencies and their limits
21220
+ * @param request - the request object to be provided in the API request
21221
+ * @returns a promise that resolves with nft primary Currencies
21222
+ * @throws {@link index.IMXError}
21192
21223
  */
21193
- getSignableWithdrawal(requestParameters: WithdrawalsApiGetSignableWithdrawalRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableWithdrawalResponse, any>>;
21224
+ getCurrenciesNFTCheckoutPrimary(request: NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest$1): Promise<CurrencyWithLimits$1>;
21194
21225
  /**
21195
- * Gets details of withdrawal with the given ID
21196
- * @summary Gets details of withdrawal with the given ID
21197
- * @param {WithdrawalsApiGetWithdrawalRequest} requestParameters Request parameters.
21198
- * @param {*} [options] Override http request option.
21199
- * @throws {RequiredError}
21200
- * @memberof WithdrawalsApi
21226
+ * Get nft primary transaction by transaction id
21227
+ * @param request - the request object to be provided in the API request
21228
+ * @returns a promise that resolves with nft primary transaction
21229
+ * @throws {@link index.IMXError}
21201
21230
  */
21202
- getWithdrawal(requestParameters: WithdrawalsApiGetWithdrawalRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Withdrawal, any>>;
21231
+ getNftPrimaryTransaction(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest$1): Promise<NftprimarytransactionGetResponse$1>;
21203
21232
  /**
21204
- * Get a list of withdrawals
21205
- * @summary Get a list of withdrawals
21206
- * @param {WithdrawalsApiListWithdrawalsRequest} requestParameters Request parameters.
21207
- * @param {*} [options] Override http request option.
21208
- * @throws {RequiredError}
21209
- * @memberof WithdrawalsApi
21233
+ * Get list of nft primary transactions
21234
+ * @param request - the request object to be provided in the API request
21235
+ * @returns a promise that resolves with nft primary transaction
21236
+ * @throws {@link index.IMXError}
21210
21237
  */
21211
- listWithdrawals(requestParameters?: WithdrawalsApiListWithdrawalsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListWithdrawalsResponse, any>>;
21212
- }
21213
-
21214
- /**
21215
- * Configuration for generated clients
21216
- */
21217
- type ImmutableAPIConfiguration = Configuration;
21218
-
21219
- declare class ImxApiClients {
21220
- config: ImmutableAPIConfiguration;
21221
- assetApi: AssetsApi;
21222
- balanceApi: BalancesApi;
21223
- collectionApi: CollectionsApi;
21224
- depositsApi: DepositsApi;
21225
- encodingApi: EncodingApi;
21226
- exchangeApi: ExchangesApi;
21227
- metadataApi: MetadataApi;
21228
- metadataRefreshesApi: MetadataRefreshesApi;
21229
- mintsApi: MintsApi;
21230
- nftCheckoutPrimaryApi: NftCheckoutPrimaryApi;
21231
- ordersApi: OrdersApi;
21232
- projectsApi: ProjectsApi;
21233
- tokensApi: TokensApi;
21234
- tradesApi: TradesApi;
21235
- transfersApi: TransfersApi;
21236
- usersApi: UsersApi;
21237
- withdrawalsApi: WithdrawalsApi;
21238
- constructor(config: ImmutableAPIConfiguration);
21238
+ getNftPrimaryTransactions(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest$1): Promise<NftprimarytransactionListTransactionsResponse$1>;
21239
21239
  }
21240
21240
 
21241
21241
  type UserProfile = {
@@ -21258,12 +21258,12 @@ interface PassportOverrides {
21258
21258
  passportDomain: string;
21259
21259
  imxPublicApiDomain: string;
21260
21260
  immutableXClient: IMXClient;
21261
- imxApiClients: ImxApiClients;
21262
21261
  zkEvmRpcUrl: string;
21263
21262
  relayerUrl: string;
21264
21263
  indexerMrBasePath: string;
21265
21264
  orderBookMrBasePath: string;
21266
21265
  passportMrBasePath: string;
21266
+ imxApiClients?: ImxApiClients;
21267
21267
  }
21268
21268
  interface PassportModuleConfiguration extends ModuleConfiguration<PassportOverrides>, OidcConfiguration {
21269
21269
  /**