@brokerize/client 1.0.1

package/dist/swagger/models/PrepareTradeResponse.js

@@ -0,0 +1,38 @@
+/* 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 { PreparedTradeFromJSON, PreparedTradeToJSON, } from "./PreparedTrade";
+export function PrepareTradeResponseFromJSON(json) {
+    return PrepareTradeResponseFromJSONTyped(json, false);
+}
+export function PrepareTradeResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        preparedTrade: PreparedTradeFromJSON(json["preparedTrade"]),
+    };
+}
+export function PrepareTradeResponseToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        preparedTrade: PreparedTradeToJSON(value.preparedTrade),
+    };
+}
+export function PrepareTradeResponseToJSON(value) {
+    return PrepareTradeResponseToJSONRecursive(value, false);
+}

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

@@ -0,0 +1,154 @@
+/**
+ * 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 { Exchange } from "./Exchange";
+import { OrderIntentAvailability } from "./OrderIntentAvailability";
+import { RiskClassInfo } from "./RiskClassInfo";
+import { Security } from "./Security";
+import { SecurityDetailedInfo } from "./SecurityDetailedInfo";
+import { SellPosition } from "./SellPosition";
+import { SizeUnitConstraint } from "./SizeUnitConstraint";
+/**
+ *
+ * @export
+ * @interface PreparedTrade
+ */
+export interface PreparedTrade {
+    /**
+     *
+     * @type {OrderIntentAvailability}
+     * @memberof PreparedTrade
+     */
+    availableOrderIntents?: OrderIntentAvailability;
+    /**
+     * If available, the available order intents can be polled/subscribed using this token. In this case,
+     * the `availableOrderIntents` field must be regarded as the initial snapshot.
+     * @type {string}
+     * @memberof PreparedTrade
+     */
+    availableOrderIntentsToken?: string;
+    /**
+     * The broker security id is the unique identifier for the security *at the given broker*. It is
+     * used in subsequent requests in the order creation process to identify the security.
+     * @type {string}
+     * @memberof PreparedTrade
+     */
+    brokerSecurityId: string;
+    /**
+     * True if no cost estimation is available at all for this instrument.
+     * @type {boolean}
+     * @memberof PreparedTrade
+     */
+    costEstimationIsNotAvailable: boolean;
+    /**
+     * If this is true, cost estimations only have the detailed table property, so it is not feasible
+     * to embed them into the order form, but show the table in a dedicated view.
+     * @type {boolean}
+     * @memberof PreparedTrade
+     */
+    costEstimationIsOnlyDetailedTable?: boolean;
+    /**
+     * If this is true, the estimated order costs must be shown before the user can create the order.
+     * If this is false, showing the order costs is optional.
+     * @type {boolean}
+     * @memberof PreparedTrade
+     */
+    costEstimationMustBeShown: boolean;
+    /**
+     *
+     * @type {Array<Exchange>}
+     * @memberof PreparedTrade
+     */
+    exchanges: Array<Exchange>;
+    /**
+     * If this is true, frontends are not allowed to set an exchange default. Users must select an exchange explicitly.
+     * @type {boolean}
+     * @memberof PreparedTrade
+     */
+    noExchangeDefault?: boolean;
+    /**
+     *
+     * @type {RiskClassInfo}
+     * @memberof PreparedTrade
+     */
+    riskClassInfo?: RiskClassInfo;
+    /**
+     *
+     * @type {Security}
+     * @memberof PreparedTrade
+     */
+    security: Security;
+    /**
+     *
+     * @type {SecurityDetailedInfo}
+     * @memberof PreparedTrade
+     */
+    securityDetailedInfo?: SecurityDetailedInfo;
+    /**
+     * If this is set, the user has to select a position to sell from. This may be the case if a position is
+     * stored in different locations or sub-positions are blocked until some date.
+     * If the user does not need to specify the position, this is left undefined.
+     * If it is set, user interfaces should offer a dropdown for selecting the position.
+     * @type {Array<SellPosition>}
+     * @memberof PreparedTrade
+     */
+    sellPositions?: Array<SellPosition>;
+    /**
+     * The maximum number of decimal places specified for each sizeUnit.
+     * If it is defined for the selected sizeUnit, frontends should limit the number input to this number of decimal places.
+     * If it is not defined, the number of decimal places is unknown and frontends should allow any number.
+     * @type {{ [key: string]: number; }}
+     * @memberof PreparedTrade
+     */
+    sizeMaxDecimalsBySizeUnit?: {
+        [key: string]: number;
+    };
+    /**
+     * - ISO code (e.g. EUR for Euro), if it is a monetary amount
+     * - or 'USDT' if its Tether (https://en.wikipedia.org/wiki/Tether_(cryptocurrency)
+     * - or 'XXX' if it is pieces
+     * - or 'PRC' if it is a percentage
+     * - or 'PRM' if it is permil
+     * - or 'XXP' if it is points (as for indices)
+     * - or 'GRAMS' if it is grams (as for precious metals)
+     * @type {string}
+     * @memberof PreparedTrade
+     */
+    sizeUnit: string;
+    /**
+     * If present, this defines which sizeUnits are available for a combination of cashAccountId, orderModel and direction.
+     * An entry in this list is considered a match if all specified attributes match.
+     *
+     * For example, if an entry specifies orderModels and directions and both orderModel and direction are included
+     * in the respective attributes in the constraint, the entry specifies the available sizeUnits.
+     * @type {Array<SizeUnitConstraint>}
+     * @memberof PreparedTrade
+     */
+    sizeUnitConstraints?: Array<SizeUnitConstraint>;
+    /**
+     *
+     * @type {{ [key: string]: Array<string>; }}
+     * @memberof PreparedTrade
+     */
+    sizeUnitsByCashAccountId?: {
+        [key: string]: Array<string>;
+    };
+    /**
+     * If present, this hint must be displayed in the order form. It should be visible during the order
+     * creation process, but does not need to be accepted by the user explicitly.
+     * @type {string}
+     * @memberof PreparedTrade
+     */
+    strikingHint?: string;
+}
+export declare function PreparedTradeFromJSON(json: any): PreparedTrade;
+export declare function PreparedTradeFromJSONTyped(json: any, ignoreDiscriminator: boolean): PreparedTrade;
+export declare function PreparedTradeToJSONRecursive(value?: PreparedTrade | null, ignoreParent?: boolean): any;
+export declare function PreparedTradeToJSON(value?: PreparedTrade | null): any;

