@cosmotech/aip-client 0.4.0-dev2 → 0.4.0-dev5

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

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -55,13 +55,13 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      */
     getInvestments: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
      * @summary Investment overview table
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getInvestmentsOverview: (valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getInvestmentsOverview: (valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an investment
@@ -118,13 +118,13 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      */
     getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentResponse>>>;
     /**
-     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
      * @summary Investment overview table
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentOverviewResponse>>>;
+    getInvestmentsOverview(valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentOverviewResponse>>>;
     /**
      * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an investment
@@ -181,13 +181,13 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      */
     getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentResponse>>;
     /**
-     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
      * @summary Investment overview table
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentOverviewResponse>>;
+    getInvestmentsOverview(valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentOverviewResponse>>;
     /**
      * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an investment
@@ -244,13 +244,13 @@ export declare class InvestmentApi extends BaseAPI {
      */
     getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse[], any, {}>>;
     /**
-     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
      * @summary Investment overview table
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentOverviewResponse[], any, {}>>;
+    getInvestmentsOverview(valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentOverviewResponse[], any, {}>>;
     /**
      * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an investment

package/dist/api/investment-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -170,15 +170,13 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
          * @summary Investment overview table
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
         getInvestmentsOverview: (valueFrameworkId_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, ...args_1], void 0, function* (valueFrameworkId, options = {}) {
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            (0, common_1.assertParamExists)('getInvestmentsOverview', 'valueFrameworkId', valueFrameworkId);
             const localVarPath = `/investment/overview`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -351,9 +349,9 @@ const InvestmentApiFp = function (configuration) {
             });
         },
         /**
-         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
          * @summary Investment overview table
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -450,9 +448,9 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getInvestments(offset, limit, options).then((request) => request(axios, basePath));
         },
         /**
-         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
          * @summary Investment overview table
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -529,9 +527,9 @@ class InvestmentApi extends base_1.BaseAPI {
         return (0, exports.InvestmentApiFp)(this.configuration).getInvestments(offset, limit, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
      * @summary Investment overview table
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */

package/dist/api/metric-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/metric-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/metric-costs-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/metric-costs-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/metric-costs-per-year-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/metric-costs-per-year-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/objective-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/objective-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/objective-weight-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/objective-weight-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/objective-weights-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/objective-weights-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/option-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -49,15 +49,15 @@ export declare const OptionApiAxiosParamCreator: (configuration?: Configuration)
      */
     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. Data is sourced from the v_option_yearly_kpis database view.
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
      * @summary Get the kpis for a given option inside a value framework
      * @param {string} optionId UUID of the option
      * @param {string} investmentId UUID of the investment
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOptionKpis: (optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getOptionKpis: (optionId: string, investmentId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -120,15 +120,15 @@ export declare const OptionApiFp: (configuration?: Configuration) => {
      */
     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. Data is sourced from the v_option_yearly_kpis database view.
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
      * @summary Get the kpis for a given option inside a value framework
      * @param {string} optionId UUID of the option
      * @param {string} investmentId UUID of the investment
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>>;
+    getOptionKpis(optionId: string, investmentId: string, valueFrameworkId?: string | null, 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
@@ -191,15 +191,15 @@ export declare const OptionApiFactory: (configuration?: Configuration, basePath?
      */
     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. Data is sourced from the v_option_yearly_kpis database view.
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
      * @summary Get the kpis for a given option inside a value framework
      * @param {string} optionId UUID of the option
      * @param {string} investmentId UUID of the investment
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>>;
+    getOptionKpis(optionId: string, investmentId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -262,15 +262,15 @@ export declare class OptionApi extends BaseAPI {
      */
     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. Data is sourced from the v_option_yearly_kpis database view.
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
      * @summary Get the kpis for a given option inside a value framework
      * @param {string} optionId UUID of the option
      * @param {string} investmentId UUID of the investment
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionChartKPIsYearly[], any, {}>>;
+    getOptionKpis(optionId: string, investmentId: string, valueFrameworkId?: string | null, 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

package/dist/api/option-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -146,11 +146,11 @@ const OptionApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
          * @summary Get the kpis for a given option inside a value framework
          * @param {string} optionId UUID of the option
          * @param {string} investmentId UUID of the investment
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -159,12 +159,9 @@ const OptionApiAxiosParamCreator = function (configuration) {
             (0, common_1.assertParamExists)('getOptionKpis', 'optionId', optionId);
             // verify required parameter 'investmentId' is not null or undefined
             (0, common_1.assertParamExists)('getOptionKpis', 'investmentId', investmentId);
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            (0, common_1.assertParamExists)('getOptionKpis', 'valueFrameworkId', valueFrameworkId);
-            const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis/{value_framework_id}`
+            const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis`
                 .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
-                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
-                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -177,6 +174,9 @@ const OptionApiAxiosParamCreator = function (configuration) {
             // authentication OAuth2AuthorizationCodeBearer required
             // oauth required
             yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
             localVarHeaderParameter['Accept'] = 'application/json';
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -369,11 +369,11 @@ const OptionApiFp = function (configuration) {
             });
         },
         /**
-         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
          * @summary Get the kpis for a given option inside a value framework
          * @param {string} optionId UUID of the option
          * @param {string} investmentId UUID of the investment
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -482,11 +482,11 @@ const OptionApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
         },
         /**
-         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
          * @summary Get the kpis for a given option inside a value framework
          * @param {string} optionId UUID of the option
          * @param {string} investmentId UUID of the investment
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -569,11 +569,11 @@ class OptionApi extends base_1.BaseAPI {
         return (0, exports.OptionApiFp)(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
      * @summary Get the kpis for a given option inside a value framework
      * @param {string} optionId UUID of the option
      * @param {string} investmentId UUID of the investment
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */

package/dist/api/portfolio-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -46,15 +46,15 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
      */
     getPortfolioById: (portfolioId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
      * @summary Portfolio overview with KPIs
-     * @param {string} valueFrameworkId UUID of the value framework
      * @param {number} [offset] Number of records to skip
      * @param {number} [limit] Max number of records to return
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPortfolioOverview: (valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getPortfolioOverview: (offset?: number, limit?: number, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve a paginated list of all portfolios.
      * @summary List portfolios
@@ -111,15 +111,15 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
      */
     getPortfolioById(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioResponse>>;
     /**
-     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
      * @summary Portfolio overview with KPIs
-     * @param {string} valueFrameworkId UUID of the value framework
      * @param {number} [offset] Number of records to skip
      * @param {number} [limit] Max number of records to return
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioOverviewItemResponse>>>;
+    getPortfolioOverview(offset?: number, limit?: number, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioOverviewItemResponse>>>;
     /**
      * Retrieve a paginated list of all portfolios.
      * @summary List portfolios
@@ -176,15 +176,15 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
      */
     getPortfolioById(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioResponse>;
     /**
-     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
      * @summary Portfolio overview with KPIs
-     * @param {string} valueFrameworkId UUID of the value framework
      * @param {number} [offset] Number of records to skip
      * @param {number} [limit] Max number of records to return
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioOverviewItemResponse>>;
+    getPortfolioOverview(offset?: number, limit?: number, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioOverviewItemResponse>>;
     /**
      * Retrieve a paginated list of all portfolios.
      * @summary List portfolios
@@ -241,15 +241,15 @@ export declare class PortfolioApi extends BaseAPI {
      */
     getPortfolioById(portfolioId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioResponse, any, {}>>;
     /**
-     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
      * @summary Portfolio overview with KPIs
-     * @param {string} valueFrameworkId UUID of the value framework
      * @param {number} [offset] Number of records to skip
      * @param {number} [limit] Max number of records to return
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioOverviewItemResponse[], any, {}>>;
+    getPortfolioOverview(offset?: number, limit?: number, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioOverviewItemResponse[], any, {}>>;
     /**
      * Retrieve a paginated list of all portfolios.
      * @summary List portfolios