@brokerize/client 1.2.3 → 1.2.4

package/dist/client.d.ts

@@ -2672,6 +2672,12 @@ declare interface ClientConfig {
      * @memberof ClientConfig
      */
     page: any | null;
+    /**
+     * These flags are used in supporting the reporting logic
+     * @type {Array<string>}
+     * @memberof ClientConfig
+     */
+    reportingFlags?: Array<string>;
 }
 
 declare function ClientConfigFromJSON(json: any): ClientConfig;
@@ -2854,6 +2860,12 @@ declare interface ClientConfigUpdate {
      * @memberof ClientConfigUpdate
      */
     rateLimitPointsToConsume?: ClientConfigUpdateRateLimitPointsToConsume;
+    /**
+     * These flags are used in supporting the reporting logic
+     * @type {Array<string>}
+     * @memberof ClientConfigUpdate
+     */
+    reportingFlags?: Array<string>;
 }
 
 declare function ClientConfigUpdateFromJSON(json: any): ClientConfigUpdate;
@@ -13545,6 +13557,26 @@ declare interface TradeStatistics {
      * @memberof TradeStatistics
      */
     winnerCount: number;
+    /**
+     * The proportion of trading days that ended with a net profit within the selected timeframe.
+     *
+     * - Calculated as the number of profitable trading days divided by the total number of trading days with activity.
+     * - For example, if trades were executed on 10 days and 2 of those days resulted in a net profit, the ratio would be `0.2`.
+     * - If no trades occurred during the selected period, the value is `undefined`.
+     * @type {number}
+     * @memberof TradeStatistics
+     */
+    winnerDaysRatio?: number;
+    /**
+     * The proportion of months that ended with a net profit within the selected timeframe.
+     *
+     * - Calculated as the number of profitable trading months divided by the total number of trading months with activity.
+     * - For example, if trades were executed in 10 months and 2 of those months resulted in a net profit, the ratio would be `0.2`.
+     * - If no trades occurred during the selected period, the value is `undefined`.
+     * @type {number}
+     * @memberof TradeStatistics
+     */
+    winnerMonthsRatio?: number;
     /**
      *
      * @type {SummarizedTrade}

package/dist/swagger/models/ClientConfig.d.ts

@@ -117,6 +117,12 @@ export interface ClientConfig {
      * @memberof ClientConfig
      */
     page: any | null;
+    /**
+     * These flags are used in supporting the reporting logic
+     * @type {Array<string>}
+     * @memberof ClientConfig
+     */
+    reportingFlags?: Array<string>;
 }
 export declare function ClientConfigFromJSON(json: any): ClientConfig;
 export declare function ClientConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClientConfig;

package/dist/swagger/models/ClientConfig.js

