@brokerize/client 1.0.1

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

@@ -0,0 +1,209 @@
+/**
+ * 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 { CashQuotation } from "./CashQuotation";
+import { Direction } from "./Direction";
+import { OrderExtension } from "./OrderExtension";
+import { OrderModel } from "./OrderModel";
+import { OrderValidity } from "./OrderValidity";
+import { TrailingDistance } from "./TrailingDistance";
+/**
+ *
+ * @export
+ * @interface OrderCreate
+ */
+export interface OrderCreate {
+    /**
+     *
+     * @type {string}
+     * @memberof OrderCreate
+     */
+    brokerExchangeId: string;
+    /**
+     * The `brokerSecurityId` is the broker-specific identifier for the security to trade. It is provided by the `PreparedTrade` endpoint
+     * and must be used in the order creation process to identify the security.
+     *
+     * This is only optional temporarily and will be required in the future. It will also replace the fields `isin` and `usTicker` for order creations.
+     * @type {string}
+     * @memberof OrderCreate
+     */
+    brokerSecurityId?: string;
+    /**
+     * If a list of cash accounts is provided for the portfolio, this should contain the selected account.
+     * @type {string}
+     * @memberof OrderCreate
+     */
+    cashAccountId?: string;
+    /**
+     *
+     * @type {CashQuotation}
+     * @memberof OrderCreate
+     */
+    cashQuotation?: CashQuotation;
+    /**
+     *
+     * @type {Direction}
+     * @memberof OrderCreate
+     */
+    direction: Direction;
+    /**
+     *
+     * @type {number}
+     * @memberof OrderCreate
+     */
+    ifDoneLimit?: number;
+    /**
+     * Whether this order is supposed to open or close a position. If `PreparedTrade.availableOrderIntents` (and/or the
+     * corresponding subscription via `availableOrderIntentsToken`) is available, it should be set.
+     *
+     * Set it to `close` for orders that are supposed to close an existing position. Note that this is independent
+     * of the order's direction (e.g. a short position is closed by a buy order).
+     * @type {string}
+     * @memberof OrderCreate
+     */
+    intent?: OrderCreateIntentEnum;
+    /**
+     * The ISIN of the security to trade, if applicable. Note that at least one of `isin` and `usTicker` must be set.
+     *
+     * Note that we will make isin optional in a future version of the API.
+     * @type {string}
+     * @memberof OrderCreate
+     */
+    isin: string;
+    /**
+     * 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 OrderCreate
+     */
+    limit?: number;
+    /**
+     * limit (and stop etc.) currency to use for this order
+     * @type {string}
+     * @memberof OrderCreate
+     */
+    limitCurrencyIso?: string;
+    /**
+     *
+     * @type {OrderExtension}
+     * @memberof OrderCreate
+     */
+    orderExtension?: OrderExtension;
+    /**
+     *
+     * @type {OrderModel}
+     * @memberof OrderCreate
+     */
+    orderModel: OrderModel;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderCreate
+     */
+    portfolioId: string;
+    /**
+     * For `orderModel=quote`: the quoteId, as retrieved from `GetQuote`.
+     * @type {string}
+     * @memberof OrderCreate
+     */
+    quoteId?: string;
+    /**
+     * If supported by the broker, an optional limit can be added to a quote trade (`orderModel=quote`).
+     * @type {number}
+     * @memberof OrderCreate
+     */
+    quoteLimit?: number;
+    /**
+     * If a list of sellPositions has been provided in `PrepareTrade`, this must contain the selected position id to sell from
+     * @type {string}
+     * @memberof OrderCreate
+     */
+    sellPositionId?: string;
+    /**
+     * How much of the security should be traded. For stocks, this is the number of stocks. For bonds, this is a monetary amount.
+     * @type {number}
+     * @memberof OrderCreate
+     */
+    size: number;
+    /**
+     * The currency in which the order sizes are provided
+     * @type {string}
+     * @memberof OrderCreate
+     */
+    sizeUnit?: string;
+    /**
+     * 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 OrderCreate
+     */
+    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 OrderCreate
+     */
+    stopLimit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof OrderCreate
+     */
+    stopLoss?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof OrderCreate
+     */
+    takeProfit?: number;
+    /**
+     *
+     * @type {TrailingDistance}
+     * @memberof OrderCreate
+     */
+    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 OrderCreate
+     */
+    trailingLimitTolerance?: number;
+    /**
+     * The US ticker of the security to trade, if applicable. Note that at least one of `isin` and `usTicker` must be set.
+     * @type {string}
+     * @memberof OrderCreate
+     * @deprecated
+     */
+    usTicker?: string;
+    /**
+     *
+     * @type {OrderValidity}
+     * @memberof OrderCreate
+     */
+    validity?: OrderValidity;
+}
+/**
+ * @export
+ */
+export declare const OrderCreateIntentEnum: {
+    readonly Open: "open";
+    readonly Close: "close";
+};
+export type OrderCreateIntentEnum = (typeof OrderCreateIntentEnum)[keyof typeof OrderCreateIntentEnum];
+export declare function OrderCreateFromJSON(json: any): OrderCreate;
+export declare function OrderCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderCreate;
+export declare function OrderCreateToJSONRecursive(value?: OrderCreate | null, ignoreParent?: boolean): any;
+export declare function OrderCreateToJSON(value?: OrderCreate | null): any;

