@brokerize/client 1.0.1

package/dist/swagger/models/Order.js

@@ -0,0 +1,246 @@
+/* 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";
+import { AmountFromJSON, AmountToJSON, } from "./Amount";
+import { CashQuotationFromJSON, CashQuotationToJSON, } from "./CashQuotation";
+import { DirectionFromJSON, DirectionToJSON, } from "./Direction";
+import { OrderExecutionFromJSON, OrderExecutionToJSON, } from "./OrderExecution";
+import { OrderExtensionFromJSON, OrderExtensionToJSON, } from "./OrderExtension";
+import { OrderModelFromJSON, OrderModelToJSON, } from "./OrderModel";
+import { OrderStatusFromJSON, OrderStatusToJSON, } from "./OrderStatus";
+import { OrderValidityFromJSON, OrderValidityToJSON, } from "./OrderValidity";
+import { OrderValidityTypeFromJSON, OrderValidityTypeToJSON, } from "./OrderValidityType";
+import { SecurityFromJSON, SecurityToJSON, } from "./Security";
+import { TrailingDistanceFromJSON, TrailingDistanceToJSON, } from "./TrailingDistance";
+/**
+ * @export
+ */
+export const OrderIntentEnum = {
+    Open: "open",
+    Close: "close",
+};
+export function OrderFromJSON(json) {
+    return OrderFromJSONTyped(json, false);
+}
+export function OrderFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        allowsCancel: json["allowsCancel"],
+        allowsChangeLimit: !exists(json, "allowsChangeLimit")
+            ? undefined
+            : json["allowsChangeLimit"],
+        allowsChangeOrderModels: !exists(json, "allowsChangeOrderModels")
+            ? undefined
+            : json["allowsChangeOrderModels"].map(OrderModelFromJSON),
+        allowsChangeSize: json["allowsChangeSize"],
+        allowsChangeStop: !exists(json, "allowsChangeStop")
+            ? undefined
+            : json["allowsChangeStop"],
+        allowsChangeStopLimit: !exists(json, "allowsChangeStopLimit")
+            ? undefined
+            : json["allowsChangeStopLimit"],
+        allowsChangeStopLoss: !exists(json, "allowsChangeStopLoss")
+            ? undefined
+            : json["allowsChangeStopLoss"],
+        allowsChangeTakeProfit: !exists(json, "allowsChangeTakeProfit")
+            ? undefined
+            : json["allowsChangeTakeProfit"],
+        allowsChangeTrailingDistance: !exists(json, "allowsChangeTrailingDistance")
+            ? undefined
+            : json["allowsChangeTrailingDistance"],
+        allowsChangeValidityTypes: !exists(json, "allowsChangeValidityTypes")
+            ? undefined
+            : json["allowsChangeValidityTypes"].map(OrderValidityTypeFromJSON),
+        bondCurrencyIso: !exists(json, "bondCurrencyIso")
+            ? undefined
+            : json["bondCurrencyIso"],
+        brokerExchangeId: json["brokerExchangeId"],
+        brokerSecurityId: !exists(json, "brokerSecurityId")
+            ? undefined
+            : json["brokerSecurityId"],
+        cancellationDateTime: !exists(json, "cancellationDateTime")
+            ? undefined
+            : new Date(json["cancellationDateTime"]),
+        cancelledSize: !exists(json, "cancelledSize")
+            ? undefined
+            : json["cancelledSize"],
+        cashQuotation: !exists(json, "cashQuotation")
+            ? undefined
+            : CashQuotationFromJSON(json["cashQuotation"]),
+        changesHaveCostEstimations: !exists(json, "changesHaveCostEstimations")
+            ? undefined
+            : json["changesHaveCostEstimations"],
+        createdAt: new Date(json["createdAt"]),
+        currentStop: !exists(json, "currentStop")
+            ? undefined
+            : AmountFromJSON(json["currentStop"]),
+        direction: DirectionFromJSON(json["direction"]),
+        displayNo: !exists(json, "displayNo") ? undefined : json["displayNo"],
+        exchangeId: !exists(json, "exchangeId") ? undefined : json["exchangeId"],
+        exchangeName: !exists(json, "exchangeName")
+            ? undefined
+            : json["exchangeName"],
+        executedAt: !exists(json, "executedAt")
+            ? undefined
+            : new Date(json["executedAt"]),
+        executedSize: !exists(json, "executedSize")
+            ? undefined
+            : json["executedSize"],
+        executions: !exists(json, "executions")
+            ? undefined
+            : json["executions"].map(OrderExecutionFromJSON),
+        hasNoOrderReceipt: !exists(json, "hasNoOrderReceipt")
+            ? undefined
+            : json["hasNoOrderReceipt"],
+        id: json["id"],
+        ifDoneLimit: !exists(json, "ifDoneLimit") ? undefined : json["ifDoneLimit"],
+        intent: !exists(json, "intent") ? undefined : json["intent"],
+        isin: json["isin"],
+        limit: !exists(json, "limit") ? undefined : json["limit"],
+        limitCurrencyIso: !exists(json, "limitCurrencyIso")
+            ? undefined
+            : json["limitCurrencyIso"],
+        mayObserveCurrentStop: !exists(json, "mayObserveCurrentStop")
+            ? undefined
+            : json["mayObserveCurrentStop"],
+        openSize: !exists(json, "openSize") ? undefined : json["openSize"],
+        orderExtension: !exists(json, "orderExtension")
+            ? undefined
+            : OrderExtensionFromJSON(json["orderExtension"]),
+        orderModel: OrderModelFromJSON(json["orderModel"]),
+        orderStatusIsAwaitingParentOrder: !exists(json, "orderStatusIsAwaitingParentOrder")
+            ? undefined
+            : json["orderStatusIsAwaitingParentOrder"],
+        portfolioId: json["portfolioId"],
+        profitLossAbs: !exists(json, "profitLossAbs")
+            ? undefined
+            : AmountFromJSON(json["profitLossAbs"]),
+        profitLossRel: !exists(json, "profitLossRel")
+            ? undefined
+            : json["profitLossRel"],
+        quoteDecimals: !exists(json, "quoteDecimals")
+            ? undefined
+            : json["quoteDecimals"],
+        quoteLimit: !exists(json, "quoteLimit") ? undefined : json["quoteLimit"],
+        security: SecurityFromJSON(json["security"]),
+        showAsDisabled: !exists(json, "showAsDisabled")
+            ? undefined
+            : json["showAsDisabled"],
+        size: json["size"],
+        sizeDecimals: !exists(json, "sizeDecimals")
+            ? undefined
+            : json["sizeDecimals"],
+        sizeUnit: !exists(json, "sizeUnit") ? undefined : json["sizeUnit"],
+        sourceData: !exists(json, "sourceData") ? undefined : json["sourceData"],
+        status: OrderStatusFromJSON(json["status"]),
+        statusText: !exists(json, "statusText") ? undefined : json["statusText"],
+        stop: !exists(json, "stop") ? undefined : json["stop"],
+        stopLimit: !exists(json, "stopLimit") ? undefined : json["stopLimit"],
+        stopLoss: !exists(json, "stopLoss") ? undefined : json["stopLoss"],
+        takeProfit: !exists(json, "takeProfit") ? undefined : json["takeProfit"],
+        trailingDistance: !exists(json, "trailingDistance")
+            ? undefined
+            : TrailingDistanceFromJSON(json["trailingDistance"]),
+        trailingLimitTolerance: !exists(json, "trailingLimitTolerance")
+            ? undefined
+            : json["trailingLimitTolerance"],
+        usTicker: !exists(json, "usTicker") ? undefined : json["usTicker"],
+        validity: !exists(json, "validity")
+            ? undefined
+            : OrderValidityFromJSON(json["validity"]),
+    };
+}
+export function OrderToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        allowsCancel: value.allowsCancel,
+        allowsChangeLimit: value.allowsChangeLimit,
+        allowsChangeOrderModels: value.allowsChangeOrderModels === undefined
+            ? undefined
+            : value.allowsChangeOrderModels.map(OrderModelToJSON),
+        allowsChangeSize: value.allowsChangeSize,
+        allowsChangeStop: value.allowsChangeStop,
+        allowsChangeStopLimit: value.allowsChangeStopLimit,
+        allowsChangeStopLoss: value.allowsChangeStopLoss,
+        allowsChangeTakeProfit: value.allowsChangeTakeProfit,
+        allowsChangeTrailingDistance: value.allowsChangeTrailingDistance,
+        allowsChangeValidityTypes: value.allowsChangeValidityTypes === undefined
+            ? undefined
+            : value.allowsChangeValidityTypes.map(OrderValidityTypeToJSON),
+        bondCurrencyIso: value.bondCurrencyIso,
+        brokerExchangeId: value.brokerExchangeId,
+        brokerSecurityId: value.brokerSecurityId,
+        cancellationDateTime: value.cancellationDateTime === undefined
+            ? undefined
+            : value.cancellationDateTime.toISOString(),
+        cancelledSize: value.cancelledSize,
+        cashQuotation: CashQuotationToJSON(value.cashQuotation),
+        changesHaveCostEstimations: value.changesHaveCostEstimations,
+        createdAt: value.createdAt.toISOString(),
+        currentStop: AmountToJSON(value.currentStop),
+        direction: DirectionToJSON(value.direction),
+        displayNo: value.displayNo,
+        exchangeId: value.exchangeId,
+        exchangeName: value.exchangeName,
+        executedAt: value.executedAt === undefined
+            ? undefined
+            : value.executedAt.toISOString(),
+        executedSize: value.executedSize,
+        executions: value.executions === undefined
+            ? undefined
+            : value.executions.map(OrderExecutionToJSON),
+        hasNoOrderReceipt: value.hasNoOrderReceipt,
+        id: value.id,
+        ifDoneLimit: value.ifDoneLimit,
+        intent: value.intent,
+        isin: value.isin,
+        limit: value.limit,
+        limitCurrencyIso: value.limitCurrencyIso,
+        mayObserveCurrentStop: value.mayObserveCurrentStop,
+        openSize: value.openSize,
+        orderExtension: OrderExtensionToJSON(value.orderExtension),
+        orderModel: OrderModelToJSON(value.orderModel),
+        orderStatusIsAwaitingParentOrder: value.orderStatusIsAwaitingParentOrder,
+        portfolioId: value.portfolioId,
+        profitLossAbs: AmountToJSON(value.profitLossAbs),
+        profitLossRel: value.profitLossRel,
+        quoteDecimals: value.quoteDecimals,
+        quoteLimit: value.quoteLimit,
+        security: SecurityToJSON(value.security),
+        showAsDisabled: value.showAsDisabled,
+        size: value.size,
+        sizeDecimals: value.sizeDecimals,
+        sizeUnit: value.sizeUnit,
+        sourceData: value.sourceData,
+        status: OrderStatusToJSON(value.status),
+        statusText: value.statusText,
+        stop: value.stop,
+        stopLimit: value.stopLimit,
+        stopLoss: value.stopLoss,
+        takeProfit: value.takeProfit,
+        trailingDistance: TrailingDistanceToJSON(value.trailingDistance),
+        trailingLimitTolerance: value.trailingLimitTolerance,
+        usTicker: value.usTicker,
+        validity: OrderValidityToJSON(value.validity),
+    };
+}
+export function OrderToJSON(value) {
+    return OrderToJSONRecursive(value, false);
+}

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

