@monaco-protocol/client-v2 0.0.73-dev.0 → 0.0.73

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/apis/AppManagementApi.d.ts +4 -2
  2. package/dist/apis/AppManagementApi.js +4 -2
  3. package/dist/models/Trade.d.ts +13 -0
  4. package/dist/models/TradeSummary.d.ts +13 -0
  5. package/dist/models/UpdateAppCommissionRateRequest.d.ts +1 -1
  6. package/package.json +1 -1
package/dist/apis/AppManagementApi.d.ts CHANGED
@@ -57,11 +57,13 @@ export declare class AppManagementApi extends runtime.BaseAPI {
57
57
  */
58
58
  getCommissionRates(requestParameters: AppManagementApiGetCommissionRatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CommissionRateResponse>;
59
59
  /**
60
- * Fetch commission rates
60
+ * Create a new commission rate to be applied to profit on risk created via the given app. Commission rates can have a value between 0.0 and 1.0, where e.g., 0.01 would be 1% of the profit.<br /><br />The most recently created rate will be used as the default rate. The default rate is used when no commission rate ID is passed during order creation.<br /><br />NOTE maximum effective commission rate for an app will be <br /><code>1.0 - protocol commission(fee) rate</code>
61
+ * Create a new app commission rate
61
62
  */
62
63
  updateCommissionRateRaw(requestParameters: AppManagementApiUpdateCommissionRateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AppResponse>>;
63
64
  /**
64
- * Fetch commission rates
65
+ * Create a new commission rate to be applied to profit on risk created via the given app. Commission rates can have a value between 0.0 and 1.0, where e.g., 0.01 would be 1% of the profit.<br /><br />The most recently created rate will be used as the default rate. The default rate is used when no commission rate ID is passed during order creation.<br /><br />NOTE maximum effective commission rate for an app will be <br /><code>1.0 - protocol commission(fee) rate</code>
66
+ * Create a new app commission rate
65
67
  */
66
68
  updateCommissionRate(requestParameters: AppManagementApiUpdateCommissionRateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AppResponse>;
67
69
  }
package/dist/apis/AppManagementApi.js CHANGED
@@ -134,7 +134,8 @@ class AppManagementApi extends runtime.BaseAPI {
134
134
  });
135
135
  }
136
136
  /**
137
- * Fetch commission rates
137
+ * Create a new commission rate to be applied to profit on risk created via the given app. Commission rates can have a value between 0.0 and 1.0, where e.g., 0.01 would be 1% of the profit.<br /><br />The most recently created rate will be used as the default rate. The default rate is used when no commission rate ID is passed during order creation.<br /><br />NOTE maximum effective commission rate for an app will be <br /><code>1.0 - protocol commission(fee) rate</code>
138
+ * Create a new app commission rate
138
139
  */
139
140
  updateCommissionRateRaw(requestParameters, initOverrides) {
140
141
  return __awaiter(this, void 0, void 0, function* () {
@@ -164,7 +165,8 @@ class AppManagementApi extends runtime.BaseAPI {
164
165
  });
165
166
  }
166
167
  /**
167
- * Fetch commission rates
168
+ * Create a new commission rate to be applied to profit on risk created via the given app. Commission rates can have a value between 0.0 and 1.0, where e.g., 0.01 would be 1% of the profit.<br /><br />The most recently created rate will be used as the default rate. The default rate is used when no commission rate ID is passed during order creation.<br /><br />NOTE maximum effective commission rate for an app will be <br /><code>1.0 - protocol commission(fee) rate</code>
169
+ * Create a new app commission rate
168
170
  */
169
171
  updateCommissionRate(requestParameters, initOverrides) {
170
172
  return __awaiter(this, void 0, void 0, function* () {
package/dist/models/Trade.d.ts CHANGED
@@ -65,6 +65,19 @@ export interface Trade {
65
65
  */
66
66
  stake?: number;
67
67
  /**
68
+ * Profit or Loss for the trade, calculated as follows:<br>
69
+ * 'For' trades
70
+ * <ul>
71
+ * <li> Winning; profitLoss = stake * (price-1) </li>
72
+ * <li> Losing; profitLoss = (stake * -1) </li>
73
+ * <li> Voided; profitLoss = 0 </li>
74
+ * </ul>
75
+ * 'Against' trades
76
+ * <ul>
77
+ * <li> Winning; profitLoss = stake </li>
78
+ * <li> Losing; profitLoss = stake * (price-1) * (-1) </li>
79
+ * <li> Voided; profitLoss = 0 </li>
80
+ * </ul>
68
81
  *
69
82
  * @type {number}
70
83
  * @memberof Trade
package/dist/models/TradeSummary.d.ts CHANGED
@@ -41,6 +41,19 @@ export interface TradeSummary {
41
41
  */
42
42
  stake?: number;
43
43
  /**
44
+ * Profit or Loss for the trade, calculated as follows:<br>
45
+ * 'For' trades
46
+ * <ul>
47
+ * <li> Winning trade; profitLoss = stake * (price-1) </li>
48
+ * <li> Losing trade, profitLoss = (stake * -1) </li>
49
+ * <li> Voided trade, profitLoss = 0 </li>
50
+ * </ul>
51
+ * 'Against' trades
52
+ * <ul>
53
+ * <li> Winning trade, profitLoss = stake </li>
54
+ * <li> Losing trade, profitLoss = stake * (price-1) * (-1) </li>
55
+ * <li> Voided trade, profitLoss = 0 </li>
56
+ * </ul>
44
57
  *
45
58
  * @type {number}
46
59
  * @memberof TradeSummary
package/dist/models/UpdateAppCommissionRateRequest.d.ts CHANGED
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface UpdateAppCommissionRateRequest {
18
18
  /**
19
- *
19
+ * A value between 0.00 and 1.0, where e.g., 0.01 is treated as 1%
20
20
  * @type {number}
21
21
  * @memberof UpdateAppCommissionRateRequest
22
22
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@monaco-protocol/client-v2",
3
- "version": "0.0.73-dev.0",
3
+ "version": "0.0.73",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "files": [