package/dist/swagger/models/OrderCreate.js

@@ -0,0 +1,119 @@
+/* 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 { CashQuotationFromJSON, CashQuotationToJSON, } from "./CashQuotation";
+import { DirectionFromJSON, DirectionToJSON, } from "./Direction";
+import { OrderExtensionFromJSON, OrderExtensionToJSON, } from "./OrderExtension";
+import { OrderModelFromJSON, OrderModelToJSON, } from "./OrderModel";
+import { OrderValidityFromJSON, OrderValidityToJSON, } from "./OrderValidity";
+import { TrailingDistanceFromJSON, TrailingDistanceToJSON, } from "./TrailingDistance";
+/**
+ * @export
+ */
+export const OrderCreateIntentEnum = {
+    Open: "open",
+    Close: "close",
+};
+export function OrderCreateFromJSON(json) {
+    return OrderCreateFromJSONTyped(json, false);
+}
+export function OrderCreateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        brokerExchangeId: json["brokerExchangeId"],
+        brokerSecurityId: !exists(json, "brokerSecurityId")
+            ? undefined
+            : json["brokerSecurityId"],
+        cashAccountId: !exists(json, "cashAccountId")
+            ? undefined
+            : json["cashAccountId"],
+        cashQuotation: !exists(json, "cashQuotation")
+            ? undefined
+            : CashQuotationFromJSON(json["cashQuotation"]),
+        direction: DirectionFromJSON(json["direction"]),
+        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"],
+        orderExtension: !exists(json, "orderExtension")
+            ? undefined
+            : OrderExtensionFromJSON(json["orderExtension"]),
+        orderModel: OrderModelFromJSON(json["orderModel"]),
+        portfolioId: json["portfolioId"],
+        quoteId: !exists(json, "quoteId") ? undefined : json["quoteId"],
+        quoteLimit: !exists(json, "quoteLimit") ? undefined : json["quoteLimit"],
+        sellPositionId: !exists(json, "sellPositionId")
+            ? undefined
+            : json["sellPositionId"],
+        size: json["size"],
+        sizeUnit: !exists(json, "sizeUnit") ? undefined : json["sizeUnit"],
+        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 OrderCreateToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        brokerExchangeId: value.brokerExchangeId,
+        brokerSecurityId: value.brokerSecurityId,
+        cashAccountId: value.cashAccountId,
+        cashQuotation: CashQuotationToJSON(value.cashQuotation),
+        direction: DirectionToJSON(value.direction),
+        ifDoneLimit: value.ifDoneLimit,
+        intent: value.intent,
+        isin: value.isin,
+        limit: value.limit,
+        limitCurrencyIso: value.limitCurrencyIso,
+        orderExtension: OrderExtensionToJSON(value.orderExtension),
+        orderModel: OrderModelToJSON(value.orderModel),
+        portfolioId: value.portfolioId,
+        quoteId: value.quoteId,
+        quoteLimit: value.quoteLimit,
+        sellPositionId: value.sellPositionId,
+        size: value.size,
+        sizeUnit: value.sizeUnit,
+        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 OrderCreateToJSON(value) {
+    return OrderCreateToJSONRecursive(value, false);
+}

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