@@ -0,0 +1,92 @@
+/**
+ * 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 { OrderModel } from "./OrderModel";
+import { OrderValidity } from "./OrderValidity";
+import { TrailingDistance } from "./TrailingDistance";
+/**
+ *
+ * @export
+ * @interface OrderChanges
+ */
+export interface OrderChanges {
+    /**
+     * The limit of an order specifies a maximum (direction buy) or minimum (direction sell) value to execute the
+     * order at.
+     *
+     * A limit can be set for orderModel `limit`
+     * @type {number}
+     * @memberof OrderChanges
+     */
+    limit?: number;
+    /**
+     *
+     * @type {OrderModel}
+     * @memberof OrderChanges
+     */
+    orderModel?: OrderModel;
+    /**
+     *
+     * @type {number}
+     * @memberof OrderChanges
+     */
+    size?: number;
+    /**
+     * The stop of an order specifies a usually higher value than the current quote (direction buy) or a usually lower value than the current quote (direction sell).
+     *
+     * For the orderModel `stop`, the order is executed immediately when the stop is reached.
+     * For the orderModel `stopLimit`, the order will only be executed with a limit value of `stopLimit` (so for buy orders the price of execution will not be higher than `stopLimit`, for sell it orders it will not be lower than `stopLimit`).
+     * @type {number}
+     * @memberof OrderChanges
+     */
+    stop?: number;
+    /**
+     * The stop limit specifies a limit to use *after stop has been reached*. For buy orders, the stopLimit will be usually higher than stop, for sell orders the stopLimit will usually be lower than stop.
+     * @type {number}
+     * @memberof OrderChanges
+     */
+    stopLimit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof OrderChanges
+     */
+    stopLoss?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof OrderChanges
+     */
+    takeProfit?: number;
+    /**
+     *
+     * @type {TrailingDistance}
+     * @memberof OrderChanges
+     */
+    trailingDistance?: TrailingDistance;
+    /**
+     * For orderModel `trailingStopLimit`: when the trailing stop has been reached, the tolerance
+     * value is added to (for buy orders) or subtracted from (for sell orders) the stop value to obtain
+     * a limit value. After that, the order can be regarded as a limit order with that limit value.
+     * @type {number}
+     * @memberof OrderChanges
+     */
+    trailingLimitTolerance?: number;
+    /**
+     *
+     * @type {OrderValidity}
+     * @memberof OrderChanges
+     */
+    validity?: OrderValidity;
+}
+export declare function OrderChangesFromJSON(json: any): OrderChanges;
+export declare function OrderChangesFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderChanges;
+export declare function OrderChangesToJSONRecursive(value?: OrderChanges | null, ignoreParent?: boolean): any;
+export declare function OrderChangesToJSON(value?: OrderChanges | null): any;

