@brokerize/client 1.0.1

package/dist/swagger/apis/SecuritiesApi.js

@@ -0,0 +1,91 @@
+/* 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 * as runtime from "../runtime";
+import { SecurityQuotesMetaFromJSON, SecurityQuotesResponseFromJSON, } from "../models";
+/**
+ *
+ */
+export class SecuritiesApi extends runtime.BaseAPI {
+    /**
+     * Load the current quotes for the given `securityQuotesToken` (provided by `PreparedTrade`). Currently, polling this endpoint is the only way to get the current quotes. A polling interval of 2500 milliseconds is recommended and it counts towards the general rate limit.
+     */
+    async getSecurityQuotesRaw(requestParameters, initOverrides) {
+        if (requestParameters.securityQuotesToken === null ||
+            requestParameters.securityQuotesToken === undefined) {
+            throw new runtime.RequiredError("securityQuotesToken", "Required parameter requestParameters.securityQuotesToken was null or undefined when calling getSecurityQuotes.");
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-brkrz-client-id"] =
+                this.configuration.apiKey("x-brkrz-client-id"); // clientId authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("idToken", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/securities/quotes/{securityQuotesToken}`.replace(`{${"securityQuotesToken"}}`, encodeURIComponent(String(requestParameters.securityQuotesToken))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => SecurityQuotesResponseFromJSON(jsonValue));
+    }
+    /**
+     * Load the current quotes for the given `securityQuotesToken` (provided by `PreparedTrade`). Currently, polling this endpoint is the only way to get the current quotes. A polling interval of 2500 milliseconds is recommended and it counts towards the general rate limit.
+     */
+    async getSecurityQuotes(requestParameters, initOverrides) {
+        const response = await this.getSecurityQuotesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Load metadata about the given securityQuotesToken. This includes the currency, decimals and the quote source name.
+     */
+    async getSecurityQuotesMetaRaw(requestParameters, initOverrides) {
+        if (requestParameters.securityQuotesToken === null ||
+            requestParameters.securityQuotesToken === undefined) {
+            throw new runtime.RequiredError("securityQuotesToken", "Required parameter requestParameters.securityQuotesToken was null or undefined when calling getSecurityQuotesMeta.");
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-brkrz-client-id"] =
+                this.configuration.apiKey("x-brkrz-client-id"); // clientId authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("idToken", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/securities/quotes/{securityQuotesToken}/meta`.replace(`{${"securityQuotesToken"}}`, encodeURIComponent(String(requestParameters.securityQuotesToken))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => SecurityQuotesMetaFromJSON(jsonValue));
+    }
+    /**
+     * Load metadata about the given securityQuotesToken. This includes the currency, decimals and the quote source name.
+     */
+    async getSecurityQuotesMeta(requestParameters, initOverrides) {
+        const response = await this.getSecurityQuotesMetaRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}

package/dist/swagger/apis/TradeApi.d.ts

@@ -0,0 +1,98 @@
+/**
+ * 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 * as runtime from "../runtime";
+import { Challenge, CreateOrderChallengeParams, CreateOrderParams, CreateTradeResponse, GenericTable, GetCostEstimationParams, GetQuoteParams, GetQuoteResponse, OrderCostEstimation, OrderIntentAvailability, PrepareTradeResponse } from "../models";
+export interface CreateTradeRequest {
+    createOrderParams: CreateOrderParams;
+}
+export interface CreateTradeChallengeRequest {
+    createOrderChallengeParams: CreateOrderChallengeParams;
+}
+export interface GetAvailableOrderIntentsRequest {
+    token: string;
+}
+export interface GetCostEstimationRequest {
+    getCostEstimationParams: GetCostEstimationParams;
+}
+export interface GetQuoteRequest {
+    portfolioId: string;
+    getQuoteParams: GetQuoteParams;
+}
+export interface GetSecurityDetailedInfoRequest {
+    token: string;
+}
+export interface PrepareTradeRequest {
+    portfolioId: string;
+    isin: string;
+    usTicker?: string;
+    cryptoCode?: string;
+    cryptoPair?: string;
+    brokerSecurityId?: string;
+}
+/**
+ *
+ */
+export declare class TradeApi extends runtime.BaseAPI {
+    /**
+     * Create a trade.  It is possible that the broker rejects the order because of some extra hints that the user must accept (which can not be figured out in `prepareTrade`, e.g. because the order volume has to be determined first). In thise case, the `MUST_ACCEPT_HINT` error code is returned. The user can choose to accept that hint. If that is the case, the request can be retried with the `acceptHintId` parameter.
+     */
+    createTradeRaw(requestParameters: CreateTradeRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<CreateTradeResponse>>;
+    /**
+     * Create a trade.  It is possible that the broker rejects the order because of some extra hints that the user must accept (which can not be figured out in `prepareTrade`, e.g. because the order volume has to be determined first). In thise case, the `MUST_ACCEPT_HINT` error code is returned. The user can choose to accept that hint. If that is the case, the request can be retried with the `acceptHintId` parameter.
+     */
+    createTrade(requestParameters: CreateTradeRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<CreateTradeResponse>;
+    /**
+     * If the user chose an auth method from `GetAuthInfo` with the flow `CHALLENGE_RESPONSE`, before creating a trade, a challenge must be requested first. If any other flow is used, a challenge *must not* be requested.
+     */
+    createTradeChallengeRaw(requestParameters: CreateTradeChallengeRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<Challenge>>;
+    /**
+     * If the user chose an auth method from `GetAuthInfo` with the flow `CHALLENGE_RESPONSE`, before creating a trade, a challenge must be requested first. If any other flow is used, a challenge *must not* be requested.
+     */
+    createTradeChallenge(requestParameters: CreateTradeChallengeRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<Challenge>;
+    /**
+     * If `PreparedTrade` contains an `availableOrderIntentsToken`, this endpoint can be used to update the available order intents.  It is recommended to poll this (e.g. at a rate of one request per 5s). In a future version updates will be provided over WebSockets.
+     */
+    getAvailableOrderIntentsRaw(requestParameters: GetAvailableOrderIntentsRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<OrderIntentAvailability>>;
+    /**
+     * If `PreparedTrade` contains an `availableOrderIntentsToken`, this endpoint can be used to update the available order intents.  It is recommended to poll this (e.g. at a rate of one request per 5s). In a future version updates will be provided over WebSockets.
+     */
+    getAvailableOrderIntents(requestParameters: GetAvailableOrderIntentsRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<OrderIntentAvailability>;
+    /**
+     */
+    getCostEstimationRaw(requestParameters: GetCostEstimationRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<OrderCostEstimation>>;
+    /**
+     */
+    getCostEstimation(requestParameters: GetCostEstimationRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<OrderCostEstimation>;
+    /**
+     * Get a quote to use with `orderModel=quote`. The actual quote trade is then performed using `createTradeChallenge` / `createTrade` as for other orderModels.
+     */
+    getQuoteRaw(requestParameters: GetQuoteRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<GetQuoteResponse>>;
+    /**
+     * Get a quote to use with `orderModel=quote`. The actual quote trade is then performed using `createTradeChallenge` / `createTrade` as for other orderModels.
+     */
+    getQuote(requestParameters: GetQuoteRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<GetQuoteResponse>;
+    /**
+     * Loads more detailed information about a security specified by the given token. The token is extracted from the securityDetailedInfo object in the prepareTrade response
+     */
+    getSecurityDetailedInfoRaw(requestParameters: GetSecurityDetailedInfoRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<GenericTable>>;
+    /**
+     * Loads more detailed information about a security specified by the given token. The token is extracted from the securityDetailedInfo object in the prepareTrade response
+     */
+    getSecurityDetailedInfo(requestParameters: GetSecurityDetailedInfoRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<GenericTable>;
+    /**
+     * Prepare a trade of the security in the given portfolio `portfolioId`. You can provide `isin`, `usTicker`, `cryptoCode`, `cryptoPair` to select a security. The actual broker implementation then automatically uses the appropriate identifier.  If you already have a `brokerSecurityId` for the given broker, you can also pass that.  Note that for backwards-compatibility reasons `isin` is required. However, if the isin is not applicable, an empty string can be passed.  The response describes what kind of orders are supported by the broker for the security.  It requires the portfolio to have at least one active broker session.
+     */
+    prepareTradeRaw(requestParameters: PrepareTradeRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<PrepareTradeResponse>>;
+    /**
+     * Prepare a trade of the security in the given portfolio `portfolioId`. You can provide `isin`, `usTicker`, `cryptoCode`, `cryptoPair` to select a security. The actual broker implementation then automatically uses the appropriate identifier.  If you already have a `brokerSecurityId` for the given broker, you can also pass that.  Note that for backwards-compatibility reasons `isin` is required. However, if the isin is not applicable, an empty string can be passed.  The response describes what kind of orders are supported by the broker for the security.  It requires the portfolio to have at least one active broker session.
+     */
+    prepareTrade(requestParameters: PrepareTradeRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<PrepareTradeResponse>;
+}

package/dist/swagger/apis/TradeApi.js

@@ -0,0 +1,312 @@
+/* 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 * as runtime from "../runtime";
+import { ChallengeFromJSON, CreateOrderChallengeParamsToJSON, CreateOrderParamsToJSON, CreateTradeResponseFromJSON, GenericTableFromJSON, GetCostEstimationParamsToJSON, GetQuoteParamsToJSON, GetQuoteResponseFromJSON, OrderCostEstimationFromJSON, OrderIntentAvailabilityFromJSON, PrepareTradeResponseFromJSON, } from "../models";
+/**
+ *
+ */
+export class TradeApi extends runtime.BaseAPI {
+    /**
+     * Create a trade.  It is possible that the broker rejects the order because of some extra hints that the user must accept (which can not be figured out in `prepareTrade`, e.g. because the order volume has to be determined first). In thise case, the `MUST_ACCEPT_HINT` error code is returned. The user can choose to accept that hint. If that is the case, the request can be retried with the `acceptHintId` parameter.
+     */
+    async createTradeRaw(requestParameters, initOverrides) {
+        if (requestParameters.createOrderParams === null ||
+            requestParameters.createOrderParams === undefined) {
+            throw new runtime.RequiredError("createOrderParams", "Required parameter requestParameters.createOrderParams was null or undefined when calling createTrade.");
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters["Content-Type"] = "application/json";
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-brkrz-client-id"] =
+                this.configuration.apiKey("x-brkrz-client-id"); // clientId authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("idToken", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/trade/create`,
+            method: "POST",
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateOrderParamsToJSON(requestParameters.createOrderParams),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateTradeResponseFromJSON(jsonValue));
+    }
+    /**
+     * Create a trade.  It is possible that the broker rejects the order because of some extra hints that the user must accept (which can not be figured out in `prepareTrade`, e.g. because the order volume has to be determined first). In thise case, the `MUST_ACCEPT_HINT` error code is returned. The user can choose to accept that hint. If that is the case, the request can be retried with the `acceptHintId` parameter.
+     */
+    async createTrade(requestParameters, initOverrides) {
+        const response = await this.createTradeRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * If the user chose an auth method from `GetAuthInfo` with the flow `CHALLENGE_RESPONSE`, before creating a trade, a challenge must be requested first. If any other flow is used, a challenge *must not* be requested.
+     */
+    async createTradeChallengeRaw(requestParameters, initOverrides) {
+        if (requestParameters.createOrderChallengeParams === null ||
+            requestParameters.createOrderChallengeParams === undefined) {
+            throw new runtime.RequiredError("createOrderChallengeParams", "Required parameter requestParameters.createOrderChallengeParams was null or undefined when calling createTradeChallenge.");
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters["Content-Type"] = "application/json";
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-brkrz-client-id"] =
+                this.configuration.apiKey("x-brkrz-client-id"); // clientId authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("idToken", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/trade/challenge`,
+            method: "POST",
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateOrderChallengeParamsToJSON(requestParameters.createOrderChallengeParams),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ChallengeFromJSON(jsonValue));
+    }
+    /**
+     * If the user chose an auth method from `GetAuthInfo` with the flow `CHALLENGE_RESPONSE`, before creating a trade, a challenge must be requested first. If any other flow is used, a challenge *must not* be requested.
+     */
+    async createTradeChallenge(requestParameters, initOverrides) {
+        const response = await this.createTradeChallengeRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * If `PreparedTrade` contains an `availableOrderIntentsToken`, this endpoint can be used to update the available order intents.  It is recommended to poll this (e.g. at a rate of one request per 5s). In a future version updates will be provided over WebSockets.
+     */
+    async getAvailableOrderIntentsRaw(requestParameters, initOverrides) {
+        if (requestParameters.token === null ||
+            requestParameters.token === undefined) {
+            throw new runtime.RequiredError("token", "Required parameter requestParameters.token was null or undefined when calling getAvailableOrderIntents.");
+        }
+        const queryParameters = {};
+        if (requestParameters.token !== undefined) {
+            queryParameters["token"] = requestParameters.token;
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-brkrz-client-id"] =
+                this.configuration.apiKey("x-brkrz-client-id"); // clientId authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("idToken", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/trade/availableOrderIntents`,
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrderIntentAvailabilityFromJSON(jsonValue));
+    }
+    /**
+     * If `PreparedTrade` contains an `availableOrderIntentsToken`, this endpoint can be used to update the available order intents.  It is recommended to poll this (e.g. at a rate of one request per 5s). In a future version updates will be provided over WebSockets.
+     */
+    async getAvailableOrderIntents(requestParameters, initOverrides) {
+        const response = await this.getAvailableOrderIntentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     */
+    async getCostEstimationRaw(requestParameters, initOverrides) {
+        if (requestParameters.getCostEstimationParams === null ||
+            requestParameters.getCostEstimationParams === undefined) {
+            throw new runtime.RequiredError("getCostEstimationParams", "Required parameter requestParameters.getCostEstimationParams was null or undefined when calling getCostEstimation.");
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters["Content-Type"] = "application/json";
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-brkrz-client-id"] =
+                this.configuration.apiKey("x-brkrz-client-id"); // clientId authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("idToken", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/trade/costEstimation`,
+            method: "POST",
+            headers: headerParameters,
+            query: queryParameters,
+            body: GetCostEstimationParamsToJSON(requestParameters.getCostEstimationParams),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrderCostEstimationFromJSON(jsonValue));
+    }
+    /**
+     */
+    async getCostEstimation(requestParameters, initOverrides) {
+        const response = await this.getCostEstimationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Get a quote to use with `orderModel=quote`. The actual quote trade is then performed using `createTradeChallenge` / `createTrade` as for other orderModels.
+     */
+    async getQuoteRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling getQuote.");
+        }
+        if (requestParameters.getQuoteParams === null ||
+            requestParameters.getQuoteParams === undefined) {
+            throw new runtime.RequiredError("getQuoteParams", "Required parameter requestParameters.getQuoteParams was null or undefined when calling getQuote.");
+        }
+        const queryParameters = {};
+        if (requestParameters.portfolioId !== undefined) {
+            queryParameters["portfolioId"] = requestParameters.portfolioId;
+        }
+        const headerParameters = {};
+        headerParameters["Content-Type"] = "application/json";
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-brkrz-client-id"] =
+                this.configuration.apiKey("x-brkrz-client-id"); // clientId authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("idToken", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/trade/quote`,
+            method: "POST",
+            headers: headerParameters,
+            query: queryParameters,
+            body: GetQuoteParamsToJSON(requestParameters.getQuoteParams),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetQuoteResponseFromJSON(jsonValue));
+    }
+    /**
+     * Get a quote to use with `orderModel=quote`. The actual quote trade is then performed using `createTradeChallenge` / `createTrade` as for other orderModels.
+     */
+    async getQuote(requestParameters, initOverrides) {
+        const response = await this.getQuoteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Loads more detailed information about a security specified by the given token. The token is extracted from the securityDetailedInfo object in the prepareTrade response
+     */
+    async getSecurityDetailedInfoRaw(requestParameters, initOverrides) {
+        if (requestParameters.token === null ||
+            requestParameters.token === undefined) {
+            throw new runtime.RequiredError("token", "Required parameter requestParameters.token was null or undefined when calling getSecurityDetailedInfo.");
+        }
+        const queryParameters = {};
+        if (requestParameters.token !== undefined) {
+            queryParameters["token"] = requestParameters.token;
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-brkrz-client-id"] =
+                this.configuration.apiKey("x-brkrz-client-id"); // clientId authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("idToken", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/trade/securityDetails`,
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericTableFromJSON(jsonValue));
+    }
+    /**
+     * Loads more detailed information about a security specified by the given token. The token is extracted from the securityDetailedInfo object in the prepareTrade response
+     */
+    async getSecurityDetailedInfo(requestParameters, initOverrides) {
+        const response = await this.getSecurityDetailedInfoRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Prepare a trade of the security in the given portfolio `portfolioId`. You can provide `isin`, `usTicker`, `cryptoCode`, `cryptoPair` to select a security. The actual broker implementation then automatically uses the appropriate identifier.  If you already have a `brokerSecurityId` for the given broker, you can also pass that.  Note that for backwards-compatibility reasons `isin` is required. However, if the isin is not applicable, an empty string can be passed.  The response describes what kind of orders are supported by the broker for the security.  It requires the portfolio to have at least one active broker session.
+     */
+    async prepareTradeRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling prepareTrade.");
+        }
+        if (requestParameters.isin === null ||
+            requestParameters.isin === undefined) {
+            throw new runtime.RequiredError("isin", "Required parameter requestParameters.isin was null or undefined when calling prepareTrade.");
+        }
+        const queryParameters = {};
+        if (requestParameters.portfolioId !== undefined) {
+            queryParameters["portfolioId"] = requestParameters.portfolioId;
+        }
+        if (requestParameters.isin !== undefined) {
+            queryParameters["isin"] = requestParameters.isin;
+        }
+        if (requestParameters.usTicker !== undefined) {
+            queryParameters["usTicker"] = requestParameters.usTicker;
+        }
+        if (requestParameters.cryptoCode !== undefined) {
+            queryParameters["cryptoCode"] = requestParameters.cryptoCode;
+        }
+        if (requestParameters.cryptoPair !== undefined) {
+            queryParameters["cryptoPair"] = requestParameters.cryptoPair;
+        }
+        if (requestParameters.brokerSecurityId !== undefined) {
+            queryParameters["brokerSecurityId"] = requestParameters.brokerSecurityId;
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-brkrz-client-id"] =
+                this.configuration.apiKey("x-brkrz-client-id"); // clientId authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("idToken", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/trade/prepare`,
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => PrepareTradeResponseFromJSON(jsonValue));
+    }
+    /**
+     * Prepare a trade of the security in the given portfolio `portfolioId`. You can provide `isin`, `usTicker`, `cryptoCode`, `cryptoPair` to select a security. The actual broker implementation then automatically uses the appropriate identifier.  If you already have a `brokerSecurityId` for the given broker, you can also pass that.  Note that for backwards-compatibility reasons `isin` is required. However, if the isin is not applicable, an empty string can be passed.  The response describes what kind of orders are supported by the broker for the security.  It requires the portfolio to have at least one active broker session.
+     */
+    async prepareTrade(requestParameters, initOverrides) {
+        const response = await this.prepareTradeRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}

package/dist/swagger/apis/TradeDraftApi.d.ts

@@ -0,0 +1,74 @@
+/**
+ * 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 * as runtime from "../runtime";
+import { CreateTradeDrafts200Response, GetActiveTradeDraftsResponse, TradeDraftCreateParams, TradeDraftUpdateParams } from "../models";
+export interface CreateTradeDraftsRequest {
+    tradeDraftCreateParams: TradeDraftCreateParams;
+}
+export interface DeactivateTradeDraftRequest {
+    id: string;
+}
+export interface DeleteTradeDraftRequest {
+    id: string;
+}
+export interface GetTradeDraftsRequest {
+    take?: number;
+    skip?: number;
+}
+export interface UpdateTradeDraftRequest {
+    id: string;
+    tradeDraftUpdateParams: TradeDraftUpdateParams;
+}
+/**
+ *
+ */
+export declare class TradeDraftApi extends runtime.BaseAPI {
+    /**
+     * Create a new trade draft
+     */
+    createTradeDraftsRaw(requestParameters: CreateTradeDraftsRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<CreateTradeDrafts200Response>>;
+    /**
+     * Create a new trade draft
+     */
+    createTradeDrafts(requestParameters: CreateTradeDraftsRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<CreateTradeDrafts200Response>;
+    /**
+     * Set a trade draft inactive, but NOT deleted. Inactive trade drafts will not be shown to the user anymore.
+     */
+    deactivateTradeDraftRaw(requestParameters: DeactivateTradeDraftRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Set a trade draft inactive, but NOT deleted. Inactive trade drafts will not be shown to the user anymore.
+     */
+    deactivateTradeDraft(requestParameters: DeactivateTradeDraftRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<void>;
+    /**
+     * Delete an trade draft from the database
+     */
+    deleteTradeDraftRaw(requestParameters: DeleteTradeDraftRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete an trade draft from the database
+     */
+    deleteTradeDraft(requestParameters: DeleteTradeDraftRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<void>;
+    /**
+     * Returns active trade draft for a specific user in the specified pagination
+     */
+    getTradeDraftsRaw(requestParameters: GetTradeDraftsRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<GetActiveTradeDraftsResponse>>;
+    /**
+     * Returns active trade draft for a specific user in the specified pagination
+     */
+    getTradeDrafts(requestParameters?: GetTradeDraftsRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<GetActiveTradeDraftsResponse>;
+    /**
+     * Update a trade draft
+     */
+    updateTradeDraftRaw(requestParameters: UpdateTradeDraftRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update a trade draft
+     */
+    updateTradeDraft(requestParameters: UpdateTradeDraftRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<void>;
+}