diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Assets/IGetAllAssetsRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Assets/IGetAllAssetsRest.cs index a561323b..03797c63 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Assets/IGetAllAssetsRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Assets/IGetAllAssetsRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving all assets supported on an exchange. + /// Operation for retrieving all assets supported on an exchange. /// public interface IGetAllAssets : ISharedApiCapability { @@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving all assets supported on an exchange. + /// Operation for retrieving all assets supported on an exchange via the REST API. /// public interface IGetAllAssetsRest : IGetAllAssets, ISharedRest { - - /// - /// Get info on all assets the exchange supports, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetAllAssetsAsync(GetAssetsRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Assets/IGetAssetRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Assets/IGetAssetRest.cs index d60d4bd9..39c40152 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Assets/IGetAssetRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Assets/IGetAssetRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving an asset on an exchange. + /// Operation for retrieving asset info from an exchange. /// public interface IGetAsset : ISharedApiCapability { @@ -28,15 +28,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving an asset on an exchange. + /// Operation for retrieving asset info from an exchange via the REST API. /// public interface IGetAssetRest : IGetAsset, ISharedRest { - /// - /// Get info on a specific asset, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetAssetAsync(GetAssetRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Balances/IGetBalancesRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Balances/IGetBalancesRest.cs index d6f2312d..b7c0ad13 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Balances/IGetBalancesRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Balances/IGetBalancesRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving user asset balances on an exchange. + /// Operation for retrieving user asset balances from an exchange. /// public interface IGetBalances : ISharedApiCapability { @@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving user asset balances on an exchange. + /// Operation for retrieving user asset balances from an exchange via the REST API. /// public interface IGetBalancesRest : IGetBalances, ISharedRest { - /// - /// Get balances for the user, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token - /// + /// new Task> GetBalancesAsync(GetBalancesRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Balances/ISubscribeBalancesSocket.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Balances/ISubscribeBalancesSocket.cs index d6810195..fc86c5f7 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Balances/ISubscribeBalancesSocket.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Balances/ISubscribeBalancesSocket.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Client for subscribing to user balance updates + /// Operation for subscribing to user balance updates /// public interface ISubscribeBalancesSocket : ISharedSubscription { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Deposits/IGetDepositAddressesRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Deposits/IGetDepositAddressesRest.cs index 7693dcb6..782d64a8 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Deposits/IGetDepositAddressesRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Deposits/IGetDepositAddressesRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving user deposit addresses on an exchange. + /// Operation for retrieving user deposit addresses for an exchange. /// public interface IGetDepositAddresses : ISharedApiCapability { @@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving user deposit addresses on an exchange. + /// Operation for retrieving user deposit addresses for an exchange via the REST API. /// public interface IGetDepositAddressesRest : IGetDepositAddresses, ISharedRest { - /// - /// Get deposit addresses for an asset, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token - /// + /// new Task> GetDepositAddressesAsync(GetDepositAddressesRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Deposits/IGetDepositHistoryRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Deposits/IGetDepositHistoryRest.cs index a4f99981..dcbc37ec 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Deposits/IGetDepositHistoryRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Deposits/IGetDepositHistoryRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving user deposit history on an exchange. + /// Operation for retrieving user deposit history from an exchange. /// public interface IGetDepositHistory : ISharedApiCapability { @@ -31,18 +31,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving user deposit history on an exchange. + /// Operation for retrieving user deposit history from an exchange via the REST API. /// public interface IGetDepositHistoryRest : IGetDepositHistory, ISharedRest { - /// - /// Get deposit records, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token - /// + /// new Task> GetDepositHistoryAsync(GetDepositsRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Fees/IGetFeesRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Fees/IGetFeesRest.cs index 216642c3..406abe2c 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Fees/IGetFeesRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Fees/IGetFeesRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving user trading fees on an exchange. + /// Operation for retrieving user trading fees from an exchange. /// public interface IGetFees : ISharedApiCapability { @@ -28,15 +28,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving user trading fees on an exchange. + /// Operation for retrieving user trading fees from an exchange via the REST API. /// public interface IGetFeesRest : IGetFees, ISharedRest { - /// - /// Get trading fees for a symbol, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetFeesAsync(GetFeeRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Funding/IGetFundingRateHistoryRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Funding/IGetFundingRateHistoryRest.cs index cb14543e..dc29c6b2 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Funding/IGetFundingRateHistoryRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Funding/IGetFundingRateHistoryRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving funding rate history for a symbol on an exchange. + /// Operation for retrieving funding rate history for a symbol on an exchange. /// public interface IGetFundingRateHistory : ISharedApiCapability { @@ -27,19 +27,13 @@ namespace CryptoExchange.Net.SharedApis /// Cancellation token Task> GetFundingRateHistoryAsync(GetFundingRateHistoryRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } - + /// - /// Endpoint definition for retrieving funding rate history for a symbol on an exchange. + /// Operation for retrieving funding rate history for a symbol on an exchange via the REST API. /// public interface IGetFundingRateHistoryRest : IGetFundingRateHistory, ISharedRest { - /// - /// Get funding rate records, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token + /// new Task> GetFundingRateHistoryAsync(GetFundingRateHistoryRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedApi.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedApi.cs index ced0a8c0..d3958fad 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedApi.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedApi.cs @@ -4,7 +4,7 @@ using System.Collections.Generic; namespace CryptoExchange.Net.SharedApis { /// - /// A shared/common client interface + /// Shared API /// public interface ISharedApi { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedApiCapability.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedApiCapability.cs index 36993245..81f02562 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedApiCapability.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedApiCapability.cs @@ -5,7 +5,7 @@ using System.Text; namespace CryptoExchange.Net.SharedApis { /// - /// Interface for a shared API capability + /// Shared API capability /// public interface ISharedApiCapability : ISharedApi { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedRest.cs index 11fae998..d440c7f4 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedRest.cs @@ -5,7 +5,7 @@ using System.Text; namespace CryptoExchange.Net.SharedApis { /// - /// Interface for a shared API endpoint + /// Shared REST API capabitlity /// public interface ISharedRest : ISharedApiCapability { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedSocket.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedSocket.cs index 700bfa76..48e50272 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedSocket.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedSocket.cs @@ -5,7 +5,7 @@ using System.Text; namespace CryptoExchange.Net.SharedApis { /// - /// Interface for a shared socket operation + /// Shared WebSocket API capabitlity /// public interface ISharedSocket : ISharedApiCapability { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedSubscription.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedSubscription.cs index 88ae4b42..1d6cd387 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedSubscription.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/ISharedSubscription.cs @@ -5,7 +5,7 @@ using System.Text; namespace CryptoExchange.Net.SharedApis { /// - /// Identifies a fine-grained Shared API subscription capability. + /// Shared WebSocket API subscription capabitlity /// public interface ISharedSubscription : ISharedSocket { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/Futures/IGetIndexPriceKlinesRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/Futures/IGetIndexPriceKlinesRest.cs index 68b75122..04fefa05 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/Futures/IGetIndexPriceKlinesRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/Futures/IGetIndexPriceKlinesRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving index price kline/candlestick data from an exchange + /// Operation for retrieving index price kline/candlestick data from an exchange /// public interface IGetIndexPriceKlines : ISharedApiCapability { @@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving index price kline/candlestick data from an exchange + /// Operation for retrieving index price kline/candlestick data from an exchange via the REST API. /// public interface IGetIndexPriceKlinesRest : IGetIndexPriceKlines, ISharedRest { - /// - /// Get index price kline/candlestick data, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token + /// new Task> GetIndexPriceKlinesAsync(GetKlinesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/Futures/IGetMarkPriceKlinesRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/Futures/IGetMarkPriceKlinesRest.cs index 20c91e02..1bab9b32 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/Futures/IGetMarkPriceKlinesRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/Futures/IGetMarkPriceKlinesRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving mark price kline/candlestick data from an exchange. + /// Operation for retrieving mark price kline/candlestick data from an exchange. /// public interface IGetMarkPriceKlines : ISharedApiCapability { @@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving mark price kline/candlestick data from an exchange. + /// Operation for retrieving mark price kline/candlestick data from an exchange via the REST API. /// public interface IGetMarkPriceKlinesRest : IGetMarkPriceKlines, ISharedRest { - /// - /// Get mark price kline/candlestick data, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token + /// new Task> GetMarkPriceKlinesAsync(GetKlinesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/IGetKlinesRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/IGetKlinesRest.cs index 1e7ce93b..cd607e4b 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/IGetKlinesRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/IGetKlinesRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for getting kline/candlestick data from an exchange. + /// Operation for getting kline/candlestick data from an exchange. /// public interface IGetKlines : ISharedApiCapability { @@ -31,18 +31,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for getting kline/candlestick data from an exchange. + /// Operation for getting kline/candlestick data from an exchange via the REST API. /// public interface IGetKlinesRest : IGetKlines, ISharedRest { - /// - /// Get kline/candlestick data, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token - /// + /// new Task> GetKlinesAsync(GetKlinesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/ISubscribeKlinesSocket.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/ISubscribeKlinesSocket.cs index 4f7448b5..819db4f8 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/ISubscribeKlinesSocket.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Klines/ISubscribeKlinesSocket.cs @@ -7,7 +7,7 @@ using CryptoExchange.Net.Objects; namespace CryptoExchange.Net.SharedApis { /// - /// Client for subscribing to kline/candlestick updates for a symbol + /// Operation for subscribing to kline/candlestick updates for a symbol /// public interface ISubscribeKlinesSocket : ISharedSubscription { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Leverage/IGetLeverageRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Leverage/IGetLeverageRest.cs index af2d0b48..b2cabdc0 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Leverage/IGetLeverageRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Leverage/IGetLeverageRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving leverage information for a symbol on an exchange. + /// Operation for retrieving leverage information for a symbol on an exchange. /// public interface IGetLeverage : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving leverage information for a symbol on an exchange. + /// Operation for retrieving leverage information for a symbol on an exchange via the REST API. /// public interface IGetLeverageRest : IGetLeverage, ISharedRest { - /// - /// Get the current leverage setting for a symbol, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetLeverageAsync(GetLeverageRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Leverage/ISetLeverageRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Leverage/ISetLeverageRest.cs index b3bb1345..6dc26d56 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Leverage/ISetLeverageRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Leverage/ISetLeverageRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for setting leverage on an exchange. + /// Operation for setting leverage on an exchange. /// public interface ISetLeverage : ISharedApiCapability { @@ -32,15 +32,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for setting leverage on an exchange. + /// Operation for setting leverage on an exchange via the REST API. /// public interface ISetLeverageRest : ISetLeverage, ISharedRest { - /// - /// Set the leverage for a symbol, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> SetLeverageAsync(SetLeverageRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/OpenInterest/IGetOpenInterestRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/OpenInterest/IGetOpenInterestRest.cs index 992f4204..d17ecb16 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/OpenInterest/IGetOpenInterestRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/OpenInterest/IGetOpenInterestRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving open interest data from an exchange + /// Operation for retrieving open interest data from an exchange. /// public interface IGetOpenInterest : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving open interest data from an exchange + /// Operation for retrieving open interest data from an exchange via the REST API. /// public interface IGetOpenInterestRest : IGetOpenInterest, ISharedRest { - /// - /// Get the open interest for a symbol, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetOpenInterestAsync(GetOpenInterestRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/IGetBookTickerRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/IGetBookTickerRest.cs index a488cd79..55ecd205 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/IGetBookTickerRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/IGetBookTickerRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving the best bid/ask prices for a symbol on an exchange. + /// Operation for retrieving the best bid/ask prices for a symbol on an exchange. /// public interface IGetBookTicker : ISharedApiCapability { @@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving the best bid/ask prices for a symbol on an exchange. + /// Operation for retrieving the best bid/ask prices for a symbol on an exchange via the REST API. /// public interface IGetBookTickerRest : IGetBookTicker, ISharedRest { - /// - /// Get the best ask/bid info for a symbol, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token - /// + /// new Task> GetBookTickerAsync(GetBookTickerRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/IGetOrderBookRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/IGetOrderBookRest.cs index 3427fc1d..3d796216 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/IGetOrderBookRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/IGetOrderBookRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving an order book snapshot for a symbol on an exchange. + /// Operation for retrieving an order book snapshot for a symbol on an exchange. /// public interface IGetOrderBook : ISharedApiCapability { @@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving an order book snapshot for a symbol on an exchange. + /// Operation for retrieving an order book snapshot for a symbol on an exchange via the REST API. /// public interface IGetOrderBookRest : IGetOrderBook, ISharedRest { - /// - /// Get the order book for a symbol, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token - /// + /// new Task> GetOrderBookAsync(GetOrderBookRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/ISubscribeIncrementalOrderBookSocket.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/ISubscribeIncrementalOrderBookSocket.cs index 660b91a3..d99b2776 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/ISubscribeIncrementalOrderBookSocket.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/ISubscribeIncrementalOrderBookSocket.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Client for subscribing to incremental order book updates for a symbol + /// Operation for subscribing to incremental order book updates for a symbol /// public interface ISubscribeIncrementalOrderBookSocket : ISharedSubscription { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/ISubscribeOrderBookSocket.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/ISubscribeOrderBookSocket.cs index d0649561..f5126935 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/ISubscribeOrderBookSocket.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/OrderBooks/ISubscribeOrderBookSocket.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Client for subscribing to order book snapshot updates for a symbol + /// Operation for subscribing to order book snapshot updates for a symbol /// public interface ISubscribeOrderBookSocket : ISharedSubscription { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ICancelFuturesOrder.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ICancelFuturesOrder.cs index f064fffe..80be793c 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ICancelFuturesOrder.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ICancelFuturesOrder.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for canceling a futures order on an exchange. + /// Operation for canceling an open futures order on an exchange. /// public interface ICancelFuturesOrder : ISharedApiCapability { @@ -27,29 +27,21 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for canceling a futures order on an exchange. + /// Operation for canceling an open futures order on an exchange via the REST API. /// public interface ICancelFuturesOrderRest : ICancelFuturesOrder, ISharedRest { - /// - /// Cancel a futures order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> CancelFuturesOrderAsync(CancelOrderRequest request, CancellationToken ct = default); } /// - /// Endpoint definition for canceling a futures order on an exchange. + /// Operation for canceling an open futures order on an exchange via the WebSocket API. /// public interface ICancelFuturesOrderSocket : ICancelFuturesOrder, ISharedSocket { - /// - /// Cancel a futures order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> CancelFuturesOrderAsync(CancelOrderRequest request, CancellationToken ct = default); } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ICancelFuturesOrderByClientOrderId.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ICancelFuturesOrderByClientOrderId.cs index 66f3eb7d..3593d8ba 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ICancelFuturesOrderByClientOrderId.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ICancelFuturesOrderByClientOrderId.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for canceling a futures order by client order id on an exchange. + /// Operation for canceling an open futures order by its client order id on an exchange. /// public interface ICancelFuturesOrderByClientOrderId : ISharedApiCapability { @@ -27,28 +27,20 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for canceling a futures order by client order id on an exchange. + /// Operation for canceling an open futures order by its client order id on an exchange via the REST API. /// public interface ICancelFuturesOrderByClientOrderIdRest : ICancelFuturesOrderByClientOrderId, ISharedRest { - /// - /// Cancel a futures order using client order id, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> CancelFuturesOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default); } /// - /// Endpoint definition for canceling a futures order by client order id on an exchange. + /// Operation for canceling an open futures order by its client order id on an exchange via the WebSocket API. /// public interface ICancelFuturesOrderByClientOrderIdSocket : ICancelFuturesOrderByClientOrderId, ISharedSocket { - /// - /// Cancel a futures order using client order id, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> CancelFuturesOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetClosedFuturesOrders.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetClosedFuturesOrders.cs index 10e604c4..44eae1e6 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetClosedFuturesOrders.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetClosedFuturesOrders.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving closed futures orders on an exchange. + /// Operation for retrieving closed futures orders on an exchange. /// public interface IGetClosedFuturesOrders : ISharedApiCapability { @@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving closed futures orders on an exchange. + /// Operation for retrieving closed futures orders on an exchange via the REST API. /// public interface IGetClosedFuturesOrdersRest : IGetClosedFuturesOrders, ISharedRest { - /// - /// Get info on closed futures orders, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token + /// new Task> GetClosedFuturesOrdersAsync(GetClosedOrdersRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetFuturesOrder.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetFuturesOrder.cs index fbcf25e7..6d613764 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetFuturesOrder.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetFuturesOrder.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving a futures order on an exchange. + /// Operation for retrieving a futures order from an exchange. /// public interface IGetFuturesOrder : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving a futures order on an exchange. + /// Operation for retrieving a futures order from an exchange via the REST API. /// public interface IGetFuturesOrderRest : IGetFuturesOrder, ISharedRest { - /// - /// Get info on a specific futures order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetFuturesOrderAsync(GetOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetFuturesOrderByClientOrderId.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetFuturesOrderByClientOrderId.cs index 92b57693..ad8fc396 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetFuturesOrderByClientOrderId.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetFuturesOrderByClientOrderId.cs @@ -32,11 +32,7 @@ namespace CryptoExchange.Net.SharedApis /// public interface IGetFuturesOrderByClientOrderIdRest : IGetFuturesOrderByClientOrderId, ISharedRest { - /// - /// Get info on a specific futures order using a client order id, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetFuturesOrderByClientOrderIdAsync(GetOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetOpenFuturesOrders.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetOpenFuturesOrders.cs index 5ec0f297..e0d7655b 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetOpenFuturesOrders.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IGetOpenFuturesOrders.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for retrieving open futures orders on an exchange. + /// Operation for retrieving open futures orders from an exchange. /// public interface IGetOpenFuturesOrders : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for retrieving open futures orders on an exchange. + /// Operation for retrieving open futures orders from an exchange via the REST API. /// public interface IGetOpenFuturesOrdersRest : IGetOpenFuturesOrders, ISharedRest { - /// - /// Get info on a open futures orders, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetOpenFuturesOrdersAsync(GetOpenOrdersRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IPlaceFuturesOrder.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IPlaceFuturesOrder.cs index 76086f1d..54171e51 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IPlaceFuturesOrder.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/IPlaceFuturesOrder.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for placing a futures order on an exchange. + /// Operation for placing a futures order on an exchange. /// public interface IPlaceFuturesOrder : ISharedApiCapability { @@ -55,28 +55,20 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for placing a futures order on an exchange. + /// Operation for placing a futures order on an exchange via the REST API. /// public interface IPlaceFuturesOrderRest : IPlaceFuturesOrder, ISharedRest { - /// - /// Place a new futures order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> PlaceFuturesOrderAsync(PlaceFuturesOrderRequest request, CancellationToken ct = default); } /// - /// Endpoint definition for placing a futures order on an exchange. + /// Operation for placing a futures order on an exchange via the WebSocket API. /// public interface IPlaceFuturesOrderSocket : IPlaceFuturesOrder, ISharedSocket { - /// - /// Place a new futures order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> PlaceFuturesOrderAsync(PlaceFuturesOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ISubscribePositionsSocket.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ISubscribePositionsSocket.cs index 676a88de..d6dfc581 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ISubscribePositionsSocket.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Futures/ISubscribePositionsSocket.cs @@ -7,7 +7,7 @@ using CryptoExchange.Net.Objects; namespace CryptoExchange.Net.SharedApis { /// - /// Client for subscribing to position updates + /// Operation for subscribing to position updates /// public interface ISubscribePositionsSocket : ISharedSubscription { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ICancelSpotOrder.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ICancelSpotOrder.cs index 99dcb54e..101f4d0b 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ICancelSpotOrder.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ICancelSpotOrder.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for canceling a spot order on an exchange. + /// Operation for canceling a spot order on an exchange. /// public interface ICancelSpotOrder : ISharedApiCapability { @@ -27,28 +27,20 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for canceling a spot order on an exchange. + /// Operation for canceling a spot order on an exchange via the REST API. /// public interface ICancelSpotOrderRest : ICancelSpotOrder, ISharedRest { - /// - /// Cancel a spot order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> CancelSpotOrderAsync(CancelOrderRequest request, CancellationToken ct = default); } /// - /// Client for placing and managing spot orders + /// Operation for canceling a spot order on an exchange via the WebSocket API. /// public interface ICancelSpotOrderSocket : ICancelSpotOrder, ISharedSocket { - /// - /// Cancel a spot order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> CancelSpotOrderAsync(CancelOrderRequest request, CancellationToken ct = default); } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ICancelSpotOrderByClientOrderId.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ICancelSpotOrderByClientOrderId.cs index f1f50cbf..1137597a 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ICancelSpotOrderByClientOrderId.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ICancelSpotOrderByClientOrderId.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for canceling a spot order by client order id on an exchange. + /// Operation for canceling a spot order by client order id on an exchange. /// public interface ICancelSpotOrderByClientOrderId: ISharedApiCapability { @@ -27,28 +27,20 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for canceling a spot order by client order id on an exchange. + /// Operation for canceling a spot order by client order id on an exchange via the REST API. /// public interface ICancelSpotOrderByClientOrderIdRest : ICancelSpotOrderByClientOrderId, ISharedRest { - /// - /// Cancel a spot order using client order id, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> CancelSpotOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default); } /// - /// Request definition for canceling a spot order by client order id on an exchange. + /// Operation for canceling a spot order by client order id on an exchange via the WebSocket API. /// public interface ICancelSpotOrderByClientOrderIdSocket : ICancelSpotOrderByClientOrderId, ISharedSocket { - /// - /// Cancel a spot order using client order id, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> CancelSpotOrderByClientOrderIdAsync(CancelOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetClosedSpotOrders.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetClosedSpotOrders.cs index 78718be0..3b824095 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetClosedSpotOrders.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetClosedSpotOrders.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving closed spot orders from an exchange. + /// Operation for retrieving closed spot orders from an exchange. /// public interface IGetClosedSpotOrders : ISharedApiCapability { @@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving closed spot orders from an exchange. + /// Operation for retrieving closed spot orders from an exchange via the REST API. /// public interface IGetClosedSpotOrdersRest : IGetClosedSpotOrders, ISharedRest { - /// - /// Get info on closed spot orders, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token + /// new Task> GetClosedSpotOrdersAsync(GetClosedOrdersRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetOpenSpotOrders.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetOpenSpotOrders.cs index c5edf64d..327b4374 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetOpenSpotOrders.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetOpenSpotOrders.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving open spot order from an exchange. + /// Operation for retrieving open spot orders from an exchange. /// public interface IGetOpenSpotOrders : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving open spot order from an exchange. + /// Operation for retrieving open spot orders from an exchange via the REST API. /// public interface IGetOpenSpotOrdersRest : IGetOpenSpotOrders, ISharedRest { - /// - /// Get info on a open spot orders, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetOpenSpotOrdersAsync(GetOpenOrdersRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetSpotOrder.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetSpotOrder.cs index 07ed3281..de63c849 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetSpotOrder.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetSpotOrder.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving a spot order from an exchange. + /// Operation for retrieving a spot order from an exchange. /// public interface IGetSpotOrder : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving a spot order from an exchange. + /// Operation for retrieving a spot order from an exchange via the REST API. /// public interface IGetSpotOrderRest : IGetSpotOrder, ISharedRest { - /// - /// Get info on a specific spot order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetSpotOrderAsync(GetOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetSpotOrderByClientOrderId.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetSpotOrderByClientOrderId.cs index 83163c9c..c266b71f 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetSpotOrderByClientOrderId.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IGetSpotOrderByClientOrderId.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving a spot order by client order id from an exchange. + /// Operation for retrieving a spot order by client order id from an exchange. /// public interface IGetSpotOrderByClientOrderId : ISharedApiCapability { @@ -29,15 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving a spot order by client order id from an exchange. + /// Operation for retrieving a spot order by client order id from an exchange via the REST API. /// public interface IGetSpotOrderByClientOrderIdRest : IGetSpotOrderByClientOrderId, ISharedRest { - /// - /// Get info on a specific spot order using a client order id, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetSpotOrderByClientOrderIdAsync(GetOrderRequest request, CancellationToken ct = default); } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IPlaceSpotOrder.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IPlaceSpotOrder.cs index 4dad8aaf..073a6186 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IPlaceSpotOrder.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/IPlaceSpotOrder.cs @@ -7,6 +7,9 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { + /// + /// Operation for placing a spot order on an exchange. + /// public interface IPlaceSpotOrder : ISharedApiCapability { /// @@ -42,35 +45,32 @@ namespace CryptoExchange.Net.SharedApis /// Exchange specific parameters can be added to the request via the `ExchangeParameters` property of the request object. /// PlaceSpotOrderOptions PlaceSpotOrderOptions { get; } - + + /// + /// Place a new spot order, see for request options and exchange specific required/optional parameters.
+ ///
+ /// Request info + /// Cancellation token Task> PlaceSpotOrderAsync( PlaceSpotOrderRequest request, CancellationToken ct = default); } /// - /// Request definition for placing a spot order on an exchange. + /// Operation for placing a spot order on an exchange via the REST API. /// public interface IPlaceSpotOrderRest : IPlaceSpotOrder, ISharedRest { - /// - /// Place a new spot order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> PlaceSpotOrderAsync(PlaceSpotOrderRequest request, CancellationToken ct = default); } /// - /// Client for placing and managing spot orders + /// Operation for placing a spot order on an exchange via the WebSocket API. /// public interface IPlaceSpotOrderSocket : IPlaceSpotOrder, ISharedSocket { - /// - /// Place a new spot order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> PlaceSpotOrderAsync(PlaceSpotOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ISubscribeSpotOrdersSocket.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ISubscribeSpotOrdersSocket.cs index 58331c8a..fe3c721b 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ISubscribeSpotOrdersSocket.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Orders/Spot/ISubscribeSpotOrdersSocket.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Client for subscribing to user spot order updates + /// Operation for subscribing to user spot order updates /// public interface ISubscribeSpotOrdersSocket : ISharedSubscription { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/PositionMode/IGetPositionModeRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/PositionMode/IGetPositionModeRest.cs index a6afb6ba..4cb2569e 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/PositionMode/IGetPositionModeRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/PositionMode/IGetPositionModeRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request defintion for getting the current user position mode setting on an exchange. + /// Operation for getting the current user position mode setting from an exchange. /// public interface IGetPositionMode : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request defintion for getting the current user position mode setting on an exchange. + /// Operation for getting the current user position mode setting from an exchange via the REST API. /// public interface IGetPositionModeRest : IGetPositionMode, ISharedRest { - /// - /// Get the current position mode setting, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetPositionModeAsync(GetPositionModeRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/PositionMode/ISetPositionModeRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/PositionMode/ISetPositionModeRest.cs index 3c3234cb..342deabb 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/PositionMode/ISetPositionModeRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/PositionMode/ISetPositionModeRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Endpoint definition for setting the user position mode on an exchange. + /// Operation for setting the user position mode on an exchange. /// public interface ISetPositionMode : ISharedApiCapability { @@ -32,15 +32,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Endpoint definition for setting the user position mode on an exchange. + /// Operation for setting the user position mode on an exchange via the REST API. /// public interface ISetPositionModeRest : ISetPositionMode, ISharedRest { - /// - /// Set the position mode to a new value, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> SetPositionModeAsync(SetPositionModeRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IClosePositionRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IClosePositionRest.cs index c0831c91..4651ab3b 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IClosePositionRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IClosePositionRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for closing a position on an exchange. + /// Operation for closing an open position on an exchange. /// public interface IClosePosition : ISharedApiCapability { @@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for closing a position on an exchange. + /// Operation for closing an open position on an exchange via the REST API. /// public interface IClosePositionRest : IClosePosition, ISharedRest { - /// - /// Close a currently open position, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token - /// + /// new Task> ClosePositionAsync(ClosePositionRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IGetPositionHistoryRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IGetPositionHistoryRest.cs index 04221f44..8b215eda 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IGetPositionHistoryRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IGetPositionHistoryRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving position history from an exchange. + /// Operation for retrieving position history from an exchange. /// public interface IGetPositionHistory : ISharedApiCapability { @@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving position history from an exchange. + /// Operation for retrieving position history from an exchange via the REST API. /// public interface IGetPositionHistoryRest : IGetPositionHistory, ISharedRest { - /// - /// Get position history, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token + /// new Task> GetPositionHistoryAsync(GetPositionHistoryRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IGetPositionsRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IGetPositionsRest.cs index 58270b41..e19fc1d1 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IGetPositionsRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Positions/IGetPositionsRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving open positions from an exchange. + /// Operation for retrieving open positions from an exchange. /// public interface IGetPositions : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving open positions from an exchange. + /// Operation for retrieving open positions from an exchange via the REST API. /// public interface IGetPositionsRest : IGetPositions, ISharedRest { - /// - /// Get open position info, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetPositionsAsync(GetPositionsRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Symbols/Futures/IGetFuturesSymbolsRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Symbols/Futures/IGetFuturesSymbolsRest.cs index 9be32a2f..7a59e6d6 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Symbols/Futures/IGetFuturesSymbolsRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Symbols/Futures/IGetFuturesSymbolsRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for getting futures symbols from an exchange + /// Operation for getting supported futures symbols from an exchange. /// public interface IGetFuturesSymbols : ISharedApiCapability { @@ -51,15 +51,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for getting futures symbols from an exchange + /// Operation for getting supported futures symbols from an exchange via the REST API. /// public interface IGetFuturesSymbolsRest : IGetFuturesSymbols, ISharedRest { - /// - /// Get info on all futures symbols supported on the exchange, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetFuturesSymbolsAsync(GetSymbolsRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Symbols/Spot/IGetSpotSymbolsRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Symbols/Spot/IGetSpotSymbolsRest.cs index c528d590..fa946e9f 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Symbols/Spot/IGetSpotSymbolsRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Symbols/Spot/IGetSpotSymbolsRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving spot symbols from an exchange. + /// Operation for getting supported spot symbols from an exchange. /// public interface IGetSpotSymbols: ISharedApiCapability { @@ -51,16 +51,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving spot symbols from an exchange. + /// Operation for getting supported futures symbols from an exchange via the REST API. /// public interface IGetSpotSymbolsRest : IGetSpotSymbols, ISharedRest { - - /// - /// Get info on all available spot symbols on the exchange, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetSpotSymbolsAsync(GetSymbolsRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Futures/IGetAllFuturesTickersRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Futures/IGetAllFuturesTickersRest.cs index 00b3070d..5ec05819 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Futures/IGetAllFuturesTickersRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Futures/IGetAllFuturesTickersRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving all futures tickers from an exchange. + /// Operation for retrieving all futures tickers from an exchange. /// public interface IGetAllFuturesTickers : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving all futures tickers from an exchange. + /// Operation for retrieving all futures tickers from an exchange via the REST API. /// public interface IGetAllFuturesTickersRest : IGetAllFuturesTickers { - /// - /// Get ticker info for all futures symbols, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetAllFuturesTickersAsync(GetTickersRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Futures/IGetFuturesTickerRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Futures/IGetFuturesTickerRest.cs index d5c5057b..56c09813 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Futures/IGetFuturesTickerRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Futures/IGetFuturesTickerRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving a futures ticker from an exchange. + /// Operation for retrieving a single futures ticker from an exchange. /// public interface IGetFuturesTicker : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving a futures ticker from an exchange. + /// Operation for retrieving a single futures ticker from an exchange via the REST API. /// public interface IGetFuturesTickerRest : IGetFuturesTicker, ISharedRest { - /// - /// Get ticker info for a specific futures symbol, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetFuturesTickerAsync(GetTickerRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeAllTickersSocket.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeAllTickersSocket.cs index 6a48d3cb..2817522f 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeAllTickersSocket.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeAllTickersSocket.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Client for subscribing to ticker updates for all symbols + /// Operation for subscribing to ticker updates for all symbols /// public interface ISubscribeAllTickersSocket : ISharedSubscription { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeBookTickerSocket.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeBookTickerSocket.cs index 507dedfd..07b17510 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeBookTickerSocket.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeBookTickerSocket.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Client for subscribing to book ticker updates for a symbol + /// Operation for subscribing to book ticker updates for a symbol /// public interface ISubscribeBookTickerSocket : ISharedSubscription { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeTickerSocket.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeTickerSocket.cs index 8ec05d4c..4dacde2d 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeTickerSocket.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/ISubscribeTickerSocket.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Client for subscribing to ticker updates for a symbol + /// Operation for subscribing to ticker updates for a symbol /// public interface ISubscribeTickerSocket : ISharedSubscription { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Spot/IGetAllSpotTickersRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Spot/IGetAllSpotTickersRest.cs index a020cebe..c8042d5b 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Spot/IGetAllSpotTickersRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Spot/IGetAllSpotTickersRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving all spot tickers from an exchange. + /// Operation for retrieving all spot tickers from an exchange. /// public interface IGetAllSpotTickers : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving all spot tickers from an exchange. + /// Operation for retrieving all spot tickers from an exchange via the REST API. /// public interface IGetAllSpotTickersRest : IGetAllSpotTickers, ISharedRest { - /// - /// Get tickers for all spot symbols, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetAllSpotTickersAsync(GetTickersRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Spot/IGetSpotTickerRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Spot/IGetSpotTickerRest.cs index f01ab517..3757c2e7 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Spot/IGetSpotTickerRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Tickers/Spot/IGetSpotTickerRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for getting spot ticker info from an exchange. + /// Operation for retrieving a single spot ticker from an exchange. /// public interface IGetSpotTicker : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for getting spot ticker info from an exchange. + /// Operation for retrieving a single spot ticker from an exchange via the REST API /// public interface IGetSpotTickerRest : IGetSpotTicker, ISharedRest { - /// - /// Get ticker for a specific spot symbol, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetSpotTickerAsync(GetTickerRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/TpSl/ICancelFuturesTpSlRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/TpSl/ICancelFuturesTpSlRest.cs index 45074d64..d8ffde02 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/TpSl/ICancelFuturesTpSlRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/TpSl/ICancelFuturesTpSlRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for canceling a take profit and/or stop loss for an open position on an exchange. + /// Operation for canceling a take profit and/or stop loss for an open position on an exchange. /// public interface ICancelFuturesTpSl : ISharedApiCapability { @@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for canceling a take profit and/or stop loss for an open position on an exchange. + /// Operation for canceling a take profit and/or stop loss for an open position on an exchange via the REST API. /// public interface ICancelFuturesTpSlRest : ICancelFuturesTpSl, ISharedRest { - /// - /// Cancel an active take profit and/or stop loss for an open position, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token - /// + /// new Task> CancelFuturesTpSlAsync(CancelTpSlRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/TpSl/ISetFuturesTpSlRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/TpSl/ISetFuturesTpSlRest.cs index ce9bfa8f..1f81dbaa 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/TpSl/ISetFuturesTpSlRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/TpSl/ISetFuturesTpSlRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for setting take profit and/or stop loss for an open position on an exchange. + /// Operation for setting a take profit and/or stop loss for an open position on an exchange. /// public interface ISetFuturesTpSl : ISharedApiCapability { @@ -28,16 +28,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for setting take profit and/or stop loss for an open position on an exchange. + /// Operation for setting a take profit and/or stop loss for an open position on an exchange via the REST API. /// public interface ISetFuturesTpSlRest : ISetFuturesTpSl, ISharedRest { - /// - /// Set a take profit and/or stop loss for an open position, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token - /// + /// new Task> SetFuturesTpSlAsync(SetTpSlRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Trades/IGetRecentTradesRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Trades/IGetRecentTradesRest.cs index 1108a453..a97a68a2 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Trades/IGetRecentTradesRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Trades/IGetRecentTradesRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving recent trades for a symbol on an exchange. + /// Operation for retrieving the most recent trades for a symbol on an exchange. /// public interface IGetRecentTrades : ISharedApiCapability { @@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving recent trades for a symbol on an exchange. + /// Operation for retrieving the most recent trades for a symbol on an exchange via the REST API. /// public interface IGetRecentTradesRest : IGetRecentTrades, ISharedRest { - - /// - /// Get the most recent public trades, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token - /// + /// new Task> GetRecentTradesAsync(GetRecentTradesRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Trades/IGetTradeHistoryRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Trades/IGetTradeHistoryRest.cs index a8013b8e..2a2c440d 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Trades/IGetTradeHistoryRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Trades/IGetTradeHistoryRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving trade history from an exchange. + /// Operation for retrieving trade history from an exchange. /// public interface IGetTradeHistory : ISharedApiCapability { @@ -31,19 +31,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving trade history from an exchange. + /// Operation for retrieving trade history from an exchange via the REST API. /// - public interface IGetTradeHistoryRest : ISharedRest + public interface IGetTradeHistoryRest : IGetTradeHistory, ISharedRest { - - /// - /// Get public trade history, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token - /// + /// new Task> GetTradeHistoryAsync(GetTradeHistoryRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Transfers/ITransferRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Transfers/ITransferRest.cs index 08e4ab1f..d87337a2 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Transfers/ITransferRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Transfers/ITransferRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for transferring funds between account types on an exchange. + /// Operation for transferring funds between account types on an exchange. /// public interface ITransfer : ISharedApiCapability { @@ -28,15 +28,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for transferring funds between account types on an exchange. + /// Operation for transferring funds between account types on an exchange via the REST API. /// public interface ITransferRest : ITransfer, ISharedRest - { - /// - /// Transfer funds between account types, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + { + /// new Task> TransferAsync(TransferRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/ICancelFuturesTriggerOrderRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/ICancelFuturesTriggerOrderRest.cs index 887bf041..a7be9807 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/ICancelFuturesTriggerOrderRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/ICancelFuturesTriggerOrderRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for canceling a futures trigger order on an exchange. + /// Operation for canceling an active futures trigger order on an exchange. /// public interface ICancelFuturesTriggerOrder : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for canceling a futures trigger order on an exchange. + /// Operation for canceling an active futures trigger order on an exchange via the REST API. /// public interface ICancelFuturesTriggerOrderRest : ICancelFuturesTriggerOrder, ISharedRest { - /// - /// Cancel a trigger order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> CancelFuturesTriggerOrderAsync(CancelOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/IGetFuturesTriggerOrderRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/IGetFuturesTriggerOrderRest.cs index c3cc734e..0322219e 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/IGetFuturesTriggerOrderRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/IGetFuturesTriggerOrderRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for getting a specific futures trigger order from the exchange. + /// Operation for getting a specific futures trigger order from the exchange. /// public interface IGetFuturesTriggerOrder : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for getting a specific futures trigger order from the exchange. + /// Operation for getting a specific futures trigger order from the exchange via the REST API. /// public interface IGetFuturesTriggerOrderRest : IGetFuturesTriggerOrder, ISharedRest - { - /// - /// Get info on a specific trigger order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + { + /// new Task> GetFuturesTriggerOrderAsync(GetOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/IPlaceFuturesTriggerOrderRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/IPlaceFuturesTriggerOrderRest.cs index 164d6169..ea99632e 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/IPlaceFuturesTriggerOrderRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Futures/IPlaceFuturesTriggerOrderRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for placing a futures trigger order on an exchange. + /// Operation for placing a futures trigger order on an exchange. /// public interface IPlaceFuturesTriggerOrder : ISharedApiCapability { @@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for placing a futures trigger order on an exchange. + /// Operation for placing a futures trigger order on an exchange via the REST API. /// public interface IPlaceFuturesTriggerOrderRest : IPlaceFuturesTriggerOrder, ISharedRest { - /// - /// Place a new trigger order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token - /// + /// new Task> PlaceFuturesTriggerOrderAsync(PlaceFuturesTriggerOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/ICancelSpotTriggerOrderRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/ICancelSpotTriggerOrderRest.cs index 4fa79fcd..fea3852a 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/ICancelSpotTriggerOrderRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/ICancelSpotTriggerOrderRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for canceling a spot trigger order on an exchange + /// Operation for canceling a spot trigger order on an exchange. /// public interface ICancelSpotTriggerOrder : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for canceling a spot trigger order on an exchange + /// Operation for canceling a spot trigger order on an exchange via the REST API. /// public interface ICancelSpotTriggerOrderRest : ICancelSpotTriggerOrder, ISharedRest { - /// - /// Cancel a trigger order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> CancelSpotTriggerOrderAsync(CancelOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/IGetSpotTriggerOrderRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/IGetSpotTriggerOrderRest.cs index d4873341..513930e0 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/IGetSpotTriggerOrderRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/IGetSpotTriggerOrderRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for getting a specific spot trigger order on an exchange + /// Operation for retrieving a specific spot trigger order from an exchange. /// public interface IGetSpotTriggerOrder : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for getting a specific spot trigger order on an exchange + /// Operation for retrieving a specific spot trigger order from an exchange via the REST API. /// public interface IGetSpotTriggerOrderRest : IGetSpotTriggerOrder, ISharedRest { - /// - /// Get info on a specific trigger order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetSpotTriggerOrderAsync(GetOrderRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/IPlaceSpotTriggerOrderRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/IPlaceSpotTriggerOrderRest.cs index c3636305..0c4a2e4a 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/IPlaceSpotTriggerOrderRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/TriggerOrders/Spot/IPlaceSpotTriggerOrderRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for placing a spot trigger order on an exchange. + /// Operation for placing a spot trigger order on an exchange. /// public interface IPlaceSpotTriggerOrder : ISharedApiCapability { @@ -30,16 +30,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for placing a spot trigger order on an exchange. + /// Operation for placing a spot trigger order on an exchange via the REST API. /// public interface IPlaceSpotTriggerOrderRest : IPlaceSpotTriggerOrder, ISharedRest { - /// - /// Place a new trigger order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token - /// + /// new Task> PlaceSpotTriggerOrderAsync(PlaceSpotTriggerOrderRequest request, CancellationToken ct = default); } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Futures/IGetFuturesOrderTradesRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Futures/IGetFuturesOrderTradesRest.cs index 400f14e9..c10fee8c 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Futures/IGetFuturesOrderTradesRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Futures/IGetFuturesOrderTradesRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for getting trades for a specific futures order on an exchange. + /// Operation for retrieving trades for a specific futures order on an exchange. /// public interface IGetFuturesOrderTrades : ISharedApiCapability { @@ -27,15 +27,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for getting trades for a specific futures order on an exchange. + /// Operation for retrieving trades for a specific futures order on an exchange via the REST API. /// public interface IGetFuturesOrderTradesRest : IGetFuturesOrderTrades, ISharedRest { - /// - /// Get trades for a specific futures order, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token + /// new Task> GetFuturesOrderTradesAsync(GetOrderTradesRequest request, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Futures/IGetFuturesUserTradeHistoryRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Futures/IGetFuturesUserTradeHistoryRest.cs index 5c5abc1a..4981670d 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Futures/IGetFuturesUserTradeHistoryRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Futures/IGetFuturesUserTradeHistoryRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving futures user trade history from an exchange. + /// Operation for retrieving futures user trade history from an exchange. /// public interface IGetFuturesUserTradeHistory : ISharedApiCapability { @@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving futures user trade history from an exchange. + /// Operation for retrieving futures user trade history from an exchange via the REST API. /// public interface IGetFuturesUserTradeHistoryRest : IGetFuturesUserTradeHistory, ISharedRest { - /// - /// Get futures user trade records, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token + /// new Task> GetFuturesUserTradeHistoryAsync(GetUserTradesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/ISubscribeUserTradesSocket.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/ISubscribeUserTradesSocket.cs index 263f5f72..93f16ce7 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/ISubscribeUserTradesSocket.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/ISubscribeUserTradesSocket.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Client for subscribing to user trade updates + /// Operation for subscribing to user trade updates /// public interface ISubscribeUserTradesSocket : ISharedSubscription { diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Spot/IGetSpotOrderTradesRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Spot/IGetSpotOrderTradesRest.cs index c0318007..7f0dcb19 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Spot/IGetSpotOrderTradesRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Spot/IGetSpotOrderTradesRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for getting trades for a specific spot order on an exchange. + /// Operation for getting trades for a specific spot order on an exchange. /// public interface IGetSpotOrderTrades : ISharedApiCapability { @@ -29,16 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for getting trades for a specific spot order on an exchange. + /// Operation for getting trades for a specific spot order on an exchange via the REST API. /// public interface IGetSpotOrderTradesRest : IGetSpotOrderTrades, ISharedRest { - /// - /// Get trades for a specific spot order, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the `NextPageRequest` property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// Cancellation token + /// new Task> GetSpotOrderTradesAsync(GetOrderTradesRequest request, CancellationToken ct = default); } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Spot/IGetSpotUserTradeHistoryRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Spot/IGetSpotUserTradeHistoryRest.cs index d16aad29..f2154a27 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Spot/IGetSpotUserTradeHistoryRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/UserTrades/Spot/IGetSpotUserTradeHistoryRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for getting spot user trade history from an exchange + /// Operation for retrieving spot user trade history from an exchange. /// public interface IGetSpotUserTradeHistory : ISharedApiCapability { @@ -28,19 +28,12 @@ namespace CryptoExchange.Net.SharedApis Task> GetSpotUserTradeHistoryAsync(GetUserTradesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } - /// - /// Request definition for getting spot user trade history from an exchange + /// Operation for retrieving spot user trade history from an exchange via the REST API. /// public interface IGetSpotUserTradeHistoryRest : IGetSpotUserTradeHistory, ISharedRest { - /// - /// Get spot user trade records, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token + /// new Task> GetSpotUserTradeHistoryAsync(GetUserTradesRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Withdrawals/IGetWithdrawalHistoryRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Withdrawals/IGetWithdrawalHistoryRest.cs index 036f90e7..88af4da1 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Withdrawals/IGetWithdrawalHistoryRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Withdrawals/IGetWithdrawalHistoryRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for retrieving withdrawal history from an exchange + /// Operation for retrieving withdrawal history from an exchange. /// public interface IGetWithdrawalHistory : ISharedApiCapability { @@ -31,19 +31,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for retrieving withdrawal history from an exchange + /// Operation for retrieving withdrawal history from an exchange via the REST API. /// public interface IGetWithdrawalHistoryRest : IGetWithdrawalHistory, ISharedRest { - - /// - /// Get withdrawal records, see for request options and exchange specific required/optional parameters.
- /// The result is paginated, if there are more results to be retrieved, the property of the result will contain the pagination request to be used for the next request to continue pagination. - ///
- /// Request info - /// The pagination request from the previous request result property to continue pagination - /// Cancellation token - /// + /// new Task> GetWithdrawalHistoryAsync(GetWithdrawalsRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default); } } diff --git a/CryptoExchange.Net/SharedApis/Interfaces/V2/Withdrawals/IWithdrawRest.cs b/CryptoExchange.Net/SharedApis/Interfaces/V2/Withdrawals/IWithdrawRest.cs index f899265b..347e3a2f 100644 --- a/CryptoExchange.Net/SharedApis/Interfaces/V2/Withdrawals/IWithdrawRest.cs +++ b/CryptoExchange.Net/SharedApis/Interfaces/V2/Withdrawals/IWithdrawRest.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace CryptoExchange.Net.SharedApis { /// - /// Request definition for withdrawing a specific asset from an exchange. + /// Operation for withdrawing a specific asset from an exchange. /// public interface IWithdraw : ISharedApiCapability { @@ -29,17 +29,11 @@ namespace CryptoExchange.Net.SharedApis } /// - /// Request definition for withdrawing a specific asset from an exchange. + /// Operation for withdrawing a specific asset from an exchange via the REST API. /// public interface IWithdrawRest : IWithdraw, ISharedRest { - - /// - /// Request a withdrawal, see for request options and exchange specific required/optional parameters.
- ///
- /// Request info - /// Cancellation token - /// + /// new Task> WithdrawAsync(WithdrawRequest request, CancellationToken ct = default); } }