@brokerize/client 1.5.0 → 1.6.0

package/dist/cjs/swagger/apis/PortfolioApi.js

@@ -0,0 +1,484 @@
+"use strict";
+/* 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PortfolioApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const models_1 = require("../models");
+/**
+ *
+ */
+class PortfolioApi extends runtime.BaseAPI {
+    /**
+     */
+    async deletePortfolioRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling deletePortfolio.");
+        }
+        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: `/portfolios/{portfolioId}`.replace(`{${"portfolioId"}}`, encodeURIComponent(String(requestParameters.portfolioId))),
+            method: "DELETE",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.OkResponseBodyFromJSON)(jsonValue));
+    }
+    /**
+     */
+    async deletePortfolio(requestParameters, initOverrides) {
+        const response = await this.deletePortfolioRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Get the AuthInfo for the given portfolio.  If the portfolio does not have an online session, this will return a 400 status code.  If it does, the response describes whether session TAN is available or active and which auth methods are available for the given portfolio (this information depends on the broker and the user\'s account settings).  The response determines which of the following operations can be used and which are required to successfully perform an operation in a portfolio:  -   Session TAN handling (for performing other actions in portfolios without further per-case authorization)     -   [CreateSessionTanChallenge](#operation/CreateSessionTanChallenge) to request a challenge for s TAN activation.     -   [EnableSessionTan](#operation/EnableSessionTan) to enable the session TAN.     -   [EndSessionTan](#operation/EndSessionTan) to end the session TAN. -   Create a trade     -   [PrepareTrade](#operation/PrepareTrade) to figure out how a given security can be traded in a portfolio.     -   [CreateTradeChallenge](#operation/CreateTradeChallenge) to (for example) request a TAN for a trade.     -   [CreateTrade](#operation/CreateTrade) to perform the trade. -   Edit an order     -   [CreateChangeOrderChallenge](#operation/CreateChangeOrderChallenge) to request a challenge for an order change.     -   [ChangeOrder](#operation/ChangeOrder) to change an order. -   Cancel an order     -   [CreateCancelOrderChallenge](#operation/CreateCancelOrderChallenge) to request a Challenge for an order cancellation.     -   [CancelOrder](#operation/CancelOrder) to cancel an order.  The list of available AuthMethods should only be presented to the user if session TAN is not active (yet). The list and names are defined by our partner brokers. All auth methods are generally categorized using the `flow` attribute:  | `flow`               | requires challenge? | Description                                                                                                                                                                                                          | | -------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `TAN`                | no                  | the simplest flow: no challenge is required to perform the operation. the TAN is simply sent as parameter `tan`                                                                              | | `CHALLENGE_RESPONSE` | yes                 | a challenge must be created using the `createXYZChallenge` operations and the challenge must be presented to the user. The user can then execute the action using the `challengeId` and `challengeResponse` parameters. If the auth method has `challengeResponseIsOnlyConfirmation=true`, that challengeResponse is always an empty string and users do not enter a TAN. Otherwise, a text field labelled with `tanFieldLabel` must be displayed where the user enteirs their challengeResponse. | | `DECOUPLED`          | no                  | the operation is executed without any TAN, but returns a `decoupledOperationId` which can be used to read the action\'s status. Users will authorize the action in another frontend (usually in their broker\'s app). Note that currently `DECOUPLED` auth methods only work for enabling session TAN.   |  - If `sessionTanActive` is `true`: Session TAN has been enabled for the session that currently backs the portfolio. In this case, all operations like `CreateTrade` can be executed right away without an `authMethod`. The UI should *not* show a dropdown with the auth methods in this case. - If `sessionTanActive` is `false` but `sessionTanSupported` is `true`: the user can enable session TAN using `CreateSessionTanChallenge` / `EnableSessionTan`. - If `allOperationsRequireSessionTan` is `true`, the auth methods can *ONLY* be used for enabling session TAN. - Otherwise, the `authMethods` can be used to perform individual operations.  | sessionTanActive | sessionTanSupported | allOperationsRequireSessionTan | Description                                                                                                                                                                                                                                                 | | ---------------- | ------------------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `true`           | `true`              | -                              | Session TAN has been enabled for the session that currently backs the portfolio. In this case, all operations like `CreateTrade`, `ChangeOrder`, `CancelOrder` can be executed right away without an `authMethod`. The UI should _not_ show a dropdown with the auth methods in this case. | | `false`          | `true`              | `true`                         | the user can enable session TAN using the provided auth methods via `CreateSessionTanChallenge` / `EnableSessionTan`. All other operations can only take place after session TAN has been enabled.                                                          | | `false`          | `true`              | `false`                        | the user can enable any operation (enable session tan, create trade, cancel order, change order) using the provided auth methods                                                                                                                            |  Note that it is possible that brokers only reveal all details about the available auth methods *TOGETHER* with the first `GetChallenge` request. This special behavior can be simulated with our demo broker when the flag `lazyAuthMethods=true` is specified upon creation of a demo account. In those accounts, the `GetAuthInfo` endpoint will initially return a single \"placeholder\" method with `{flow: \"CHALLENGE_RESPONSE\", isDefaultMethod: true, ...}`.  In the situation where there is *exactly one* auth method like this, frontends may immediately request the challenge for the desired operation without waiting for the user to click the get challenge button (for Session TAN, this means that as soon as the user opens the dialog for enabling session TAN, `CreateSessionTanChallenge` can be called). In the case described here, `AuthInfo` will be populated with the actual list of auth methods when the create challenge request returns (also, the corresponding WebSocket event is published to notify about this change). `GetAuthInfo` must be called again in this case and repopulate the corresponding frontend (e.g. the name of the auth method will become available etc.). So what is done in this case is: request a challenge for the *unknown* default method in order to get both a challenge and an update of the auth methods.  Note that usually challenges have effects like an SMS or some broker app notification for the end user, so it is important to keep the requested challenge info, *even when auth info is refreshed*. For example, if there is a select box with the auth method list, that box must keep its selected `id` while updating the now-available `label`. This way, the user can use the first requested challenge, as the frontend will still be in the right state.
+     */
+    async getAuthInfoRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling getAuthInfo.");
+        }
+        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: `/portfolios/{portfolioId}/authinfo`.replace(`{${"portfolioId"}}`, encodeURIComponent(String(requestParameters.portfolioId))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.GetAuthInfoResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Get the AuthInfo for the given portfolio.  If the portfolio does not have an online session, this will return a 400 status code.  If it does, the response describes whether session TAN is available or active and which auth methods are available for the given portfolio (this information depends on the broker and the user\'s account settings).  The response determines which of the following operations can be used and which are required to successfully perform an operation in a portfolio:  -   Session TAN handling (for performing other actions in portfolios without further per-case authorization)     -   [CreateSessionTanChallenge](#operation/CreateSessionTanChallenge) to request a challenge for s TAN activation.     -   [EnableSessionTan](#operation/EnableSessionTan) to enable the session TAN.     -   [EndSessionTan](#operation/EndSessionTan) to end the session TAN. -   Create a trade     -   [PrepareTrade](#operation/PrepareTrade) to figure out how a given security can be traded in a portfolio.     -   [CreateTradeChallenge](#operation/CreateTradeChallenge) to (for example) request a TAN for a trade.     -   [CreateTrade](#operation/CreateTrade) to perform the trade. -   Edit an order     -   [CreateChangeOrderChallenge](#operation/CreateChangeOrderChallenge) to request a challenge for an order change.     -   [ChangeOrder](#operation/ChangeOrder) to change an order. -   Cancel an order     -   [CreateCancelOrderChallenge](#operation/CreateCancelOrderChallenge) to request a Challenge for an order cancellation.     -   [CancelOrder](#operation/CancelOrder) to cancel an order.  The list of available AuthMethods should only be presented to the user if session TAN is not active (yet). The list and names are defined by our partner brokers. All auth methods are generally categorized using the `flow` attribute:  | `flow`               | requires challenge? | Description                                                                                                                                                                                                          | | -------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `TAN`                | no                  | the simplest flow: no challenge is required to perform the operation. the TAN is simply sent as parameter `tan`                                                                              | | `CHALLENGE_RESPONSE` | yes                 | a challenge must be created using the `createXYZChallenge` operations and the challenge must be presented to the user. The user can then execute the action using the `challengeId` and `challengeResponse` parameters. If the auth method has `challengeResponseIsOnlyConfirmation=true`, that challengeResponse is always an empty string and users do not enter a TAN. Otherwise, a text field labelled with `tanFieldLabel` must be displayed where the user enteirs their challengeResponse. | | `DECOUPLED`          | no                  | the operation is executed without any TAN, but returns a `decoupledOperationId` which can be used to read the action\'s status. Users will authorize the action in another frontend (usually in their broker\'s app). Note that currently `DECOUPLED` auth methods only work for enabling session TAN.   |  - If `sessionTanActive` is `true`: Session TAN has been enabled for the session that currently backs the portfolio. In this case, all operations like `CreateTrade` can be executed right away without an `authMethod`. The UI should *not* show a dropdown with the auth methods in this case. - If `sessionTanActive` is `false` but `sessionTanSupported` is `true`: the user can enable session TAN using `CreateSessionTanChallenge` / `EnableSessionTan`. - If `allOperationsRequireSessionTan` is `true`, the auth methods can *ONLY* be used for enabling session TAN. - Otherwise, the `authMethods` can be used to perform individual operations.  | sessionTanActive | sessionTanSupported | allOperationsRequireSessionTan | Description                                                                                                                                                                                                                                                 | | ---------------- | ------------------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `true`           | `true`              | -                              | Session TAN has been enabled for the session that currently backs the portfolio. In this case, all operations like `CreateTrade`, `ChangeOrder`, `CancelOrder` can be executed right away without an `authMethod`. The UI should _not_ show a dropdown with the auth methods in this case. | | `false`          | `true`              | `true`                         | the user can enable session TAN using the provided auth methods via `CreateSessionTanChallenge` / `EnableSessionTan`. All other operations can only take place after session TAN has been enabled.                                                          | | `false`          | `true`              | `false`                        | the user can enable any operation (enable session tan, create trade, cancel order, change order) using the provided auth methods                                                                                                                            |  Note that it is possible that brokers only reveal all details about the available auth methods *TOGETHER* with the first `GetChallenge` request. This special behavior can be simulated with our demo broker when the flag `lazyAuthMethods=true` is specified upon creation of a demo account. In those accounts, the `GetAuthInfo` endpoint will initially return a single \"placeholder\" method with `{flow: \"CHALLENGE_RESPONSE\", isDefaultMethod: true, ...}`.  In the situation where there is *exactly one* auth method like this, frontends may immediately request the challenge for the desired operation without waiting for the user to click the get challenge button (for Session TAN, this means that as soon as the user opens the dialog for enabling session TAN, `CreateSessionTanChallenge` can be called). In the case described here, `AuthInfo` will be populated with the actual list of auth methods when the create challenge request returns (also, the corresponding WebSocket event is published to notify about this change). `GetAuthInfo` must be called again in this case and repopulate the corresponding frontend (e.g. the name of the auth method will become available etc.). So what is done in this case is: request a challenge for the *unknown* default method in order to get both a challenge and an update of the auth methods.  Note that usually challenges have effects like an SMS or some broker app notification for the end user, so it is important to keep the requested challenge info, *even when auth info is refreshed*. For example, if there is a select box with the auth method list, that box must keep its selected `id` while updating the now-available `label`. This way, the user can use the first requested challenge, as the frontend will still be in the right state.
+     */
+    async getAuthInfo(requestParameters, initOverrides) {
+        const response = await this.getAuthInfoRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Retrieve \"by-day\" aggregated values for the selected date ranges.
+     */
+    async getPortfolioCalendarRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling getPortfolioCalendar.");
+        }
+        if (requestParameters.dateRanges === null ||
+            requestParameters.dateRanges === undefined) {
+            throw new runtime.RequiredError("dateRanges", "Required parameter requestParameters.dateRanges was null or undefined when calling getPortfolioCalendar.");
+        }
+        const queryParameters = {};
+        if (requestParameters.dateRanges !== undefined) {
+            queryParameters["dateRanges"] = requestParameters.dateRanges;
+        }
+        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: `/portfolios/{portfolioId}/calendar`.replace(`{${"portfolioId"}}`, encodeURIComponent(String(requestParameters.portfolioId))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.GetPortfolioCalendarResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Retrieve \"by-day\" aggregated values for the selected date ranges.
+     */
+    async getPortfolioCalendar(requestParameters, initOverrides) {
+        const response = await this.getPortfolioCalendarRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     */
+    async getPortfolioOrdersRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling getPortfolioOrders.");
+        }
+        const queryParameters = {};
+        if (requestParameters.take !== undefined) {
+            queryParameters["take"] = requestParameters.take;
+        }
+        if (requestParameters.skip !== undefined) {
+            queryParameters["skip"] = requestParameters.skip;
+        }
+        if (requestParameters.search !== undefined) {
+            queryParameters["search"] = requestParameters.search;
+        }
+        if (requestParameters.statuses !== undefined) {
+            queryParameters["statuses"] = requestParameters.statuses;
+        }
+        if (requestParameters.orderBy !== undefined) {
+            queryParameters["orderBy"] = requestParameters.orderBy;
+        }
+        if (requestParameters.isin !== undefined) {
+            queryParameters["isin"] = requestParameters.isin;
+        }
+        if (requestParameters.wkn !== undefined) {
+            queryParameters["wkn"] = requestParameters.wkn;
+        }
+        if (requestParameters.sinoTicker !== undefined) {
+            queryParameters["sinoTicker"] = requestParameters.sinoTicker;
+        }
+        if (requestParameters.usTicker !== undefined) {
+            queryParameters["usTicker"] = requestParameters.usTicker;
+        }
+        if (requestParameters.cryptoCode !== undefined) {
+            queryParameters["cryptoCode"] = requestParameters.cryptoCode;
+        }
+        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: `/portfolios/{portfolioId}/orders`.replace(`{${"portfolioId"}}`, encodeURIComponent(String(requestParameters.portfolioId))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.GetPortfolioOrdersResponseFromJSON)(jsonValue));
+    }
+    /**
+     */
+    async getPortfolioOrders(requestParameters, initOverrides) {
+        const response = await this.getPortfolioOrdersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     */
+    async getPortfolioPositionsRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling getPortfolioPositions.");
+        }
+        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: `/portfolios/{portfolioId}/positions`.replace(`{${"portfolioId"}}`, encodeURIComponent(String(requestParameters.portfolioId))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.GetPortfolioPositionsResponseFromJSON)(jsonValue));
+    }
+    /**
+     */
+    async getPortfolioPositions(requestParameters, initOverrides) {
+        const response = await this.getPortfolioPositionsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     */
+    async getPortfolioQuotesRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling getPortfolioQuotes.");
+        }
+        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: `/portfolios/{portfolioId}/quotes`.replace(`{${"portfolioId"}}`, encodeURIComponent(String(requestParameters.portfolioId))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.GetPortfolioQuotesResponseFromJSON)(jsonValue));
+    }
+    /**
+     */
+    async getPortfolioQuotes(requestParameters, initOverrides) {
+        const response = await this.getPortfolioQuotesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Load statistics based on the trade list for selected date ranges. The statistics (such as `longestWinningStreak` or `tradeCount`) are computed for each of the requested date ranges.
+     */
+    async getPortfolioTradeStatisticsRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling getPortfolioTradeStatistics.");
+        }
+        if (requestParameters.dateRanges === null ||
+            requestParameters.dateRanges === undefined) {
+            throw new runtime.RequiredError("dateRanges", "Required parameter requestParameters.dateRanges was null or undefined when calling getPortfolioTradeStatistics.");
+        }
+        const queryParameters = {};
+        if (requestParameters.dateRanges !== undefined) {
+            queryParameters["dateRanges"] = requestParameters.dateRanges;
+        }
+        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: `/portfolios/{portfolioId}/trades/statistics`.replace(`{${"portfolioId"}}`, encodeURIComponent(String(requestParameters.portfolioId))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.GetPortfolioTradeStatisticsResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Load statistics based on the trade list for selected date ranges. The statistics (such as `longestWinningStreak` or `tradeCount`) are computed for each of the requested date ranges.
+     */
+    async getPortfolioTradeStatistics(requestParameters, initOverrides) {
+        const response = await this.getPortfolioTradeStatisticsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     */
+    async getPortfolioTradeWarningsRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling getPortfolioTradeWarnings.");
+        }
+        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: `/portfolios/{portfolioId}/trades/warnings`.replace(`{${"portfolioId"}}`, encodeURIComponent(String(requestParameters.portfolioId))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(models_1.TradeWarningFromJSON));
+    }
+    /**
+     */
+    async getPortfolioTradeWarnings(requestParameters, initOverrides) {
+        const response = await this.getPortfolioTradeWarningsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Load a list of completed trades in a portfolio. A completed trade corresponds to *one* closing of a position. Technically each closing of a position corresponds to one execution of an order with `intent=close` (usually those are sell orders, but in the case of short selling, opening a position is a sell order with intent=open).  The analysis follows the FIFO (First In, First Out) principle to accurately summarize trades. Each time a position is closed (note that partial executions are possible. In this case, each individual execution is regarded as a transaction), the system identifies the earliest corresponding \"open position execution\" that contributed to that closing. The result includes a single entry for each closing transaction, detailing key metrics such as profit/loss and holding period, based on the matched opening transactions.  This could be a real world example: - 2020-01-01: buy 5 stock1 for 100 USD each - 2021-06-01: buy 3 stock1 for 200 USD each - 2021-06-06: sell 6 stock1 for 300 USD each  In this case, the result would be one completed trade (corresponding to the last sell) with a profit of `(300*6)-(100*5+1*200)=1800-700=1100 USD`. There is an open position remaining (2 units of stock1, which correspond to the second buy transaction).  When we add this sell: - 2021-06-07: sell 2 stock1 for 400 USD each  It would add a second complete trade with a profit of `(400*2)-(200*2)=800-400=400 USD`.  For some brokers, the order history may be incomplete (e.g. only reveals the latest 90 days), so that we do not know if there could be older transactions. Thus, our implementation might detect (given the current set of open positions together with the list of order executions) that we cannot figure out the corresponding opening transactions for a closing transaction. Affected trades will be ignored for this analysis and might appear as warning items in the `/warnings` endpoint. Frontends should show those warnings so that users can understand why the analysis is incomplete.
+     */
+    async getPortfolioTradesRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling getPortfolioTrades.");
+        }
+        const queryParameters = {};
+        if (requestParameters.search !== undefined) {
+            queryParameters["search"] = requestParameters.search;
+        }
+        if (requestParameters.take !== undefined) {
+            queryParameters["take"] = requestParameters.take;
+        }
+        if (requestParameters.skip !== undefined) {
+            queryParameters["skip"] = requestParameters.skip;
+        }
+        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: `/portfolios/{portfolioId}/trades`.replace(`{${"portfolioId"}}`, encodeURIComponent(String(requestParameters.portfolioId))),
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.GetPortfolioTradesResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Load a list of completed trades in a portfolio. A completed trade corresponds to *one* closing of a position. Technically each closing of a position corresponds to one execution of an order with `intent=close` (usually those are sell orders, but in the case of short selling, opening a position is a sell order with intent=open).  The analysis follows the FIFO (First In, First Out) principle to accurately summarize trades. Each time a position is closed (note that partial executions are possible. In this case, each individual execution is regarded as a transaction), the system identifies the earliest corresponding \"open position execution\" that contributed to that closing. The result includes a single entry for each closing transaction, detailing key metrics such as profit/loss and holding period, based on the matched opening transactions.  This could be a real world example: - 2020-01-01: buy 5 stock1 for 100 USD each - 2021-06-01: buy 3 stock1 for 200 USD each - 2021-06-06: sell 6 stock1 for 300 USD each  In this case, the result would be one completed trade (corresponding to the last sell) with a profit of `(300*6)-(100*5+1*200)=1800-700=1100 USD`. There is an open position remaining (2 units of stock1, which correspond to the second buy transaction).  When we add this sell: - 2021-06-07: sell 2 stock1 for 400 USD each  It would add a second complete trade with a profit of `(400*2)-(200*2)=800-400=400 USD`.  For some brokers, the order history may be incomplete (e.g. only reveals the latest 90 days), so that we do not know if there could be older transactions. Thus, our implementation might detect (given the current set of open positions together with the list of order executions) that we cannot figure out the corresponding opening transactions for a closing transaction. Affected trades will be ignored for this analysis and might appear as warning items in the `/warnings` endpoint. Frontends should show those warnings so that users can understand why the analysis is incomplete.
+     */
+    async getPortfolioTrades(requestParameters, initOverrides) {
+        const response = await this.getPortfolioTradesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     */
+    async getPortfoliosRaw(initOverrides) {
+        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: `/portfolios`,
+            method: "GET",
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.PortfoliosResponseFromJSON)(jsonValue));
+    }
+    /**
+     */
+    async getPortfolios(initOverrides) {
+        const response = await this.getPortfoliosRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * This endpoint can be used to rename the display name of a specified portfolio. To restore the original portfolio name, send a rename request with an empty string as the new name. **Note**: This does not change the original portfolio name at your broker.
+     */
+    async renamePortfolioRaw(requestParameters, initOverrides) {
+        if (requestParameters.portfolioId === null ||
+            requestParameters.portfolioId === undefined) {
+            throw new runtime.RequiredError("portfolioId", "Required parameter requestParameters.portfolioId was null or undefined when calling renamePortfolio.");
+        }
+        if (requestParameters.renamePortfolioRequest === null ||
+            requestParameters.renamePortfolioRequest === undefined) {
+            throw new runtime.RequiredError("renamePortfolioRequest", "Required parameter requestParameters.renamePortfolioRequest was null or undefined when calling renamePortfolio.");
+        }
+        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: `/portfolios/{portfolioId}/rename`.replace(`{${"portfolioId"}}`, encodeURIComponent(String(requestParameters.portfolioId))),
+            method: "POST",
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, models_1.RenamePortfolioRequestToJSON)(requestParameters.renamePortfolioRequest),
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * This endpoint can be used to rename the display name of a specified portfolio. To restore the original portfolio name, send a rename request with an empty string as the new name. **Note**: This does not change the original portfolio name at your broker.
+     */
+    async renamePortfolio(requestParameters, initOverrides) {
+        await this.renamePortfolioRaw(requestParameters, initOverrides);
+    }
+}
+exports.PortfolioApi = PortfolioApi;

package/dist/cjs/swagger/apis/SecuritiesApi.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { SecurityQuotesMeta, SecurityQuotesResponse } from "../models";
+export interface GetSecurityQuotesRequest {
+    securityQuotesToken: string;
+}
+export interface GetSecurityQuotesMetaRequest {
+    securityQuotesToken: string;
+}
+/**
+ *
+ */
+export declare 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.
+     */
+    getSecurityQuotesRaw(requestParameters: GetSecurityQuotesRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<SecurityQuotesResponse>>;
+    /**
+     * 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.
+     */
+    getSecurityQuotes(requestParameters: GetSecurityQuotesRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<SecurityQuotesResponse>;
+    /**
+     * Load metadata about the given securityQuotesToken. This includes the currency, decimals and the quote source name.
+     */
+    getSecurityQuotesMetaRaw(requestParameters: GetSecurityQuotesMetaRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<SecurityQuotesMeta>>;
+    /**
+     * Load metadata about the given securityQuotesToken. This includes the currency, decimals and the quote source name.
+     */
+    getSecurityQuotesMeta(requestParameters: GetSecurityQuotesMetaRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<SecurityQuotesMeta>;
+}