@@ -0,0 +1,82 @@
+/**
+ * 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";
+/**
+ *
+ * @export
+ * @interface OrderExecution
+ */
+export interface OrderExecution {
+    /**
+     *
+     * @type {Amount}
+     * @memberof OrderExecution
+     */
+    amount?: Amount;
+    /**
+     *
+     * @type {number}
+     * @memberof OrderExecution
+     */
+    crossRate?: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof OrderExecution
+     */
+    executedDateTime?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderExecution
+     */
+    executionStatusText?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderExecution
+     */
+    id?: string;
+    /**
+     *
+     * @type {Amount}
+     * @memberof OrderExecution
+     */
+    quote?: Amount;
+    /**
+     *
+     * @type {Amount}
+     * @memberof OrderExecution
+     */
+    size: Amount;
+    /**
+     *
+     * @type {Amount}
+     * @memberof OrderExecution
+     */
+    tax?: Amount;
+    /**
+     *
+     * @type {Amount}
+     * @memberof OrderExecution
+     */
+    totalAmount?: Amount;
+    /**
+     *
+     * @type {Amount}
+     * @memberof OrderExecution
+     */
+    transactionTax?: Amount;
+}
+export declare function OrderExecutionFromJSON(json: any): OrderExecution;
+export declare function OrderExecutionFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderExecution;
+export declare function OrderExecutionToJSONRecursive(value?: OrderExecution | null, ignoreParent?: boolean): any;
+export declare function OrderExecutionToJSON(value?: OrderExecution | null): any;

package/dist/swagger/models/OrderExecution.js

@@ -0,0 +1,69 @@
+/* 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";
+export function OrderExecutionFromJSON(json) {
+    return OrderExecutionFromJSONTyped(json, false);
+}
+export function OrderExecutionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        amount: !exists(json, "amount")
+            ? undefined
+            : AmountFromJSON(json["amount"]),
+        crossRate: !exists(json, "crossRate") ? undefined : json["crossRate"],
+        executedDateTime: !exists(json, "executedDateTime")
+            ? undefined
+            : new Date(json["executedDateTime"]),
+        executionStatusText: !exists(json, "executionStatusText")
+            ? undefined
+            : json["executionStatusText"],
+        id: !exists(json, "id") ? undefined : json["id"],
+        quote: !exists(json, "quote") ? undefined : AmountFromJSON(json["quote"]),
+        size: AmountFromJSON(json["size"]),
+        tax: !exists(json, "tax") ? undefined : AmountFromJSON(json["tax"]),
+        totalAmount: !exists(json, "totalAmount")
+            ? undefined
+            : AmountFromJSON(json["totalAmount"]),
+        transactionTax: !exists(json, "transactionTax")
+            ? undefined
+            : AmountFromJSON(json["transactionTax"]),
+    };
+}
+export function OrderExecutionToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        amount: AmountToJSON(value.amount),
+        crossRate: value.crossRate,
+        executedDateTime: value.executedDateTime === undefined
+            ? undefined
+            : value.executedDateTime.toISOString(),
+        executionStatusText: value.executionStatusText,
+        id: value.id,
+        quote: AmountToJSON(value.quote),
+        size: AmountToJSON(value.size),
+        tax: AmountToJSON(value.tax),
+        totalAmount: AmountToJSON(value.totalAmount),
+        transactionTax: AmountToJSON(value.transactionTax),
+    };
+}
+export function OrderExecutionToJSON(value) {
+    return OrderExecutionToJSONRecursive(value, false);
+}

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

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+/**
+ * Some brokers and exchanges allow adding an order extension that influence how the order is executed.
+ *
+ * - `FOK`: Fill or kill
+ * - `ICO`: Immediate or cancel
+ * - `AON`: All or None
+ * - `PEA`: Partial executions allowed
+ * @export
+ */
+export declare const OrderExtension: {
+    readonly Fok: "FOK";
+    readonly Ioc: "IOC";
+    readonly Aon: "AON";
+    readonly Pea: "PEA";
+};
+export type OrderExtension = (typeof OrderExtension)[keyof typeof OrderExtension];
+export declare function OrderExtensionFromJSON(json: any): OrderExtension;
+export declare function OrderExtensionFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderExtension;
+export declare function OrderExtensionToJSON(value?: OrderExtension | null): any;

