@brokerize/client 1.1.3 → 1.2.0

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

@@ -0,0 +1,28 @@
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ChangeOrderResponse
+ */
+export interface ChangeOrderResponse {
+    /**
+     * If a decoupled method is used to change the order, the cancellation process can be observed through the
+     * `decoupledOperationId`.
+     * @type {string}
+     * @memberof ChangeOrderResponse
+     */
+    decoupledOperationId?: string;
+}
+export declare function ChangeOrderResponseFromJSON(json: any): ChangeOrderResponse;
+export declare function ChangeOrderResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChangeOrderResponse;
+export declare function ChangeOrderResponseToJSONRecursive(value?: ChangeOrderResponse | null, ignoreParent?: boolean): any;
+export declare function ChangeOrderResponseToJSON(value?: ChangeOrderResponse | null): any;

package/dist/swagger/models/ChangeOrderResponse.js

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from "../runtime";
+export function ChangeOrderResponseFromJSON(json) {
+    return ChangeOrderResponseFromJSONTyped(json, false);
+}
+export function ChangeOrderResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        decoupledOperationId: !exists(json, "decoupledOperationId")
+            ? undefined
+            : json["decoupledOperationId"],
+    };
+}
+export function ChangeOrderResponseToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        decoupledOperationId: value.decoupledOperationId,
+    };
+}
+export function ChangeOrderResponseToJSON(value) {
+    return ChangeOrderResponseToJSONRecursive(value, false);
+}

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

@@ -15,7 +15,15 @@
  */
 export interface CreateTradeResponse {
     /**
-     *
+     * If a decoupled method is used to create the trade, the creation process can be observed through the
+     * `decoupledOperationId`. In this case, no `orderId` is returned.
+     * @type {string}
+     * @memberof CreateTradeResponse
+     */
+    decoupledOperationId?: string;
+    /**
+     * The id of the created order, if applicable. Some brokers don't return an orderId in all cases, so
+     * frontends should be able to just show a generic "order has been created" message in this case.
      * @type {string}
      * @memberof CreateTradeResponse
      */

package/dist/swagger/models/CreateTradeResponse.js

@@ -19,6 +19,9 @@ export function CreateTradeResponseFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        decoupledOperationId: !exists(json, "decoupledOperationId")
+            ? undefined
+            : json["decoupledOperationId"],
         orderId: !exists(json, "orderId") ? undefined : json["orderId"],
     };
 }
@@ -30,6 +33,7 @@ export function CreateTradeResponseToJSONRecursive(value, ignoreParent = false)
         return null;
     }
     return {
+        decoupledOperationId: value.decoupledOperationId,
         orderId: value.orderId,
     };
 }

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

