@cosmotech/aip-client 0.2.0-dev3 → 0.2.0-dev5

package/dist/esm/api/favored-option-api.js

@@ -0,0 +1,202 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
+/**
+ * FavoredOptionApi - axios parameter creator
+ */
+export const FavoredOptionApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Get the preferred option for an investment.
+         * @summary Get the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFavoredOption: (investmentId_1, ...args_1) => __awaiter(this, [investmentId_1, ...args_1], void 0, function* (investmentId, options = {}) {
+            // verify required parameter 'investmentId' is not null or undefined
+            assertParamExists('getFavoredOption', 'investmentId', investmentId);
+            const localVarPath = `/investment/{investment_id}/favored_option`
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Set the preferred option for an investment.
+         * @summary Set the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {FavoredOptionRequest} favoredOptionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setFavoredOption: (investmentId_1, favoredOptionRequest_1, ...args_1) => __awaiter(this, [investmentId_1, favoredOptionRequest_1, ...args_1], void 0, function* (investmentId, favoredOptionRequest, options = {}) {
+            // verify required parameter 'investmentId' is not null or undefined
+            assertParamExists('setFavoredOption', 'investmentId', investmentId);
+            // verify required parameter 'favoredOptionRequest' is not null or undefined
+            assertParamExists('setFavoredOption', 'favoredOptionRequest', favoredOptionRequest);
+            const localVarPath = `/investment/{investment_id}/favored_option`
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(favoredOptionRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * FavoredOptionApi - functional programming interface
+ */
+export const FavoredOptionApiFp = function (configuration) {
+    const localVarAxiosParamCreator = FavoredOptionApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Get the preferred option for an investment.
+         * @summary Get the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFavoredOption(investmentId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getFavoredOption(investmentId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FavoredOptionApi.getFavoredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Set the preferred option for an investment.
+         * @summary Set the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {FavoredOptionRequest} favoredOptionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setFavoredOption(investmentId, favoredOptionRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FavoredOptionApi.setFavoredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * FavoredOptionApi - factory interface
+ */
+export const FavoredOptionApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = FavoredOptionApiFp(configuration);
+    return {
+        /**
+         * Get the preferred option for an investment.
+         * @summary Get the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFavoredOption(investmentId, options) {
+            return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Set the preferred option for an investment.
+         * @summary Set the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {FavoredOptionRequest} favoredOptionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setFavoredOption(investmentId, favoredOptionRequest, options) {
+            return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * FavoredOptionApi - object-oriented interface
+ */
+export class FavoredOptionApi extends BaseAPI {
+    /**
+     * Get the preferred option for an investment.
+     * @summary Get the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFavoredOption(investmentId, options) {
+        return FavoredOptionApiFp(this.configuration).getFavoredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Set the preferred option for an investment.
+     * @summary Set the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {FavoredOptionRequest} favoredOptionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setFavoredOption(investmentId, favoredOptionRequest, options) {
+        return FavoredOptionApiFp(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/dist/esm/api/investment-api.d.ts

@@ -12,12 +12,15 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
+import type { FavoredOptionRequest } from '../models';
+import type { FavoredOptionResponse } from '../models';
 import type { ImpactAPIResponse } from '../models';
 import type { ImpactCreate } from '../models';
 import type { ImpactUpdate } from '../models';
 import type { InvestmentCreate } from '../models';
 import type { InvestmentResponse } from '../models';
 import type { InvestmentUpdate } from '../models';
+import type { OptionChartKPIsYearly } from '../models';
 import type { OptionCreate } from '../models';
 import type { OptionResponse } from '../models';
 import type { OptionUpdate } from '../models';
@@ -71,6 +74,14 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     deleteOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the preferred option for an investment.
+     * @summary Get the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFavoredOption: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve a specific impact for the option.
      * @summary Get an impact for this option
@@ -118,6 +129,16 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     getOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis: (investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -166,6 +187,15 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     postInvestment: (investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Set the preferred option for an investment.
+     * @summary Set the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {FavoredOptionRequest} favoredOptionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setFavoredOption: (investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * InvestmentApi - functional programming interface
@@ -217,6 +247,14 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get the preferred option for an investment.
+     * @summary Get the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>>;
     /**
      * Retrieve a specific impact for the option.
      * @summary Get an impact for this option
@@ -264,6 +302,16 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -312,6 +360,15 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvestmentResponse>>;
+    /**
+     * Set the preferred option for an investment.
+     * @summary Set the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {FavoredOptionRequest} favoredOptionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>>;
 };
 /**
  * InvestmentApi - factory interface
@@ -363,6 +420,14 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get the preferred option for an investment.
+     * @summary Get the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse>;
     /**
      * Retrieve a specific impact for the option.
      * @summary Get an impact for this option
@@ -410,6 +475,16 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -458,6 +533,15 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse>;
+    /**
+     * Set the preferred option for an investment.
+     * @summary Set the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {FavoredOptionRequest} favoredOptionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse>;
 };
 /**
  * InvestmentApi - object-oriented interface
@@ -509,6 +593,14 @@ export declare class InvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Get the preferred option for an investment.
+     * @summary Get the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoredOptionResponse, any, {}>>;
     /**
      * Retrieve a specific impact for the option.
      * @summary Get an impact for this option
@@ -556,6 +648,16 @@ export declare class InvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionChartKPIsYearly[], any, {}>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -604,4 +706,13 @@ export declare class InvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse, any, {}>>;
+    /**
+     * Set the preferred option for an investment.
+     * @summary Set the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {FavoredOptionRequest} favoredOptionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoredOptionResponse, any, {}>>;
 }