Skip to content

Commit

Permalink
Docs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
JKorf committed Jun 27, 2023
1 parent b4b1f8e commit 13e5ee4
Show file tree
Hide file tree
Showing 33 changed files with 1,238 additions and 1,029 deletions.
36 changes: 18 additions & 18 deletions Binance.Net/Binance.Net.xml
Original file line number Diff line number Diff line change
Expand Up @@ -769,31 +769,31 @@
<member name="M:Binance.Net.Clients.GeneralApi.BinanceRestClientGeneralApiFutures.GetCrossCollateralLiquidationHistoryAsync(System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="T:Binance.Net.Clients.GeneralApi.BinanceClientGeneralApiCryptoLoans">
<member name="T:Binance.Net.Clients.GeneralApi.BinanceRestClientGeneralApiLoans">
<inheritdoc />
</member>
<member name="M:Binance.Net.Clients.GeneralApi.BinanceClientGeneralApiCryptoLoans.GetIncomeHistoryAsync(System.String,System.Nullable{Binance.Net.Enums.LoanIncomeType},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Clients.GeneralApi.BinanceRestClientGeneralApiLoans.GetIncomeHistoryAsync(System.String,System.Nullable{Binance.Net.Enums.LoanIncomeType},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:Binance.Net.Clients.GeneralApi.BinanceClientGeneralApiCryptoLoans.BorrowAsync(System.String,System.String,System.Int32,System.Nullable{System.Decimal},System.Nullable{System.Decimal},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Clients.GeneralApi.BinanceRestClientGeneralApiLoans.BorrowAsync(System.String,System.String,System.Int32,System.Nullable{System.Decimal},System.Nullable{System.Decimal},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:Binance.Net.Clients.GeneralApi.BinanceClientGeneralApiCryptoLoans.GetBorrowHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Clients.GeneralApi.BinanceRestClientGeneralApiLoans.GetBorrowHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:Binance.Net.Clients.GeneralApi.BinanceClientGeneralApiCryptoLoans.GetOpenBorrowOrdersAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Clients.GeneralApi.BinanceRestClientGeneralApiLoans.GetOpenBorrowOrdersAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:Binance.Net.Clients.GeneralApi.BinanceClientGeneralApiCryptoLoans.RepayAsync(System.Int64,System.Decimal,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Clients.GeneralApi.BinanceRestClientGeneralApiLoans.RepayAsync(System.Int64,System.Decimal,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:Binance.Net.Clients.GeneralApi.BinanceClientGeneralApiCryptoLoans.GetRepayHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Clients.GeneralApi.BinanceRestClientGeneralApiLoans.GetRepayHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:Binance.Net.Clients.GeneralApi.BinanceClientGeneralApiCryptoLoans.AdjustLTVAsync(System.Int64,System.Decimal,System.Boolean,System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Clients.GeneralApi.BinanceRestClientGeneralApiLoans.AdjustLTVAsync(System.Int64,System.Decimal,System.Boolean,System.Nullable{System.Int64},System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="M:Binance.Net.Clients.GeneralApi.BinanceClientGeneralApiCryptoLoans.GetLtvAdjustHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Clients.GeneralApi.BinanceRestClientGeneralApiLoans.GetLtvAdjustHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<inheritdoc />
</member>
<member name="T:Binance.Net.Clients.GeneralApi.BinanceRestClientGeneralApiMining">
Expand Down Expand Up @@ -6255,12 +6255,12 @@
<param name="ct">Cancellation token</param>
<returns>Liquidation history</returns>
</member>
<member name="T:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceClientGeneralApiCryptoLoans">
<member name="T:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceRestClientGeneralApiLoans">
<summary>
Binance Spot Crypto loans endpoints
</summary>
</member>
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceClientGeneralApiCryptoLoans.GetIncomeHistoryAsync(System.String,System.Nullable{Binance.Net.Enums.LoanIncomeType},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceRestClientGeneralApiLoans.GetIncomeHistoryAsync(System.String,System.Nullable{Binance.Net.Enums.LoanIncomeType},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<summary>
Get income history from crypto loans
<para><a href="https://binance-docs.github.io/apidocs/spot/en/#get-crypto-loans-income-history-user_data" /></para>
Expand All @@ -6274,7 +6274,7 @@
<param name="ct">Cancellation token</param>
<returns></returns>
</member>
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceClientGeneralApiCryptoLoans.BorrowAsync(System.String,System.String,System.Int32,System.Nullable{System.Decimal},System.Nullable{System.Decimal},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceRestClientGeneralApiLoans.BorrowAsync(System.String,System.String,System.Int32,System.Nullable{System.Decimal},System.Nullable{System.Decimal},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<summary>
Take a crypto loan
<para><a href="https://binance-docs.github.io/apidocs/spot/en/#borrow-crypto-loan-borrow-trade" /></para>
Expand All @@ -6288,7 +6288,7 @@
<param name="ct">Cancellation token</param>
<returns></returns>
</member>
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceClientGeneralApiCryptoLoans.GetBorrowHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceRestClientGeneralApiLoans.GetBorrowHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<summary>
Get borrow order history
<para><a href="https://binance-docs.github.io/apidocs/spot/en/#borrow-get-loan-borrow-history-user_data" /></para>
Expand All @@ -6304,7 +6304,7 @@
<param name="ct">Cancellation token</param>
<returns></returns>
</member>
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceClientGeneralApiCryptoLoans.GetOpenBorrowOrdersAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceRestClientGeneralApiLoans.GetOpenBorrowOrdersAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<summary>
Get ongoing loan orders
<para><a href="https://binance-docs.github.io/apidocs/spot/en/#borrow-get-loan-ongoing-orders-user_data" /></para>
Expand All @@ -6318,7 +6318,7 @@
<param name="ct">Cancellation token</param>
<returns></returns>
</member>
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceClientGeneralApiCryptoLoans.RepayAsync(System.Int64,System.Decimal,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceRestClientGeneralApiLoans.RepayAsync(System.Int64,System.Decimal,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<summary>
Repay a loan
<para><a href="https://binance-docs.github.io/apidocs/spot/en/#repay-crypto-loan-repay-trade" /></para>
Expand All @@ -6331,7 +6331,7 @@
<param name="ct">Cancellation token</param>
<returns></returns>
</member>
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceClientGeneralApiCryptoLoans.GetRepayHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceRestClientGeneralApiLoans.GetRepayHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<summary>
Get loan repayment history
<para><a href="https://binance-docs.github.io/apidocs/spot/en/#repay-get-loan-repayment-history-user_data" /></para>
Expand All @@ -6347,7 +6347,7 @@
<param name="ct">Cancellation token</param>
<returns></returns>
</member>
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceClientGeneralApiCryptoLoans.AdjustLTVAsync(System.Int64,System.Decimal,System.Boolean,System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceRestClientGeneralApiLoans.AdjustLTVAsync(System.Int64,System.Decimal,System.Boolean,System.Nullable{System.Int64},System.Threading.CancellationToken)">
<summary>
Adjust LTV for a loan
<para><a href="https://binance-docs.github.io/apidocs/spot/en/#adjust-ltv-crypto-loan-adjust-ltv-trade" /></para>
Expand All @@ -6359,7 +6359,7 @@
<param name="ct">Cancellation token</param>
<returns></returns>
</member>
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceClientGeneralApiCryptoLoans.GetLtvAdjustHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<member name="M:Binance.Net.Interfaces.Clients.GeneralApi.IBinanceRestClientGeneralApiLoans.GetLtvAdjustHistoryAsync(System.Nullable{System.Int64},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int64},System.Threading.CancellationToken)">
<summary>
Get LTV adjustment history
<para><a href="https://binance-docs.github.io/apidocs/spot/en/#adjust-ltv-get-loan-ltv-adjustment-history-user_data" /></para>
Expand Down
4 changes: 2 additions & 2 deletions Binance.Net/Clients/GeneralApi/BinanceRestClientGeneralApi.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public class BinanceRestClientGeneralApi : RestApiClient, IBinanceRestClientGene
/// <inheritdoc />
public IBinanceRestClientGeneralApiSavings Savings { get; }
/// <inheritdoc />
public IBinanceClientGeneralApiCryptoLoans CryptoLoans { get; }
public IBinanceRestClientGeneralApiLoans CryptoLoans { get; }
/// <inheritdoc />
public IBinanceRestClientGeneralApiMining Mining { get; }
/// <inheritdoc />
Expand All @@ -52,7 +52,7 @@ internal BinanceRestClientGeneralApi(ILogger logger, HttpClient? httpClient, Bin
Brokerage = new BinanceRestClientGeneralApiBrokerage(this);
Futures = new BinanceRestClientGeneralApiFutures(this);
Savings = new BinanceRestClientGeneralApiSavings(this);
CryptoLoans = new BinanceClientGeneralApiCryptoLoans(this);
CryptoLoans = new BinanceRestClientGeneralApiLoans(this);
Mining = new BinanceRestClientGeneralApiMining(this);
SubAccount = new BinanceRestClientGeneralApiSubAccount(this);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
namespace Binance.Net.Clients.GeneralApi
{
/// <inheritdoc />
public class BinanceClientGeneralApiCryptoLoans : IBinanceClientGeneralApiCryptoLoans
public class BinanceRestClientGeneralApiLoans : IBinanceRestClientGeneralApiLoans
{
// Crypto loans
private const string incomingEndpoint = "loan/income";
Expand All @@ -31,7 +31,7 @@ public class BinanceClientGeneralApiCryptoLoans : IBinanceClientGeneralApiCrypto

private readonly BinanceRestClientGeneralApi _baseClient;

internal BinanceClientGeneralApiCryptoLoans(BinanceRestClientGeneralApi baseClient)
internal BinanceRestClientGeneralApiLoans(BinanceRestClientGeneralApi baseClient)
{
_baseClient = baseClient;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public interface IBinanceRestClientGeneralApi : IRestApiClient, IDisposable
/// <summary>
/// Endpoints related to crypto loans
/// </summary>
public IBinanceClientGeneralApiCryptoLoans CryptoLoans { get; }
public IBinanceRestClientGeneralApiLoans CryptoLoans { get; }

/// <summary>
/// Endpoints related to mining
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace Binance.Net.Interfaces.Clients.GeneralApi
/// <summary>
/// Binance Spot Crypto loans endpoints
/// </summary>
public interface IBinanceClientGeneralApiCryptoLoans
public interface IBinanceRestClientGeneralApiLoans
{
/// <summary>
/// Get income history from crypto loans
Expand Down
15 changes: 0 additions & 15 deletions Examples/Blazor.ServerSide/Data/WeatherForecast.cs

This file was deleted.

25 changes: 0 additions & 25 deletions Examples/Blazor.ServerSide/Data/WeatherForecastService.cs

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
---
title: IBinanceRestClientCoinFuturesApi
has_children: true
parent: IBinanceClientCoinFuturesApi
grand_parent: Rest API documentation
parent: Rest API documentation
---
*[generated documentation]*
`BinanceClient > CoinFuturesApi > IBinanceRestClient`
`BinanceRestClient > CoinFuturesApi`
*Binance Coin futures API endpoints*

***
*Get the IFuturesClient for this client. This is a common interface which allows for some basic operations without knowing any details of the exchange.*
**IFuturesClient CommonFuturesClient { get; }**
***
*Endpoints related to account settings, info or actions*
**IBinanceRestClientCoinFuturesApiAccount Account { get; }**
**[IBinanceRestClientCoinFuturesApiAccount](IBinanceRestClientCoinFuturesApiAccount.html) Account { get; }**
***
*Endpoints related to retrieving market data*
**IBinanceRestClientCoinFuturesApiExchangeData ExchangeData { get; }**
**[IBinanceRestClientCoinFuturesApiExchangeData](IBinanceRestClientCoinFuturesApiExchangeData.html) ExchangeData { get; }**
***
*Endpoints related to orders and trades*
**IBinanceRestClientCoinFuturesApiTrading Trading { get; }**
**[IBinanceRestClientCoinFuturesApiTrading](IBinanceRestClientCoinFuturesApiTrading.html) Trading { get; }**
Loading

0 comments on commit 13e5ee4

Please sign in to comment.