package/dist/swagger/models/PreparedTrade.js

@@ -0,0 +1,103 @@
+/* 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 { ExchangeFromJSON, ExchangeToJSON, } from "./Exchange";
+import { OrderIntentAvailabilityFromJSON, OrderIntentAvailabilityToJSON, } from "./OrderIntentAvailability";
+import { RiskClassInfoFromJSON, RiskClassInfoToJSON, } from "./RiskClassInfo";
+import { SecurityFromJSON, SecurityToJSON, } from "./Security";
+import { SecurityDetailedInfoFromJSON, SecurityDetailedInfoToJSON, } from "./SecurityDetailedInfo";
+import { SellPositionFromJSON, SellPositionToJSON, } from "./SellPosition";
+import { SizeUnitConstraintFromJSON, SizeUnitConstraintToJSON, } from "./SizeUnitConstraint";
+export function PreparedTradeFromJSON(json) {
+    return PreparedTradeFromJSONTyped(json, false);
+}
+export function PreparedTradeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        availableOrderIntents: !exists(json, "availableOrderIntents")
+            ? undefined
+            : OrderIntentAvailabilityFromJSON(json["availableOrderIntents"]),
+        availableOrderIntentsToken: !exists(json, "availableOrderIntentsToken")
+            ? undefined
+            : json["availableOrderIntentsToken"],
+        brokerSecurityId: json["brokerSecurityId"],
+        costEstimationIsNotAvailable: json["costEstimationIsNotAvailable"],
+        costEstimationIsOnlyDetailedTable: !exists(json, "costEstimationIsOnlyDetailedTable")
+            ? undefined
+            : json["costEstimationIsOnlyDetailedTable"],
+        costEstimationMustBeShown: json["costEstimationMustBeShown"],
+        exchanges: json["exchanges"].map(ExchangeFromJSON),
+        noExchangeDefault: !exists(json, "noExchangeDefault")
+            ? undefined
+            : json["noExchangeDefault"],
+        riskClassInfo: !exists(json, "riskClassInfo")
+            ? undefined
+            : RiskClassInfoFromJSON(json["riskClassInfo"]),
+        security: SecurityFromJSON(json["security"]),
+        securityDetailedInfo: !exists(json, "securityDetailedInfo")
+            ? undefined
+            : SecurityDetailedInfoFromJSON(json["securityDetailedInfo"]),
+        sellPositions: !exists(json, "sellPositions")
+            ? undefined
+            : json["sellPositions"].map(SellPositionFromJSON),
+        sizeMaxDecimalsBySizeUnit: !exists(json, "sizeMaxDecimalsBySizeUnit")
+            ? undefined
+            : json["sizeMaxDecimalsBySizeUnit"],
+        sizeUnit: json["sizeUnit"],
+        sizeUnitConstraints: !exists(json, "sizeUnitConstraints")
+            ? undefined
+            : json["sizeUnitConstraints"].map(SizeUnitConstraintFromJSON),
+        sizeUnitsByCashAccountId: !exists(json, "sizeUnitsByCashAccountId")
+            ? undefined
+            : json["sizeUnitsByCashAccountId"],
+        strikingHint: !exists(json, "strikingHint")
+            ? undefined
+            : json["strikingHint"],
+    };
+}
+export function PreparedTradeToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        availableOrderIntents: OrderIntentAvailabilityToJSON(value.availableOrderIntents),
+        availableOrderIntentsToken: value.availableOrderIntentsToken,
+        brokerSecurityId: value.brokerSecurityId,
+        costEstimationIsNotAvailable: value.costEstimationIsNotAvailable,
+        costEstimationIsOnlyDetailedTable: value.costEstimationIsOnlyDetailedTable,
+        costEstimationMustBeShown: value.costEstimationMustBeShown,
+        exchanges: value.exchanges.map(ExchangeToJSON),
+        noExchangeDefault: value.noExchangeDefault,
+        riskClassInfo: RiskClassInfoToJSON(value.riskClassInfo),
+        security: SecurityToJSON(value.security),
+        securityDetailedInfo: SecurityDetailedInfoToJSON(value.securityDetailedInfo),
+        sellPositions: value.sellPositions === undefined
+            ? undefined
+            : value.sellPositions.map(SellPositionToJSON),
+        sizeMaxDecimalsBySizeUnit: value.sizeMaxDecimalsBySizeUnit,
+        sizeUnit: value.sizeUnit,
+        sizeUnitConstraints: value.sizeUnitConstraints === undefined
+            ? undefined
+            : value.sizeUnitConstraints.map(SizeUnitConstraintToJSON),
+        sizeUnitsByCashAccountId: value.sizeUnitsByCashAccountId,
+        strikingHint: value.strikingHint,
+    };
+}
+export function PreparedTradeToJSON(value) {
+    return PreparedTradeToJSONRecursive(value, false);
+}

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

@@ -0,0 +1,41 @@
+/**
+ * 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 QuoteExpiration
+ */
+export interface QuoteExpiration {
+    /**
+     * Timestamp at which the quotation expiration timer ends (after this, the quote order is likely to be rejected).
+     * @type {Date}
+     * @memberof QuoteExpiration
+     */
+    expires: Date;
+    /**
+     * Milliseconds to expiration. This can be calculated from `expires - started`, assuming the local clock works correctly.
+     * Sometimes end users have not set their local clock correctly. You can either correct for the clock drift using the
+     * `Date` HTTP header or just use this value and assume the expiration to happen at `time of receiving the response + milliseconds`.
+     * @type {number}
+     * @memberof QuoteExpiration
+     */
+    milliseconds: number;
+    /**
+     * Timestamp at which the quote expiration timer starts.
+     * @type {Date}
+     * @memberof QuoteExpiration
+     */
+    started: Date;
+}
+export declare function QuoteExpirationFromJSON(json: any): QuoteExpiration;
+export declare function QuoteExpirationFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuoteExpiration;
+export declare function QuoteExpirationToJSONRecursive(value?: QuoteExpiration | null, ignoreParent?: boolean): any;
+export declare function QuoteExpirationToJSON(value?: QuoteExpiration | null): any;

