@imtbl/sdk 1.4.1 → 1.4.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.
- package/dist/blockchain_data.js +2 -2
- package/dist/browser/checkout/sdk.js +4 -4
- package/dist/browser/checkout/widgets.js +4 -4
- package/dist/checkout.d.ts +1424 -1418
- package/dist/checkout.js +7 -4
- package/dist/config.js +1 -1
- package/dist/index.browser.js +6 -6
- package/dist/index.browser.js.map +1 -1
- package/dist/index.cjs +64 -30
- package/dist/index.d.ts +8 -2
- package/dist/index.js +64 -30
- package/dist/orderbook.js +1 -1
- package/dist/passport.d.ts +1417 -1417
- package/dist/passport.js +58 -27
- package/dist/x.js +2 -2
- package/package.json +1 -1
package/dist/passport.d.ts
CHANGED
|
@@ -9840,358 +9840,6 @@ interface ModuleConfiguration<T> {
|
|
|
9840
9840
|
overrides?: T;
|
|
9841
9841
|
}
|
|
9842
9842
|
|
|
9843
|
-
interface ImxOverrides {
|
|
9844
|
-
immutableXConfig: ImmutableXConfiguration;
|
|
9845
|
-
}
|
|
9846
|
-
interface ImxModuleConfiguration extends ModuleConfiguration<ImxOverrides> {
|
|
9847
|
-
}
|
|
9848
|
-
|
|
9849
|
-
declare class IMXClient {
|
|
9850
|
-
private immutableX;
|
|
9851
|
-
depositsApi: DepositsApi$1;
|
|
9852
|
-
mintsApi: MintsApi$1;
|
|
9853
|
-
ordersApi: OrdersApi$1;
|
|
9854
|
-
tokensApi: TokensApi$1;
|
|
9855
|
-
tradesApi: TradesApi$1;
|
|
9856
|
-
transfersApi: TransfersApi$1;
|
|
9857
|
-
exchangeApi: ExchangesApi$1;
|
|
9858
|
-
nftCheckoutPrimaryApi: NftCheckoutPrimaryApi$1;
|
|
9859
|
-
usersApi: UsersApi$1;
|
|
9860
|
-
withdrawalsApi: WithdrawalsApi$1;
|
|
9861
|
-
balanceApi: BalancesApi$1;
|
|
9862
|
-
assetApi: AssetsApi$1;
|
|
9863
|
-
collectionApi: CollectionsApi$1;
|
|
9864
|
-
metadataApi: MetadataApi$1;
|
|
9865
|
-
metadataRefreshesApi: MetadataRefreshesApi$1;
|
|
9866
|
-
projectsApi: ProjectsApi$1;
|
|
9867
|
-
constructor(config: ImxModuleConfiguration);
|
|
9868
|
-
/**
|
|
9869
|
-
* Get details of a Deposit with the given ID
|
|
9870
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
9871
|
-
* @returns a promise that resolves with the requested Deposit
|
|
9872
|
-
* @throws {@link index.IMXError}
|
|
9873
|
-
*/
|
|
9874
|
-
getDeposit(request: DepositsApiGetDepositRequest$1): Promise<Deposit$1>;
|
|
9875
|
-
/**
|
|
9876
|
-
* Get a list of Deposits
|
|
9877
|
-
* @param request - optional object containing the parameters to be provided in the API request
|
|
9878
|
-
* @returns a promise that resolves with the requested list of Deposits
|
|
9879
|
-
* @throws {@link index.IMXError}
|
|
9880
|
-
*/
|
|
9881
|
-
listDeposits(request?: DepositsApiListDepositsRequest$1): Promise<ListDepositsResponse$1>;
|
|
9882
|
-
/**
|
|
9883
|
-
* Get Stark keys for a registered User
|
|
9884
|
-
* @param ethAddress - the eth address of the User
|
|
9885
|
-
* @returns a promise that resolves with the requested User
|
|
9886
|
-
* @throws {@link index.IMXError}
|
|
9887
|
-
*/
|
|
9888
|
-
getUser(ethAddress: string): Promise<GetUsersApiResponse$1>;
|
|
9889
|
-
/**
|
|
9890
|
-
* Get details of an Asset
|
|
9891
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
9892
|
-
* @returns a promise that resolves with the requested Asset
|
|
9893
|
-
* @throws {@link index.IMXError}
|
|
9894
|
-
*/
|
|
9895
|
-
getAsset(request: AssetsApiGetAssetRequest$1): Promise<Asset$1>;
|
|
9896
|
-
/**
|
|
9897
|
-
* Get a list of Assets
|
|
9898
|
-
* @param request - optional object containing the parameters to be provided in the API request
|
|
9899
|
-
* @returns a promise that resolves with the requested list of Assets
|
|
9900
|
-
* @throws {@link index.IMXError}
|
|
9901
|
-
*/
|
|
9902
|
-
listAssets(request?: AssetsApiListAssetsRequest$1): Promise<ListAssetsResponse$1>;
|
|
9903
|
-
/**
|
|
9904
|
-
* Create a Collection
|
|
9905
|
-
* @param ethSigner - the L1 signer
|
|
9906
|
-
* @param request - the request object to be provided in the API request
|
|
9907
|
-
* @returns a promise that resolves with the created Collection
|
|
9908
|
-
* @throws {@link index.IMXError}
|
|
9909
|
-
*/
|
|
9910
|
-
createCollection(ethSigner: Signer, request: CreateCollectionRequest$1): Promise<Collection$1>;
|
|
9911
|
-
/**
|
|
9912
|
-
* Get details of a Collection at the given address
|
|
9913
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
9914
|
-
* @returns a promise that resolves with the requested Collection
|
|
9915
|
-
* @throws {@link index.IMXError}
|
|
9916
|
-
*/
|
|
9917
|
-
getCollection(request: CollectionsApiGetCollectionRequest$1): Promise<Collection$1>;
|
|
9918
|
-
/**
|
|
9919
|
-
* Get a list of Collection filters
|
|
9920
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
9921
|
-
* @returns a promise that resolves with the requested list of Collection Filters
|
|
9922
|
-
* @throws {@link index.IMXError}
|
|
9923
|
-
*/
|
|
9924
|
-
listCollectionFilters(request: CollectionsApiListCollectionFiltersRequest$1): Promise<CollectionFilter$1>;
|
|
9925
|
-
/**
|
|
9926
|
-
* Get a list of Collections
|
|
9927
|
-
* @param request - optional object containing the parameters to be provided in the API request
|
|
9928
|
-
* @returns a promise that resolves with the requested list of Collections
|
|
9929
|
-
* @throws {@link index.IMXError}
|
|
9930
|
-
*/
|
|
9931
|
-
listCollections(request?: CollectionsApiListCollectionsRequest$1): Promise<ListCollectionsResponse$1>;
|
|
9932
|
-
/**
|
|
9933
|
-
* Update a Collection
|
|
9934
|
-
* @param ethSigner - the L1 signer
|
|
9935
|
-
* @param collectionAddress - the Collection contract address
|
|
9936
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
9937
|
-
* @returns a promise that resolves with the updated Collection
|
|
9938
|
-
* @throws {@link index.IMXError}
|
|
9939
|
-
*/
|
|
9940
|
-
updateCollection(ethSigner: Signer, collectionAddress: string, request: UpdateCollectionRequest$1): Promise<Collection$1>;
|
|
9941
|
-
/**
|
|
9942
|
-
* Add metadata schema to Collection
|
|
9943
|
-
* @param ethSigner - the L1 signer
|
|
9944
|
-
* @param collectionAddress - the Collection contract address
|
|
9945
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
9946
|
-
* @returns a promise that resolves with the SuccessResponse if successful
|
|
9947
|
-
* @throws {@link index.IMXError}
|
|
9948
|
-
*/
|
|
9949
|
-
addMetadataSchemaToCollection(ethSigner: Signer, collectionAddress: string, request: AddMetadataSchemaToCollectionRequest$1): Promise<SuccessResponse$1>;
|
|
9950
|
-
/**
|
|
9951
|
-
* Get Metadata schema
|
|
9952
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
9953
|
-
* @returns a promise that resolves with the requested Metadata schema
|
|
9954
|
-
* @throws {@link index.IMXError}
|
|
9955
|
-
*/
|
|
9956
|
-
getMetadataSchema(request: MetadataApiGetMetadataSchemaRequest$1): Promise<MetadataSchemaProperty$1[]>;
|
|
9957
|
-
/**
|
|
9958
|
-
* Update metadata schema by name
|
|
9959
|
-
* @param ethSigner - the L1 signer
|
|
9960
|
-
* @param collectionAddress - the Collection contract address
|
|
9961
|
-
* @param name - the Metadata schema name
|
|
9962
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
9963
|
-
* @returns a promise that resolves with the SuccessResponse if successful
|
|
9964
|
-
* @throws {@link index.IMXError}
|
|
9965
|
-
*/
|
|
9966
|
-
updateMetadataSchemaByName(ethSigner: Signer, collectionAddress: string, name: string, request: MetadataSchemaRequest$1): Promise<SuccessResponse$1>;
|
|
9967
|
-
/**
|
|
9968
|
-
* Get a list of metadata refreshes
|
|
9969
|
-
* @param ethSigner - the L1 signer
|
|
9970
|
-
* @param collectionAddress - the Collection contract address
|
|
9971
|
-
* @param pageSize - the page size of the result
|
|
9972
|
-
* @param cursor - the cursor
|
|
9973
|
-
* @returns a promise that resolves with the requested metadata refreshes
|
|
9974
|
-
* @throws {@link index.IMXError}
|
|
9975
|
-
*/
|
|
9976
|
-
listMetadataRefreshes(ethSigner: Signer, collectionAddress?: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshes$1>;
|
|
9977
|
-
/**
|
|
9978
|
-
* Get a list of metadata refresh errors
|
|
9979
|
-
* @param ethSigner - the L1 signer
|
|
9980
|
-
* @param refreshId - the metadata refresh ID
|
|
9981
|
-
* @param pageSize - the page size of the result
|
|
9982
|
-
* @param cursor - the cursor
|
|
9983
|
-
* @returns a promise that resolves with the requested metadata refresh errors
|
|
9984
|
-
* @throws {@link index.IMXError}
|
|
9985
|
-
*/
|
|
9986
|
-
getMetadataRefreshErrors(ethSigner: Signer, refreshId: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshErrorsResponse$1>;
|
|
9987
|
-
/**
|
|
9988
|
-
* Get a list of metadata refresh results
|
|
9989
|
-
* @param ethSigner - the L1 signer
|
|
9990
|
-
* @param refreshId - the metadata refresh ID
|
|
9991
|
-
* @returns a promise that resolves with the requested metadata refresh results
|
|
9992
|
-
* @throws {@link index.IMXError}
|
|
9993
|
-
*/
|
|
9994
|
-
getMetadataRefreshResults(ethSigner: Signer, refreshId: string): Promise<GetMetadataRefreshResponse$1>;
|
|
9995
|
-
/**
|
|
9996
|
-
* Request a metadata refresh
|
|
9997
|
-
* @param ethSigner - the L1 signer
|
|
9998
|
-
* @param request the request object containing the parameters to be provided in the API request
|
|
9999
|
-
* @returns a promise that resolves with the requested metadata refresh
|
|
10000
|
-
* @throws {@link index.IMXError}
|
|
10001
|
-
*/
|
|
10002
|
-
createMetadataRefresh(ethSigner: Signer, request: CreateMetadataRefreshRequest$1): Promise<CreateMetadataRefreshResponse$1>;
|
|
10003
|
-
/**
|
|
10004
|
-
* Create a Project
|
|
10005
|
-
* @param ethSigner - the L1 signer
|
|
10006
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
10007
|
-
* @returns a promise that resolves with the created Project
|
|
10008
|
-
* @throws {@link index.IMXError}
|
|
10009
|
-
*/
|
|
10010
|
-
createProject(ethSigner: Signer, request: CreateProjectRequest$1): Promise<CreateProjectResponse$1>;
|
|
10011
|
-
/**
|
|
10012
|
-
* Get a Project
|
|
10013
|
-
* @param ethSigner - the L1 signer
|
|
10014
|
-
* @param id - the Project ID
|
|
10015
|
-
* @returns a promise that resolves with the requested Project
|
|
10016
|
-
* @throws {@link index.IMXError}
|
|
10017
|
-
*/
|
|
10018
|
-
getProject(ethSigner: Signer, id: string): Promise<Project$1>;
|
|
10019
|
-
/**
|
|
10020
|
-
* Get Projects owned by the given User
|
|
10021
|
-
* @param ethSigner - the L1 signer
|
|
10022
|
-
* @param pageSize - the page size of the result
|
|
10023
|
-
* @param cursor - the cursor
|
|
10024
|
-
* @param orderBy - the property to sort by
|
|
10025
|
-
* @param direction - direction to sort (asc/desc)
|
|
10026
|
-
* @returns a promise that resolves with the requested Projects
|
|
10027
|
-
* @throws {@link index.IMXError}
|
|
10028
|
-
*/
|
|
10029
|
-
getProjects(ethSigner: Signer, pageSize?: number, cursor?: string, orderBy?: string, direction?: string): Promise<GetProjectsResponse$1>;
|
|
10030
|
-
/**
|
|
10031
|
-
* Get the token Balances of the User
|
|
10032
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
10033
|
-
* @returns a promise that resolves with the requested Balance
|
|
10034
|
-
* @throws {@link index.IMXError}
|
|
10035
|
-
*/
|
|
10036
|
-
getBalance(request: BalancesApiGetBalanceRequest$1): Promise<Balance$1>;
|
|
10037
|
-
/**
|
|
10038
|
-
* Get a list of Balances for given User
|
|
10039
|
-
* @param request the request object containing the parameters to be provided in the API request
|
|
10040
|
-
* @returns a promise that resolves with the requested list of Balances
|
|
10041
|
-
* @throws {@link index.IMXError}
|
|
10042
|
-
*/
|
|
10043
|
-
listBalances(request: BalancesApiListBalancesRequest$1): Promise<ListBalancesResponse$1>;
|
|
10044
|
-
/**
|
|
10045
|
-
* Get details of a Mint with the given ID
|
|
10046
|
-
* @param request the request object containing the parameters to be provided in the API request
|
|
10047
|
-
* @returns a promise that resolves with the requested Mint
|
|
10048
|
-
* @throws {@link index.IMXError}
|
|
10049
|
-
*/
|
|
10050
|
-
getMint(request: MintsApiGetMintRequest$1): Promise<Mint$1[]>;
|
|
10051
|
-
/**
|
|
10052
|
-
* Get a list of Mints
|
|
10053
|
-
* @param request optional object containing the parameters to be provided in the API request
|
|
10054
|
-
* @returns a promise that resolves with the requested list of Mints
|
|
10055
|
-
* @throws {@link index.IMXError}
|
|
10056
|
-
*/
|
|
10057
|
-
listMints(request?: MintsApiListMintsRequest$1): Promise<ListMintsResponse$1>;
|
|
10058
|
-
/**
|
|
10059
|
-
* Mint tokens in a batch with fees
|
|
10060
|
-
* @param ethSigner - the L1 signer
|
|
10061
|
-
* @param request - the request object to be provided in the API request
|
|
10062
|
-
* @returns a promise that resolves with the minted tokens
|
|
10063
|
-
* @throws {@link index.IMXError}
|
|
10064
|
-
*/
|
|
10065
|
-
mint(ethSigner: Signer, request: UnsignedMintRequest): Promise<MintTokensResponse$1>;
|
|
10066
|
-
/**
|
|
10067
|
-
* Get a list of Withdrawals
|
|
10068
|
-
* @param request - optional object containing the parameters to be provided in the API request
|
|
10069
|
-
* @returns a promise that resolves with the requested list of Withdrawals
|
|
10070
|
-
* @throws {@link index.IMXError}
|
|
10071
|
-
*/
|
|
10072
|
-
listWithdrawals(request?: WithdrawalsApiListWithdrawalsRequest$1): Promise<ListWithdrawalsResponse$1>;
|
|
10073
|
-
/**
|
|
10074
|
-
* Get details of Withdrawal with the given ID
|
|
10075
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
10076
|
-
* @returns a promise that resolves with the requested Withdrawal
|
|
10077
|
-
* @throws {@link index.IMXError}
|
|
10078
|
-
*/
|
|
10079
|
-
getWithdrawal(request: WithdrawalsApiGetWithdrawalRequest$1): Promise<Withdrawal$1>;
|
|
10080
|
-
/**
|
|
10081
|
-
* Get details of an Order with the given ID
|
|
10082
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
10083
|
-
* @returns a promise that resolves with the requested Order
|
|
10084
|
-
* @throws {@link index.IMXError}
|
|
10085
|
-
*/
|
|
10086
|
-
getOrder(request: OrdersApiGetOrderV3Request$1): Promise<OrderV3$1>;
|
|
10087
|
-
/**
|
|
10088
|
-
* Get a list of Orders
|
|
10089
|
-
* @param request - optional object containing the parameters to be provided in the API request
|
|
10090
|
-
* @returns a promise that resolves with the requested list of Orders
|
|
10091
|
-
* @throws {@link index.IMXError}
|
|
10092
|
-
*/
|
|
10093
|
-
listOrders(request?: OrdersApiListOrdersV3Request$1): Promise<ListOrdersResponseV3$1>;
|
|
10094
|
-
/**
|
|
10095
|
-
* Get details of a Trade with the given ID
|
|
10096
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
10097
|
-
* @returns a promise that resolves with the requested Trade
|
|
10098
|
-
* @throws {@link index.IMXError}
|
|
10099
|
-
*/
|
|
10100
|
-
getTrade(request: TradesApiGetTradeV3Request$1): Promise<Trade$1>;
|
|
10101
|
-
/**
|
|
10102
|
-
* Get a list of Trades
|
|
10103
|
-
* @param request - optional object containing the parameters to be provided in the API request
|
|
10104
|
-
* @returns a promise that resolves with the requested list of Trades
|
|
10105
|
-
* @throws {@link index.IMXError}
|
|
10106
|
-
*/
|
|
10107
|
-
listTrades(request?: TradesApiListTradesV3Request$1): Promise<ListTradesResponse$1>;
|
|
10108
|
-
/**
|
|
10109
|
-
* Get details of a Token
|
|
10110
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
10111
|
-
* @returns a promise that resolves with the requested Token
|
|
10112
|
-
* @throws {@link index.IMXError}
|
|
10113
|
-
*/
|
|
10114
|
-
getToken(request: TokensApiGetTokenRequest$1): Promise<TokenDetails$1>;
|
|
10115
|
-
/**
|
|
10116
|
-
* Get a list of Tokens
|
|
10117
|
-
* @param request - optional object containing the parameters to be provided in the API request
|
|
10118
|
-
* @returns a promise that resolves with the requested list of Tokens
|
|
10119
|
-
* @throws {@link index.IMXError}
|
|
10120
|
-
*/
|
|
10121
|
-
listTokens(request?: TokensApiListTokensRequest$1): Promise<ListTokensResponse$1>;
|
|
10122
|
-
/**
|
|
10123
|
-
* Get details of a Transfer with the given ID
|
|
10124
|
-
* @param request - the request object containing the parameters to be provided in the API request
|
|
10125
|
-
* @returns a promise that resolves with the requested Transfer
|
|
10126
|
-
* @throws {@link index.IMXError}
|
|
10127
|
-
*/
|
|
10128
|
-
getTransfer(request: TransfersApiGetTransferRequest$1): Promise<Transfer$1>;
|
|
10129
|
-
/**
|
|
10130
|
-
* Get a list of Transfers
|
|
10131
|
-
* @param request - optional object containing the parameters to be provided in the API request
|
|
10132
|
-
* @returns a promise that resolves with the requested list of Transfers
|
|
10133
|
-
* @throws {@link index.IMXError}
|
|
10134
|
-
*/
|
|
10135
|
-
listTransfers(request?: TransfersApiListTransfersRequest$1): Promise<ListTransfersResponse$1>;
|
|
10136
|
-
/**
|
|
10137
|
-
* Create a new Exchange transaction
|
|
10138
|
-
* @param request - the request object to be provided in the API request
|
|
10139
|
-
* @returns a promise that resolves with the created Exchange Transaction
|
|
10140
|
-
* @throws {@link index.IMXError}
|
|
10141
|
-
*/
|
|
10142
|
-
createExchange(request: ExchangesApiCreateExchangeRequest$1): Promise<ExchangeCreateExchangeAndURLResponse$1>;
|
|
10143
|
-
/**
|
|
10144
|
-
* Get an Exchange transaction
|
|
10145
|
-
* @param request - the request object to be provided in the API request
|
|
10146
|
-
* @returns a promise that resolves with the Exchange Transaction
|
|
10147
|
-
* @throws {@link index.IMXError}
|
|
10148
|
-
*/
|
|
10149
|
-
getExchange(request: ExchangesApiGetExchangeRequest$1): Promise<Exchange$1>;
|
|
10150
|
-
/**
|
|
10151
|
-
* Get Exchange transactions
|
|
10152
|
-
* @param request - the request object to be provided in the API request
|
|
10153
|
-
* @returns a promise that resolves with Exchange Transactions
|
|
10154
|
-
* @throws {@link index.IMXError}
|
|
10155
|
-
*/
|
|
10156
|
-
getExchanges(request: ExchangesApiGetExchangesRequest$1): Promise<GetTransactionsResponse$1>;
|
|
10157
|
-
/**
|
|
10158
|
-
* Create a new Transfer request
|
|
10159
|
-
* @param walletConnection - the pair of Eth/Stark signers
|
|
10160
|
-
* @param request - the request object to be provided in the API request
|
|
10161
|
-
* @returns a promise that resolves with the created Exchange Transfer
|
|
10162
|
-
* @throws {@link index.IMXError}
|
|
10163
|
-
*/
|
|
10164
|
-
exchangeTransfer(walletConnection: WalletConnection, request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1$1>;
|
|
10165
|
-
/**
|
|
10166
|
-
* Create a new nft primary transaction
|
|
10167
|
-
* @param request - the request object to be provided in the API request
|
|
10168
|
-
* @returns a promise that resolves with the created nft primary Transaction
|
|
10169
|
-
* @throws {@link index.IMXError}
|
|
10170
|
-
*/
|
|
10171
|
-
createNftPrimary(request: NftCheckoutPrimaryApiCreateNftPrimaryRequest$1): Promise<NftprimarytransactionCreateResponse$1>;
|
|
10172
|
-
/**
|
|
10173
|
-
* Get nft primary supported currencies and their limits
|
|
10174
|
-
* @param request - the request object to be provided in the API request
|
|
10175
|
-
* @returns a promise that resolves with nft primary Currencies
|
|
10176
|
-
* @throws {@link index.IMXError}
|
|
10177
|
-
*/
|
|
10178
|
-
getCurrenciesNFTCheckoutPrimary(request: NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest$1): Promise<CurrencyWithLimits$1>;
|
|
10179
|
-
/**
|
|
10180
|
-
* Get nft primary transaction by transaction id
|
|
10181
|
-
* @param request - the request object to be provided in the API request
|
|
10182
|
-
* @returns a promise that resolves with nft primary transaction
|
|
10183
|
-
* @throws {@link index.IMXError}
|
|
10184
|
-
*/
|
|
10185
|
-
getNftPrimaryTransaction(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest$1): Promise<NftprimarytransactionGetResponse$1>;
|
|
10186
|
-
/**
|
|
10187
|
-
* Get list of nft primary transactions
|
|
10188
|
-
* @param request - the request object to be provided in the API request
|
|
10189
|
-
* @returns a promise that resolves with nft primary transaction
|
|
10190
|
-
* @throws {@link index.IMXError}
|
|
10191
|
-
*/
|
|
10192
|
-
getNftPrimaryTransactions(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest$1): Promise<NftprimarytransactionListTransactionsResponse$1>;
|
|
10193
|
-
}
|
|
10194
|
-
|
|
10195
9843
|
// TypeScript Version: 4.7
|
|
10196
9844
|
type AxiosHeaderValue = AxiosHeaders | string | string[] | number | boolean | null;
|
|
10197
9845
|
|
|
@@ -19137,1820 +18785,2172 @@ interface OrdersApiGetSignableOrderRequest {
|
|
|
19137
18785
|
* @type {GetSignableOrderRequestV3}
|
|
19138
18786
|
* @memberof OrdersApiGetSignableOrder
|
|
19139
18787
|
*/
|
|
19140
|
-
readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
|
|
18788
|
+
readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
|
|
18789
|
+
}
|
|
18790
|
+
/**
|
|
18791
|
+
* Request parameters for listOrders operation in OrdersApi.
|
|
18792
|
+
* @export
|
|
18793
|
+
* @interface OrdersApiListOrdersRequest
|
|
18794
|
+
*/
|
|
18795
|
+
interface OrdersApiListOrdersRequest {
|
|
18796
|
+
/**
|
|
18797
|
+
* Page size of the result
|
|
18798
|
+
* @type {number}
|
|
18799
|
+
* @memberof OrdersApiListOrders
|
|
18800
|
+
*/
|
|
18801
|
+
readonly pageSize?: number;
|
|
18802
|
+
/**
|
|
18803
|
+
* Cursor
|
|
18804
|
+
* @type {string}
|
|
18805
|
+
* @memberof OrdersApiListOrders
|
|
18806
|
+
*/
|
|
18807
|
+
readonly cursor?: string;
|
|
18808
|
+
/**
|
|
18809
|
+
* Property to sort by
|
|
18810
|
+
* @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
|
|
18811
|
+
* @memberof OrdersApiListOrders
|
|
18812
|
+
*/
|
|
18813
|
+
readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
|
|
18814
|
+
/**
|
|
18815
|
+
* Direction to sort (asc/desc)
|
|
18816
|
+
* @type {string}
|
|
18817
|
+
* @memberof OrdersApiListOrders
|
|
18818
|
+
*/
|
|
18819
|
+
readonly direction?: string;
|
|
18820
|
+
/**
|
|
18821
|
+
* Ethereum address of the user who submitted this order
|
|
18822
|
+
* @type {string}
|
|
18823
|
+
* @memberof OrdersApiListOrders
|
|
18824
|
+
*/
|
|
18825
|
+
readonly user?: string;
|
|
18826
|
+
/**
|
|
18827
|
+
* Status of this order
|
|
18828
|
+
* @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
|
|
18829
|
+
* @memberof OrdersApiListOrders
|
|
18830
|
+
*/
|
|
18831
|
+
readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
|
|
18832
|
+
/**
|
|
18833
|
+
* Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
18834
|
+
* @type {string}
|
|
18835
|
+
* @memberof OrdersApiListOrders
|
|
18836
|
+
*/
|
|
18837
|
+
readonly minTimestamp?: string;
|
|
18838
|
+
/**
|
|
18839
|
+
* Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
18840
|
+
* @type {string}
|
|
18841
|
+
* @memberof OrdersApiListOrders
|
|
18842
|
+
*/
|
|
18843
|
+
readonly maxTimestamp?: string;
|
|
18844
|
+
/**
|
|
18845
|
+
* Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
18846
|
+
* @type {string}
|
|
18847
|
+
* @memberof OrdersApiListOrders
|
|
18848
|
+
*/
|
|
18849
|
+
readonly updatedMinTimestamp?: string;
|
|
18850
|
+
/**
|
|
18851
|
+
* Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
18852
|
+
* @type {string}
|
|
18853
|
+
* @memberof OrdersApiListOrders
|
|
18854
|
+
*/
|
|
18855
|
+
readonly updatedMaxTimestamp?: string;
|
|
18856
|
+
/**
|
|
18857
|
+
* Token type of the asset this order buys
|
|
18858
|
+
* @type {string}
|
|
18859
|
+
* @memberof OrdersApiListOrders
|
|
18860
|
+
*/
|
|
18861
|
+
readonly buyTokenType?: string;
|
|
18862
|
+
/**
|
|
18863
|
+
* ERC721 Token ID of the asset this order buys
|
|
18864
|
+
* @type {string}
|
|
18865
|
+
* @memberof OrdersApiListOrders
|
|
18866
|
+
*/
|
|
18867
|
+
readonly buyTokenId?: string;
|
|
18868
|
+
/**
|
|
18869
|
+
* Internal IMX ID of the asset this order buys
|
|
18870
|
+
* @type {string}
|
|
18871
|
+
* @memberof OrdersApiListOrders
|
|
18872
|
+
*/
|
|
18873
|
+
readonly buyAssetId?: string;
|
|
18874
|
+
/**
|
|
18875
|
+
* Token address of the asset this order buys
|
|
18876
|
+
* @type {string}
|
|
18877
|
+
* @memberof OrdersApiListOrders
|
|
18878
|
+
*/
|
|
18879
|
+
readonly buyTokenAddress?: string;
|
|
18880
|
+
/**
|
|
18881
|
+
* Token name of the asset this order buys
|
|
18882
|
+
* @type {string}
|
|
18883
|
+
* @memberof OrdersApiListOrders
|
|
18884
|
+
*/
|
|
18885
|
+
readonly buyTokenName?: string;
|
|
18886
|
+
/**
|
|
18887
|
+
* Min quantity for the asset this order buys
|
|
18888
|
+
* @type {string}
|
|
18889
|
+
* @memberof OrdersApiListOrders
|
|
18890
|
+
*/
|
|
18891
|
+
readonly buyMinQuantity?: string;
|
|
18892
|
+
/**
|
|
18893
|
+
* Max quantity for the asset this order buys
|
|
18894
|
+
* @type {string}
|
|
18895
|
+
* @memberof OrdersApiListOrders
|
|
18896
|
+
*/
|
|
18897
|
+
readonly buyMaxQuantity?: string;
|
|
18898
|
+
/**
|
|
18899
|
+
* JSON-encoded metadata filters for the asset this order buys
|
|
18900
|
+
* @type {string}
|
|
18901
|
+
* @memberof OrdersApiListOrders
|
|
18902
|
+
*/
|
|
18903
|
+
readonly buyMetadata?: string;
|
|
18904
|
+
/**
|
|
18905
|
+
* Token type of the asset this order sells
|
|
18906
|
+
* @type {string}
|
|
18907
|
+
* @memberof OrdersApiListOrders
|
|
18908
|
+
*/
|
|
18909
|
+
readonly sellTokenType?: string;
|
|
18910
|
+
/**
|
|
18911
|
+
* ERC721 Token ID of the asset this order sells
|
|
18912
|
+
* @type {string}
|
|
18913
|
+
* @memberof OrdersApiListOrders
|
|
18914
|
+
*/
|
|
18915
|
+
readonly sellTokenId?: string;
|
|
18916
|
+
/**
|
|
18917
|
+
* Internal IMX ID of the asset this order sells
|
|
18918
|
+
* @type {string}
|
|
18919
|
+
* @memberof OrdersApiListOrders
|
|
18920
|
+
*/
|
|
18921
|
+
readonly sellAssetId?: string;
|
|
18922
|
+
/**
|
|
18923
|
+
* Token address of the asset this order sells
|
|
18924
|
+
* @type {string}
|
|
18925
|
+
* @memberof OrdersApiListOrders
|
|
18926
|
+
*/
|
|
18927
|
+
readonly sellTokenAddress?: string;
|
|
18928
|
+
/**
|
|
18929
|
+
* Token name of the asset this order sells
|
|
18930
|
+
* @type {string}
|
|
18931
|
+
* @memberof OrdersApiListOrders
|
|
18932
|
+
*/
|
|
18933
|
+
readonly sellTokenName?: string;
|
|
18934
|
+
/**
|
|
18935
|
+
* Min quantity for the asset this order sells
|
|
18936
|
+
* @type {string}
|
|
18937
|
+
* @memberof OrdersApiListOrders
|
|
18938
|
+
*/
|
|
18939
|
+
readonly sellMinQuantity?: string;
|
|
18940
|
+
/**
|
|
18941
|
+
* Max quantity for the asset this order sells
|
|
18942
|
+
* @type {string}
|
|
18943
|
+
* @memberof OrdersApiListOrders
|
|
18944
|
+
*/
|
|
18945
|
+
readonly sellMaxQuantity?: string;
|
|
18946
|
+
/**
|
|
18947
|
+
* JSON-encoded metadata filters for the asset this order sells
|
|
18948
|
+
* @type {string}
|
|
18949
|
+
* @memberof OrdersApiListOrders
|
|
18950
|
+
*/
|
|
18951
|
+
readonly sellMetadata?: string;
|
|
18952
|
+
/**
|
|
18953
|
+
* Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
|
|
18954
|
+
* @type {string}
|
|
18955
|
+
* @memberof OrdersApiListOrders
|
|
18956
|
+
*/
|
|
18957
|
+
readonly auxiliaryFeePercentages?: string;
|
|
18958
|
+
/**
|
|
18959
|
+
* Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
|
|
18960
|
+
* @type {string}
|
|
18961
|
+
* @memberof OrdersApiListOrders
|
|
18962
|
+
*/
|
|
18963
|
+
readonly auxiliaryFeeRecipients?: string;
|
|
18964
|
+
/**
|
|
18965
|
+
* Set flag to true to include fee object for orders
|
|
18966
|
+
* @type {boolean}
|
|
18967
|
+
* @memberof OrdersApiListOrders
|
|
18968
|
+
*/
|
|
18969
|
+
readonly includeFees?: boolean;
|
|
19141
18970
|
}
|
|
19142
18971
|
/**
|
|
19143
|
-
* Request parameters for
|
|
18972
|
+
* Request parameters for listOrdersV3 operation in OrdersApi.
|
|
19144
18973
|
* @export
|
|
19145
|
-
* @interface
|
|
18974
|
+
* @interface OrdersApiListOrdersV3Request
|
|
19146
18975
|
*/
|
|
19147
|
-
interface
|
|
18976
|
+
interface OrdersApiListOrdersV3Request {
|
|
19148
18977
|
/**
|
|
19149
18978
|
* Page size of the result
|
|
19150
18979
|
* @type {number}
|
|
19151
|
-
* @memberof
|
|
18980
|
+
* @memberof OrdersApiListOrdersV3
|
|
19152
18981
|
*/
|
|
19153
18982
|
readonly pageSize?: number;
|
|
19154
18983
|
/**
|
|
19155
18984
|
* Cursor
|
|
19156
18985
|
* @type {string}
|
|
19157
|
-
* @memberof
|
|
18986
|
+
* @memberof OrdersApiListOrdersV3
|
|
19158
18987
|
*/
|
|
19159
18988
|
readonly cursor?: string;
|
|
19160
18989
|
/**
|
|
19161
18990
|
* Property to sort by
|
|
19162
18991
|
* @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
|
|
19163
|
-
* @memberof
|
|
18992
|
+
* @memberof OrdersApiListOrdersV3
|
|
19164
18993
|
*/
|
|
19165
18994
|
readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
|
|
19166
18995
|
/**
|
|
19167
18996
|
* Direction to sort (asc/desc)
|
|
19168
18997
|
* @type {string}
|
|
19169
|
-
* @memberof
|
|
18998
|
+
* @memberof OrdersApiListOrdersV3
|
|
19170
18999
|
*/
|
|
19171
19000
|
readonly direction?: string;
|
|
19172
19001
|
/**
|
|
19173
19002
|
* Ethereum address of the user who submitted this order
|
|
19174
19003
|
* @type {string}
|
|
19175
|
-
* @memberof
|
|
19004
|
+
* @memberof OrdersApiListOrdersV3
|
|
19176
19005
|
*/
|
|
19177
19006
|
readonly user?: string;
|
|
19178
19007
|
/**
|
|
19179
19008
|
* Status of this order
|
|
19180
19009
|
* @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
|
|
19181
|
-
* @memberof
|
|
19010
|
+
* @memberof OrdersApiListOrdersV3
|
|
19182
19011
|
*/
|
|
19183
19012
|
readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
|
|
19184
19013
|
/**
|
|
19185
19014
|
* Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
19186
19015
|
* @type {string}
|
|
19187
|
-
* @memberof
|
|
19016
|
+
* @memberof OrdersApiListOrdersV3
|
|
19188
19017
|
*/
|
|
19189
19018
|
readonly minTimestamp?: string;
|
|
19190
19019
|
/**
|
|
19191
19020
|
* Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
19192
19021
|
* @type {string}
|
|
19193
|
-
* @memberof
|
|
19022
|
+
* @memberof OrdersApiListOrdersV3
|
|
19194
19023
|
*/
|
|
19195
19024
|
readonly maxTimestamp?: string;
|
|
19196
19025
|
/**
|
|
19197
19026
|
* Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
19198
19027
|
* @type {string}
|
|
19199
|
-
* @memberof
|
|
19028
|
+
* @memberof OrdersApiListOrdersV3
|
|
19200
19029
|
*/
|
|
19201
19030
|
readonly updatedMinTimestamp?: string;
|
|
19202
19031
|
/**
|
|
19203
19032
|
* Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
19204
19033
|
* @type {string}
|
|
19205
|
-
* @memberof
|
|
19034
|
+
* @memberof OrdersApiListOrdersV3
|
|
19206
19035
|
*/
|
|
19207
19036
|
readonly updatedMaxTimestamp?: string;
|
|
19208
19037
|
/**
|
|
19209
19038
|
* Token type of the asset this order buys
|
|
19210
19039
|
* @type {string}
|
|
19211
|
-
* @memberof
|
|
19040
|
+
* @memberof OrdersApiListOrdersV3
|
|
19212
19041
|
*/
|
|
19213
19042
|
readonly buyTokenType?: string;
|
|
19214
19043
|
/**
|
|
19215
19044
|
* ERC721 Token ID of the asset this order buys
|
|
19216
19045
|
* @type {string}
|
|
19217
|
-
* @memberof
|
|
19046
|
+
* @memberof OrdersApiListOrdersV3
|
|
19218
19047
|
*/
|
|
19219
19048
|
readonly buyTokenId?: string;
|
|
19220
19049
|
/**
|
|
19221
19050
|
* Internal IMX ID of the asset this order buys
|
|
19222
19051
|
* @type {string}
|
|
19223
|
-
* @memberof
|
|
19052
|
+
* @memberof OrdersApiListOrdersV3
|
|
19224
19053
|
*/
|
|
19225
19054
|
readonly buyAssetId?: string;
|
|
19226
19055
|
/**
|
|
19227
19056
|
* Token address of the asset this order buys
|
|
19228
19057
|
* @type {string}
|
|
19229
|
-
* @memberof
|
|
19058
|
+
* @memberof OrdersApiListOrdersV3
|
|
19230
19059
|
*/
|
|
19231
19060
|
readonly buyTokenAddress?: string;
|
|
19232
19061
|
/**
|
|
19233
19062
|
* Token name of the asset this order buys
|
|
19234
19063
|
* @type {string}
|
|
19235
|
-
* @memberof
|
|
19064
|
+
* @memberof OrdersApiListOrdersV3
|
|
19236
19065
|
*/
|
|
19237
19066
|
readonly buyTokenName?: string;
|
|
19238
19067
|
/**
|
|
19239
19068
|
* Min quantity for the asset this order buys
|
|
19240
19069
|
* @type {string}
|
|
19241
|
-
* @memberof
|
|
19070
|
+
* @memberof OrdersApiListOrdersV3
|
|
19242
19071
|
*/
|
|
19243
19072
|
readonly buyMinQuantity?: string;
|
|
19244
19073
|
/**
|
|
19245
19074
|
* Max quantity for the asset this order buys
|
|
19246
19075
|
* @type {string}
|
|
19247
|
-
* @memberof
|
|
19076
|
+
* @memberof OrdersApiListOrdersV3
|
|
19248
19077
|
*/
|
|
19249
19078
|
readonly buyMaxQuantity?: string;
|
|
19250
19079
|
/**
|
|
19251
19080
|
* JSON-encoded metadata filters for the asset this order buys
|
|
19252
19081
|
* @type {string}
|
|
19253
|
-
* @memberof
|
|
19082
|
+
* @memberof OrdersApiListOrdersV3
|
|
19254
19083
|
*/
|
|
19255
19084
|
readonly buyMetadata?: string;
|
|
19256
19085
|
/**
|
|
19257
19086
|
* Token type of the asset this order sells
|
|
19258
19087
|
* @type {string}
|
|
19259
|
-
* @memberof
|
|
19088
|
+
* @memberof OrdersApiListOrdersV3
|
|
19260
19089
|
*/
|
|
19261
19090
|
readonly sellTokenType?: string;
|
|
19262
19091
|
/**
|
|
19263
19092
|
* ERC721 Token ID of the asset this order sells
|
|
19264
19093
|
* @type {string}
|
|
19265
|
-
* @memberof
|
|
19094
|
+
* @memberof OrdersApiListOrdersV3
|
|
19266
19095
|
*/
|
|
19267
19096
|
readonly sellTokenId?: string;
|
|
19268
19097
|
/**
|
|
19269
19098
|
* Internal IMX ID of the asset this order sells
|
|
19270
19099
|
* @type {string}
|
|
19271
|
-
* @memberof
|
|
19100
|
+
* @memberof OrdersApiListOrdersV3
|
|
19272
19101
|
*/
|
|
19273
19102
|
readonly sellAssetId?: string;
|
|
19274
19103
|
/**
|
|
19275
19104
|
* Token address of the asset this order sells
|
|
19276
19105
|
* @type {string}
|
|
19277
|
-
* @memberof
|
|
19106
|
+
* @memberof OrdersApiListOrdersV3
|
|
19278
19107
|
*/
|
|
19279
19108
|
readonly sellTokenAddress?: string;
|
|
19280
19109
|
/**
|
|
19281
19110
|
* Token name of the asset this order sells
|
|
19282
19111
|
* @type {string}
|
|
19283
|
-
* @memberof
|
|
19112
|
+
* @memberof OrdersApiListOrdersV3
|
|
19284
19113
|
*/
|
|
19285
19114
|
readonly sellTokenName?: string;
|
|
19286
19115
|
/**
|
|
19287
19116
|
* Min quantity for the asset this order sells
|
|
19288
19117
|
* @type {string}
|
|
19289
|
-
* @memberof
|
|
19118
|
+
* @memberof OrdersApiListOrdersV3
|
|
19290
19119
|
*/
|
|
19291
19120
|
readonly sellMinQuantity?: string;
|
|
19292
19121
|
/**
|
|
19293
19122
|
* Max quantity for the asset this order sells
|
|
19294
19123
|
* @type {string}
|
|
19295
|
-
* @memberof
|
|
19124
|
+
* @memberof OrdersApiListOrdersV3
|
|
19296
19125
|
*/
|
|
19297
19126
|
readonly sellMaxQuantity?: string;
|
|
19298
19127
|
/**
|
|
19299
19128
|
* JSON-encoded metadata filters for the asset this order sells
|
|
19300
19129
|
* @type {string}
|
|
19301
|
-
* @memberof
|
|
19130
|
+
* @memberof OrdersApiListOrdersV3
|
|
19302
19131
|
*/
|
|
19303
19132
|
readonly sellMetadata?: string;
|
|
19304
19133
|
/**
|
|
19305
19134
|
* Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
|
|
19306
19135
|
* @type {string}
|
|
19307
|
-
* @memberof
|
|
19136
|
+
* @memberof OrdersApiListOrdersV3
|
|
19308
19137
|
*/
|
|
19309
19138
|
readonly auxiliaryFeePercentages?: string;
|
|
19310
19139
|
/**
|
|
19311
19140
|
* Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
|
|
19312
19141
|
* @type {string}
|
|
19313
|
-
* @memberof
|
|
19142
|
+
* @memberof OrdersApiListOrdersV3
|
|
19314
19143
|
*/
|
|
19315
19144
|
readonly auxiliaryFeeRecipients?: string;
|
|
19316
19145
|
/**
|
|
19317
19146
|
* Set flag to true to include fee object for orders
|
|
19318
19147
|
* @type {boolean}
|
|
19319
|
-
* @memberof
|
|
19148
|
+
* @memberof OrdersApiListOrdersV3
|
|
19320
19149
|
*/
|
|
19321
19150
|
readonly includeFees?: boolean;
|
|
19322
19151
|
}
|
|
19323
19152
|
/**
|
|
19324
|
-
*
|
|
19153
|
+
* OrdersApi - object-oriented interface
|
|
19325
19154
|
* @export
|
|
19326
|
-
* @
|
|
19155
|
+
* @class OrdersApi
|
|
19156
|
+
* @extends {BaseAPI}
|
|
19327
19157
|
*/
|
|
19328
|
-
|
|
19158
|
+
declare class OrdersApi extends BaseAPI {
|
|
19329
19159
|
/**
|
|
19330
|
-
*
|
|
19331
|
-
* @
|
|
19332
|
-
* @
|
|
19160
|
+
* 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
|
|
19161
|
+
* @summary Cancel an order
|
|
19162
|
+
* @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
|
|
19163
|
+
* @param {*} [options] Override http request option.
|
|
19164
|
+
* @deprecated
|
|
19165
|
+
* @throws {RequiredError}
|
|
19166
|
+
* @memberof OrdersApi
|
|
19333
19167
|
*/
|
|
19334
|
-
|
|
19168
|
+
cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
|
|
19335
19169
|
/**
|
|
19336
|
-
*
|
|
19337
|
-
* @
|
|
19338
|
-
* @
|
|
19170
|
+
* Cancel an order (V3)
|
|
19171
|
+
* @summary Cancel an order (V3)
|
|
19172
|
+
* @param {OrdersApiCancelOrderV3Request} requestParameters Request parameters.
|
|
19173
|
+
* @param {*} [options] Override http request option.
|
|
19174
|
+
* @throws {RequiredError}
|
|
19175
|
+
* @memberof OrdersApi
|
|
19339
19176
|
*/
|
|
19340
|
-
|
|
19177
|
+
cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
|
|
19341
19178
|
/**
|
|
19342
|
-
*
|
|
19343
|
-
* @
|
|
19344
|
-
* @
|
|
19179
|
+
* 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
|
|
19180
|
+
* @summary Create an order
|
|
19181
|
+
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
19182
|
+
* @param {*} [options] Override http request option.
|
|
19183
|
+
* @deprecated
|
|
19184
|
+
* @throws {RequiredError}
|
|
19185
|
+
* @memberof OrdersApi
|
|
19345
19186
|
*/
|
|
19346
|
-
|
|
19187
|
+
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
|
|
19347
19188
|
/**
|
|
19348
|
-
*
|
|
19349
|
-
* @
|
|
19350
|
-
* @
|
|
19189
|
+
* Create an order using the v3 orderbook. Currently only buy NFT orders are supported.
|
|
19190
|
+
* @summary Create an order (V3)
|
|
19191
|
+
* @param {OrdersApiCreateOrderV3Request} requestParameters Request parameters.
|
|
19192
|
+
* @param {*} [options] Override http request option.
|
|
19193
|
+
* @throws {RequiredError}
|
|
19194
|
+
* @memberof OrdersApi
|
|
19351
19195
|
*/
|
|
19352
|
-
|
|
19196
|
+
createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
|
|
19353
19197
|
/**
|
|
19354
|
-
*
|
|
19355
|
-
* @
|
|
19356
|
-
* @
|
|
19198
|
+
* 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
|
|
19199
|
+
* @summary Get an order
|
|
19200
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
19201
|
+
* @param {*} [options] Override http request option.
|
|
19202
|
+
* @deprecated
|
|
19203
|
+
* @throws {RequiredError}
|
|
19204
|
+
* @memberof OrdersApi
|
|
19357
19205
|
*/
|
|
19358
|
-
|
|
19206
|
+
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order, any>>;
|
|
19359
19207
|
/**
|
|
19360
|
-
*
|
|
19361
|
-
* @
|
|
19362
|
-
* @
|
|
19208
|
+
* Get an order (V3)
|
|
19209
|
+
* @summary Get an order (V3)
|
|
19210
|
+
* @param {OrdersApiGetOrderV3Request} requestParameters Request parameters.
|
|
19211
|
+
* @param {*} [options] Override http request option.
|
|
19212
|
+
* @throws {RequiredError}
|
|
19213
|
+
* @memberof OrdersApi
|
|
19363
19214
|
*/
|
|
19364
|
-
|
|
19215
|
+
getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
|
|
19365
19216
|
/**
|
|
19366
|
-
*
|
|
19367
|
-
* @
|
|
19368
|
-
* @
|
|
19217
|
+
* 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
|
|
19218
|
+
* @summary Sign cancel order message
|
|
19219
|
+
* @param {OrdersApiGetSignableCancelOrderRequest} requestParameters Request parameters.
|
|
19220
|
+
* @param {*} [options] Override http request option.
|
|
19221
|
+
* @deprecated
|
|
19222
|
+
* @throws {RequiredError}
|
|
19223
|
+
* @memberof OrdersApi
|
|
19369
19224
|
*/
|
|
19370
|
-
|
|
19225
|
+
getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
|
|
19371
19226
|
/**
|
|
19372
|
-
*
|
|
19373
|
-
* @
|
|
19374
|
-
* @
|
|
19227
|
+
* Generate a signable cancel order message (V3)
|
|
19228
|
+
* @summary Generate a signable cancel order message (V3)
|
|
19229
|
+
* @param {OrdersApiGetSignableCancelOrderV3Request} requestParameters Request parameters.
|
|
19230
|
+
* @param {*} [options] Override http request option.
|
|
19231
|
+
* @throws {RequiredError}
|
|
19232
|
+
* @memberof OrdersApi
|
|
19375
19233
|
*/
|
|
19376
|
-
|
|
19234
|
+
getSignableCancelOrderV3(requestParameters: OrdersApiGetSignableCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
|
|
19377
19235
|
/**
|
|
19378
|
-
*
|
|
19379
|
-
* @
|
|
19380
|
-
* @
|
|
19236
|
+
* Generate a signable order request (V3)
|
|
19237
|
+
* @summary Generate a signable order request (V3)
|
|
19238
|
+
* @param {OrdersApiGetSignableOrderRequest} requestParameters Request parameters.
|
|
19239
|
+
* @param {*} [options] Override http request option.
|
|
19240
|
+
* @throws {RequiredError}
|
|
19241
|
+
* @memberof OrdersApi
|
|
19381
19242
|
*/
|
|
19382
|
-
|
|
19243
|
+
getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableOrderResponse, any>>;
|
|
19383
19244
|
/**
|
|
19384
|
-
*
|
|
19245
|
+
* 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
|
|
19246
|
+
* @summary Get a list of orders.
|
|
19247
|
+
* @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
|
|
19248
|
+
* @param {*} [options] Override http request option.
|
|
19249
|
+
* @deprecated
|
|
19250
|
+
* @throws {RequiredError}
|
|
19251
|
+
* @memberof OrdersApi
|
|
19252
|
+
*/
|
|
19253
|
+
listOrders(requestParameters?: OrdersApiListOrdersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponse, any>>;
|
|
19254
|
+
/**
|
|
19255
|
+
* Get a list of orders (V3)
|
|
19256
|
+
* @summary Get a list of orders (V3)
|
|
19257
|
+
* @param {OrdersApiListOrdersV3Request} requestParameters Request parameters.
|
|
19258
|
+
* @param {*} [options] Override http request option.
|
|
19259
|
+
* @throws {RequiredError}
|
|
19260
|
+
* @memberof OrdersApi
|
|
19261
|
+
*/
|
|
19262
|
+
listOrdersV3(requestParameters?: OrdersApiListOrdersV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponseV3, any>>;
|
|
19263
|
+
}
|
|
19264
|
+
|
|
19265
|
+
/**
|
|
19266
|
+
* Request parameters for createProject operation in ProjectsApi.
|
|
19267
|
+
* @export
|
|
19268
|
+
* @interface ProjectsApiCreateProjectRequest
|
|
19269
|
+
*/
|
|
19270
|
+
interface ProjectsApiCreateProjectRequest {
|
|
19271
|
+
/**
|
|
19272
|
+
* String created by signing wallet address and timestamp
|
|
19385
19273
|
* @type {string}
|
|
19386
|
-
* @memberof
|
|
19274
|
+
* @memberof ProjectsApiCreateProject
|
|
19387
19275
|
*/
|
|
19388
|
-
readonly
|
|
19276
|
+
readonly iMXSignature: string;
|
|
19389
19277
|
/**
|
|
19390
|
-
*
|
|
19278
|
+
* Unix Epoc timestamp
|
|
19391
19279
|
* @type {string}
|
|
19392
|
-
* @memberof
|
|
19280
|
+
* @memberof ProjectsApiCreateProject
|
|
19393
19281
|
*/
|
|
19394
|
-
readonly
|
|
19282
|
+
readonly iMXTimestamp: string;
|
|
19395
19283
|
/**
|
|
19396
|
-
*
|
|
19284
|
+
* create a project
|
|
19285
|
+
* @type {CreateProjectRequest}
|
|
19286
|
+
* @memberof ProjectsApiCreateProject
|
|
19287
|
+
*/
|
|
19288
|
+
readonly createProjectRequest: CreateProjectRequest;
|
|
19289
|
+
}
|
|
19290
|
+
/**
|
|
19291
|
+
* Request parameters for createProjectAPIKey operation in ProjectsApi.
|
|
19292
|
+
* @export
|
|
19293
|
+
* @interface ProjectsApiCreateProjectAPIKeyRequest
|
|
19294
|
+
*/
|
|
19295
|
+
interface ProjectsApiCreateProjectAPIKeyRequest {
|
|
19296
|
+
/**
|
|
19297
|
+
* Project ID
|
|
19397
19298
|
* @type {string}
|
|
19398
|
-
* @memberof
|
|
19299
|
+
* @memberof ProjectsApiCreateProjectAPIKey
|
|
19399
19300
|
*/
|
|
19400
|
-
readonly
|
|
19301
|
+
readonly id: string;
|
|
19302
|
+
}
|
|
19303
|
+
/**
|
|
19304
|
+
* Request parameters for createProjectGroup operation in ProjectsApi.
|
|
19305
|
+
* @export
|
|
19306
|
+
* @interface ProjectsApiCreateProjectGroupRequest
|
|
19307
|
+
*/
|
|
19308
|
+
interface ProjectsApiCreateProjectGroupRequest {
|
|
19309
|
+
/**
|
|
19310
|
+
* create a project group
|
|
19311
|
+
* @type {CreateProjectGroupRequest}
|
|
19312
|
+
* @memberof ProjectsApiCreateProjectGroup
|
|
19313
|
+
*/
|
|
19314
|
+
readonly createProjectGroupRequest: CreateProjectGroupRequest;
|
|
19315
|
+
}
|
|
19316
|
+
/**
|
|
19317
|
+
* Request parameters for getProject operation in ProjectsApi.
|
|
19318
|
+
* @export
|
|
19319
|
+
* @interface ProjectsApiGetProjectRequest
|
|
19320
|
+
*/
|
|
19321
|
+
interface ProjectsApiGetProjectRequest {
|
|
19401
19322
|
/**
|
|
19402
|
-
*
|
|
19323
|
+
* Project ID
|
|
19403
19324
|
* @type {string}
|
|
19404
|
-
* @memberof
|
|
19325
|
+
* @memberof ProjectsApiGetProject
|
|
19405
19326
|
*/
|
|
19406
|
-
readonly
|
|
19327
|
+
readonly id: string;
|
|
19407
19328
|
/**
|
|
19408
|
-
*
|
|
19329
|
+
* String created by signing wallet address and timestamp
|
|
19409
19330
|
* @type {string}
|
|
19410
|
-
* @memberof
|
|
19331
|
+
* @memberof ProjectsApiGetProject
|
|
19411
19332
|
*/
|
|
19412
|
-
readonly
|
|
19333
|
+
readonly iMXSignature: string;
|
|
19413
19334
|
/**
|
|
19414
|
-
*
|
|
19335
|
+
* Unix Epoc timestamp
|
|
19415
19336
|
* @type {string}
|
|
19416
|
-
* @memberof
|
|
19337
|
+
* @memberof ProjectsApiGetProject
|
|
19417
19338
|
*/
|
|
19418
|
-
readonly
|
|
19339
|
+
readonly iMXTimestamp: string;
|
|
19340
|
+
}
|
|
19341
|
+
/**
|
|
19342
|
+
* Request parameters for getProjectGroup operation in ProjectsApi.
|
|
19343
|
+
* @export
|
|
19344
|
+
* @interface ProjectsApiGetProjectGroupRequest
|
|
19345
|
+
*/
|
|
19346
|
+
interface ProjectsApiGetProjectGroupRequest {
|
|
19419
19347
|
/**
|
|
19420
|
-
*
|
|
19348
|
+
* Project group ID
|
|
19421
19349
|
* @type {string}
|
|
19422
|
-
* @memberof
|
|
19350
|
+
* @memberof ProjectsApiGetProjectGroup
|
|
19423
19351
|
*/
|
|
19424
|
-
readonly
|
|
19352
|
+
readonly id: string;
|
|
19353
|
+
}
|
|
19354
|
+
/**
|
|
19355
|
+
* Request parameters for getProjectGroups operation in ProjectsApi.
|
|
19356
|
+
* @export
|
|
19357
|
+
* @interface ProjectsApiGetProjectGroupsRequest
|
|
19358
|
+
*/
|
|
19359
|
+
interface ProjectsApiGetProjectGroupsRequest {
|
|
19425
19360
|
/**
|
|
19426
|
-
*
|
|
19427
|
-
* @type {
|
|
19428
|
-
* @memberof
|
|
19361
|
+
* Page size of the result
|
|
19362
|
+
* @type {number}
|
|
19363
|
+
* @memberof ProjectsApiGetProjectGroups
|
|
19429
19364
|
*/
|
|
19430
|
-
readonly
|
|
19365
|
+
readonly pageSize?: number;
|
|
19431
19366
|
/**
|
|
19432
|
-
*
|
|
19367
|
+
* Cursor
|
|
19433
19368
|
* @type {string}
|
|
19434
|
-
* @memberof
|
|
19369
|
+
* @memberof ProjectsApiGetProjectGroups
|
|
19435
19370
|
*/
|
|
19436
|
-
readonly
|
|
19371
|
+
readonly cursor?: string;
|
|
19437
19372
|
/**
|
|
19438
|
-
*
|
|
19373
|
+
* Property to sort by
|
|
19439
19374
|
* @type {string}
|
|
19440
|
-
* @memberof
|
|
19375
|
+
* @memberof ProjectsApiGetProjectGroups
|
|
19441
19376
|
*/
|
|
19442
|
-
readonly
|
|
19377
|
+
readonly orderBy?: string;
|
|
19443
19378
|
/**
|
|
19444
|
-
*
|
|
19379
|
+
* Direction to sort (asc/desc)
|
|
19445
19380
|
* @type {string}
|
|
19446
|
-
* @memberof
|
|
19381
|
+
* @memberof ProjectsApiGetProjectGroups
|
|
19447
19382
|
*/
|
|
19448
|
-
readonly
|
|
19383
|
+
readonly direction?: string;
|
|
19384
|
+
}
|
|
19385
|
+
/**
|
|
19386
|
+
* Request parameters for getProjects operation in ProjectsApi.
|
|
19387
|
+
* @export
|
|
19388
|
+
* @interface ProjectsApiGetProjectsRequest
|
|
19389
|
+
*/
|
|
19390
|
+
interface ProjectsApiGetProjectsRequest {
|
|
19449
19391
|
/**
|
|
19450
|
-
*
|
|
19392
|
+
* String created by signing wallet address and timestamp
|
|
19451
19393
|
* @type {string}
|
|
19452
|
-
* @memberof
|
|
19394
|
+
* @memberof ProjectsApiGetProjects
|
|
19453
19395
|
*/
|
|
19454
|
-
readonly
|
|
19396
|
+
readonly iMXSignature: string;
|
|
19455
19397
|
/**
|
|
19456
|
-
*
|
|
19398
|
+
* Unix Epoc timestamp
|
|
19457
19399
|
* @type {string}
|
|
19458
|
-
* @memberof
|
|
19400
|
+
* @memberof ProjectsApiGetProjects
|
|
19459
19401
|
*/
|
|
19460
|
-
readonly
|
|
19402
|
+
readonly iMXTimestamp: string;
|
|
19461
19403
|
/**
|
|
19462
|
-
*
|
|
19463
|
-
* @type {
|
|
19464
|
-
* @memberof
|
|
19404
|
+
* Page size of the result
|
|
19405
|
+
* @type {number}
|
|
19406
|
+
* @memberof ProjectsApiGetProjects
|
|
19465
19407
|
*/
|
|
19466
|
-
readonly
|
|
19408
|
+
readonly pageSize?: number;
|
|
19467
19409
|
/**
|
|
19468
|
-
*
|
|
19410
|
+
* Cursor
|
|
19469
19411
|
* @type {string}
|
|
19470
|
-
* @memberof
|
|
19412
|
+
* @memberof ProjectsApiGetProjects
|
|
19471
19413
|
*/
|
|
19472
|
-
readonly
|
|
19414
|
+
readonly cursor?: string;
|
|
19473
19415
|
/**
|
|
19474
|
-
*
|
|
19416
|
+
* Property to sort by
|
|
19475
19417
|
* @type {string}
|
|
19476
|
-
* @memberof
|
|
19418
|
+
* @memberof ProjectsApiGetProjects
|
|
19477
19419
|
*/
|
|
19478
|
-
readonly
|
|
19420
|
+
readonly orderBy?: string;
|
|
19479
19421
|
/**
|
|
19480
|
-
*
|
|
19422
|
+
* Direction to sort (asc/desc)
|
|
19481
19423
|
* @type {string}
|
|
19482
|
-
* @memberof
|
|
19424
|
+
* @memberof ProjectsApiGetProjects
|
|
19483
19425
|
*/
|
|
19484
|
-
readonly
|
|
19426
|
+
readonly direction?: string;
|
|
19427
|
+
}
|
|
19428
|
+
/**
|
|
19429
|
+
* Request parameters for getSdkVersion operation in ProjectsApi.
|
|
19430
|
+
* @export
|
|
19431
|
+
* @interface ProjectsApiGetSdkVersionRequest
|
|
19432
|
+
*/
|
|
19433
|
+
interface ProjectsApiGetSdkVersionRequest {
|
|
19485
19434
|
/**
|
|
19486
|
-
*
|
|
19435
|
+
* Runtime Details
|
|
19487
19436
|
* @type {string}
|
|
19488
|
-
* @memberof
|
|
19437
|
+
* @memberof ProjectsApiGetSdkVersion
|
|
19489
19438
|
*/
|
|
19490
|
-
readonly
|
|
19439
|
+
readonly details: string;
|
|
19491
19440
|
/**
|
|
19492
|
-
*
|
|
19441
|
+
* SDK Version
|
|
19493
19442
|
* @type {string}
|
|
19494
|
-
* @memberof
|
|
19443
|
+
* @memberof ProjectsApiGetSdkVersion
|
|
19495
19444
|
*/
|
|
19496
|
-
readonly
|
|
19445
|
+
readonly version?: string;
|
|
19497
19446
|
/**
|
|
19498
|
-
*
|
|
19499
|
-
* @type {
|
|
19500
|
-
* @memberof
|
|
19447
|
+
* Runtime ID
|
|
19448
|
+
* @type {string}
|
|
19449
|
+
* @memberof ProjectsApiGetSdkVersion
|
|
19501
19450
|
*/
|
|
19502
|
-
readonly
|
|
19451
|
+
readonly id?: string;
|
|
19503
19452
|
}
|
|
19504
19453
|
/**
|
|
19505
|
-
*
|
|
19454
|
+
* ProjectsApi - object-oriented interface
|
|
19506
19455
|
* @export
|
|
19507
|
-
* @class
|
|
19456
|
+
* @class ProjectsApi
|
|
19508
19457
|
* @extends {BaseAPI}
|
|
19509
19458
|
*/
|
|
19510
|
-
declare class
|
|
19459
|
+
declare class ProjectsApi extends BaseAPI {
|
|
19511
19460
|
/**
|
|
19512
|
-
*
|
|
19513
|
-
* @summary
|
|
19514
|
-
* @param {
|
|
19461
|
+
* Create a project
|
|
19462
|
+
* @summary Create a project
|
|
19463
|
+
* @param {ProjectsApiCreateProjectRequest} requestParameters Request parameters.
|
|
19515
19464
|
* @param {*} [options] Override http request option.
|
|
19516
19465
|
* @deprecated
|
|
19517
19466
|
* @throws {RequiredError}
|
|
19518
|
-
* @memberof
|
|
19467
|
+
* @memberof ProjectsApi
|
|
19519
19468
|
*/
|
|
19520
|
-
|
|
19469
|
+
createProject(requestParameters: ProjectsApiCreateProjectRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectResponse, any>>;
|
|
19521
19470
|
/**
|
|
19522
|
-
*
|
|
19523
|
-
* @summary
|
|
19524
|
-
* @param {
|
|
19471
|
+
* Create a project api key
|
|
19472
|
+
* @summary A new API key will be generated every time this endpoint is called.
|
|
19473
|
+
* @param {ProjectsApiCreateProjectAPIKeyRequest} requestParameters Request parameters.
|
|
19525
19474
|
* @param {*} [options] Override http request option.
|
|
19526
19475
|
* @throws {RequiredError}
|
|
19527
|
-
* @memberof
|
|
19476
|
+
* @memberof ProjectsApi
|
|
19528
19477
|
*/
|
|
19529
|
-
|
|
19478
|
+
createProjectAPIKey(requestParameters: ProjectsApiCreateProjectAPIKeyRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectAPIKeyResponse, any>>;
|
|
19530
19479
|
/**
|
|
19531
|
-
* Create
|
|
19532
|
-
* @summary Create
|
|
19533
|
-
* @param {
|
|
19480
|
+
* Create a project group
|
|
19481
|
+
* @summary Create a project group
|
|
19482
|
+
* @param {ProjectsApiCreateProjectGroupRequest} requestParameters Request parameters.
|
|
19534
19483
|
* @param {*} [options] Override http request option.
|
|
19535
|
-
* @deprecated
|
|
19536
19484
|
* @throws {RequiredError}
|
|
19537
|
-
* @memberof
|
|
19485
|
+
* @memberof ProjectsApi
|
|
19538
19486
|
*/
|
|
19539
|
-
|
|
19487
|
+
createProjectGroup(requestParameters: ProjectsApiCreateProjectGroupRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectResponse, any>>;
|
|
19540
19488
|
/**
|
|
19541
|
-
*
|
|
19542
|
-
* @summary
|
|
19543
|
-
* @param {
|
|
19489
|
+
* Get a project
|
|
19490
|
+
* @summary Get a project
|
|
19491
|
+
* @param {ProjectsApiGetProjectRequest} requestParameters Request parameters.
|
|
19544
19492
|
* @param {*} [options] Override http request option.
|
|
19545
19493
|
* @throws {RequiredError}
|
|
19546
|
-
* @memberof
|
|
19494
|
+
* @memberof ProjectsApi
|
|
19547
19495
|
*/
|
|
19548
|
-
|
|
19496
|
+
getProject(requestParameters: ProjectsApiGetProjectRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Project, any>>;
|
|
19549
19497
|
/**
|
|
19550
|
-
* Get
|
|
19551
|
-
* @summary Get
|
|
19552
|
-
* @param {
|
|
19498
|
+
* Get a project group
|
|
19499
|
+
* @summary Get a project group
|
|
19500
|
+
* @param {ProjectsApiGetProjectGroupRequest} requestParameters Request parameters.
|
|
19553
19501
|
* @param {*} [options] Override http request option.
|
|
19554
|
-
* @deprecated
|
|
19555
19502
|
* @throws {RequiredError}
|
|
19556
|
-
* @memberof
|
|
19503
|
+
* @memberof ProjectsApi
|
|
19557
19504
|
*/
|
|
19558
|
-
|
|
19505
|
+
getProjectGroup(requestParameters: ProjectsApiGetProjectGroupRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Project, any>>;
|
|
19559
19506
|
/**
|
|
19560
|
-
* Get
|
|
19561
|
-
* @summary Get
|
|
19562
|
-
* @param {
|
|
19507
|
+
* Get project groups
|
|
19508
|
+
* @summary Get project groups
|
|
19509
|
+
* @param {ProjectsApiGetProjectGroupsRequest} requestParameters Request parameters.
|
|
19563
19510
|
* @param {*} [options] Override http request option.
|
|
19564
19511
|
* @throws {RequiredError}
|
|
19565
|
-
* @memberof
|
|
19512
|
+
* @memberof ProjectsApi
|
|
19513
|
+
*/
|
|
19514
|
+
getProjectGroups(requestParameters?: ProjectsApiGetProjectGroupsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetProjectsResponse, any>>;
|
|
19515
|
+
/**
|
|
19516
|
+
* Get projects
|
|
19517
|
+
* @summary Get projects
|
|
19518
|
+
* @param {ProjectsApiGetProjectsRequest} requestParameters Request parameters.
|
|
19519
|
+
* @param {*} [options] Override http request option.
|
|
19520
|
+
* @throws {RequiredError}
|
|
19521
|
+
* @memberof ProjectsApi
|
|
19522
|
+
*/
|
|
19523
|
+
getProjects(requestParameters: ProjectsApiGetProjectsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetProjectsResponse, any>>;
|
|
19524
|
+
/**
|
|
19525
|
+
* Checks the SDK Version of caller against the current SDK Version and returns a message.
|
|
19526
|
+
* @summary Checks the SDK Version of caller against the current SDK Version
|
|
19527
|
+
* @param {ProjectsApiGetSdkVersionRequest} requestParameters Request parameters.
|
|
19528
|
+
* @param {*} [options] Override http request option.
|
|
19529
|
+
* @throws {RequiredError}
|
|
19530
|
+
* @memberof ProjectsApi
|
|
19531
|
+
*/
|
|
19532
|
+
getSdkVersion(requestParameters: ProjectsApiGetSdkVersionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ApiSDKVersionCheckResponse, any>>;
|
|
19533
|
+
}
|
|
19534
|
+
|
|
19535
|
+
/**
|
|
19536
|
+
* Request parameters for getToken operation in TokensApi.
|
|
19537
|
+
* @export
|
|
19538
|
+
* @interface TokensApiGetTokenRequest
|
|
19539
|
+
*/
|
|
19540
|
+
interface TokensApiGetTokenRequest {
|
|
19541
|
+
/**
|
|
19542
|
+
* Token Contract Address
|
|
19543
|
+
* @type {string}
|
|
19544
|
+
* @memberof TokensApiGetToken
|
|
19545
|
+
*/
|
|
19546
|
+
readonly address: string;
|
|
19547
|
+
}
|
|
19548
|
+
/**
|
|
19549
|
+
* Request parameters for listTokens operation in TokensApi.
|
|
19550
|
+
* @export
|
|
19551
|
+
* @interface TokensApiListTokensRequest
|
|
19552
|
+
*/
|
|
19553
|
+
interface TokensApiListTokensRequest {
|
|
19554
|
+
/**
|
|
19555
|
+
* Page size of the result
|
|
19556
|
+
* @type {number}
|
|
19557
|
+
* @memberof TokensApiListTokens
|
|
19558
|
+
*/
|
|
19559
|
+
readonly pageSize?: number;
|
|
19560
|
+
/**
|
|
19561
|
+
* Cursor
|
|
19562
|
+
* @type {string}
|
|
19563
|
+
* @memberof TokensApiListTokens
|
|
19566
19564
|
*/
|
|
19567
|
-
|
|
19565
|
+
readonly cursor?: string;
|
|
19568
19566
|
/**
|
|
19569
|
-
*
|
|
19570
|
-
* @
|
|
19571
|
-
* @
|
|
19572
|
-
* @param {*} [options] Override http request option.
|
|
19573
|
-
* @deprecated
|
|
19574
|
-
* @throws {RequiredError}
|
|
19575
|
-
* @memberof OrdersApi
|
|
19567
|
+
* Property to sort by
|
|
19568
|
+
* @type {'contract_address' | 'name' | 'symbol'}
|
|
19569
|
+
* @memberof TokensApiListTokens
|
|
19576
19570
|
*/
|
|
19577
|
-
|
|
19571
|
+
readonly orderBy?: 'contract_address' | 'name' | 'symbol';
|
|
19578
19572
|
/**
|
|
19579
|
-
*
|
|
19580
|
-
* @
|
|
19581
|
-
* @
|
|
19582
|
-
* @param {*} [options] Override http request option.
|
|
19583
|
-
* @throws {RequiredError}
|
|
19584
|
-
* @memberof OrdersApi
|
|
19573
|
+
* Direction to sort (asc/desc)
|
|
19574
|
+
* @type {string}
|
|
19575
|
+
* @memberof TokensApiListTokens
|
|
19585
19576
|
*/
|
|
19586
|
-
|
|
19577
|
+
readonly direction?: string;
|
|
19587
19578
|
/**
|
|
19588
|
-
*
|
|
19589
|
-
* @
|
|
19590
|
-
* @
|
|
19591
|
-
* @param {*} [options] Override http request option.
|
|
19592
|
-
* @throws {RequiredError}
|
|
19593
|
-
* @memberof OrdersApi
|
|
19579
|
+
* Contract address of the token
|
|
19580
|
+
* @type {string}
|
|
19581
|
+
* @memberof TokensApiListTokens
|
|
19594
19582
|
*/
|
|
19595
|
-
|
|
19583
|
+
readonly address?: string;
|
|
19596
19584
|
/**
|
|
19597
|
-
*
|
|
19598
|
-
* @
|
|
19599
|
-
* @
|
|
19585
|
+
* Token symbols for the token, e.g. ?symbols=IMX,ETH
|
|
19586
|
+
* @type {string}
|
|
19587
|
+
* @memberof TokensApiListTokens
|
|
19588
|
+
*/
|
|
19589
|
+
readonly symbols?: string;
|
|
19590
|
+
}
|
|
19591
|
+
/**
|
|
19592
|
+
* TokensApi - object-oriented interface
|
|
19593
|
+
* @export
|
|
19594
|
+
* @class TokensApi
|
|
19595
|
+
* @extends {BaseAPI}
|
|
19596
|
+
*/
|
|
19597
|
+
declare class TokensApi extends BaseAPI {
|
|
19598
|
+
/**
|
|
19599
|
+
* Get details of a token
|
|
19600
|
+
* @summary Get details of a token
|
|
19601
|
+
* @param {TokensApiGetTokenRequest} requestParameters Request parameters.
|
|
19600
19602
|
* @param {*} [options] Override http request option.
|
|
19601
|
-
* @deprecated
|
|
19602
19603
|
* @throws {RequiredError}
|
|
19603
|
-
* @memberof
|
|
19604
|
+
* @memberof TokensApi
|
|
19604
19605
|
*/
|
|
19605
|
-
|
|
19606
|
+
getToken(requestParameters: TokensApiGetTokenRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<TokenDetails, any>>;
|
|
19606
19607
|
/**
|
|
19607
|
-
* Get a list of
|
|
19608
|
-
* @summary Get a list of
|
|
19609
|
-
* @param {
|
|
19608
|
+
* Get a list of tokens
|
|
19609
|
+
* @summary Get a list of tokens
|
|
19610
|
+
* @param {TokensApiListTokensRequest} requestParameters Request parameters.
|
|
19610
19611
|
* @param {*} [options] Override http request option.
|
|
19611
19612
|
* @throws {RequiredError}
|
|
19612
|
-
* @memberof
|
|
19613
|
+
* @memberof TokensApi
|
|
19613
19614
|
*/
|
|
19614
|
-
|
|
19615
|
+
listTokens(requestParameters?: TokensApiListTokensRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTokensResponse, any>>;
|
|
19615
19616
|
}
|
|
19616
19617
|
|
|
19617
19618
|
/**
|
|
19618
|
-
* Request parameters for
|
|
19619
|
+
* Request parameters for createTrade operation in TradesApi.
|
|
19619
19620
|
* @export
|
|
19620
|
-
* @interface
|
|
19621
|
+
* @interface TradesApiCreateTradeRequest
|
|
19621
19622
|
*/
|
|
19622
|
-
interface
|
|
19623
|
+
interface TradesApiCreateTradeRequest {
|
|
19623
19624
|
/**
|
|
19624
|
-
*
|
|
19625
|
+
* create a trade
|
|
19626
|
+
* @type {CreateTradeRequestV1}
|
|
19627
|
+
* @memberof TradesApiCreateTrade
|
|
19628
|
+
*/
|
|
19629
|
+
readonly createTradeRequest: CreateTradeRequestV1;
|
|
19630
|
+
/**
|
|
19631
|
+
* eth address
|
|
19625
19632
|
* @type {string}
|
|
19626
|
-
* @memberof
|
|
19633
|
+
* @memberof TradesApiCreateTrade
|
|
19627
19634
|
*/
|
|
19628
|
-
readonly
|
|
19635
|
+
readonly xImxEthAddress?: string;
|
|
19629
19636
|
/**
|
|
19630
|
-
*
|
|
19637
|
+
* eth signature
|
|
19631
19638
|
* @type {string}
|
|
19632
|
-
* @memberof
|
|
19639
|
+
* @memberof TradesApiCreateTrade
|
|
19633
19640
|
*/
|
|
19634
|
-
readonly
|
|
19641
|
+
readonly xImxEthSignature?: string;
|
|
19635
19642
|
/**
|
|
19636
|
-
*
|
|
19637
|
-
* @type {
|
|
19638
|
-
* @memberof
|
|
19643
|
+
* Authorization header
|
|
19644
|
+
* @type {string}
|
|
19645
|
+
* @memberof TradesApiCreateTrade
|
|
19639
19646
|
*/
|
|
19640
|
-
readonly
|
|
19647
|
+
readonly authorization?: string;
|
|
19641
19648
|
}
|
|
19642
19649
|
/**
|
|
19643
|
-
* Request parameters for
|
|
19650
|
+
* Request parameters for createTradeV3 operation in TradesApi.
|
|
19644
19651
|
* @export
|
|
19645
|
-
* @interface
|
|
19652
|
+
* @interface TradesApiCreateTradeV3Request
|
|
19646
19653
|
*/
|
|
19647
|
-
interface
|
|
19654
|
+
interface TradesApiCreateTradeV3Request {
|
|
19648
19655
|
/**
|
|
19649
|
-
*
|
|
19656
|
+
* create a trade
|
|
19657
|
+
* @type {TradesCreateTradeRequest}
|
|
19658
|
+
* @memberof TradesApiCreateTradeV3
|
|
19659
|
+
*/
|
|
19660
|
+
readonly createTradeRequest: TradesCreateTradeRequest;
|
|
19661
|
+
/**
|
|
19662
|
+
* eth address
|
|
19650
19663
|
* @type {string}
|
|
19651
|
-
* @memberof
|
|
19664
|
+
* @memberof TradesApiCreateTradeV3
|
|
19652
19665
|
*/
|
|
19653
|
-
readonly
|
|
19666
|
+
readonly xImxEthAddress?: string;
|
|
19667
|
+
/**
|
|
19668
|
+
* eth signature
|
|
19669
|
+
* @type {string}
|
|
19670
|
+
* @memberof TradesApiCreateTradeV3
|
|
19671
|
+
*/
|
|
19672
|
+
readonly xImxEthSignature?: string;
|
|
19673
|
+
/**
|
|
19674
|
+
* Authorization header
|
|
19675
|
+
* @type {string}
|
|
19676
|
+
* @memberof TradesApiCreateTradeV3
|
|
19677
|
+
*/
|
|
19678
|
+
readonly authorization?: string;
|
|
19654
19679
|
}
|
|
19655
19680
|
/**
|
|
19656
|
-
* Request parameters for
|
|
19681
|
+
* Request parameters for getSignableTrade operation in TradesApi.
|
|
19657
19682
|
* @export
|
|
19658
|
-
* @interface
|
|
19683
|
+
* @interface TradesApiGetSignableTradeRequest
|
|
19659
19684
|
*/
|
|
19660
|
-
interface
|
|
19685
|
+
interface TradesApiGetSignableTradeRequest {
|
|
19661
19686
|
/**
|
|
19662
|
-
*
|
|
19663
|
-
* @type {
|
|
19664
|
-
* @memberof
|
|
19687
|
+
* get a signable trade
|
|
19688
|
+
* @type {GetSignableTradeRequest}
|
|
19689
|
+
* @memberof TradesApiGetSignableTrade
|
|
19665
19690
|
*/
|
|
19666
|
-
readonly
|
|
19691
|
+
readonly getSignableTradeRequest: GetSignableTradeRequest;
|
|
19667
19692
|
}
|
|
19668
19693
|
/**
|
|
19669
|
-
* Request parameters for
|
|
19694
|
+
* Request parameters for getTrade operation in TradesApi.
|
|
19670
19695
|
* @export
|
|
19671
|
-
* @interface
|
|
19696
|
+
* @interface TradesApiGetTradeRequest
|
|
19672
19697
|
*/
|
|
19673
|
-
interface
|
|
19698
|
+
interface TradesApiGetTradeRequest {
|
|
19674
19699
|
/**
|
|
19675
|
-
*
|
|
19700
|
+
* Trade ID
|
|
19676
19701
|
* @type {string}
|
|
19677
|
-
* @memberof
|
|
19702
|
+
* @memberof TradesApiGetTrade
|
|
19678
19703
|
*/
|
|
19679
19704
|
readonly id: string;
|
|
19680
|
-
/**
|
|
19681
|
-
* String created by signing wallet address and timestamp
|
|
19682
|
-
* @type {string}
|
|
19683
|
-
* @memberof ProjectsApiGetProject
|
|
19684
|
-
*/
|
|
19685
|
-
readonly iMXSignature: string;
|
|
19686
|
-
/**
|
|
19687
|
-
* Unix Epoc timestamp
|
|
19688
|
-
* @type {string}
|
|
19689
|
-
* @memberof ProjectsApiGetProject
|
|
19690
|
-
*/
|
|
19691
|
-
readonly iMXTimestamp: string;
|
|
19692
19705
|
}
|
|
19693
19706
|
/**
|
|
19694
|
-
* Request parameters for
|
|
19707
|
+
* Request parameters for getTradeV3 operation in TradesApi.
|
|
19695
19708
|
* @export
|
|
19696
|
-
* @interface
|
|
19709
|
+
* @interface TradesApiGetTradeV3Request
|
|
19697
19710
|
*/
|
|
19698
|
-
interface
|
|
19711
|
+
interface TradesApiGetTradeV3Request {
|
|
19699
19712
|
/**
|
|
19700
|
-
*
|
|
19713
|
+
* Trade ID
|
|
19701
19714
|
* @type {string}
|
|
19702
|
-
* @memberof
|
|
19715
|
+
* @memberof TradesApiGetTradeV3
|
|
19703
19716
|
*/
|
|
19704
19717
|
readonly id: string;
|
|
19705
19718
|
}
|
|
19706
19719
|
/**
|
|
19707
|
-
* Request parameters for
|
|
19720
|
+
* Request parameters for listTrades operation in TradesApi.
|
|
19708
19721
|
* @export
|
|
19709
|
-
* @interface
|
|
19722
|
+
* @interface TradesApiListTradesRequest
|
|
19710
19723
|
*/
|
|
19711
|
-
interface
|
|
19724
|
+
interface TradesApiListTradesRequest {
|
|
19725
|
+
/**
|
|
19726
|
+
* Party A\'s (buy order) token type of currency used to buy
|
|
19727
|
+
* @type {string}
|
|
19728
|
+
* @memberof TradesApiListTrades
|
|
19729
|
+
*/
|
|
19730
|
+
readonly partyATokenType?: string;
|
|
19731
|
+
/**
|
|
19732
|
+
* Party A\'s (buy order) token address of currency used to buy
|
|
19733
|
+
* @type {string}
|
|
19734
|
+
* @memberof TradesApiListTrades
|
|
19735
|
+
*/
|
|
19736
|
+
readonly partyATokenAddress?: string;
|
|
19737
|
+
/**
|
|
19738
|
+
* Party B\'s (sell order) token type of NFT sold - always ERC721
|
|
19739
|
+
* @type {string}
|
|
19740
|
+
* @memberof TradesApiListTrades
|
|
19741
|
+
*/
|
|
19742
|
+
readonly partyBTokenType?: string;
|
|
19743
|
+
/**
|
|
19744
|
+
* Party B\'s (sell order) collection address of NFT sold
|
|
19745
|
+
* @type {string}
|
|
19746
|
+
* @memberof TradesApiListTrades
|
|
19747
|
+
*/
|
|
19748
|
+
readonly partyBTokenAddress?: string;
|
|
19749
|
+
/**
|
|
19750
|
+
* Party B\'s (sell order) token id of NFT sold
|
|
19751
|
+
* @type {string}
|
|
19752
|
+
* @memberof TradesApiListTrades
|
|
19753
|
+
*/
|
|
19754
|
+
readonly partyBTokenId?: string;
|
|
19712
19755
|
/**
|
|
19713
19756
|
* Page size of the result
|
|
19714
19757
|
* @type {number}
|
|
19715
|
-
* @memberof
|
|
19758
|
+
* @memberof TradesApiListTrades
|
|
19716
19759
|
*/
|
|
19717
19760
|
readonly pageSize?: number;
|
|
19718
19761
|
/**
|
|
19719
19762
|
* Cursor
|
|
19720
19763
|
* @type {string}
|
|
19721
|
-
* @memberof
|
|
19764
|
+
* @memberof TradesApiListTrades
|
|
19765
|
+
*/
|
|
19766
|
+
readonly cursor?: string;
|
|
19767
|
+
/**
|
|
19768
|
+
* Property to sort by
|
|
19769
|
+
* @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
|
|
19770
|
+
* @memberof TradesApiListTrades
|
|
19771
|
+
*/
|
|
19772
|
+
readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
|
|
19773
|
+
/**
|
|
19774
|
+
* Direction to sort (asc/desc)
|
|
19775
|
+
* @type {string}
|
|
19776
|
+
* @memberof TradesApiListTrades
|
|
19777
|
+
*/
|
|
19778
|
+
readonly direction?: string;
|
|
19779
|
+
/**
|
|
19780
|
+
* Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
19781
|
+
* @type {string}
|
|
19782
|
+
* @memberof TradesApiListTrades
|
|
19783
|
+
*/
|
|
19784
|
+
readonly minTimestamp?: string;
|
|
19785
|
+
/**
|
|
19786
|
+
* Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
19787
|
+
* @type {string}
|
|
19788
|
+
* @memberof TradesApiListTrades
|
|
19789
|
+
*/
|
|
19790
|
+
readonly maxTimestamp?: string;
|
|
19791
|
+
}
|
|
19792
|
+
/**
|
|
19793
|
+
* Request parameters for listTradesV3 operation in TradesApi.
|
|
19794
|
+
* @export
|
|
19795
|
+
* @interface TradesApiListTradesV3Request
|
|
19796
|
+
*/
|
|
19797
|
+
interface TradesApiListTradesV3Request {
|
|
19798
|
+
/**
|
|
19799
|
+
* Party A\'s (buy order) token type of currency used to buy
|
|
19800
|
+
* @type {string}
|
|
19801
|
+
* @memberof TradesApiListTradesV3
|
|
19722
19802
|
*/
|
|
19723
|
-
readonly
|
|
19803
|
+
readonly partyATokenType?: string;
|
|
19724
19804
|
/**
|
|
19725
|
-
*
|
|
19805
|
+
* Party A\'s (buy order) token address of currency used to buy
|
|
19726
19806
|
* @type {string}
|
|
19727
|
-
* @memberof
|
|
19807
|
+
* @memberof TradesApiListTradesV3
|
|
19728
19808
|
*/
|
|
19729
|
-
readonly
|
|
19809
|
+
readonly partyATokenAddress?: string;
|
|
19730
19810
|
/**
|
|
19731
|
-
*
|
|
19811
|
+
* Party B\'s (sell order) token type of NFT sold - always ERC721
|
|
19732
19812
|
* @type {string}
|
|
19733
|
-
* @memberof
|
|
19813
|
+
* @memberof TradesApiListTradesV3
|
|
19734
19814
|
*/
|
|
19735
|
-
readonly
|
|
19736
|
-
}
|
|
19737
|
-
/**
|
|
19738
|
-
* Request parameters for getProjects operation in ProjectsApi.
|
|
19739
|
-
* @export
|
|
19740
|
-
* @interface ProjectsApiGetProjectsRequest
|
|
19741
|
-
*/
|
|
19742
|
-
interface ProjectsApiGetProjectsRequest {
|
|
19815
|
+
readonly partyBTokenType?: string;
|
|
19743
19816
|
/**
|
|
19744
|
-
*
|
|
19817
|
+
* Party B\'s (sell order) collection address of NFT sold
|
|
19745
19818
|
* @type {string}
|
|
19746
|
-
* @memberof
|
|
19819
|
+
* @memberof TradesApiListTradesV3
|
|
19747
19820
|
*/
|
|
19748
|
-
readonly
|
|
19821
|
+
readonly partyBTokenAddress?: string;
|
|
19749
19822
|
/**
|
|
19750
|
-
*
|
|
19823
|
+
* Party B\'s (sell order) token id of NFT sold
|
|
19751
19824
|
* @type {string}
|
|
19752
|
-
* @memberof
|
|
19825
|
+
* @memberof TradesApiListTradesV3
|
|
19753
19826
|
*/
|
|
19754
|
-
readonly
|
|
19827
|
+
readonly partyBTokenId?: string;
|
|
19755
19828
|
/**
|
|
19756
19829
|
* Page size of the result
|
|
19757
19830
|
* @type {number}
|
|
19758
|
-
* @memberof
|
|
19831
|
+
* @memberof TradesApiListTradesV3
|
|
19759
19832
|
*/
|
|
19760
19833
|
readonly pageSize?: number;
|
|
19761
19834
|
/**
|
|
19762
19835
|
* Cursor
|
|
19763
19836
|
* @type {string}
|
|
19764
|
-
* @memberof
|
|
19837
|
+
* @memberof TradesApiListTradesV3
|
|
19765
19838
|
*/
|
|
19766
19839
|
readonly cursor?: string;
|
|
19767
19840
|
/**
|
|
19768
19841
|
* Property to sort by
|
|
19769
|
-
* @type {
|
|
19770
|
-
* @memberof
|
|
19842
|
+
* @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp'}
|
|
19843
|
+
* @memberof TradesApiListTradesV3
|
|
19771
19844
|
*/
|
|
19772
|
-
readonly orderBy?:
|
|
19845
|
+
readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp';
|
|
19773
19846
|
/**
|
|
19774
19847
|
* Direction to sort (asc/desc)
|
|
19775
19848
|
* @type {string}
|
|
19776
|
-
* @memberof
|
|
19849
|
+
* @memberof TradesApiListTradesV3
|
|
19777
19850
|
*/
|
|
19778
19851
|
readonly direction?: string;
|
|
19779
|
-
}
|
|
19780
|
-
/**
|
|
19781
|
-
* Request parameters for getSdkVersion operation in ProjectsApi.
|
|
19782
|
-
* @export
|
|
19783
|
-
* @interface ProjectsApiGetSdkVersionRequest
|
|
19784
|
-
*/
|
|
19785
|
-
interface ProjectsApiGetSdkVersionRequest {
|
|
19786
|
-
/**
|
|
19787
|
-
* Runtime Details
|
|
19788
|
-
* @type {string}
|
|
19789
|
-
* @memberof ProjectsApiGetSdkVersion
|
|
19790
|
-
*/
|
|
19791
|
-
readonly details: string;
|
|
19792
19852
|
/**
|
|
19793
|
-
*
|
|
19853
|
+
* Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
19794
19854
|
* @type {string}
|
|
19795
|
-
* @memberof
|
|
19855
|
+
* @memberof TradesApiListTradesV3
|
|
19796
19856
|
*/
|
|
19797
|
-
readonly
|
|
19857
|
+
readonly minTimestamp?: string;
|
|
19798
19858
|
/**
|
|
19799
|
-
*
|
|
19859
|
+
* Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
19800
19860
|
* @type {string}
|
|
19801
|
-
* @memberof
|
|
19861
|
+
* @memberof TradesApiListTradesV3
|
|
19802
19862
|
*/
|
|
19803
|
-
readonly
|
|
19863
|
+
readonly maxTimestamp?: string;
|
|
19804
19864
|
}
|
|
19805
19865
|
/**
|
|
19806
|
-
*
|
|
19866
|
+
* TradesApi - object-oriented interface
|
|
19807
19867
|
* @export
|
|
19808
|
-
* @class
|
|
19868
|
+
* @class TradesApi
|
|
19809
19869
|
* @extends {BaseAPI}
|
|
19810
19870
|
*/
|
|
19811
|
-
declare class
|
|
19871
|
+
declare class TradesApi extends BaseAPI {
|
|
19812
19872
|
/**
|
|
19813
|
-
* Create a
|
|
19814
|
-
* @summary Create a
|
|
19815
|
-
* @param {
|
|
19873
|
+
* 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
|
|
19874
|
+
* @summary Create a Trade between two parties
|
|
19875
|
+
* @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
|
|
19816
19876
|
* @param {*} [options] Override http request option.
|
|
19817
19877
|
* @deprecated
|
|
19818
19878
|
* @throws {RequiredError}
|
|
19819
|
-
* @memberof
|
|
19820
|
-
*/
|
|
19821
|
-
createProject(requestParameters: ProjectsApiCreateProjectRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectResponse, any>>;
|
|
19822
|
-
/**
|
|
19823
|
-
* Create a project api key
|
|
19824
|
-
* @summary A new API key will be generated every time this endpoint is called.
|
|
19825
|
-
* @param {ProjectsApiCreateProjectAPIKeyRequest} requestParameters Request parameters.
|
|
19826
|
-
* @param {*} [options] Override http request option.
|
|
19827
|
-
* @throws {RequiredError}
|
|
19828
|
-
* @memberof ProjectsApi
|
|
19829
|
-
*/
|
|
19830
|
-
createProjectAPIKey(requestParameters: ProjectsApiCreateProjectAPIKeyRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectAPIKeyResponse, any>>;
|
|
19831
|
-
/**
|
|
19832
|
-
* Create a project group
|
|
19833
|
-
* @summary Create a project group
|
|
19834
|
-
* @param {ProjectsApiCreateProjectGroupRequest} requestParameters Request parameters.
|
|
19835
|
-
* @param {*} [options] Override http request option.
|
|
19836
|
-
* @throws {RequiredError}
|
|
19837
|
-
* @memberof ProjectsApi
|
|
19838
|
-
*/
|
|
19839
|
-
createProjectGroup(requestParameters: ProjectsApiCreateProjectGroupRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateProjectResponse, any>>;
|
|
19840
|
-
/**
|
|
19841
|
-
* Get a project
|
|
19842
|
-
* @summary Get a project
|
|
19843
|
-
* @param {ProjectsApiGetProjectRequest} requestParameters Request parameters.
|
|
19844
|
-
* @param {*} [options] Override http request option.
|
|
19845
|
-
* @throws {RequiredError}
|
|
19846
|
-
* @memberof ProjectsApi
|
|
19879
|
+
* @memberof TradesApi
|
|
19847
19880
|
*/
|
|
19848
|
-
|
|
19881
|
+
createTrade(requestParameters: TradesApiCreateTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
|
|
19849
19882
|
/**
|
|
19850
|
-
*
|
|
19851
|
-
* @summary
|
|
19852
|
-
* @param {
|
|
19883
|
+
* Create a Trade. Currently only buy order is supported.
|
|
19884
|
+
* @summary Create a Trade (V3)
|
|
19885
|
+
* @param {TradesApiCreateTradeV3Request} requestParameters Request parameters.
|
|
19853
19886
|
* @param {*} [options] Override http request option.
|
|
19854
19887
|
* @throws {RequiredError}
|
|
19855
|
-
* @memberof
|
|
19888
|
+
* @memberof TradesApi
|
|
19856
19889
|
*/
|
|
19857
|
-
|
|
19890
|
+
createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
|
|
19858
19891
|
/**
|
|
19859
|
-
*
|
|
19860
|
-
* @summary
|
|
19861
|
-
* @param {
|
|
19892
|
+
* Generate a signable trade message (V3)
|
|
19893
|
+
* @summary Generate a signable trade message (V3)
|
|
19894
|
+
* @param {TradesApiGetSignableTradeRequest} requestParameters Request parameters.
|
|
19862
19895
|
* @param {*} [options] Override http request option.
|
|
19863
19896
|
* @throws {RequiredError}
|
|
19864
|
-
* @memberof
|
|
19897
|
+
* @memberof TradesApi
|
|
19865
19898
|
*/
|
|
19866
|
-
|
|
19899
|
+
getSignableTrade(requestParameters: TradesApiGetSignableTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTradeResponse, any>>;
|
|
19867
19900
|
/**
|
|
19868
|
-
* Get
|
|
19869
|
-
* @summary Get
|
|
19870
|
-
* @param {
|
|
19901
|
+
* Get details of a trade with the given ID
|
|
19902
|
+
* @summary Get details of a trade with the given ID
|
|
19903
|
+
* @param {TradesApiGetTradeRequest} requestParameters Request parameters.
|
|
19871
19904
|
* @param {*} [options] Override http request option.
|
|
19905
|
+
* @deprecated
|
|
19872
19906
|
* @throws {RequiredError}
|
|
19873
|
-
* @memberof
|
|
19907
|
+
* @memberof TradesApi
|
|
19874
19908
|
*/
|
|
19875
|
-
|
|
19909
|
+
getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
|
|
19876
19910
|
/**
|
|
19877
|
-
*
|
|
19878
|
-
* @summary
|
|
19879
|
-
* @param {
|
|
19911
|
+
* Get details of a trade with the given ID
|
|
19912
|
+
* @summary Get details of a trade with the given ID
|
|
19913
|
+
* @param {TradesApiGetTradeV3Request} requestParameters Request parameters.
|
|
19880
19914
|
* @param {*} [options] Override http request option.
|
|
19881
19915
|
* @throws {RequiredError}
|
|
19882
|
-
* @memberof
|
|
19883
|
-
*/
|
|
19884
|
-
getSdkVersion(requestParameters: ProjectsApiGetSdkVersionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ApiSDKVersionCheckResponse, any>>;
|
|
19885
|
-
}
|
|
19886
|
-
|
|
19887
|
-
/**
|
|
19888
|
-
* Request parameters for getToken operation in TokensApi.
|
|
19889
|
-
* @export
|
|
19890
|
-
* @interface TokensApiGetTokenRequest
|
|
19891
|
-
*/
|
|
19892
|
-
interface TokensApiGetTokenRequest {
|
|
19893
|
-
/**
|
|
19894
|
-
* Token Contract Address
|
|
19895
|
-
* @type {string}
|
|
19896
|
-
* @memberof TokensApiGetToken
|
|
19897
|
-
*/
|
|
19898
|
-
readonly address: string;
|
|
19899
|
-
}
|
|
19900
|
-
/**
|
|
19901
|
-
* Request parameters for listTokens operation in TokensApi.
|
|
19902
|
-
* @export
|
|
19903
|
-
* @interface TokensApiListTokensRequest
|
|
19904
|
-
*/
|
|
19905
|
-
interface TokensApiListTokensRequest {
|
|
19906
|
-
/**
|
|
19907
|
-
* Page size of the result
|
|
19908
|
-
* @type {number}
|
|
19909
|
-
* @memberof TokensApiListTokens
|
|
19910
|
-
*/
|
|
19911
|
-
readonly pageSize?: number;
|
|
19912
|
-
/**
|
|
19913
|
-
* Cursor
|
|
19914
|
-
* @type {string}
|
|
19915
|
-
* @memberof TokensApiListTokens
|
|
19916
|
-
*/
|
|
19917
|
-
readonly cursor?: string;
|
|
19918
|
-
/**
|
|
19919
|
-
* Property to sort by
|
|
19920
|
-
* @type {'contract_address' | 'name' | 'symbol'}
|
|
19921
|
-
* @memberof TokensApiListTokens
|
|
19922
|
-
*/
|
|
19923
|
-
readonly orderBy?: 'contract_address' | 'name' | 'symbol';
|
|
19924
|
-
/**
|
|
19925
|
-
* Direction to sort (asc/desc)
|
|
19926
|
-
* @type {string}
|
|
19927
|
-
* @memberof TokensApiListTokens
|
|
19928
|
-
*/
|
|
19929
|
-
readonly direction?: string;
|
|
19930
|
-
/**
|
|
19931
|
-
* Contract address of the token
|
|
19932
|
-
* @type {string}
|
|
19933
|
-
* @memberof TokensApiListTokens
|
|
19934
|
-
*/
|
|
19935
|
-
readonly address?: string;
|
|
19936
|
-
/**
|
|
19937
|
-
* Token symbols for the token, e.g. ?symbols=IMX,ETH
|
|
19938
|
-
* @type {string}
|
|
19939
|
-
* @memberof TokensApiListTokens
|
|
19916
|
+
* @memberof TradesApi
|
|
19940
19917
|
*/
|
|
19941
|
-
|
|
19942
|
-
}
|
|
19943
|
-
/**
|
|
19944
|
-
* TokensApi - object-oriented interface
|
|
19945
|
-
* @export
|
|
19946
|
-
* @class TokensApi
|
|
19947
|
-
* @extends {BaseAPI}
|
|
19948
|
-
*/
|
|
19949
|
-
declare class TokensApi extends BaseAPI {
|
|
19918
|
+
getTradeV3(requestParameters: TradesApiGetTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
|
|
19950
19919
|
/**
|
|
19951
|
-
* Get
|
|
19952
|
-
* @summary Get
|
|
19953
|
-
* @param {
|
|
19920
|
+
* 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
|
|
19921
|
+
* @summary Get a list of trades
|
|
19922
|
+
* @param {TradesApiListTradesRequest} requestParameters Request parameters.
|
|
19954
19923
|
* @param {*} [options] Override http request option.
|
|
19924
|
+
* @deprecated
|
|
19955
19925
|
* @throws {RequiredError}
|
|
19956
|
-
* @memberof
|
|
19926
|
+
* @memberof TradesApi
|
|
19957
19927
|
*/
|
|
19958
|
-
|
|
19928
|
+
listTrades(requestParameters?: TradesApiListTradesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
|
|
19959
19929
|
/**
|
|
19960
|
-
* Get a list of
|
|
19961
|
-
* @summary Get a list of
|
|
19962
|
-
* @param {
|
|
19930
|
+
* Get a list of trades (V3)
|
|
19931
|
+
* @summary Get a list of trades (V3)
|
|
19932
|
+
* @param {TradesApiListTradesV3Request} requestParameters Request parameters.
|
|
19963
19933
|
* @param {*} [options] Override http request option.
|
|
19964
19934
|
* @throws {RequiredError}
|
|
19965
|
-
* @memberof
|
|
19935
|
+
* @memberof TradesApi
|
|
19966
19936
|
*/
|
|
19967
|
-
|
|
19937
|
+
listTradesV3(requestParameters?: TradesApiListTradesV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
|
|
19968
19938
|
}
|
|
19969
19939
|
|
|
19970
19940
|
/**
|
|
19971
|
-
* Request parameters for
|
|
19941
|
+
* Request parameters for createTransfer operation in TransfersApi.
|
|
19972
19942
|
* @export
|
|
19973
|
-
* @interface
|
|
19943
|
+
* @interface TransfersApiCreateTransferRequest
|
|
19974
19944
|
*/
|
|
19975
|
-
interface
|
|
19945
|
+
interface TransfersApiCreateTransferRequest {
|
|
19976
19946
|
/**
|
|
19977
|
-
*
|
|
19978
|
-
* @type {
|
|
19979
|
-
* @memberof
|
|
19947
|
+
* Create transfer
|
|
19948
|
+
* @type {CreateTransferRequest}
|
|
19949
|
+
* @memberof TransfersApiCreateTransfer
|
|
19980
19950
|
*/
|
|
19981
|
-
readonly
|
|
19951
|
+
readonly createTransferRequestV2: CreateTransferRequest;
|
|
19982
19952
|
/**
|
|
19983
19953
|
* eth address
|
|
19984
19954
|
* @type {string}
|
|
19985
|
-
* @memberof
|
|
19955
|
+
* @memberof TransfersApiCreateTransfer
|
|
19986
19956
|
*/
|
|
19987
19957
|
readonly xImxEthAddress?: string;
|
|
19988
19958
|
/**
|
|
19989
19959
|
* eth signature
|
|
19990
19960
|
* @type {string}
|
|
19991
|
-
* @memberof
|
|
19961
|
+
* @memberof TransfersApiCreateTransfer
|
|
19992
19962
|
*/
|
|
19993
19963
|
readonly xImxEthSignature?: string;
|
|
19994
19964
|
/**
|
|
19995
19965
|
* Authorization header
|
|
19996
19966
|
* @type {string}
|
|
19997
|
-
* @memberof
|
|
19967
|
+
* @memberof TransfersApiCreateTransfer
|
|
19998
19968
|
*/
|
|
19999
19969
|
readonly authorization?: string;
|
|
20000
19970
|
}
|
|
20001
19971
|
/**
|
|
20002
|
-
* Request parameters for
|
|
19972
|
+
* Request parameters for createTransferV1 operation in TransfersApi.
|
|
20003
19973
|
* @export
|
|
20004
|
-
* @interface
|
|
19974
|
+
* @interface TransfersApiCreateTransferV1Request
|
|
20005
19975
|
*/
|
|
20006
|
-
interface
|
|
19976
|
+
interface TransfersApiCreateTransferV1Request {
|
|
20007
19977
|
/**
|
|
20008
|
-
*
|
|
20009
|
-
* @type {
|
|
20010
|
-
* @memberof
|
|
19978
|
+
* Create transfer
|
|
19979
|
+
* @type {CreateTransferRequestV1}
|
|
19980
|
+
* @memberof TransfersApiCreateTransferV1
|
|
20011
19981
|
*/
|
|
20012
|
-
readonly
|
|
19982
|
+
readonly createTransferRequest: CreateTransferRequestV1;
|
|
20013
19983
|
/**
|
|
20014
19984
|
* eth address
|
|
20015
19985
|
* @type {string}
|
|
20016
|
-
* @memberof
|
|
19986
|
+
* @memberof TransfersApiCreateTransferV1
|
|
20017
19987
|
*/
|
|
20018
19988
|
readonly xImxEthAddress?: string;
|
|
20019
19989
|
/**
|
|
20020
19990
|
* eth signature
|
|
20021
19991
|
* @type {string}
|
|
20022
|
-
* @memberof
|
|
19992
|
+
* @memberof TransfersApiCreateTransferV1
|
|
20023
19993
|
*/
|
|
20024
19994
|
readonly xImxEthSignature?: string;
|
|
20025
19995
|
/**
|
|
20026
19996
|
* Authorization header
|
|
20027
19997
|
* @type {string}
|
|
20028
|
-
* @memberof
|
|
19998
|
+
* @memberof TransfersApiCreateTransferV1
|
|
20029
19999
|
*/
|
|
20030
20000
|
readonly authorization?: string;
|
|
20031
20001
|
}
|
|
20032
20002
|
/**
|
|
20033
|
-
* Request parameters for
|
|
20003
|
+
* Request parameters for getSignableTransfer operation in TransfersApi.
|
|
20034
20004
|
* @export
|
|
20035
|
-
* @interface
|
|
20005
|
+
* @interface TransfersApiGetSignableTransferRequest
|
|
20036
20006
|
*/
|
|
20037
|
-
interface
|
|
20007
|
+
interface TransfersApiGetSignableTransferRequest {
|
|
20038
20008
|
/**
|
|
20039
|
-
* get
|
|
20040
|
-
* @type {
|
|
20041
|
-
* @memberof
|
|
20009
|
+
* get details of signable transfer
|
|
20010
|
+
* @type {GetSignableTransferRequestV2}
|
|
20011
|
+
* @memberof TransfersApiGetSignableTransfer
|
|
20042
20012
|
*/
|
|
20043
|
-
readonly
|
|
20013
|
+
readonly getSignableTransferRequestV2: GetSignableTransferRequestV2;
|
|
20044
20014
|
}
|
|
20045
20015
|
/**
|
|
20046
|
-
* Request parameters for
|
|
20016
|
+
* Request parameters for getSignableTransferV1 operation in TransfersApi.
|
|
20047
20017
|
* @export
|
|
20048
|
-
* @interface
|
|
20018
|
+
* @interface TransfersApiGetSignableTransferV1Request
|
|
20049
20019
|
*/
|
|
20050
|
-
interface
|
|
20020
|
+
interface TransfersApiGetSignableTransferV1Request {
|
|
20051
20021
|
/**
|
|
20052
|
-
*
|
|
20053
|
-
* @type {
|
|
20054
|
-
* @memberof
|
|
20022
|
+
* get details of signable transfer
|
|
20023
|
+
* @type {GetSignableTransferRequest}
|
|
20024
|
+
* @memberof TransfersApiGetSignableTransferV1
|
|
20055
20025
|
*/
|
|
20056
|
-
readonly
|
|
20026
|
+
readonly getSignableTransferRequest: GetSignableTransferRequest;
|
|
20057
20027
|
}
|
|
20058
20028
|
/**
|
|
20059
|
-
* Request parameters for
|
|
20029
|
+
* Request parameters for getTransfer operation in TransfersApi.
|
|
20060
20030
|
* @export
|
|
20061
|
-
* @interface
|
|
20031
|
+
* @interface TransfersApiGetTransferRequest
|
|
20062
20032
|
*/
|
|
20063
|
-
interface
|
|
20033
|
+
interface TransfersApiGetTransferRequest {
|
|
20064
20034
|
/**
|
|
20065
|
-
*
|
|
20035
|
+
* Transfer ID
|
|
20066
20036
|
* @type {string}
|
|
20067
|
-
* @memberof
|
|
20037
|
+
* @memberof TransfersApiGetTransfer
|
|
20068
20038
|
*/
|
|
20069
20039
|
readonly id: string;
|
|
20070
20040
|
}
|
|
20071
20041
|
/**
|
|
20072
|
-
* Request parameters for
|
|
20042
|
+
* Request parameters for listTransfers operation in TransfersApi.
|
|
20073
20043
|
* @export
|
|
20074
|
-
* @interface
|
|
20044
|
+
* @interface TransfersApiListTransfersRequest
|
|
20075
20045
|
*/
|
|
20076
|
-
interface
|
|
20046
|
+
interface TransfersApiListTransfersRequest {
|
|
20077
20047
|
/**
|
|
20078
|
-
*
|
|
20048
|
+
* Page size of the result
|
|
20049
|
+
* @type {number}
|
|
20050
|
+
* @memberof TransfersApiListTransfers
|
|
20051
|
+
*/
|
|
20052
|
+
readonly pageSize?: number;
|
|
20053
|
+
/**
|
|
20054
|
+
* Cursor
|
|
20079
20055
|
* @type {string}
|
|
20080
|
-
* @memberof
|
|
20056
|
+
* @memberof TransfersApiListTransfers
|
|
20081
20057
|
*/
|
|
20082
|
-
readonly
|
|
20058
|
+
readonly cursor?: string;
|
|
20083
20059
|
/**
|
|
20084
|
-
*
|
|
20060
|
+
* Property to sort by
|
|
20061
|
+
* @type {'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key'}
|
|
20062
|
+
* @memberof TransfersApiListTransfers
|
|
20063
|
+
*/
|
|
20064
|
+
readonly orderBy?: 'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key';
|
|
20065
|
+
/**
|
|
20066
|
+
* Direction to sort (asc/desc)
|
|
20085
20067
|
* @type {string}
|
|
20086
|
-
* @memberof
|
|
20068
|
+
* @memberof TransfersApiListTransfers
|
|
20087
20069
|
*/
|
|
20088
|
-
readonly
|
|
20070
|
+
readonly direction?: string;
|
|
20089
20071
|
/**
|
|
20090
|
-
*
|
|
20072
|
+
* Ethereum address of the user who submitted this transfer
|
|
20091
20073
|
* @type {string}
|
|
20092
|
-
* @memberof
|
|
20074
|
+
* @memberof TransfersApiListTransfers
|
|
20093
20075
|
*/
|
|
20094
|
-
readonly
|
|
20076
|
+
readonly user?: string;
|
|
20095
20077
|
/**
|
|
20096
|
-
*
|
|
20078
|
+
* Ethereum address of the user who received this transfer
|
|
20097
20079
|
* @type {string}
|
|
20098
|
-
* @memberof
|
|
20080
|
+
* @memberof TransfersApiListTransfers
|
|
20099
20081
|
*/
|
|
20100
|
-
readonly
|
|
20082
|
+
readonly receiver?: string;
|
|
20101
20083
|
/**
|
|
20102
|
-
*
|
|
20084
|
+
* Status of this transfer
|
|
20085
|
+
* @type {'success' | 'failure'}
|
|
20086
|
+
* @memberof TransfersApiListTransfers
|
|
20087
|
+
*/
|
|
20088
|
+
readonly status?: 'success' | 'failure';
|
|
20089
|
+
/**
|
|
20090
|
+
* Minimum timestamp for this transfer, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
20103
20091
|
* @type {string}
|
|
20104
|
-
* @memberof
|
|
20092
|
+
* @memberof TransfersApiListTransfers
|
|
20105
20093
|
*/
|
|
20106
|
-
readonly
|
|
20094
|
+
readonly minTimestamp?: string;
|
|
20107
20095
|
/**
|
|
20108
|
-
*
|
|
20109
|
-
* @type {
|
|
20110
|
-
* @memberof
|
|
20096
|
+
* Maximum timestamp for this transfer, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
20097
|
+
* @type {string}
|
|
20098
|
+
* @memberof TransfersApiListTransfers
|
|
20111
20099
|
*/
|
|
20112
|
-
readonly
|
|
20100
|
+
readonly maxTimestamp?: string;
|
|
20113
20101
|
/**
|
|
20114
|
-
*
|
|
20102
|
+
* Token type of the transferred asset
|
|
20115
20103
|
* @type {string}
|
|
20116
|
-
* @memberof
|
|
20104
|
+
* @memberof TransfersApiListTransfers
|
|
20117
20105
|
*/
|
|
20118
|
-
readonly
|
|
20106
|
+
readonly tokenType?: string;
|
|
20119
20107
|
/**
|
|
20120
|
-
*
|
|
20121
|
-
* @type {
|
|
20122
|
-
* @memberof
|
|
20108
|
+
* ERC721 Token ID of the minted asset
|
|
20109
|
+
* @type {string}
|
|
20110
|
+
* @memberof TransfersApiListTransfers
|
|
20123
20111
|
*/
|
|
20124
|
-
readonly
|
|
20112
|
+
readonly tokenId?: string;
|
|
20125
20113
|
/**
|
|
20126
|
-
*
|
|
20114
|
+
* Internal IMX ID of the minted asset
|
|
20127
20115
|
* @type {string}
|
|
20128
|
-
* @memberof
|
|
20116
|
+
* @memberof TransfersApiListTransfers
|
|
20129
20117
|
*/
|
|
20130
|
-
readonly
|
|
20118
|
+
readonly assetId?: string;
|
|
20131
20119
|
/**
|
|
20132
|
-
*
|
|
20120
|
+
* Token address of the transferred asset
|
|
20133
20121
|
* @type {string}
|
|
20134
|
-
* @memberof
|
|
20122
|
+
* @memberof TransfersApiListTransfers
|
|
20135
20123
|
*/
|
|
20136
|
-
readonly
|
|
20124
|
+
readonly tokenAddress?: string;
|
|
20137
20125
|
/**
|
|
20138
|
-
*
|
|
20126
|
+
* Token name of the transferred asset
|
|
20139
20127
|
* @type {string}
|
|
20140
|
-
* @memberof
|
|
20128
|
+
* @memberof TransfersApiListTransfers
|
|
20129
|
+
*/
|
|
20130
|
+
readonly tokenName?: string;
|
|
20131
|
+
/**
|
|
20132
|
+
* Max quantity for the transferred asset
|
|
20133
|
+
* @type {string}
|
|
20134
|
+
* @memberof TransfersApiListTransfers
|
|
20135
|
+
*/
|
|
20136
|
+
readonly minQuantity?: string;
|
|
20137
|
+
/**
|
|
20138
|
+
* Max quantity for the transferred asset
|
|
20139
|
+
* @type {string}
|
|
20140
|
+
* @memberof TransfersApiListTransfers
|
|
20141
|
+
*/
|
|
20142
|
+
readonly maxQuantity?: string;
|
|
20143
|
+
/**
|
|
20144
|
+
* JSON-encoded metadata filters for the transferred asset
|
|
20145
|
+
* @type {string}
|
|
20146
|
+
* @memberof TransfersApiListTransfers
|
|
20147
|
+
*/
|
|
20148
|
+
readonly metadata?: string;
|
|
20149
|
+
}
|
|
20150
|
+
/**
|
|
20151
|
+
* TransfersApi - object-oriented interface
|
|
20152
|
+
* @export
|
|
20153
|
+
* @class TransfersApi
|
|
20154
|
+
* @extends {BaseAPI}
|
|
20155
|
+
*/
|
|
20156
|
+
declare class TransfersApi extends BaseAPI {
|
|
20157
|
+
/**
|
|
20158
|
+
* Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransfer to get request body params.
|
|
20159
|
+
* @summary Creates a transfer of multiple tokens between two parties
|
|
20160
|
+
* @param {TransfersApiCreateTransferRequest} requestParameters Request parameters.
|
|
20161
|
+
* @param {*} [options] Override http request option.
|
|
20162
|
+
* @throws {RequiredError}
|
|
20163
|
+
* @memberof TransfersApi
|
|
20164
|
+
*/
|
|
20165
|
+
createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
|
|
20166
|
+
/**
|
|
20167
|
+
* Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
|
|
20168
|
+
* @summary Creates a transfer of tokens between two parties
|
|
20169
|
+
* @param {TransfersApiCreateTransferV1Request} requestParameters Request parameters.
|
|
20170
|
+
* @param {*} [options] Override http request option.
|
|
20171
|
+
* @throws {RequiredError}
|
|
20172
|
+
* @memberof TransfersApi
|
|
20173
|
+
*/
|
|
20174
|
+
createTransferV1(requestParameters: TransfersApiCreateTransferV1Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
|
|
20175
|
+
/**
|
|
20176
|
+
* Gets bulk details of a signable transfer
|
|
20177
|
+
* @summary Gets bulk details of a signable transfer
|
|
20178
|
+
* @param {TransfersApiGetSignableTransferRequest} requestParameters Request parameters.
|
|
20179
|
+
* @param {*} [options] Override http request option.
|
|
20180
|
+
* @throws {RequiredError}
|
|
20181
|
+
* @memberof TransfersApi
|
|
20182
|
+
*/
|
|
20183
|
+
getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponse, any>>;
|
|
20184
|
+
/**
|
|
20185
|
+
* Gets details of a signable transfer
|
|
20186
|
+
* @summary Gets details of a signable transfer
|
|
20187
|
+
* @param {TransfersApiGetSignableTransferV1Request} requestParameters Request parameters.
|
|
20188
|
+
* @param {*} [options] Override http request option.
|
|
20189
|
+
* @throws {RequiredError}
|
|
20190
|
+
* @memberof TransfersApi
|
|
20191
|
+
*/
|
|
20192
|
+
getSignableTransferV1(requestParameters: TransfersApiGetSignableTransferV1Request, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponse, any>>;
|
|
20193
|
+
/**
|
|
20194
|
+
* Get details of a transfer with the given ID
|
|
20195
|
+
* @summary Get details of a transfer with the given ID
|
|
20196
|
+
* @param {TransfersApiGetTransferRequest} requestParameters Request parameters.
|
|
20197
|
+
* @param {*} [options] Override http request option.
|
|
20198
|
+
* @throws {RequiredError}
|
|
20199
|
+
* @memberof TransfersApi
|
|
20200
|
+
*/
|
|
20201
|
+
getTransfer(requestParameters: TransfersApiGetTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Transfer, any>>;
|
|
20202
|
+
/**
|
|
20203
|
+
* Get a list of transfers
|
|
20204
|
+
* @summary Get a list of transfers
|
|
20205
|
+
* @param {TransfersApiListTransfersRequest} requestParameters Request parameters.
|
|
20206
|
+
* @param {*} [options] Override http request option.
|
|
20207
|
+
* @throws {RequiredError}
|
|
20208
|
+
* @memberof TransfersApi
|
|
20209
|
+
*/
|
|
20210
|
+
listTransfers(requestParameters?: TransfersApiListTransfersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTransfersResponse, any>>;
|
|
20211
|
+
}
|
|
20212
|
+
|
|
20213
|
+
/**
|
|
20214
|
+
* Request parameters for getSignableRegistration operation in UsersApi.
|
|
20215
|
+
* @export
|
|
20216
|
+
* @interface UsersApiGetSignableRegistrationRequest
|
|
20217
|
+
*/
|
|
20218
|
+
interface UsersApiGetSignableRegistrationRequest {
|
|
20219
|
+
/**
|
|
20220
|
+
* Register User
|
|
20221
|
+
* @type {GetSignableRegistrationRequest}
|
|
20222
|
+
* @memberof UsersApiGetSignableRegistration
|
|
20223
|
+
*/
|
|
20224
|
+
readonly getSignableRegistrationRequest: GetSignableRegistrationRequest;
|
|
20225
|
+
}
|
|
20226
|
+
/**
|
|
20227
|
+
* Request parameters for getSignableRegistrationOffchain operation in UsersApi.
|
|
20228
|
+
* @export
|
|
20229
|
+
* @interface UsersApiGetSignableRegistrationOffchainRequest
|
|
20230
|
+
*/
|
|
20231
|
+
interface UsersApiGetSignableRegistrationOffchainRequest {
|
|
20232
|
+
/**
|
|
20233
|
+
* Register User Offchain
|
|
20234
|
+
* @type {GetSignableRegistrationRequest}
|
|
20235
|
+
* @memberof UsersApiGetSignableRegistrationOffchain
|
|
20141
20236
|
*/
|
|
20142
|
-
readonly
|
|
20237
|
+
readonly getSignableRegistrationRequest: GetSignableRegistrationRequest;
|
|
20143
20238
|
}
|
|
20144
20239
|
/**
|
|
20145
|
-
* Request parameters for
|
|
20240
|
+
* Request parameters for getUsers operation in UsersApi.
|
|
20146
20241
|
* @export
|
|
20147
|
-
* @interface
|
|
20242
|
+
* @interface UsersApiGetUsersRequest
|
|
20148
20243
|
*/
|
|
20149
|
-
interface
|
|
20150
|
-
/**
|
|
20151
|
-
* Party A\'s (buy order) token type of currency used to buy
|
|
20152
|
-
* @type {string}
|
|
20153
|
-
* @memberof TradesApiListTradesV3
|
|
20154
|
-
*/
|
|
20155
|
-
readonly partyATokenType?: string;
|
|
20156
|
-
/**
|
|
20157
|
-
* Party A\'s (buy order) token address of currency used to buy
|
|
20158
|
-
* @type {string}
|
|
20159
|
-
* @memberof TradesApiListTradesV3
|
|
20160
|
-
*/
|
|
20161
|
-
readonly partyATokenAddress?: string;
|
|
20162
|
-
/**
|
|
20163
|
-
* Party B\'s (sell order) token type of NFT sold - always ERC721
|
|
20164
|
-
* @type {string}
|
|
20165
|
-
* @memberof TradesApiListTradesV3
|
|
20166
|
-
*/
|
|
20167
|
-
readonly partyBTokenType?: string;
|
|
20168
|
-
/**
|
|
20169
|
-
* Party B\'s (sell order) collection address of NFT sold
|
|
20170
|
-
* @type {string}
|
|
20171
|
-
* @memberof TradesApiListTradesV3
|
|
20172
|
-
*/
|
|
20173
|
-
readonly partyBTokenAddress?: string;
|
|
20244
|
+
interface UsersApiGetUsersRequest {
|
|
20174
20245
|
/**
|
|
20175
|
-
*
|
|
20246
|
+
* User
|
|
20176
20247
|
* @type {string}
|
|
20177
|
-
* @memberof
|
|
20178
|
-
*/
|
|
20179
|
-
readonly partyBTokenId?: string;
|
|
20180
|
-
/**
|
|
20181
|
-
* Page size of the result
|
|
20182
|
-
* @type {number}
|
|
20183
|
-
* @memberof TradesApiListTradesV3
|
|
20248
|
+
* @memberof UsersApiGetUsers
|
|
20184
20249
|
*/
|
|
20185
|
-
readonly
|
|
20250
|
+
readonly user: string;
|
|
20251
|
+
}
|
|
20252
|
+
/**
|
|
20253
|
+
* Request parameters for registerPassportUser operation in UsersApi.
|
|
20254
|
+
* @export
|
|
20255
|
+
* @interface UsersApiRegisterPassportUserRequest
|
|
20256
|
+
*/
|
|
20257
|
+
interface UsersApiRegisterPassportUserRequest {
|
|
20186
20258
|
/**
|
|
20187
|
-
*
|
|
20259
|
+
* Authorization header
|
|
20188
20260
|
* @type {string}
|
|
20189
|
-
* @memberof
|
|
20261
|
+
* @memberof UsersApiRegisterPassportUser
|
|
20190
20262
|
*/
|
|
20191
|
-
readonly
|
|
20263
|
+
readonly authorization: string;
|
|
20192
20264
|
/**
|
|
20193
|
-
*
|
|
20194
|
-
* @type {
|
|
20195
|
-
* @memberof
|
|
20265
|
+
* Register Passport User
|
|
20266
|
+
* @type {ApiRegisterPassportUserRequest}
|
|
20267
|
+
* @memberof UsersApiRegisterPassportUser
|
|
20196
20268
|
*/
|
|
20197
|
-
readonly
|
|
20269
|
+
readonly registerPassportUserRequest: ApiRegisterPassportUserRequest;
|
|
20270
|
+
}
|
|
20271
|
+
/**
|
|
20272
|
+
* Request parameters for registerPassportUserV2 operation in UsersApi.
|
|
20273
|
+
* @export
|
|
20274
|
+
* @interface UsersApiRegisterPassportUserV2Request
|
|
20275
|
+
*/
|
|
20276
|
+
interface UsersApiRegisterPassportUserV2Request {
|
|
20198
20277
|
/**
|
|
20199
|
-
*
|
|
20278
|
+
* Authorization header
|
|
20200
20279
|
* @type {string}
|
|
20201
|
-
* @memberof
|
|
20280
|
+
* @memberof UsersApiRegisterPassportUserV2
|
|
20202
20281
|
*/
|
|
20203
|
-
readonly
|
|
20282
|
+
readonly authorization: string;
|
|
20204
20283
|
/**
|
|
20205
|
-
*
|
|
20206
|
-
* @type {
|
|
20207
|
-
* @memberof
|
|
20284
|
+
* Register Passport User
|
|
20285
|
+
* @type {ApiRegisterPassportUserRequest}
|
|
20286
|
+
* @memberof UsersApiRegisterPassportUserV2
|
|
20208
20287
|
*/
|
|
20209
|
-
readonly
|
|
20288
|
+
readonly registerPassportUserRequest: ApiRegisterPassportUserRequest;
|
|
20289
|
+
}
|
|
20290
|
+
/**
|
|
20291
|
+
* Request parameters for registerUser operation in UsersApi.
|
|
20292
|
+
* @export
|
|
20293
|
+
* @interface UsersApiRegisterUserRequest
|
|
20294
|
+
*/
|
|
20295
|
+
interface UsersApiRegisterUserRequest {
|
|
20210
20296
|
/**
|
|
20211
|
-
*
|
|
20212
|
-
* @type {
|
|
20213
|
-
* @memberof
|
|
20297
|
+
* Register User
|
|
20298
|
+
* @type {RegisterUserRequest}
|
|
20299
|
+
* @memberof UsersApiRegisterUser
|
|
20214
20300
|
*/
|
|
20215
|
-
readonly
|
|
20301
|
+
readonly registerUserRequest: RegisterUserRequest;
|
|
20216
20302
|
}
|
|
20217
20303
|
/**
|
|
20218
|
-
*
|
|
20304
|
+
* UsersApi - object-oriented interface
|
|
20219
20305
|
* @export
|
|
20220
|
-
* @class
|
|
20306
|
+
* @class UsersApi
|
|
20221
20307
|
* @extends {BaseAPI}
|
|
20222
20308
|
*/
|
|
20223
|
-
declare class
|
|
20224
|
-
/**
|
|
20225
|
-
* 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
|
|
20226
|
-
* @summary Create a Trade between two parties
|
|
20227
|
-
* @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
|
|
20228
|
-
* @param {*} [options] Override http request option.
|
|
20229
|
-
* @deprecated
|
|
20230
|
-
* @throws {RequiredError}
|
|
20231
|
-
* @memberof TradesApi
|
|
20232
|
-
*/
|
|
20233
|
-
createTrade(requestParameters: TradesApiCreateTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
|
|
20309
|
+
declare class UsersApi extends BaseAPI {
|
|
20234
20310
|
/**
|
|
20235
|
-
*
|
|
20236
|
-
* @summary
|
|
20237
|
-
* @param {
|
|
20311
|
+
* Get operator signature to allow clients to register the user
|
|
20312
|
+
* @summary Get operator signature to allow clients to register the user
|
|
20313
|
+
* @param {UsersApiGetSignableRegistrationRequest} requestParameters Request parameters.
|
|
20238
20314
|
* @param {*} [options] Override http request option.
|
|
20239
20315
|
* @throws {RequiredError}
|
|
20240
|
-
* @memberof
|
|
20316
|
+
* @memberof UsersApi
|
|
20241
20317
|
*/
|
|
20242
|
-
|
|
20318
|
+
getSignableRegistration(requestParameters: UsersApiGetSignableRegistrationRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableRegistrationResponse, any>>;
|
|
20243
20319
|
/**
|
|
20244
|
-
*
|
|
20245
|
-
* @summary
|
|
20246
|
-
* @param {
|
|
20320
|
+
* Get encoded details to allow clients to register the user offchain
|
|
20321
|
+
* @summary Get encoded details to allow clients to register the user offchain
|
|
20322
|
+
* @param {UsersApiGetSignableRegistrationOffchainRequest} requestParameters Request parameters.
|
|
20247
20323
|
* @param {*} [options] Override http request option.
|
|
20248
20324
|
* @throws {RequiredError}
|
|
20249
|
-
* @memberof
|
|
20325
|
+
* @memberof UsersApi
|
|
20250
20326
|
*/
|
|
20251
|
-
|
|
20327
|
+
getSignableRegistrationOffchain(requestParameters: UsersApiGetSignableRegistrationOffchainRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableRegistrationOffchainResponse, any>>;
|
|
20252
20328
|
/**
|
|
20253
|
-
* Get
|
|
20254
|
-
* @summary Get
|
|
20255
|
-
* @param {
|
|
20329
|
+
* Get stark keys for a registered user
|
|
20330
|
+
* @summary Get stark keys for a registered user
|
|
20331
|
+
* @param {UsersApiGetUsersRequest} requestParameters Request parameters.
|
|
20256
20332
|
* @param {*} [options] Override http request option.
|
|
20257
|
-
* @deprecated
|
|
20258
20333
|
* @throws {RequiredError}
|
|
20259
|
-
* @memberof
|
|
20334
|
+
* @memberof UsersApi
|
|
20260
20335
|
*/
|
|
20261
|
-
|
|
20336
|
+
getUsers(requestParameters: UsersApiGetUsersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetUsersApiResponse, any>>;
|
|
20262
20337
|
/**
|
|
20263
|
-
*
|
|
20264
|
-
* @summary
|
|
20265
|
-
* @param {
|
|
20338
|
+
* Registers a passport user
|
|
20339
|
+
* @summary Registers a passport user
|
|
20340
|
+
* @param {UsersApiRegisterPassportUserRequest} requestParameters Request parameters.
|
|
20266
20341
|
* @param {*} [options] Override http request option.
|
|
20267
20342
|
* @throws {RequiredError}
|
|
20268
|
-
* @memberof
|
|
20343
|
+
* @memberof UsersApi
|
|
20269
20344
|
*/
|
|
20270
|
-
|
|
20345
|
+
registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterPassportUserResult, any>>;
|
|
20271
20346
|
/**
|
|
20272
|
-
*
|
|
20273
|
-
* @summary
|
|
20274
|
-
* @param {
|
|
20347
|
+
* Registers a passport user
|
|
20348
|
+
* @summary Registers a passport user
|
|
20349
|
+
* @param {UsersApiRegisterPassportUserV2Request} requestParameters Request parameters.
|
|
20275
20350
|
* @param {*} [options] Override http request option.
|
|
20276
|
-
* @deprecated
|
|
20277
20351
|
* @throws {RequiredError}
|
|
20278
|
-
* @memberof
|
|
20352
|
+
* @memberof UsersApi
|
|
20279
20353
|
*/
|
|
20280
|
-
|
|
20354
|
+
registerPassportUserV2(requestParameters: UsersApiRegisterPassportUserV2Request, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterPassportUserResult, any>>;
|
|
20281
20355
|
/**
|
|
20282
|
-
*
|
|
20283
|
-
* @summary
|
|
20284
|
-
* @param {
|
|
20356
|
+
* Registers a user
|
|
20357
|
+
* @summary Registers a user
|
|
20358
|
+
* @param {UsersApiRegisterUserRequest} requestParameters Request parameters.
|
|
20285
20359
|
* @param {*} [options] Override http request option.
|
|
20286
20360
|
* @throws {RequiredError}
|
|
20287
|
-
* @memberof
|
|
20361
|
+
* @memberof UsersApi
|
|
20288
20362
|
*/
|
|
20289
|
-
|
|
20363
|
+
registerUser(requestParameters: UsersApiRegisterUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterUserResponse, any>>;
|
|
20290
20364
|
}
|
|
20291
20365
|
|
|
20292
20366
|
/**
|
|
20293
|
-
* Request parameters for
|
|
20294
|
-
* @export
|
|
20295
|
-
* @interface TransfersApiCreateTransferRequest
|
|
20296
|
-
*/
|
|
20297
|
-
interface TransfersApiCreateTransferRequest {
|
|
20298
|
-
/**
|
|
20299
|
-
* Create transfer
|
|
20300
|
-
* @type {CreateTransferRequest}
|
|
20301
|
-
* @memberof TransfersApiCreateTransfer
|
|
20302
|
-
*/
|
|
20303
|
-
readonly createTransferRequestV2: CreateTransferRequest;
|
|
20304
|
-
/**
|
|
20305
|
-
* eth address
|
|
20306
|
-
* @type {string}
|
|
20307
|
-
* @memberof TransfersApiCreateTransfer
|
|
20308
|
-
*/
|
|
20309
|
-
readonly xImxEthAddress?: string;
|
|
20310
|
-
/**
|
|
20311
|
-
* eth signature
|
|
20312
|
-
* @type {string}
|
|
20313
|
-
* @memberof TransfersApiCreateTransfer
|
|
20314
|
-
*/
|
|
20315
|
-
readonly xImxEthSignature?: string;
|
|
20316
|
-
/**
|
|
20317
|
-
* Authorization header
|
|
20318
|
-
* @type {string}
|
|
20319
|
-
* @memberof TransfersApiCreateTransfer
|
|
20320
|
-
*/
|
|
20321
|
-
readonly authorization?: string;
|
|
20322
|
-
}
|
|
20323
|
-
/**
|
|
20324
|
-
* Request parameters for createTransferV1 operation in TransfersApi.
|
|
20367
|
+
* Request parameters for createWithdrawal operation in WithdrawalsApi.
|
|
20325
20368
|
* @export
|
|
20326
|
-
* @interface
|
|
20369
|
+
* @interface WithdrawalsApiCreateWithdrawalRequest
|
|
20327
20370
|
*/
|
|
20328
|
-
interface
|
|
20329
|
-
/**
|
|
20330
|
-
* Create transfer
|
|
20331
|
-
* @type {CreateTransferRequestV1}
|
|
20332
|
-
* @memberof TransfersApiCreateTransferV1
|
|
20333
|
-
*/
|
|
20334
|
-
readonly createTransferRequest: CreateTransferRequestV1;
|
|
20371
|
+
interface WithdrawalsApiCreateWithdrawalRequest {
|
|
20335
20372
|
/**
|
|
20336
20373
|
* eth address
|
|
20337
20374
|
* @type {string}
|
|
20338
|
-
* @memberof
|
|
20375
|
+
* @memberof WithdrawalsApiCreateWithdrawal
|
|
20339
20376
|
*/
|
|
20340
|
-
readonly xImxEthAddress
|
|
20377
|
+
readonly xImxEthAddress: string;
|
|
20341
20378
|
/**
|
|
20342
20379
|
* eth signature
|
|
20343
20380
|
* @type {string}
|
|
20344
|
-
* @memberof
|
|
20345
|
-
*/
|
|
20346
|
-
readonly xImxEthSignature?: string;
|
|
20347
|
-
/**
|
|
20348
|
-
* Authorization header
|
|
20349
|
-
* @type {string}
|
|
20350
|
-
* @memberof TransfersApiCreateTransferV1
|
|
20381
|
+
* @memberof WithdrawalsApiCreateWithdrawal
|
|
20351
20382
|
*/
|
|
20352
|
-
readonly
|
|
20353
|
-
}
|
|
20354
|
-
/**
|
|
20355
|
-
* Request parameters for getSignableTransfer operation in TransfersApi.
|
|
20356
|
-
* @export
|
|
20357
|
-
* @interface TransfersApiGetSignableTransferRequest
|
|
20358
|
-
*/
|
|
20359
|
-
interface TransfersApiGetSignableTransferRequest {
|
|
20383
|
+
readonly xImxEthSignature: string;
|
|
20360
20384
|
/**
|
|
20361
|
-
*
|
|
20362
|
-
* @type {
|
|
20363
|
-
* @memberof
|
|
20385
|
+
* create a withdrawal
|
|
20386
|
+
* @type {CreateWithdrawalRequest}
|
|
20387
|
+
* @memberof WithdrawalsApiCreateWithdrawal
|
|
20364
20388
|
*/
|
|
20365
|
-
readonly
|
|
20389
|
+
readonly createWithdrawalRequest: CreateWithdrawalRequest;
|
|
20366
20390
|
}
|
|
20367
20391
|
/**
|
|
20368
|
-
* Request parameters for
|
|
20392
|
+
* Request parameters for getSignableWithdrawal operation in WithdrawalsApi.
|
|
20369
20393
|
* @export
|
|
20370
|
-
* @interface
|
|
20394
|
+
* @interface WithdrawalsApiGetSignableWithdrawalRequest
|
|
20371
20395
|
*/
|
|
20372
|
-
interface
|
|
20396
|
+
interface WithdrawalsApiGetSignableWithdrawalRequest {
|
|
20373
20397
|
/**
|
|
20374
|
-
* get details of signable
|
|
20375
|
-
* @type {
|
|
20376
|
-
* @memberof
|
|
20398
|
+
* get details of signable withdrawal
|
|
20399
|
+
* @type {GetSignableWithdrawalRequest}
|
|
20400
|
+
* @memberof WithdrawalsApiGetSignableWithdrawal
|
|
20377
20401
|
*/
|
|
20378
|
-
readonly
|
|
20402
|
+
readonly getSignableWithdrawalRequest: GetSignableWithdrawalRequest;
|
|
20379
20403
|
}
|
|
20380
20404
|
/**
|
|
20381
|
-
* Request parameters for
|
|
20405
|
+
* Request parameters for getWithdrawal operation in WithdrawalsApi.
|
|
20382
20406
|
* @export
|
|
20383
|
-
* @interface
|
|
20407
|
+
* @interface WithdrawalsApiGetWithdrawalRequest
|
|
20384
20408
|
*/
|
|
20385
|
-
interface
|
|
20409
|
+
interface WithdrawalsApiGetWithdrawalRequest {
|
|
20386
20410
|
/**
|
|
20387
|
-
*
|
|
20411
|
+
* Withdrawal ID
|
|
20388
20412
|
* @type {string}
|
|
20389
|
-
* @memberof
|
|
20413
|
+
* @memberof WithdrawalsApiGetWithdrawal
|
|
20390
20414
|
*/
|
|
20391
20415
|
readonly id: string;
|
|
20392
20416
|
}
|
|
20393
20417
|
/**
|
|
20394
|
-
* Request parameters for
|
|
20418
|
+
* Request parameters for listWithdrawals operation in WithdrawalsApi.
|
|
20395
20419
|
* @export
|
|
20396
|
-
* @interface
|
|
20420
|
+
* @interface WithdrawalsApiListWithdrawalsRequest
|
|
20397
20421
|
*/
|
|
20398
|
-
interface
|
|
20422
|
+
interface WithdrawalsApiListWithdrawalsRequest {
|
|
20423
|
+
/**
|
|
20424
|
+
* Withdrawal has been transferred to user\'s Layer 1 wallet
|
|
20425
|
+
* @type {boolean}
|
|
20426
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20427
|
+
*/
|
|
20428
|
+
readonly withdrawnToWallet?: boolean;
|
|
20429
|
+
/**
|
|
20430
|
+
* Status of the on-chain batch confirmation for this withdrawal
|
|
20431
|
+
* @type {string}
|
|
20432
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20433
|
+
*/
|
|
20434
|
+
readonly rollupStatus?: string;
|
|
20399
20435
|
/**
|
|
20400
20436
|
* Page size of the result
|
|
20401
20437
|
* @type {number}
|
|
20402
|
-
* @memberof
|
|
20438
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20403
20439
|
*/
|
|
20404
20440
|
readonly pageSize?: number;
|
|
20405
20441
|
/**
|
|
20406
20442
|
* Cursor
|
|
20407
20443
|
* @type {string}
|
|
20408
|
-
* @memberof
|
|
20444
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20409
20445
|
*/
|
|
20410
20446
|
readonly cursor?: string;
|
|
20411
20447
|
/**
|
|
20412
20448
|
* Property to sort by
|
|
20413
|
-
* @type {
|
|
20414
|
-
* @memberof
|
|
20449
|
+
* @type {string}
|
|
20450
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20415
20451
|
*/
|
|
20416
|
-
readonly orderBy?:
|
|
20452
|
+
readonly orderBy?: string;
|
|
20417
20453
|
/**
|
|
20418
20454
|
* Direction to sort (asc/desc)
|
|
20419
20455
|
* @type {string}
|
|
20420
|
-
* @memberof
|
|
20456
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20421
20457
|
*/
|
|
20422
20458
|
readonly direction?: string;
|
|
20423
20459
|
/**
|
|
20424
|
-
* Ethereum address of the user who submitted this
|
|
20460
|
+
* Ethereum address of the user who submitted this withdrawal
|
|
20425
20461
|
* @type {string}
|
|
20426
|
-
* @memberof
|
|
20462
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20427
20463
|
*/
|
|
20428
20464
|
readonly user?: string;
|
|
20429
20465
|
/**
|
|
20430
|
-
*
|
|
20466
|
+
* Status of this withdrawal
|
|
20431
20467
|
* @type {string}
|
|
20432
|
-
* @memberof
|
|
20433
|
-
*/
|
|
20434
|
-
readonly receiver?: string;
|
|
20435
|
-
/**
|
|
20436
|
-
* Status of this transfer
|
|
20437
|
-
* @type {'success' | 'failure'}
|
|
20438
|
-
* @memberof TransfersApiListTransfers
|
|
20468
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20439
20469
|
*/
|
|
20440
|
-
readonly status?:
|
|
20470
|
+
readonly status?: string;
|
|
20441
20471
|
/**
|
|
20442
|
-
* Minimum timestamp for this
|
|
20472
|
+
* Minimum timestamp for this deposit, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
20443
20473
|
* @type {string}
|
|
20444
|
-
* @memberof
|
|
20474
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20445
20475
|
*/
|
|
20446
20476
|
readonly minTimestamp?: string;
|
|
20447
20477
|
/**
|
|
20448
|
-
* Maximum timestamp for this
|
|
20478
|
+
* Maximum timestamp for this deposit, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
20449
20479
|
* @type {string}
|
|
20450
|
-
* @memberof
|
|
20480
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20451
20481
|
*/
|
|
20452
20482
|
readonly maxTimestamp?: string;
|
|
20453
20483
|
/**
|
|
20454
|
-
* Token type of the
|
|
20484
|
+
* Token type of the withdrawn asset
|
|
20455
20485
|
* @type {string}
|
|
20456
|
-
* @memberof
|
|
20486
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20457
20487
|
*/
|
|
20458
20488
|
readonly tokenType?: string;
|
|
20459
20489
|
/**
|
|
20460
20490
|
* ERC721 Token ID of the minted asset
|
|
20461
20491
|
* @type {string}
|
|
20462
|
-
* @memberof
|
|
20492
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20463
20493
|
*/
|
|
20464
20494
|
readonly tokenId?: string;
|
|
20465
20495
|
/**
|
|
20466
20496
|
* Internal IMX ID of the minted asset
|
|
20467
20497
|
* @type {string}
|
|
20468
|
-
* @memberof
|
|
20498
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20469
20499
|
*/
|
|
20470
20500
|
readonly assetId?: string;
|
|
20471
20501
|
/**
|
|
20472
|
-
* Token address of the
|
|
20502
|
+
* Token address of the withdrawn asset
|
|
20473
20503
|
* @type {string}
|
|
20474
|
-
* @memberof
|
|
20504
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20475
20505
|
*/
|
|
20476
20506
|
readonly tokenAddress?: string;
|
|
20477
20507
|
/**
|
|
20478
|
-
* Token name of the
|
|
20508
|
+
* Token name of the withdrawn asset
|
|
20479
20509
|
* @type {string}
|
|
20480
|
-
* @memberof
|
|
20510
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20481
20511
|
*/
|
|
20482
20512
|
readonly tokenName?: string;
|
|
20483
20513
|
/**
|
|
20484
|
-
*
|
|
20514
|
+
* Min quantity for the withdrawn asset
|
|
20485
20515
|
* @type {string}
|
|
20486
|
-
* @memberof
|
|
20516
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20487
20517
|
*/
|
|
20488
20518
|
readonly minQuantity?: string;
|
|
20489
20519
|
/**
|
|
20490
|
-
* Max quantity for the
|
|
20520
|
+
* Max quantity for the withdrawn asset
|
|
20491
20521
|
* @type {string}
|
|
20492
|
-
* @memberof
|
|
20522
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20493
20523
|
*/
|
|
20494
20524
|
readonly maxQuantity?: string;
|
|
20495
20525
|
/**
|
|
20496
|
-
* JSON-encoded metadata filters for the
|
|
20526
|
+
* JSON-encoded metadata filters for the withdrawn asset
|
|
20497
20527
|
* @type {string}
|
|
20498
|
-
* @memberof
|
|
20528
|
+
* @memberof WithdrawalsApiListWithdrawals
|
|
20499
20529
|
*/
|
|
20500
20530
|
readonly metadata?: string;
|
|
20501
20531
|
}
|
|
20502
20532
|
/**
|
|
20503
|
-
*
|
|
20533
|
+
* WithdrawalsApi - object-oriented interface
|
|
20504
20534
|
* @export
|
|
20505
|
-
* @class
|
|
20535
|
+
* @class WithdrawalsApi
|
|
20506
20536
|
* @extends {BaseAPI}
|
|
20507
20537
|
*/
|
|
20508
|
-
declare class
|
|
20509
|
-
/**
|
|
20510
|
-
* Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransfer to get request body params.
|
|
20511
|
-
* @summary Creates a transfer of multiple tokens between two parties
|
|
20512
|
-
* @param {TransfersApiCreateTransferRequest} requestParameters Request parameters.
|
|
20513
|
-
* @param {*} [options] Override http request option.
|
|
20514
|
-
* @throws {RequiredError}
|
|
20515
|
-
* @memberof TransfersApi
|
|
20516
|
-
*/
|
|
20517
|
-
createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
|
|
20518
|
-
/**
|
|
20519
|
-
* Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
|
|
20520
|
-
* @summary Creates a transfer of tokens between two parties
|
|
20521
|
-
* @param {TransfersApiCreateTransferV1Request} requestParameters Request parameters.
|
|
20522
|
-
* @param {*} [options] Override http request option.
|
|
20523
|
-
* @throws {RequiredError}
|
|
20524
|
-
* @memberof TransfersApi
|
|
20525
|
-
*/
|
|
20526
|
-
createTransferV1(requestParameters: TransfersApiCreateTransferV1Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
|
|
20538
|
+
declare class WithdrawalsApi extends BaseAPI {
|
|
20527
20539
|
/**
|
|
20528
|
-
*
|
|
20529
|
-
* @summary
|
|
20530
|
-
* @param {
|
|
20540
|
+
* Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
|
|
20541
|
+
* @summary Creates a withdrawal of a token
|
|
20542
|
+
* @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
|
|
20531
20543
|
* @param {*} [options] Override http request option.
|
|
20532
20544
|
* @throws {RequiredError}
|
|
20533
|
-
* @memberof
|
|
20545
|
+
* @memberof WithdrawalsApi
|
|
20534
20546
|
*/
|
|
20535
|
-
|
|
20547
|
+
createWithdrawal(requestParameters: WithdrawalsApiCreateWithdrawalRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateWithdrawalResponse, any>>;
|
|
20536
20548
|
/**
|
|
20537
|
-
* Gets details of a signable
|
|
20538
|
-
* @summary Gets details of a signable
|
|
20539
|
-
* @param {
|
|
20549
|
+
* Gets details of a signable withdrawal
|
|
20550
|
+
* @summary Gets details of a signable withdrawal
|
|
20551
|
+
* @param {WithdrawalsApiGetSignableWithdrawalRequest} requestParameters Request parameters.
|
|
20540
20552
|
* @param {*} [options] Override http request option.
|
|
20541
20553
|
* @throws {RequiredError}
|
|
20542
|
-
* @memberof
|
|
20554
|
+
* @memberof WithdrawalsApi
|
|
20543
20555
|
*/
|
|
20544
|
-
|
|
20556
|
+
getSignableWithdrawal(requestParameters: WithdrawalsApiGetSignableWithdrawalRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableWithdrawalResponse, any>>;
|
|
20545
20557
|
/**
|
|
20546
|
-
*
|
|
20547
|
-
* @summary
|
|
20548
|
-
* @param {
|
|
20558
|
+
* Gets details of withdrawal with the given ID
|
|
20559
|
+
* @summary Gets details of withdrawal with the given ID
|
|
20560
|
+
* @param {WithdrawalsApiGetWithdrawalRequest} requestParameters Request parameters.
|
|
20549
20561
|
* @param {*} [options] Override http request option.
|
|
20550
20562
|
* @throws {RequiredError}
|
|
20551
|
-
* @memberof
|
|
20563
|
+
* @memberof WithdrawalsApi
|
|
20552
20564
|
*/
|
|
20553
|
-
|
|
20565
|
+
getWithdrawal(requestParameters: WithdrawalsApiGetWithdrawalRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Withdrawal, any>>;
|
|
20554
20566
|
/**
|
|
20555
|
-
* Get a list of
|
|
20556
|
-
* @summary Get a list of
|
|
20557
|
-
* @param {
|
|
20567
|
+
* Get a list of withdrawals
|
|
20568
|
+
* @summary Get a list of withdrawals
|
|
20569
|
+
* @param {WithdrawalsApiListWithdrawalsRequest} requestParameters Request parameters.
|
|
20558
20570
|
* @param {*} [options] Override http request option.
|
|
20559
20571
|
* @throws {RequiredError}
|
|
20560
|
-
* @memberof
|
|
20572
|
+
* @memberof WithdrawalsApi
|
|
20561
20573
|
*/
|
|
20562
|
-
|
|
20574
|
+
listWithdrawals(requestParameters?: WithdrawalsApiListWithdrawalsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListWithdrawalsResponse, any>>;
|
|
20563
20575
|
}
|
|
20564
20576
|
|
|
20565
20577
|
/**
|
|
20566
|
-
*
|
|
20567
|
-
* @export
|
|
20568
|
-
* @interface UsersApiGetSignableRegistrationRequest
|
|
20578
|
+
* Configuration for generated clients
|
|
20569
20579
|
*/
|
|
20570
|
-
|
|
20580
|
+
type ImmutableAPIConfiguration = Configuration;
|
|
20581
|
+
|
|
20582
|
+
declare class ImxApiClients {
|
|
20583
|
+
config: ImmutableAPIConfiguration;
|
|
20584
|
+
assetApi: AssetsApi;
|
|
20585
|
+
balanceApi: BalancesApi;
|
|
20586
|
+
collectionApi: CollectionsApi;
|
|
20587
|
+
depositsApi: DepositsApi;
|
|
20588
|
+
encodingApi: EncodingApi;
|
|
20589
|
+
exchangeApi: ExchangesApi;
|
|
20590
|
+
metadataApi: MetadataApi;
|
|
20591
|
+
metadataRefreshesApi: MetadataRefreshesApi;
|
|
20592
|
+
mintsApi: MintsApi;
|
|
20593
|
+
nftCheckoutPrimaryApi: NftCheckoutPrimaryApi;
|
|
20594
|
+
ordersApi: OrdersApi;
|
|
20595
|
+
projectsApi: ProjectsApi;
|
|
20596
|
+
tokensApi: TokensApi;
|
|
20597
|
+
tradesApi: TradesApi;
|
|
20598
|
+
transfersApi: TransfersApi;
|
|
20599
|
+
usersApi: UsersApi;
|
|
20600
|
+
withdrawalsApi: WithdrawalsApi;
|
|
20601
|
+
constructor(config: ImmutableAPIConfiguration);
|
|
20602
|
+
}
|
|
20603
|
+
|
|
20604
|
+
interface ImxOverrides {
|
|
20605
|
+
immutableXConfig: ImmutableXConfiguration;
|
|
20606
|
+
}
|
|
20607
|
+
interface ImxModuleConfiguration extends ModuleConfiguration<ImxOverrides> {
|
|
20608
|
+
}
|
|
20609
|
+
|
|
20610
|
+
declare class IMXClient {
|
|
20611
|
+
private immutableX;
|
|
20612
|
+
depositsApi: DepositsApi$1;
|
|
20613
|
+
mintsApi: MintsApi$1;
|
|
20614
|
+
ordersApi: OrdersApi$1;
|
|
20615
|
+
tokensApi: TokensApi$1;
|
|
20616
|
+
tradesApi: TradesApi$1;
|
|
20617
|
+
transfersApi: TransfersApi$1;
|
|
20618
|
+
exchangeApi: ExchangesApi$1;
|
|
20619
|
+
nftCheckoutPrimaryApi: NftCheckoutPrimaryApi$1;
|
|
20620
|
+
usersApi: UsersApi$1;
|
|
20621
|
+
withdrawalsApi: WithdrawalsApi$1;
|
|
20622
|
+
balanceApi: BalancesApi$1;
|
|
20623
|
+
assetApi: AssetsApi$1;
|
|
20624
|
+
collectionApi: CollectionsApi$1;
|
|
20625
|
+
metadataApi: MetadataApi$1;
|
|
20626
|
+
metadataRefreshesApi: MetadataRefreshesApi$1;
|
|
20627
|
+
projectsApi: ProjectsApi$1;
|
|
20628
|
+
constructor(config: ImxModuleConfiguration);
|
|
20571
20629
|
/**
|
|
20572
|
-
*
|
|
20573
|
-
* @
|
|
20574
|
-
* @
|
|
20630
|
+
* Get details of a Deposit with the given ID
|
|
20631
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20632
|
+
* @returns a promise that resolves with the requested Deposit
|
|
20633
|
+
* @throws {@link index.IMXError}
|
|
20575
20634
|
*/
|
|
20576
|
-
|
|
20577
|
-
}
|
|
20578
|
-
/**
|
|
20579
|
-
* Request parameters for getSignableRegistrationOffchain operation in UsersApi.
|
|
20580
|
-
* @export
|
|
20581
|
-
* @interface UsersApiGetSignableRegistrationOffchainRequest
|
|
20582
|
-
*/
|
|
20583
|
-
interface UsersApiGetSignableRegistrationOffchainRequest {
|
|
20635
|
+
getDeposit(request: DepositsApiGetDepositRequest$1): Promise<Deposit$1>;
|
|
20584
20636
|
/**
|
|
20585
|
-
*
|
|
20586
|
-
* @
|
|
20587
|
-
* @
|
|
20637
|
+
* Get a list of Deposits
|
|
20638
|
+
* @param request - optional object containing the parameters to be provided in the API request
|
|
20639
|
+
* @returns a promise that resolves with the requested list of Deposits
|
|
20640
|
+
* @throws {@link index.IMXError}
|
|
20641
|
+
*/
|
|
20642
|
+
listDeposits(request?: DepositsApiListDepositsRequest$1): Promise<ListDepositsResponse$1>;
|
|
20643
|
+
/**
|
|
20644
|
+
* Get Stark keys for a registered User
|
|
20645
|
+
* @param ethAddress - the eth address of the User
|
|
20646
|
+
* @returns a promise that resolves with the requested User
|
|
20647
|
+
* @throws {@link index.IMXError}
|
|
20648
|
+
*/
|
|
20649
|
+
getUser(ethAddress: string): Promise<GetUsersApiResponse$1>;
|
|
20650
|
+
/**
|
|
20651
|
+
* Get details of an Asset
|
|
20652
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20653
|
+
* @returns a promise that resolves with the requested Asset
|
|
20654
|
+
* @throws {@link index.IMXError}
|
|
20588
20655
|
*/
|
|
20589
|
-
|
|
20590
|
-
}
|
|
20591
|
-
/**
|
|
20592
|
-
* Request parameters for getUsers operation in UsersApi.
|
|
20593
|
-
* @export
|
|
20594
|
-
* @interface UsersApiGetUsersRequest
|
|
20595
|
-
*/
|
|
20596
|
-
interface UsersApiGetUsersRequest {
|
|
20656
|
+
getAsset(request: AssetsApiGetAssetRequest$1): Promise<Asset$1>;
|
|
20597
20657
|
/**
|
|
20598
|
-
*
|
|
20599
|
-
* @
|
|
20600
|
-
* @
|
|
20658
|
+
* Get a list of Assets
|
|
20659
|
+
* @param request - optional object containing the parameters to be provided in the API request
|
|
20660
|
+
* @returns a promise that resolves with the requested list of Assets
|
|
20661
|
+
* @throws {@link index.IMXError}
|
|
20601
20662
|
*/
|
|
20602
|
-
|
|
20603
|
-
}
|
|
20604
|
-
/**
|
|
20605
|
-
* Request parameters for registerPassportUser operation in UsersApi.
|
|
20606
|
-
* @export
|
|
20607
|
-
* @interface UsersApiRegisterPassportUserRequest
|
|
20608
|
-
*/
|
|
20609
|
-
interface UsersApiRegisterPassportUserRequest {
|
|
20663
|
+
listAssets(request?: AssetsApiListAssetsRequest$1): Promise<ListAssetsResponse$1>;
|
|
20610
20664
|
/**
|
|
20611
|
-
*
|
|
20612
|
-
* @
|
|
20613
|
-
* @
|
|
20665
|
+
* Create a Collection
|
|
20666
|
+
* @param ethSigner - the L1 signer
|
|
20667
|
+
* @param request - the request object to be provided in the API request
|
|
20668
|
+
* @returns a promise that resolves with the created Collection
|
|
20669
|
+
* @throws {@link index.IMXError}
|
|
20614
20670
|
*/
|
|
20615
|
-
|
|
20671
|
+
createCollection(ethSigner: Signer, request: CreateCollectionRequest$1): Promise<Collection$1>;
|
|
20616
20672
|
/**
|
|
20617
|
-
*
|
|
20618
|
-
* @
|
|
20619
|
-
* @
|
|
20673
|
+
* Get details of a Collection at the given address
|
|
20674
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20675
|
+
* @returns a promise that resolves with the requested Collection
|
|
20676
|
+
* @throws {@link index.IMXError}
|
|
20620
20677
|
*/
|
|
20621
|
-
|
|
20622
|
-
}
|
|
20623
|
-
/**
|
|
20624
|
-
* Request parameters for registerPassportUserV2 operation in UsersApi.
|
|
20625
|
-
* @export
|
|
20626
|
-
* @interface UsersApiRegisterPassportUserV2Request
|
|
20627
|
-
*/
|
|
20628
|
-
interface UsersApiRegisterPassportUserV2Request {
|
|
20678
|
+
getCollection(request: CollectionsApiGetCollectionRequest$1): Promise<Collection$1>;
|
|
20629
20679
|
/**
|
|
20630
|
-
*
|
|
20631
|
-
* @
|
|
20632
|
-
* @
|
|
20680
|
+
* Get a list of Collection filters
|
|
20681
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20682
|
+
* @returns a promise that resolves with the requested list of Collection Filters
|
|
20683
|
+
* @throws {@link index.IMXError}
|
|
20633
20684
|
*/
|
|
20634
|
-
|
|
20685
|
+
listCollectionFilters(request: CollectionsApiListCollectionFiltersRequest$1): Promise<CollectionFilter$1>;
|
|
20635
20686
|
/**
|
|
20636
|
-
*
|
|
20637
|
-
* @
|
|
20638
|
-
* @
|
|
20687
|
+
* Get a list of Collections
|
|
20688
|
+
* @param request - optional object containing the parameters to be provided in the API request
|
|
20689
|
+
* @returns a promise that resolves with the requested list of Collections
|
|
20690
|
+
* @throws {@link index.IMXError}
|
|
20639
20691
|
*/
|
|
20640
|
-
|
|
20641
|
-
}
|
|
20642
|
-
/**
|
|
20643
|
-
* Request parameters for registerUser operation in UsersApi.
|
|
20644
|
-
* @export
|
|
20645
|
-
* @interface UsersApiRegisterUserRequest
|
|
20646
|
-
*/
|
|
20647
|
-
interface UsersApiRegisterUserRequest {
|
|
20692
|
+
listCollections(request?: CollectionsApiListCollectionsRequest$1): Promise<ListCollectionsResponse$1>;
|
|
20648
20693
|
/**
|
|
20649
|
-
*
|
|
20650
|
-
* @
|
|
20651
|
-
* @
|
|
20694
|
+
* Update a Collection
|
|
20695
|
+
* @param ethSigner - the L1 signer
|
|
20696
|
+
* @param collectionAddress - the Collection contract address
|
|
20697
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20698
|
+
* @returns a promise that resolves with the updated Collection
|
|
20699
|
+
* @throws {@link index.IMXError}
|
|
20652
20700
|
*/
|
|
20653
|
-
|
|
20654
|
-
}
|
|
20655
|
-
/**
|
|
20656
|
-
* UsersApi - object-oriented interface
|
|
20657
|
-
* @export
|
|
20658
|
-
* @class UsersApi
|
|
20659
|
-
* @extends {BaseAPI}
|
|
20660
|
-
*/
|
|
20661
|
-
declare class UsersApi extends BaseAPI {
|
|
20701
|
+
updateCollection(ethSigner: Signer, collectionAddress: string, request: UpdateCollectionRequest$1): Promise<Collection$1>;
|
|
20662
20702
|
/**
|
|
20663
|
-
*
|
|
20664
|
-
* @
|
|
20665
|
-
* @param
|
|
20666
|
-
* @param
|
|
20667
|
-
* @
|
|
20668
|
-
* @
|
|
20703
|
+
* Add metadata schema to Collection
|
|
20704
|
+
* @param ethSigner - the L1 signer
|
|
20705
|
+
* @param collectionAddress - the Collection contract address
|
|
20706
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20707
|
+
* @returns a promise that resolves with the SuccessResponse if successful
|
|
20708
|
+
* @throws {@link index.IMXError}
|
|
20669
20709
|
*/
|
|
20670
|
-
|
|
20710
|
+
addMetadataSchemaToCollection(ethSigner: Signer, collectionAddress: string, request: AddMetadataSchemaToCollectionRequest$1): Promise<SuccessResponse$1>;
|
|
20671
20711
|
/**
|
|
20672
|
-
* Get
|
|
20673
|
-
* @
|
|
20674
|
-
* @
|
|
20675
|
-
* @
|
|
20676
|
-
* @throws {RequiredError}
|
|
20677
|
-
* @memberof UsersApi
|
|
20712
|
+
* Get Metadata schema
|
|
20713
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20714
|
+
* @returns a promise that resolves with the requested Metadata schema
|
|
20715
|
+
* @throws {@link index.IMXError}
|
|
20678
20716
|
*/
|
|
20679
|
-
|
|
20717
|
+
getMetadataSchema(request: MetadataApiGetMetadataSchemaRequest$1): Promise<MetadataSchemaProperty$1[]>;
|
|
20680
20718
|
/**
|
|
20681
|
-
*
|
|
20682
|
-
* @
|
|
20683
|
-
* @param
|
|
20684
|
-
* @param
|
|
20685
|
-
* @
|
|
20686
|
-
* @
|
|
20719
|
+
* Update metadata schema by name
|
|
20720
|
+
* @param ethSigner - the L1 signer
|
|
20721
|
+
* @param collectionAddress - the Collection contract address
|
|
20722
|
+
* @param name - the Metadata schema name
|
|
20723
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20724
|
+
* @returns a promise that resolves with the SuccessResponse if successful
|
|
20725
|
+
* @throws {@link index.IMXError}
|
|
20687
20726
|
*/
|
|
20688
|
-
|
|
20727
|
+
updateMetadataSchemaByName(ethSigner: Signer, collectionAddress: string, name: string, request: MetadataSchemaRequest$1): Promise<SuccessResponse$1>;
|
|
20689
20728
|
/**
|
|
20690
|
-
*
|
|
20691
|
-
* @
|
|
20692
|
-
* @param
|
|
20693
|
-
* @param
|
|
20694
|
-
* @
|
|
20695
|
-
* @
|
|
20729
|
+
* Get a list of metadata refreshes
|
|
20730
|
+
* @param ethSigner - the L1 signer
|
|
20731
|
+
* @param collectionAddress - the Collection contract address
|
|
20732
|
+
* @param pageSize - the page size of the result
|
|
20733
|
+
* @param cursor - the cursor
|
|
20734
|
+
* @returns a promise that resolves with the requested metadata refreshes
|
|
20735
|
+
* @throws {@link index.IMXError}
|
|
20696
20736
|
*/
|
|
20697
|
-
|
|
20737
|
+
listMetadataRefreshes(ethSigner: Signer, collectionAddress?: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshes$1>;
|
|
20698
20738
|
/**
|
|
20699
|
-
*
|
|
20700
|
-
* @
|
|
20701
|
-
* @param
|
|
20702
|
-
* @param
|
|
20703
|
-
* @
|
|
20704
|
-
* @
|
|
20739
|
+
* Get a list of metadata refresh errors
|
|
20740
|
+
* @param ethSigner - the L1 signer
|
|
20741
|
+
* @param refreshId - the metadata refresh ID
|
|
20742
|
+
* @param pageSize - the page size of the result
|
|
20743
|
+
* @param cursor - the cursor
|
|
20744
|
+
* @returns a promise that resolves with the requested metadata refresh errors
|
|
20745
|
+
* @throws {@link index.IMXError}
|
|
20705
20746
|
*/
|
|
20706
|
-
|
|
20747
|
+
getMetadataRefreshErrors(ethSigner: Signer, refreshId: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshErrorsResponse$1>;
|
|
20707
20748
|
/**
|
|
20708
|
-
*
|
|
20709
|
-
* @
|
|
20710
|
-
* @param
|
|
20711
|
-
* @
|
|
20712
|
-
* @throws {
|
|
20713
|
-
* @memberof UsersApi
|
|
20749
|
+
* Get a list of metadata refresh results
|
|
20750
|
+
* @param ethSigner - the L1 signer
|
|
20751
|
+
* @param refreshId - the metadata refresh ID
|
|
20752
|
+
* @returns a promise that resolves with the requested metadata refresh results
|
|
20753
|
+
* @throws {@link index.IMXError}
|
|
20714
20754
|
*/
|
|
20715
|
-
|
|
20716
|
-
}
|
|
20717
|
-
|
|
20718
|
-
/**
|
|
20719
|
-
* Request parameters for createWithdrawal operation in WithdrawalsApi.
|
|
20720
|
-
* @export
|
|
20721
|
-
* @interface WithdrawalsApiCreateWithdrawalRequest
|
|
20722
|
-
*/
|
|
20723
|
-
interface WithdrawalsApiCreateWithdrawalRequest {
|
|
20755
|
+
getMetadataRefreshResults(ethSigner: Signer, refreshId: string): Promise<GetMetadataRefreshResponse$1>;
|
|
20724
20756
|
/**
|
|
20725
|
-
*
|
|
20726
|
-
* @
|
|
20727
|
-
* @
|
|
20757
|
+
* Request a metadata refresh
|
|
20758
|
+
* @param ethSigner - the L1 signer
|
|
20759
|
+
* @param request the request object containing the parameters to be provided in the API request
|
|
20760
|
+
* @returns a promise that resolves with the requested metadata refresh
|
|
20761
|
+
* @throws {@link index.IMXError}
|
|
20728
20762
|
*/
|
|
20729
|
-
|
|
20763
|
+
createMetadataRefresh(ethSigner: Signer, request: CreateMetadataRefreshRequest$1): Promise<CreateMetadataRefreshResponse$1>;
|
|
20730
20764
|
/**
|
|
20731
|
-
*
|
|
20732
|
-
* @
|
|
20733
|
-
* @
|
|
20765
|
+
* Create a Project
|
|
20766
|
+
* @param ethSigner - the L1 signer
|
|
20767
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20768
|
+
* @returns a promise that resolves with the created Project
|
|
20769
|
+
* @throws {@link index.IMXError}
|
|
20734
20770
|
*/
|
|
20735
|
-
|
|
20771
|
+
createProject(ethSigner: Signer, request: CreateProjectRequest$1): Promise<CreateProjectResponse$1>;
|
|
20736
20772
|
/**
|
|
20737
|
-
*
|
|
20738
|
-
* @
|
|
20739
|
-
* @
|
|
20773
|
+
* Get a Project
|
|
20774
|
+
* @param ethSigner - the L1 signer
|
|
20775
|
+
* @param id - the Project ID
|
|
20776
|
+
* @returns a promise that resolves with the requested Project
|
|
20777
|
+
* @throws {@link index.IMXError}
|
|
20740
20778
|
*/
|
|
20741
|
-
|
|
20742
|
-
}
|
|
20743
|
-
/**
|
|
20744
|
-
* Request parameters for getSignableWithdrawal operation in WithdrawalsApi.
|
|
20745
|
-
* @export
|
|
20746
|
-
* @interface WithdrawalsApiGetSignableWithdrawalRequest
|
|
20747
|
-
*/
|
|
20748
|
-
interface WithdrawalsApiGetSignableWithdrawalRequest {
|
|
20779
|
+
getProject(ethSigner: Signer, id: string): Promise<Project$1>;
|
|
20749
20780
|
/**
|
|
20750
|
-
*
|
|
20751
|
-
* @
|
|
20752
|
-
* @
|
|
20781
|
+
* Get Projects owned by the given User
|
|
20782
|
+
* @param ethSigner - the L1 signer
|
|
20783
|
+
* @param pageSize - the page size of the result
|
|
20784
|
+
* @param cursor - the cursor
|
|
20785
|
+
* @param orderBy - the property to sort by
|
|
20786
|
+
* @param direction - direction to sort (asc/desc)
|
|
20787
|
+
* @returns a promise that resolves with the requested Projects
|
|
20788
|
+
* @throws {@link index.IMXError}
|
|
20753
20789
|
*/
|
|
20754
|
-
|
|
20755
|
-
}
|
|
20756
|
-
/**
|
|
20757
|
-
* Request parameters for getWithdrawal operation in WithdrawalsApi.
|
|
20758
|
-
* @export
|
|
20759
|
-
* @interface WithdrawalsApiGetWithdrawalRequest
|
|
20760
|
-
*/
|
|
20761
|
-
interface WithdrawalsApiGetWithdrawalRequest {
|
|
20790
|
+
getProjects(ethSigner: Signer, pageSize?: number, cursor?: string, orderBy?: string, direction?: string): Promise<GetProjectsResponse$1>;
|
|
20762
20791
|
/**
|
|
20763
|
-
*
|
|
20764
|
-
* @
|
|
20765
|
-
* @
|
|
20792
|
+
* Get the token Balances of the User
|
|
20793
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20794
|
+
* @returns a promise that resolves with the requested Balance
|
|
20795
|
+
* @throws {@link index.IMXError}
|
|
20766
20796
|
*/
|
|
20767
|
-
|
|
20768
|
-
}
|
|
20769
|
-
/**
|
|
20770
|
-
* Request parameters for listWithdrawals operation in WithdrawalsApi.
|
|
20771
|
-
* @export
|
|
20772
|
-
* @interface WithdrawalsApiListWithdrawalsRequest
|
|
20773
|
-
*/
|
|
20774
|
-
interface WithdrawalsApiListWithdrawalsRequest {
|
|
20797
|
+
getBalance(request: BalancesApiGetBalanceRequest$1): Promise<Balance$1>;
|
|
20775
20798
|
/**
|
|
20776
|
-
*
|
|
20777
|
-
* @
|
|
20778
|
-
* @
|
|
20799
|
+
* Get a list of Balances for given User
|
|
20800
|
+
* @param request the request object containing the parameters to be provided in the API request
|
|
20801
|
+
* @returns a promise that resolves with the requested list of Balances
|
|
20802
|
+
* @throws {@link index.IMXError}
|
|
20779
20803
|
*/
|
|
20780
|
-
|
|
20804
|
+
listBalances(request: BalancesApiListBalancesRequest$1): Promise<ListBalancesResponse$1>;
|
|
20781
20805
|
/**
|
|
20782
|
-
*
|
|
20783
|
-
* @
|
|
20784
|
-
* @
|
|
20806
|
+
* Get details of a Mint with the given ID
|
|
20807
|
+
* @param request the request object containing the parameters to be provided in the API request
|
|
20808
|
+
* @returns a promise that resolves with the requested Mint
|
|
20809
|
+
* @throws {@link index.IMXError}
|
|
20785
20810
|
*/
|
|
20786
|
-
|
|
20811
|
+
getMint(request: MintsApiGetMintRequest$1): Promise<Mint$1[]>;
|
|
20787
20812
|
/**
|
|
20788
|
-
*
|
|
20789
|
-
* @
|
|
20790
|
-
* @
|
|
20813
|
+
* Get a list of Mints
|
|
20814
|
+
* @param request optional object containing the parameters to be provided in the API request
|
|
20815
|
+
* @returns a promise that resolves with the requested list of Mints
|
|
20816
|
+
* @throws {@link index.IMXError}
|
|
20791
20817
|
*/
|
|
20792
|
-
|
|
20818
|
+
listMints(request?: MintsApiListMintsRequest$1): Promise<ListMintsResponse$1>;
|
|
20793
20819
|
/**
|
|
20794
|
-
*
|
|
20795
|
-
* @
|
|
20796
|
-
* @
|
|
20820
|
+
* Mint tokens in a batch with fees
|
|
20821
|
+
* @param ethSigner - the L1 signer
|
|
20822
|
+
* @param request - the request object to be provided in the API request
|
|
20823
|
+
* @returns a promise that resolves with the minted tokens
|
|
20824
|
+
* @throws {@link index.IMXError}
|
|
20797
20825
|
*/
|
|
20798
|
-
|
|
20826
|
+
mint(ethSigner: Signer, request: UnsignedMintRequest): Promise<MintTokensResponse$1>;
|
|
20799
20827
|
/**
|
|
20800
|
-
*
|
|
20801
|
-
* @
|
|
20802
|
-
* @
|
|
20828
|
+
* Get a list of Withdrawals
|
|
20829
|
+
* @param request - optional object containing the parameters to be provided in the API request
|
|
20830
|
+
* @returns a promise that resolves with the requested list of Withdrawals
|
|
20831
|
+
* @throws {@link index.IMXError}
|
|
20803
20832
|
*/
|
|
20804
|
-
|
|
20833
|
+
listWithdrawals(request?: WithdrawalsApiListWithdrawalsRequest$1): Promise<ListWithdrawalsResponse$1>;
|
|
20805
20834
|
/**
|
|
20806
|
-
*
|
|
20807
|
-
* @
|
|
20808
|
-
* @
|
|
20835
|
+
* Get details of Withdrawal with the given ID
|
|
20836
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20837
|
+
* @returns a promise that resolves with the requested Withdrawal
|
|
20838
|
+
* @throws {@link index.IMXError}
|
|
20809
20839
|
*/
|
|
20810
|
-
|
|
20840
|
+
getWithdrawal(request: WithdrawalsApiGetWithdrawalRequest$1): Promise<Withdrawal$1>;
|
|
20811
20841
|
/**
|
|
20812
|
-
*
|
|
20813
|
-
* @
|
|
20814
|
-
* @
|
|
20842
|
+
* Get details of an Order with the given ID
|
|
20843
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20844
|
+
* @returns a promise that resolves with the requested Order
|
|
20845
|
+
* @throws {@link index.IMXError}
|
|
20815
20846
|
*/
|
|
20816
|
-
|
|
20847
|
+
getOrder(request: OrdersApiGetOrderV3Request$1): Promise<OrderV3$1>;
|
|
20817
20848
|
/**
|
|
20818
|
-
*
|
|
20819
|
-
* @
|
|
20820
|
-
* @
|
|
20849
|
+
* Get a list of Orders
|
|
20850
|
+
* @param request - optional object containing the parameters to be provided in the API request
|
|
20851
|
+
* @returns a promise that resolves with the requested list of Orders
|
|
20852
|
+
* @throws {@link index.IMXError}
|
|
20821
20853
|
*/
|
|
20822
|
-
|
|
20854
|
+
listOrders(request?: OrdersApiListOrdersV3Request$1): Promise<ListOrdersResponseV3$1>;
|
|
20823
20855
|
/**
|
|
20824
|
-
*
|
|
20825
|
-
* @
|
|
20826
|
-
* @
|
|
20856
|
+
* Get details of a Trade with the given ID
|
|
20857
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20858
|
+
* @returns a promise that resolves with the requested Trade
|
|
20859
|
+
* @throws {@link index.IMXError}
|
|
20827
20860
|
*/
|
|
20828
|
-
|
|
20861
|
+
getTrade(request: TradesApiGetTradeV3Request$1): Promise<Trade$1>;
|
|
20829
20862
|
/**
|
|
20830
|
-
*
|
|
20831
|
-
* @
|
|
20832
|
-
* @
|
|
20863
|
+
* Get a list of Trades
|
|
20864
|
+
* @param request - optional object containing the parameters to be provided in the API request
|
|
20865
|
+
* @returns a promise that resolves with the requested list of Trades
|
|
20866
|
+
* @throws {@link index.IMXError}
|
|
20833
20867
|
*/
|
|
20834
|
-
|
|
20868
|
+
listTrades(request?: TradesApiListTradesV3Request$1): Promise<ListTradesResponse$1>;
|
|
20835
20869
|
/**
|
|
20836
|
-
*
|
|
20837
|
-
* @
|
|
20838
|
-
* @
|
|
20870
|
+
* Get details of a Token
|
|
20871
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20872
|
+
* @returns a promise that resolves with the requested Token
|
|
20873
|
+
* @throws {@link index.IMXError}
|
|
20839
20874
|
*/
|
|
20840
|
-
|
|
20875
|
+
getToken(request: TokensApiGetTokenRequest$1): Promise<TokenDetails$1>;
|
|
20841
20876
|
/**
|
|
20842
|
-
*
|
|
20843
|
-
* @
|
|
20844
|
-
* @
|
|
20877
|
+
* Get a list of Tokens
|
|
20878
|
+
* @param request - optional object containing the parameters to be provided in the API request
|
|
20879
|
+
* @returns a promise that resolves with the requested list of Tokens
|
|
20880
|
+
* @throws {@link index.IMXError}
|
|
20845
20881
|
*/
|
|
20846
|
-
|
|
20882
|
+
listTokens(request?: TokensApiListTokensRequest$1): Promise<ListTokensResponse$1>;
|
|
20847
20883
|
/**
|
|
20848
|
-
*
|
|
20849
|
-
* @
|
|
20850
|
-
* @
|
|
20884
|
+
* Get details of a Transfer with the given ID
|
|
20885
|
+
* @param request - the request object containing the parameters to be provided in the API request
|
|
20886
|
+
* @returns a promise that resolves with the requested Transfer
|
|
20887
|
+
* @throws {@link index.IMXError}
|
|
20851
20888
|
*/
|
|
20852
|
-
|
|
20889
|
+
getTransfer(request: TransfersApiGetTransferRequest$1): Promise<Transfer$1>;
|
|
20853
20890
|
/**
|
|
20854
|
-
*
|
|
20855
|
-
* @
|
|
20856
|
-
* @
|
|
20891
|
+
* Get a list of Transfers
|
|
20892
|
+
* @param request - optional object containing the parameters to be provided in the API request
|
|
20893
|
+
* @returns a promise that resolves with the requested list of Transfers
|
|
20894
|
+
* @throws {@link index.IMXError}
|
|
20857
20895
|
*/
|
|
20858
|
-
|
|
20896
|
+
listTransfers(request?: TransfersApiListTransfersRequest$1): Promise<ListTransfersResponse$1>;
|
|
20859
20897
|
/**
|
|
20860
|
-
*
|
|
20861
|
-
* @
|
|
20862
|
-
* @
|
|
20898
|
+
* Create a new Exchange transaction
|
|
20899
|
+
* @param request - the request object to be provided in the API request
|
|
20900
|
+
* @returns a promise that resolves with the created Exchange Transaction
|
|
20901
|
+
* @throws {@link index.IMXError}
|
|
20863
20902
|
*/
|
|
20864
|
-
|
|
20903
|
+
createExchange(request: ExchangesApiCreateExchangeRequest$1): Promise<ExchangeCreateExchangeAndURLResponse$1>;
|
|
20865
20904
|
/**
|
|
20866
|
-
*
|
|
20867
|
-
* @
|
|
20868
|
-
* @
|
|
20905
|
+
* Get an Exchange transaction
|
|
20906
|
+
* @param request - the request object to be provided in the API request
|
|
20907
|
+
* @returns a promise that resolves with the Exchange Transaction
|
|
20908
|
+
* @throws {@link index.IMXError}
|
|
20869
20909
|
*/
|
|
20870
|
-
|
|
20910
|
+
getExchange(request: ExchangesApiGetExchangeRequest$1): Promise<Exchange$1>;
|
|
20871
20911
|
/**
|
|
20872
|
-
*
|
|
20873
|
-
* @
|
|
20874
|
-
* @
|
|
20912
|
+
* Get Exchange transactions
|
|
20913
|
+
* @param request - the request object to be provided in the API request
|
|
20914
|
+
* @returns a promise that resolves with Exchange Transactions
|
|
20915
|
+
* @throws {@link index.IMXError}
|
|
20875
20916
|
*/
|
|
20876
|
-
|
|
20917
|
+
getExchanges(request: ExchangesApiGetExchangesRequest$1): Promise<GetTransactionsResponse$1>;
|
|
20877
20918
|
/**
|
|
20878
|
-
*
|
|
20879
|
-
* @
|
|
20880
|
-
* @
|
|
20919
|
+
* Create a new Transfer request
|
|
20920
|
+
* @param walletConnection - the pair of Eth/Stark signers
|
|
20921
|
+
* @param request - the request object to be provided in the API request
|
|
20922
|
+
* @returns a promise that resolves with the created Exchange Transfer
|
|
20923
|
+
* @throws {@link index.IMXError}
|
|
20881
20924
|
*/
|
|
20882
|
-
|
|
20883
|
-
}
|
|
20884
|
-
/**
|
|
20885
|
-
* WithdrawalsApi - object-oriented interface
|
|
20886
|
-
* @export
|
|
20887
|
-
* @class WithdrawalsApi
|
|
20888
|
-
* @extends {BaseAPI}
|
|
20889
|
-
*/
|
|
20890
|
-
declare class WithdrawalsApi extends BaseAPI {
|
|
20925
|
+
exchangeTransfer(walletConnection: WalletConnection, request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1$1>;
|
|
20891
20926
|
/**
|
|
20892
|
-
*
|
|
20893
|
-
* @
|
|
20894
|
-
* @
|
|
20895
|
-
* @
|
|
20896
|
-
* @throws {RequiredError}
|
|
20897
|
-
* @memberof WithdrawalsApi
|
|
20927
|
+
* Create a new nft primary transaction
|
|
20928
|
+
* @param request - the request object to be provided in the API request
|
|
20929
|
+
* @returns a promise that resolves with the created nft primary Transaction
|
|
20930
|
+
* @throws {@link index.IMXError}
|
|
20898
20931
|
*/
|
|
20899
|
-
|
|
20932
|
+
createNftPrimary(request: NftCheckoutPrimaryApiCreateNftPrimaryRequest$1): Promise<NftprimarytransactionCreateResponse$1>;
|
|
20900
20933
|
/**
|
|
20901
|
-
*
|
|
20902
|
-
* @
|
|
20903
|
-
* @
|
|
20904
|
-
* @
|
|
20905
|
-
* @throws {RequiredError}
|
|
20906
|
-
* @memberof WithdrawalsApi
|
|
20934
|
+
* Get nft primary supported currencies and their limits
|
|
20935
|
+
* @param request - the request object to be provided in the API request
|
|
20936
|
+
* @returns a promise that resolves with nft primary Currencies
|
|
20937
|
+
* @throws {@link index.IMXError}
|
|
20907
20938
|
*/
|
|
20908
|
-
|
|
20939
|
+
getCurrenciesNFTCheckoutPrimary(request: NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest$1): Promise<CurrencyWithLimits$1>;
|
|
20909
20940
|
/**
|
|
20910
|
-
*
|
|
20911
|
-
* @
|
|
20912
|
-
* @
|
|
20913
|
-
* @
|
|
20914
|
-
* @throws {RequiredError}
|
|
20915
|
-
* @memberof WithdrawalsApi
|
|
20941
|
+
* Get nft primary transaction by transaction id
|
|
20942
|
+
* @param request - the request object to be provided in the API request
|
|
20943
|
+
* @returns a promise that resolves with nft primary transaction
|
|
20944
|
+
* @throws {@link index.IMXError}
|
|
20916
20945
|
*/
|
|
20917
|
-
|
|
20946
|
+
getNftPrimaryTransaction(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest$1): Promise<NftprimarytransactionGetResponse$1>;
|
|
20918
20947
|
/**
|
|
20919
|
-
* Get
|
|
20920
|
-
* @
|
|
20921
|
-
* @
|
|
20922
|
-
* @
|
|
20923
|
-
* @throws {RequiredError}
|
|
20924
|
-
* @memberof WithdrawalsApi
|
|
20948
|
+
* Get list of nft primary transactions
|
|
20949
|
+
* @param request - the request object to be provided in the API request
|
|
20950
|
+
* @returns a promise that resolves with nft primary transaction
|
|
20951
|
+
* @throws {@link index.IMXError}
|
|
20925
20952
|
*/
|
|
20926
|
-
|
|
20927
|
-
}
|
|
20928
|
-
|
|
20929
|
-
/**
|
|
20930
|
-
* Configuration for generated clients
|
|
20931
|
-
*/
|
|
20932
|
-
type ImmutableAPIConfiguration = Configuration;
|
|
20933
|
-
|
|
20934
|
-
declare class ImxApiClients {
|
|
20935
|
-
config: ImmutableAPIConfiguration;
|
|
20936
|
-
assetApi: AssetsApi;
|
|
20937
|
-
balanceApi: BalancesApi;
|
|
20938
|
-
collectionApi: CollectionsApi;
|
|
20939
|
-
depositsApi: DepositsApi;
|
|
20940
|
-
encodingApi: EncodingApi;
|
|
20941
|
-
exchangeApi: ExchangesApi;
|
|
20942
|
-
metadataApi: MetadataApi;
|
|
20943
|
-
metadataRefreshesApi: MetadataRefreshesApi;
|
|
20944
|
-
mintsApi: MintsApi;
|
|
20945
|
-
nftCheckoutPrimaryApi: NftCheckoutPrimaryApi;
|
|
20946
|
-
ordersApi: OrdersApi;
|
|
20947
|
-
projectsApi: ProjectsApi;
|
|
20948
|
-
tokensApi: TokensApi;
|
|
20949
|
-
tradesApi: TradesApi;
|
|
20950
|
-
transfersApi: TransfersApi;
|
|
20951
|
-
usersApi: UsersApi;
|
|
20952
|
-
withdrawalsApi: WithdrawalsApi;
|
|
20953
|
-
constructor(config: ImmutableAPIConfiguration);
|
|
20953
|
+
getNftPrimaryTransactions(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest$1): Promise<NftprimarytransactionListTransactionsResponse$1>;
|
|
20954
20954
|
}
|
|
20955
20955
|
|
|
20956
20956
|
type UserProfile = {
|
|
@@ -20973,12 +20973,12 @@ interface PassportOverrides {
|
|
|
20973
20973
|
passportDomain: string;
|
|
20974
20974
|
imxPublicApiDomain: string;
|
|
20975
20975
|
immutableXClient: IMXClient;
|
|
20976
|
-
imxApiClients: ImxApiClients;
|
|
20977
20976
|
zkEvmRpcUrl: string;
|
|
20978
20977
|
relayerUrl: string;
|
|
20979
20978
|
indexerMrBasePath: string;
|
|
20980
20979
|
orderBookMrBasePath: string;
|
|
20981
20980
|
passportMrBasePath: string;
|
|
20981
|
+
imxApiClients?: ImxApiClients;
|
|
20982
20982
|
}
|
|
20983
20983
|
interface PassportModuleConfiguration extends ModuleConfiguration<PassportOverrides>, OidcConfiguration {
|
|
20984
20984
|
/**
|