@brokerize/client 1.0.1

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

@@ -0,0 +1,51 @@
+/**
+ * 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 ObtainToken200Response
+ */
+export interface ObtainToken200Response {
+    /**
+     *
+     * @type {string}
+     * @memberof ObtainToken200Response
+     */
+    accessToken: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ObtainToken200Response
+     */
+    expiresIn: number;
+    /**
+     *
+     * @type {any}
+     * @memberof ObtainToken200Response
+     */
+    refreshToken: any | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ObtainToken200Response
+     */
+    refreshTokenExpiresIn: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ObtainToken200Response
+     */
+    tokenType: string;
+}
+export declare function ObtainToken200ResponseFromJSON(json: any): ObtainToken200Response;
+export declare function ObtainToken200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ObtainToken200Response;
+export declare function ObtainToken200ResponseToJSONRecursive(value?: ObtainToken200Response | null, ignoreParent?: boolean): any;
+export declare function ObtainToken200ResponseToJSON(value?: ObtainToken200Response | null): any;

package/dist/swagger/models/ObtainToken200Response.js

@@ -0,0 +1,45 @@
+/* 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.
+ */
+export function ObtainToken200ResponseFromJSON(json) {
+    return ObtainToken200ResponseFromJSONTyped(json, false);
+}
+export function ObtainToken200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        accessToken: json["access_token"],
+        expiresIn: json["expires_in"],
+        refreshToken: json["refresh_token"],
+        refreshTokenExpiresIn: json["refresh_token_expires_in"],
+        tokenType: json["token_type"],
+    };
+}
+export function ObtainToken200ResponseToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        access_token: value.accessToken,
+        expires_in: value.expiresIn,
+        refresh_token: value.refreshToken,
+        refresh_token_expires_in: value.refreshTokenExpiresIn,
+        token_type: value.tokenType,
+    };
+}
+export function ObtainToken200ResponseToJSON(value) {
+    return ObtainToken200ResponseToJSONRecursive(value, false);
+}

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

@@ -0,0 +1,27 @@
+/**
+ * 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 OkResponseBody
+ */
+export interface OkResponseBody {
+    /**
+     *
+     * @type {string}
+     * @memberof OkResponseBody
+     */
+    msg: string;
+}
+export declare function OkResponseBodyFromJSON(json: any): OkResponseBody;
+export declare function OkResponseBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): OkResponseBody;
+export declare function OkResponseBodyToJSONRecursive(value?: OkResponseBody | null, ignoreParent?: boolean): any;
+export declare function OkResponseBodyToJSON(value?: OkResponseBody | null): any;

package/dist/swagger/models/OkResponseBody.js

@@ -0,0 +1,37 @@
+/* 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.
+ */
+export function OkResponseBodyFromJSON(json) {
+    return OkResponseBodyFromJSONTyped(json, false);
+}
+export function OkResponseBodyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        msg: json["msg"],
+    };
+}
+export function OkResponseBodyToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        msg: value.msg,
+    };
+}
+export function OkResponseBodyToJSON(value) {
+    return OkResponseBodyToJSONRecursive(value, false);
+}

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

