@cosmotech/aip-client 0.4.0-dev4 → 1.0.0-dev1

package/dist/esm/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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

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

package/dist/esm/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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

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

package/dist/esm/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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

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

package/dist/esm/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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

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

package/dist/esm/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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * 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/esm/api/option-api.js

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -143,11 +143,11 @@ export 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}
          */
@@ -156,12 +156,9 @@ export const OptionApiAxiosParamCreator = function (configuration) {
             assertParamExists('getOptionKpis', 'optionId', optionId);
             // verify required parameter 'investmentId' is not null or undefined
             assertParamExists('getOptionKpis', 'investmentId', investmentId);
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            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, DUMMY_BASE_URL);
             let baseOptions;
@@ -174,6 +171,9 @@ export const OptionApiAxiosParamCreator = function (configuration) {
             // authentication OAuth2AuthorizationCodeBearer required
             // oauth required
             yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
             localVarHeaderParameter['Accept'] = 'application/json';
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -365,11 +365,11 @@ export 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}
          */
@@ -477,11 +477,11 @@ export 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}
          */
@@ -563,11 +563,11 @@ export class OptionApi extends BaseAPI {
         return 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/esm/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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/api/portfolio-api.js

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

package/dist/esm/api/portfolio-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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/api/portfolio-investment-api.js

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

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

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

package/dist/esm/api/portfolio-kpiapi.js

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

package/dist/esm/api/preferred-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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

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