package/dist/swagger/models/OrderChanges.js

@@ -0,0 +1,67 @@
+/* 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";
+import { OrderModelFromJSON, OrderModelToJSON, } from "./OrderModel";
+import { OrderValidityFromJSON, OrderValidityToJSON, } from "./OrderValidity";
+import { TrailingDistanceFromJSON, TrailingDistanceToJSON, } from "./TrailingDistance";
+export function OrderChangesFromJSON(json) {
+    return OrderChangesFromJSONTyped(json, false);
+}
+export function OrderChangesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        limit: !exists(json, "limit") ? undefined : json["limit"],
+        orderModel: !exists(json, "orderModel")
+            ? undefined
+            : OrderModelFromJSON(json["orderModel"]),
+        size: !exists(json, "size") ? undefined : json["size"],
+        stop: !exists(json, "stop") ? undefined : json["stop"],
+        stopLimit: !exists(json, "stopLimit") ? undefined : json["stopLimit"],
+        stopLoss: !exists(json, "stopLoss") ? undefined : json["stopLoss"],
+        takeProfit: !exists(json, "takeProfit") ? undefined : json["takeProfit"],
+        trailingDistance: !exists(json, "trailingDistance")
+            ? undefined
+            : TrailingDistanceFromJSON(json["trailingDistance"]),
+        trailingLimitTolerance: !exists(json, "trailingLimitTolerance")
+            ? undefined
+            : json["trailingLimitTolerance"],
+        validity: !exists(json, "validity")
+            ? undefined
+            : OrderValidityFromJSON(json["validity"]),
+    };
+}
+export function OrderChangesToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        limit: value.limit,
+        orderModel: OrderModelToJSON(value.orderModel),
+        size: value.size,
+        stop: value.stop,
+        stopLimit: value.stopLimit,
+        stopLoss: value.stopLoss,
+        takeProfit: value.takeProfit,
+        trailingDistance: TrailingDistanceToJSON(value.trailingDistance),
+        trailingLimitTolerance: value.trailingLimitTolerance,
+        validity: OrderValidityToJSON(value.validity),
+    };
+}
+export function OrderChangesToJSON(value) {
+    return OrderChangesToJSONRecursive(value, false);
+}

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

@@ -0,0 +1,80 @@
+/**
+ * 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 { Amount } from "./Amount";
+import { CostDetailsLink } from "./CostDetailsLink";
+import { GenericTable } from "./GenericTable";
+/**
+ *
+ * @export
+ * @interface OrderCostEstimation
+ */
+export interface OrderCostEstimation {
+    /**
+     * If present, users have to accept this message before creating an order.
+     * If accepting the costs and performing the order is one click (which is allowed), the create order button label
+     * must contain the information that costs are accepted.
+     * @type {string}
+     * @memberof OrderCostEstimation
+     */
+    costAcceptancePrompt?: string;
+    /**
+     *
+     * @type {CostDetailsLink}
+     * @memberof OrderCostEstimation
+     */
+    costDetailsLink?: CostDetailsLink;
+    /**
+     *
+     * @type {GenericTable}
+     * @memberof OrderCostEstimation
+     */
+    detailedTable?: GenericTable;
+    /**
+     *
+     * @type {Amount}
+     * @memberof OrderCostEstimation
+     */
+    entryCosts?: Amount;
+    /**
+     *
+     * @type {Amount}
+     * @memberof OrderCostEstimation
+     */
+    expectedCounterValue?: Amount;
+    /**
+     *
+     * @type {Amount}
+     * @memberof OrderCostEstimation
+     */
+    orderFees?: Amount;
+    /**
+     * Detailed explanation for order fees
+     * @type {string}
+     * @memberof OrderCostEstimation
+     */
+    orderFeesExplanation?: string;
+    /**
+     *
+     * @type {Amount}
+     * @memberof OrderCostEstimation
+     */
+    totalCosts?: Amount;
+    /**
+     *
+     * @type {Amount}
+     * @memberof OrderCostEstimation
+     */
+    transactionTax?: Amount;
+}
+export declare function OrderCostEstimationFromJSON(json: any): OrderCostEstimation;
+export declare function OrderCostEstimationFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderCostEstimation;
+export declare function OrderCostEstimationToJSONRecursive(value?: OrderCostEstimation | null, ignoreParent?: boolean): any;
+export declare function OrderCostEstimationToJSON(value?: OrderCostEstimation | null): any;