@@ -0,0 +1,415 @@
+/**
+ * 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 { CashQuotation } from "./CashQuotation";
+import { Direction } from "./Direction";
+import { OrderExecution } from "./OrderExecution";
+import { OrderExtension } from "./OrderExtension";
+import { OrderModel } from "./OrderModel";
+import { OrderStatus } from "./OrderStatus";
+import { OrderValidity } from "./OrderValidity";
+import { OrderValidityType } from "./OrderValidityType";
+import { Security } from "./Security";
+import { TrailingDistance } from "./TrailingDistance";
+/**
+ *
+ * @export
+ * @interface Order
+ */
+export interface Order {
+    /**
+     * If `true`, the order can be canceled
+     * @type {boolean}
+     * @memberof Order
+     */
+    allowsCancel: boolean;
+    /**
+     * If true, the limit of the order can be changed.
+     * @type {boolean}
+     * @memberof Order
+     */
+    allowsChangeLimit?: boolean;
+    /**
+     * If set, the orderModel may be changed to one of the given orderModels.
+     * @type {Array<OrderModel>}
+     * @memberof Order
+     */
+    allowsChangeOrderModels?: Array<OrderModel>;
+    /**
+     * If `true`, the order size can be changed
+     * @type {boolean}
+     * @memberof Order
+     */
+    allowsChangeSize: boolean;
+    /**
+     * If true, the stop of the order can be changed.
+     * @type {boolean}
+     * @memberof Order
+     */
+    allowsChangeStop?: boolean;
+    /**
+     * If true, the stop limit of the order can be changed.
+     * @type {boolean}
+     * @memberof Order
+     */
+    allowsChangeStopLimit?: boolean;
+    /**
+     * `true` if the `stopLoss` of the order can be changed.
+     * @type {boolean}
+     * @memberof Order
+     */
+    allowsChangeStopLoss?: boolean;
+    /**
+     * `true` if the `takeProfit` of the order can be changed.
+     * @type {boolean}
+     * @memberof Order
+     */
+    allowsChangeTakeProfit?: boolean;
+    /**
+     * If true, the trailing distance of the order can be changed.
+     * @type {boolean}
+     * @memberof Order
+     */
+    allowsChangeTrailingDistance?: boolean;
+    /**
+     * If set, the validity of the order can be changed to the given types.
+     * @type {Array<OrderValidityType>}
+     * @memberof Order
+     */
+    allowsChangeValidityTypes?: Array<OrderValidityType>;
+    /**
+     * If the security is a bond, the currency ISO code to show for the size input field.
+     * @type {string}
+     * @memberof Order
+     */
+    bondCurrencyIso?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Order
+     */
+    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 Order
+     */
+    brokerSecurityId?: string;
+    /**
+     * For canceled orders: when the order has been canceled.
+     * @type {Date}
+     * @memberof Order
+     */
+    cancellationDateTime?: Date;
+    /**
+     * Already cancelled size of the order.
+     * @type {number}
+     * @memberof Order
+     */
+    cancelledSize?: number;
+    /**
+     *
+     * @type {CashQuotation}
+     * @memberof Order
+     */
+    cashQuotation?: CashQuotation;
+    /**
+     * If set and `true`, the endpoint `getChangeOrderCostEstimation` can be used to retrieve cost estimations
+     * for order changes.
+     * @type {boolean}
+     * @memberof Order
+     */
+    changesHaveCostEstimations?: boolean;
+    /**
+     * Timestamp of the order creation.
+     * @type {Date}
+     * @memberof Order
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Amount}
+     * @memberof Order
+     */
+    currentStop?: Amount;
+    /**
+     *
+     * @type {Direction}
+     * @memberof Order
+     */
+    direction: Direction;
+    /**
+     * The order number to use in the interface to display to the user.
+     * Some brokers do not assign order numbers, so if this is not present, the order should be displayed without a number.
+     * @type {string}
+     * @memberof Order
+     */
+    displayNo?: string;
+    /**
+     * The mapped exchange id, as retrievable from the `/exchanges` endpoint.
+     * @type {number}
+     * @memberof Order
+     */
+    exchangeId?: number;
+    /**
+     * Name of the exchange as provided by the broker.
+     * @type {string}
+     * @memberof Order
+     */
+    exchangeName?: string;
+    /**
+     * For fully executed orders: the timestamp of the *latest* execution.
+     * @type {Date}
+     * @memberof Order
+     */
+    executedAt?: Date;
+    /**
+     * Already executed size of the order
+     * @type {number}
+     * @memberof Order
+     */
+    executedSize?: number;
+    /**
+     * If there already have been executions of this order, a list of those.
+     * @type {Array<OrderExecution>}
+     * @memberof Order
+     */
+    executions?: Array<OrderExecution>;
+    /**
+     * If this is true, it is not possible to show a receipt for this order (this is the case if order data is incomplete in order lists).
+     * @type {boolean}
+     * @memberof Order
+     */
+    hasNoOrderReceipt?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof Order
+     */
+    id: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Order
+     */
+    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 Order
+     */
+    intent?: OrderIntentEnum;
+    /**
+     * 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 Order
+     */
+    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 Order
+     */
+    limit?: number;
+    /**
+     * limit (and stop etc.) currency to use for this order
+     * @type {string}
+     * @memberof Order
+     */
+    limitCurrencyIso?: string;
+    /**
+     * If true, the current stop value of this order can be observed. In this case, the stop value can be subcribed via WebSocket (TODO - not implemented yet)
+     * @type {boolean}
+     * @memberof Order
+     */
+    mayObserveCurrentStop?: boolean;
+    /**
+     * Remaining/open size of the order
+     * @type {number}
+     * @memberof Order
+     */
+    openSize?: number;
+    /**
+     *
+     * @type {OrderExtension}
+     * @memberof Order
+     */
+    orderExtension?: OrderExtension;
+    /**
+     *
+     * @type {OrderModel}
+     * @memberof Order
+     */
+    orderModel: OrderModel;
+    /**
+     * If this is `true` (for open orders only), this order is currently awaiting the execution of a parent order.
+     * @type {boolean}
+     * @memberof Order
+     */
+    orderStatusIsAwaitingParentOrder?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof Order
+     */
+    portfolioId: string;
+    /**
+     *
+     * @type {Amount}
+     * @memberof Order
+     */
+    profitLossAbs?: Amount;
+    /**
+     *
+     * @type {number}
+     * @memberof Order
+     */
+    profitLossRel?: number;
+    /**
+     * If present, defines how many decimal places should be displayed for quote values.
+     * @type {number}
+     * @memberof Order
+     */
+    quoteDecimals?: number;
+    /**
+     * If supported by the broker, an optional limit can be added to a quote trade (`orderModel=quote`).
+     * @type {number}
+     * @memberof Order
+     */
+    quoteLimit?: number;
+    /**
+     *
+     * @type {Security}
+     * @memberof Order
+     */
+    security: Security;
+    /**
+     * Order is visible, but it cannot be interacted with (e.g. because it is the discarded part of a combination order).
+     * If this is present and `true`, it should be displayed to the user, but visibily disabled.
+     * @type {boolean}
+     * @memberof Order
+     */
+    showAsDisabled?: boolean;
+    /**
+     * 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 Order
+     */
+    size: number;
+    /**
+     * If present, defines how many decimal places should be displayed for size values.
+     * @type {number}
+     * @memberof Order
+     */
+    sizeDecimals?: number;
+    /**
+     * The currency in which the order sizes are provided
+     * @type {string}
+     * @memberof Order
+     */
+    sizeUnit?: string;
+    /**
+     * Contains original broker data (in the broker's data format).
+     * @type {string}
+     * @memberof Order
+     */
+    sourceData?: string;
+    /**
+     *
+     * @type {OrderStatus}
+     * @memberof Order
+     */
+    status: OrderStatus;
+    /**
+     * Order status as text (may be broker-specific, only used for displaying it to users).
+     * @type {string}
+     * @memberof Order
+     */
+    statusText?: 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 Order
+     */
+    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 Order
+     */
+    stopLimit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Order
+     */
+    stopLoss?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Order
+     */
+    takeProfit?: number;
+    /**
+     *
+     * @type {TrailingDistance}
+     * @memberof Order
+     */
+    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 Order
+     */
+    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 Order
+     * @deprecated
+     */
+    usTicker?: string;
+    /**
+     *
+     * @type {OrderValidity}
+     * @memberof Order
+     */
+    validity?: OrderValidity;
+}
+/**
+ * @export
+ */
+export declare const OrderIntentEnum: {
+    readonly Open: "open";
+    readonly Close: "close";
+};
+export type OrderIntentEnum = (typeof OrderIntentEnum)[keyof typeof OrderIntentEnum];
+export declare function OrderFromJSON(json: any): Order;
+export declare function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Order;
+export declare function OrderToJSONRecursive(value?: Order | null, ignoreParent?: boolean): any;
+export declare function OrderToJSON(value?: Order | null): any;