@@ -51,6 +51,9 @@ export function ClientConfigFromJSONTyped(json, ignoreDiscriminator) {
         oAuthReturnToRegularExpressions: json["oAuthReturnToRegularExpressions"],
         oAuthReturnToUrls: json["oAuthReturnToUrls"],
         page: json["page"],
+        reportingFlags: !exists(json, "reportingFlags")
+            ? undefined
+            : json["reportingFlags"],
     };
 }
 export function ClientConfigToJSONRecursive(value, ignoreParent = false) {
@@ -77,6 +80,7 @@ export function ClientConfigToJSONRecursive(value, ignoreParent = false) {
         oAuthReturnToRegularExpressions: value.oAuthReturnToRegularExpressions,
         oAuthReturnToUrls: value.oAuthReturnToUrls,
         page: value.page,
+        reportingFlags: value.reportingFlags,
     };
 }
 export function ClientConfigToJSON(value) {

package/dist/swagger/models/ClientConfigUpdate.d.ts

@@ -149,6 +149,12 @@ export interface ClientConfigUpdate {
      * @memberof ClientConfigUpdate
      */
     rateLimitPointsToConsume?: ClientConfigUpdateRateLimitPointsToConsume;
+    /**
+     * These flags are used in supporting the reporting logic
+     * @type {Array<string>}
+     * @memberof ClientConfigUpdate
+     */
+    reportingFlags?: Array<string>;
 }
 export declare function ClientConfigUpdateFromJSON(json: any): ClientConfigUpdate;
 export declare function ClientConfigUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClientConfigUpdate;

package/dist/swagger/models/ClientConfigUpdate.js

@@ -85,6 +85,9 @@ export function ClientConfigUpdateFromJSONTyped(json, ignoreDiscriminator) {
         rateLimitPointsToConsume: !exists(json, "rateLimitPointsToConsume")
             ? undefined
             : ClientConfigUpdateRateLimitPointsToConsumeFromJSON(json["rateLimitPointsToConsume"]),
+        reportingFlags: !exists(json, "reportingFlags")
+            ? undefined
+            : json["reportingFlags"],
     };
 }
 export function ClientConfigUpdateToJSONRecursive(value, ignoreParent = false) {
@@ -118,6 +121,7 @@ export function ClientConfigUpdateToJSONRecursive(value, ignoreParent = false) {
         optionalClientSecrets: value.optionalClientSecrets,
         page: ClientConfigUpdatePageToJSON(value.page),
         rateLimitPointsToConsume: ClientConfigUpdateRateLimitPointsToConsumeToJSON(value.rateLimitPointsToConsume),
+        reportingFlags: value.reportingFlags,
     };
 }
 export function ClientConfigUpdateToJSON(value) {

package/dist/swagger/models/TradeStatistics.d.ts

@@ -97,6 +97,26 @@ export interface TradeStatistics {
      * @memberof TradeStatistics
      */
     winnerCount: number;
+    /**
+     * The proportion of trading days that ended with a net profit within the selected timeframe.
+     *
+     * - Calculated as the number of profitable trading days divided by the total number of trading days with activity.
+     * - For example, if trades were executed on 10 days and 2 of those days resulted in a net profit, the ratio would be `0.2`.
+     * - If no trades occurred during the selected period, the value is `undefined`.
+     * @type {number}
+     * @memberof TradeStatistics
+     */
+    winnerDaysRatio?: number;
+    /**
+     * The proportion of months that ended with a net profit within the selected timeframe.
+     *
+     * - Calculated as the number of profitable trading months divided by the total number of trading months with activity.
+     * - For example, if trades were executed in 10 months and 2 of those months resulted in a net profit, the ratio would be `0.2`.
+     * - If no trades occurred during the selected period, the value is `undefined`.
+     * @type {number}
+     * @memberof TradeStatistics
+     */
+    winnerMonthsRatio?: number;
     /**
      *
      * @type {SummarizedTrade}

package/dist/swagger/models/TradeStatistics.js

@@ -47,6 +47,12 @@ export function TradeStatisticsFromJSONTyped(json, ignoreDiscriminator) {
             : AmountFromJSON(json["profitLossAbs"]),
         tradeCount: json["tradeCount"],
         winnerCount: json["winnerCount"],
+        winnerDaysRatio: !exists(json, "winnerDaysRatio")
+            ? undefined
+            : json["winnerDaysRatio"],
+        winnerMonthsRatio: !exists(json, "winnerMonthsRatio")
+            ? undefined
+            : json["winnerMonthsRatio"],
         worstTrade: !exists(json, "worstTrade")
             ? undefined
             : SummarizedTradeFromJSON(json["worstTrade"]),
@@ -73,6 +79,8 @@ export function TradeStatisticsToJSONRecursive(value, ignoreParent = false) {
         profitLossAbs: AmountToJSON(value.profitLossAbs),
         tradeCount: value.tradeCount,
         winnerCount: value.winnerCount,
+        winnerDaysRatio: value.winnerDaysRatio,
+        winnerMonthsRatio: value.winnerMonthsRatio,
         worstTrade: SummarizedTradeToJSON(value.worstTrade),
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brokerize/client",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Client for the brokerize.com API",
   "keywords": [],
   "homepage": "https://github.com/brokerize/client-js#readme",