package/dist/swagger/models/OrderExtension.js

@@ -0,0 +1,36 @@
+/* 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.
+ */
+/**
+ * Some brokers and exchanges allow adding an order extension that influence how the order is executed.
+ *
+ * - `FOK`: Fill or kill
+ * - `ICO`: Immediate or cancel
+ * - `AON`: All or None
+ * - `PEA`: Partial executions allowed
+ * @export
+ */
+export const OrderExtension = {
+    Fok: "FOK",
+    Ioc: "IOC",
+    Aon: "AON",
+    Pea: "PEA",
+};
+export function OrderExtensionFromJSON(json) {
+    return OrderExtensionFromJSONTyped(json, false);
+}
+export function OrderExtensionFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function OrderExtensionToJSON(value) {
+    return value;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+/**
+ * OrderIntent `open` means that the order is supposed to open a new position. `close` means that the order is supposed to close an existing position.
+ * Note that this is independent of the order's direction (e.g. a short position is closed by a buy order).
+ * @export
+ */
+export declare const OrderIntent: {
+    readonly Open: "open";
+    readonly Close: "close";
+};
+export type OrderIntent = (typeof OrderIntent)[keyof typeof OrderIntent];
+export declare function OrderIntentFromJSON(json: any): OrderIntent;
+export declare function OrderIntentFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderIntent;
+export declare function OrderIntentToJSON(value?: OrderIntent | null): any;

package/dist/swagger/models/OrderIntent.js

@@ -0,0 +1,30 @@
+/* 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.
+ */
+/**
+ * OrderIntent `open` means that the order is supposed to open a new position. `close` means that the order is supposed to close an existing position.
+ * Note that this is independent of the order's direction (e.g. a short position is closed by a buy order).
+ * @export
+ */
+export const OrderIntent = {
+    Open: "open",
+    Close: "close",
+};
+export function OrderIntentFromJSON(json) {
+    return OrderIntentFromJSONTyped(json, false);
+}
+export function OrderIntentFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function OrderIntentToJSON(value) {
+    return value;
+}

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

@@ -0,0 +1,34 @@
+/**
+ * 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 { OrderIntent } from "./OrderIntent";
+/**
+ *
+ * @export
+ * @interface OrderIntentAvailability
+ */
+export interface OrderIntentAvailability {
+    /**
+     *
+     * @type {Array<OrderIntent>}
+     * @memberof OrderIntentAvailability
+     */
+    buy: Array<OrderIntent>;
+    /**
+     *
+     * @type {Array<OrderIntent>}
+     * @memberof OrderIntentAvailability
+     */
+    sell: Array<OrderIntent>;
+}
+export declare function OrderIntentAvailabilityFromJSON(json: any): OrderIntentAvailability;
+export declare function OrderIntentAvailabilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderIntentAvailability;
+export declare function OrderIntentAvailabilityToJSONRecursive(value?: OrderIntentAvailability | null, ignoreParent?: boolean): any;
+export declare function OrderIntentAvailabilityToJSON(value?: OrderIntentAvailability | null): any;

package/dist/swagger/models/OrderIntentAvailability.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 { OrderIntentFromJSON, OrderIntentToJSON, } from "./OrderIntent";
+export function OrderIntentAvailabilityFromJSON(json) {
+    return OrderIntentAvailabilityFromJSONTyped(json, false);
+}
+export function OrderIntentAvailabilityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        buy: json["buy"].map(OrderIntentFromJSON),
+        sell: json["sell"].map(OrderIntentFromJSON),
+    };
+}
+export function OrderIntentAvailabilityToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        buy: value.buy.map(OrderIntentToJSON),
+        sell: value.sell.map(OrderIntentToJSON),
+    };
+}
+export function OrderIntentAvailabilityToJSON(value) {
+    return OrderIntentAvailabilityToJSONRecursive(value, false);
+}