@@ -15,6 +15,20 @@ import { DecoupledOperationState } from "./DecoupledOperationState";
  * @interface DecoupledOperationStatus
  */
 export interface DecoupledOperationStatus {
+    /**
+     * If:
+     * - the decoupled operation is an order creation
+     * - *AND* it is in the state `AUTHORIZATION_USER_ACCEPTED`
+     * - *AND* the broker supports retrieving this information
+     *
+     * This is the id of the created order. Note that depending on the broker, it is possible
+     * (as with non-decoupled order creations as well), that the broker does not return this id, but
+     * instead will add the order to the order book asynchronously. In this case it is not possible to directly
+     * show an order receipt, but just a message (e.g. "Order has been created successfully - check order list for updates").
+     * @type {string}
+     * @memberof DecoupledOperationStatus
+     */
+    createdOrderId?: string;
     /**
      *
      * @type {DecoupledOperationState}

package/dist/swagger/models/DecoupledOperationStatus.js

@@ -20,6 +20,9 @@ export function DecoupledOperationStatusFromJSONTyped(json, ignoreDiscriminator)
         return json;
     }
     return {
+        createdOrderId: !exists(json, "createdOrderId")
+            ? undefined
+            : json["createdOrderId"],
         state: DecoupledOperationStateFromJSON(json["state"]),
         text: !exists(json, "text") ? undefined : json["text"],
     };
@@ -32,6 +35,7 @@ export function DecoupledOperationStatusToJSONRecursive(value, ignoreParent = fa
         return null;
     }
     return {
+        createdOrderId: value.createdOrderId,
         state: DecoupledOperationStateToJSON(value.state),
         text: value.text,
     };

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

@@ -16,6 +16,12 @@ import { Security } from "./Security";
  * @interface SummarizedTrade
  */
 export interface SummarizedTrade {
+    /**
+     *
+     * @type {Amount}
+     * @memberof SummarizedTrade
+     */
+    closeAvgQuotation: Amount;
     /**
      *
      * @type {Date}
@@ -40,6 +46,12 @@ export interface SummarizedTrade {
      * @memberof SummarizedTrade
      */
     id: string;
+    /**
+     *
+     * @type {Amount}
+     * @memberof SummarizedTrade
+     */
+    openAvgQuotation: Amount;
     /**
      *
      * @type {Date}

package/dist/swagger/models/SummarizedTrade.js

@@ -21,10 +21,12 @@ export function SummarizedTradeFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        closeAvgQuotation: AmountFromJSON(json["closeAvgQuotation"]),
         closeDateTime: new Date(json["closeDateTime"]),
         details: json["details"],
         fees: !exists(json, "fees") ? undefined : AmountFromJSON(json["fees"]),
         id: json["id"],
+        openAvgQuotation: AmountFromJSON(json["openAvgQuotation"]),
         openDateTime: new Date(json["openDateTime"]),
         profitLossAbs: AmountFromJSON(json["profitLossAbs"]),
         profitLossRel: json["profitLossRel"],
@@ -40,10 +42,12 @@ export function SummarizedTradeToJSONRecursive(value, ignoreParent = false) {
         return null;
     }
     return {
+        closeAvgQuotation: AmountToJSON(value.closeAvgQuotation),
         closeDateTime: value.closeDateTime.toISOString(),
         details: value.details,
         fees: AmountToJSON(value.fees),
         id: value.id,
+        openAvgQuotation: AmountToJSON(value.openAvgQuotation),
         openDateTime: value.openDateTime.toISOString(),
         profitLossAbs: AmountToJSON(value.profitLossAbs),
         profitLossRel: value.profitLossRel,

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

@@ -8,6 +8,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { Amount } from "./Amount";
+import { SummarizedTrade } from "./SummarizedTrade";
 import { TradeStatisticsHoldingPeriodInDays } from "./TradeStatisticsHoldingPeriodInDays";
 /**
  *
@@ -15,6 +17,30 @@ import { TradeStatisticsHoldingPeriodInDays } from "./TradeStatisticsHoldingPeri
  * @interface TradeStatistics
  */
 export interface TradeStatistics {
+    /**
+     *
+     * @type {Amount}
+     * @memberof TradeStatistics
+     */
+    avgLossAbs?: Amount;
+    /**
+     *
+     * @type {Amount}
+     * @memberof TradeStatistics
+     */
+    avgProfitAbs?: Amount;
+    /**
+     *
+     * @type {Amount}
+     * @memberof TradeStatistics
+     */
+    avgProfitLossAbs?: Amount;
+    /**
+     *
+     * @type {SummarizedTrade}
+     * @memberof TradeStatistics
+     */
+    bestTrade?: SummarizedTrade;
     /**
      * Which fraction of the trades where winners. 1 is 100%, so a value of 1 would indicate
      * "all trades were winners".
@@ -46,6 +72,19 @@ export interface TradeStatistics {
      * @memberof TradeStatistics
      */
     loserCount: number;
+    /**
+     * Profits/Losses. E.g. if there were 2000€ profits in winning trades and 1000€ losses in losing trades,
+     * the profitFactor would be 2000€ / 1000€ = 2.
+     * @type {number}
+     * @memberof TradeStatistics
+     */
+    profitFactor?: number;
+    /**
+     *
+     * @type {Amount}
+     * @memberof TradeStatistics
+     */
+    profitLossAbs?: Amount;
     /**
      * How many trades are part of the calculation.
      * @type {number}
@@ -58,6 +97,12 @@ export interface TradeStatistics {
      * @memberof TradeStatistics
      */
     winnerCount: number;
+    /**
+     *
+     * @type {SummarizedTrade}
+     * @memberof TradeStatistics
+     */
+    worstTrade?: SummarizedTrade;
 }
 export declare function TradeStatisticsFromJSON(json: any): TradeStatistics;
 export declare function TradeStatisticsFromJSONTyped(json: any, ignoreDiscriminator: boolean): TradeStatistics;

package/dist/swagger/models/TradeStatistics.js

@@ -10,6 +10,9 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { exists } from "../runtime";
+import { AmountFromJSON, AmountToJSON, } from "./Amount";
+import { SummarizedTradeFromJSON, SummarizedTradeToJSON, } from "./SummarizedTrade";
 import { TradeStatisticsHoldingPeriodInDaysFromJSON, TradeStatisticsHoldingPeriodInDaysToJSON, } from "./TradeStatisticsHoldingPeriodInDays";
 export function TradeStatisticsFromJSON(json) {
     return TradeStatisticsFromJSONTyped(json, false);
@@ -19,13 +22,34 @@ export function TradeStatisticsFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        avgLossAbs: !exists(json, "avgLossAbs")
+            ? undefined
+            : AmountFromJSON(json["avgLossAbs"]),
+        avgProfitAbs: !exists(json, "avgProfitAbs")
+            ? undefined
+            : AmountFromJSON(json["avgProfitAbs"]),
+        avgProfitLossAbs: !exists(json, "avgProfitLossAbs")
+            ? undefined
+            : AmountFromJSON(json["avgProfitLossAbs"]),
+        bestTrade: !exists(json, "bestTrade")
+            ? undefined
+            : SummarizedTradeFromJSON(json["bestTrade"]),
         hitRate: json["hitRate"],
         holdingPeriodInDays: TradeStatisticsHoldingPeriodInDaysFromJSON(json["holdingPeriodInDays"]),
         longestLosingStreak: json["longestLosingStreak"],
         longestWinningStreak: json["longestWinningStreak"],
         loserCount: json["loserCount"],
+        profitFactor: !exists(json, "profitFactor")
+            ? undefined
+            : json["profitFactor"],
+        profitLossAbs: !exists(json, "profitLossAbs")
+            ? undefined
+            : AmountFromJSON(json["profitLossAbs"]),
         tradeCount: json["tradeCount"],
         winnerCount: json["winnerCount"],
+        worstTrade: !exists(json, "worstTrade")
+            ? undefined
+            : SummarizedTradeFromJSON(json["worstTrade"]),
     };
 }
 export function TradeStatisticsToJSONRecursive(value, ignoreParent = false) {
@@ -36,13 +60,20 @@ export function TradeStatisticsToJSONRecursive(value, ignoreParent = false) {
         return null;
     }
     return {
+        avgLossAbs: AmountToJSON(value.avgLossAbs),
+        avgProfitAbs: AmountToJSON(value.avgProfitAbs),
+        avgProfitLossAbs: AmountToJSON(value.avgProfitLossAbs),
+        bestTrade: SummarizedTradeToJSON(value.bestTrade),
         hitRate: value.hitRate,
         holdingPeriodInDays: TradeStatisticsHoldingPeriodInDaysToJSON(value.holdingPeriodInDays),
         longestLosingStreak: value.longestLosingStreak,
         longestWinningStreak: value.longestWinningStreak,
         loserCount: value.loserCount,
+        profitFactor: value.profitFactor,
+        profitLossAbs: AmountToJSON(value.profitLossAbs),
         tradeCount: value.tradeCount,
         winnerCount: value.winnerCount,
+        worstTrade: SummarizedTradeToJSON(value.worstTrade),
     };
 }
 export function TradeStatisticsToJSON(value) {

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

@@ -31,14 +31,19 @@ export * from "./CancelOrderChallengeParams";
 export * from "./CancelOrderChallengeResponse";
 export * from "./CancelOrderChallengeResponseAllOf";
 export * from "./CancelOrderChallengeResponseSpecifics";
+export * from "./CancelOrderDecoupled";
+export * from "./CancelOrderDecoupledAllOf";
+export * from "./CancelOrderDecoupledSpecifics";
 export * from "./CancelOrderParams";
 export * from "./CancelOrderParamsMode";
+export * from "./CancelOrderResponse";
 export * from "./CashAccount";
 export * from "./CashAccountQuotes";
 export * from "./CashQuotation";
 export * from "./Challenge";
 export * from "./ChangeOrderChallengeParams";
 export * from "./ChangeOrderParams";
+export * from "./ChangeOrderResponse";
 export * from "./ClientConfig";
 export * from "./ClientConfigMaintenanceStatus";
 export * from "./ClientConfigUpdate";

package/dist/swagger/models/index.js

@@ -33,14 +33,19 @@ export * from "./CancelOrderChallengeParams";
 export * from "./CancelOrderChallengeResponse";
 export * from "./CancelOrderChallengeResponseAllOf";
 export * from "./CancelOrderChallengeResponseSpecifics";
+export * from "./CancelOrderDecoupled";
+export * from "./CancelOrderDecoupledAllOf";
+export * from "./CancelOrderDecoupledSpecifics";
 export * from "./CancelOrderParams";
 export * from "./CancelOrderParamsMode";
+export * from "./CancelOrderResponse";
 export * from "./CashAccount";
 export * from "./CashAccountQuotes";
 export * from "./CashQuotation";
 export * from "./Challenge";
 export * from "./ChangeOrderChallengeParams";
 export * from "./ChangeOrderParams";
+export * from "./ChangeOrderResponse";
 export * from "./ClientConfig";
 export * from "./ClientConfigMaintenanceStatus";
 export * from "./ClientConfigUpdate";

package/package.json

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