package/dist/swagger/models/QuoteExpiration.js

@@ -0,0 +1,41 @@
+/* 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 QuoteExpirationFromJSON(json) {
+    return QuoteExpirationFromJSONTyped(json, false);
+}
+export function QuoteExpirationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        expires: new Date(json["expires"]),
+        milliseconds: json["milliseconds"],
+        started: new Date(json["started"]),
+    };
+}
+export function QuoteExpirationToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        expires: value.expires.toISOString(),
+        milliseconds: value.milliseconds,
+        started: value.started.toISOString(),
+    };
+}
+export function QuoteExpirationToJSON(value) {
+    return QuoteExpirationToJSONRecursive(value, false);
+}

package/dist/swagger/models/RenamePortfolioRequest.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 RenamePortfolioRequest
+ */
+export interface RenamePortfolioRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof RenamePortfolioRequest
+     */
+    newPortfolioName: string;
+}
+export declare function RenamePortfolioRequestFromJSON(json: any): RenamePortfolioRequest;
+export declare function RenamePortfolioRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RenamePortfolioRequest;
+export declare function RenamePortfolioRequestToJSONRecursive(value?: RenamePortfolioRequest | null, ignoreParent?: boolean): any;
+export declare function RenamePortfolioRequestToJSON(value?: RenamePortfolioRequest | null): any;