package/dist/swagger/models/OrderCostEstimation.js

@@ -0,0 +1,75 @@
+/* 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";
+import { AmountFromJSON, AmountToJSON, } from "./Amount";
+import { CostDetailsLinkFromJSON, CostDetailsLinkToJSON, } from "./CostDetailsLink";
+import { GenericTableFromJSON, GenericTableToJSON, } from "./GenericTable";
+export function OrderCostEstimationFromJSON(json) {
+    return OrderCostEstimationFromJSONTyped(json, false);
+}
+export function OrderCostEstimationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        costAcceptancePrompt: !exists(json, "costAcceptancePrompt")
+            ? undefined
+            : json["costAcceptancePrompt"],
+        costDetailsLink: !exists(json, "costDetailsLink")
+            ? undefined
+            : CostDetailsLinkFromJSON(json["costDetailsLink"]),
+        detailedTable: !exists(json, "detailedTable")
+            ? undefined
+            : GenericTableFromJSON(json["detailedTable"]),
+        entryCosts: !exists(json, "entryCosts")
+            ? undefined
+            : AmountFromJSON(json["entryCosts"]),
+        expectedCounterValue: !exists(json, "expectedCounterValue")
+            ? undefined
+            : AmountFromJSON(json["expectedCounterValue"]),
+        orderFees: !exists(json, "orderFees")
+            ? undefined
+            : AmountFromJSON(json["orderFees"]),
+        orderFeesExplanation: !exists(json, "orderFeesExplanation")
+            ? undefined
+            : json["orderFeesExplanation"],
+        totalCosts: !exists(json, "totalCosts")
+            ? undefined
+            : AmountFromJSON(json["totalCosts"]),
+        transactionTax: !exists(json, "transactionTax")
+            ? undefined
+            : AmountFromJSON(json["transactionTax"]),
+    };
+}
+export function OrderCostEstimationToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        costAcceptancePrompt: value.costAcceptancePrompt,
+        costDetailsLink: CostDetailsLinkToJSON(value.costDetailsLink),
+        detailedTable: GenericTableToJSON(value.detailedTable),
+        entryCosts: AmountToJSON(value.entryCosts),
+        expectedCounterValue: AmountToJSON(value.expectedCounterValue),
+        orderFees: AmountToJSON(value.orderFees),
+        orderFeesExplanation: value.orderFeesExplanation,
+        totalCosts: AmountToJSON(value.totalCosts),
+        transactionTax: AmountToJSON(value.transactionTax),
+    };
+}
+export function OrderCostEstimationToJSON(value) {
+    return OrderCostEstimationToJSONRecursive(value, false);
+}