package/dist/swagger/models/RenamePortfolioRequest.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 RenamePortfolioRequestFromJSON(json) {
+    return RenamePortfolioRequestFromJSONTyped(json, false);
+}
+export function RenamePortfolioRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        newPortfolioName: json["newPortfolioName"],
+    };
+}
+export function RenamePortfolioRequestToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        newPortfolioName: value.newPortfolioName,
+    };
+}
+export function RenamePortfolioRequestToJSON(value) {
+    return RenamePortfolioRequestToJSONRecursive(value, false);
+}

package/dist/swagger/models/RenderGenericTableParams.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.
+ */
+import { GenericTable } from "./GenericTable";
+/**
+ *
+ * @export
+ * @interface RenderGenericTableParams
+ */
+export interface RenderGenericTableParams {
+    /**
+     *
+     * @type {GenericTable}
+     * @memberof RenderGenericTableParams
+     */
+    table: GenericTable;
+}
+export declare function RenderGenericTableParamsFromJSON(json: any): RenderGenericTableParams;
+export declare function RenderGenericTableParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): RenderGenericTableParams;
+export declare function RenderGenericTableParamsToJSONRecursive(value?: RenderGenericTableParams | null, ignoreParent?: boolean): any;
+export declare function RenderGenericTableParamsToJSON(value?: RenderGenericTableParams | null): any;

package/dist/swagger/models/RenderGenericTableParams.js

@@ -0,0 +1,38 @@
+/* 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 { GenericTableFromJSON, GenericTableToJSON, } from "./GenericTable";
+export function RenderGenericTableParamsFromJSON(json) {
+    return RenderGenericTableParamsFromJSONTyped(json, false);
+}
+export function RenderGenericTableParamsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        table: GenericTableFromJSON(json["table"]),
+    };
+}
+export function RenderGenericTableParamsToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        table: GenericTableToJSON(value.table),
+    };
+}
+export function RenderGenericTableParamsToJSON(value) {
+    return RenderGenericTableParamsToJSONRecursive(value, false);
+}

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

@@ -0,0 +1,40 @@
+/**
+ * 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 RiskClassInfo
+ */
+export interface RiskClassInfo {
+    /**
+     * If set, must be displayed as a static hint (which the user does not need to confirm) before the order button. May contain (some) HTML.
+     * @type {string}
+     * @memberof RiskClassInfo
+     */
+    legalHint?: string;
+    /**
+     * Risk class message to display (may contain a subset of HTML: `<a>` tags for linking to external pages, `<p>`/`<br>` to add paragraphs/line breaks, `<ul><li></li></ul>` to show unuordered lists).
+     * Users must accept the message before they can create the order. This can happen before the actual order form is visible.
+     * @type {string}
+     * @memberof RiskClassInfo
+     */
+    msg?: string;
+    /**
+     * If true, only sell is allowed for this instrument.
+     * @type {boolean}
+     * @memberof RiskClassInfo
+     */
+    onlySellAllowed?: boolean;
+}
+export declare function RiskClassInfoFromJSON(json: any): RiskClassInfo;
+export declare function RiskClassInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): RiskClassInfo;
+export declare function RiskClassInfoToJSONRecursive(value?: RiskClassInfo | null, ignoreParent?: boolean): any;
+export declare function RiskClassInfoToJSON(value?: RiskClassInfo | null): any;

package/dist/swagger/models/RiskClassInfo.js

@@ -0,0 +1,44 @@
+/* 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 RiskClassInfoFromJSON(json) {
+    return RiskClassInfoFromJSONTyped(json, false);
+}
+export function RiskClassInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+        return json;
+    }
+    return {
+        legalHint: !exists(json, "legalHint") ? undefined : json["legalHint"],
+        msg: !exists(json, "msg") ? undefined : json["msg"],
+        onlySellAllowed: !exists(json, "onlySellAllowed")
+            ? undefined
+            : json["onlySellAllowed"],
+    };
+}
+export function RiskClassInfoToJSONRecursive(value, ignoreParent = false) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        legalHint: value.legalHint,
+        msg: value.msg,
+        onlySellAllowed: value.onlySellAllowed,
+    };
+}
+export function RiskClassInfoToJSON(value) {
+    return RiskClassInfoToJSONRecursive(value, false);
+}