@cosmotech/aip-client 0.3.0-dev2 → 0.4.0-dev1

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.3.0-dev1
+ * The version of the OpenAPI document: 0.4.0-dev1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,9 +12,6 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
-import type { ImpactAPIResponse } from '../models';
-import type { ImpactCreate } from '../models';
-import type { ImpactUpdate } from '../models';
 import type { OptionChartKPIsYearly } from '../models';
 import type { OptionCreate } from '../models';
 import type { OptionOverviewResponse } from '../models';
@@ -24,16 +21,6 @@ import type { OptionUpdate } from '../models';
  * OptionApi - axios parameter creator
  */
 export declare const OptionApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * Create a new impact under this option.
-     * @summary Create an impact for this option
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {ImpactCreate} impactCreate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createImpactForOption: (optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create a new option under this investment.
      * @summary Create an option for this investment
@@ -43,46 +30,15 @@ export declare const OptionApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     createOptionForInvestment: (investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Delete an existing impact by its ID.
-     * @summary Delete an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteImpactForOption: (impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
      * @summary Delete an option for this investment
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Retrieve a specific impact for the option.
-     * @summary Get an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
      * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getImpactForOption: (impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Retrieve a paginated list of all impacts for a specific option.
-     * @summary List impacts for this option
      * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {number} [offset] Number of records to skip
-     * @param {number} [limit] Max number of records to return
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getImpactsForOption: (optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    deleteOptionForInvestment: (investmentId: string, optionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -95,13 +51,13 @@ export declare const OptionApiAxiosParamCreator: (configuration?: 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.
      * @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} investmentId UUID of the investment
      * @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>;
+    getOptionKpis: (optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -121,17 +77,6 @@ export declare const OptionApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getOptionsOverview: (investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
-     * @summary Partially update an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {ImpactUpdate} impactUpdate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    patchImpactForOption: (impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an option for this investment
@@ -147,16 +92,6 @@ export declare const OptionApiAxiosParamCreator: (configuration?: Configuration)
  * OptionApi - functional programming interface
  */
 export declare const OptionApiFp: (configuration?: Configuration) => {
-    /**
-     * Create a new impact under this option.
-     * @summary Create an impact for this option
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {ImpactCreate} impactCreate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
     /**
      * Create a new option under this investment.
      * @summary Create an option for this investment
@@ -166,46 +101,15 @@ export declare const OptionApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
-    /**
-     * Delete an existing impact by its ID.
-     * @summary Delete an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
      * @summary Delete an option for this investment
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Retrieve a specific impact for the option.
-     * @summary Get an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
      * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
-    /**
-     * Retrieve a paginated list of all impacts for a specific option.
-     * @summary List impacts for this option
      * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {number} [offset] Number of records to skip
-     * @param {number} [limit] Max number of records to return
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ImpactAPIResponse>>>;
+    deleteOptionForInvestment(investmentId: string, optionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -218,13 +122,13 @@ export declare const OptionApiFp: (configuration?: 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.
      * @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} investmentId UUID of the investment
      * @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>>>;
+    getOptionKpis(optionId: string, investmentId: 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
@@ -244,17 +148,6 @@ export declare const OptionApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionOverviewResponse>>>;
-    /**
-     * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
-     * @summary Partially update an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {ImpactUpdate} impactUpdate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
     /**
      * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an option for this investment
@@ -270,16 +163,6 @@ export declare const OptionApiFp: (configuration?: Configuration) => {
  * OptionApi - factory interface
  */
 export declare const OptionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * Create a new impact under this option.
-     * @summary Create an impact for this option
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {ImpactCreate} impactCreate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
     /**
      * Create a new option under this investment.
      * @summary Create an option for this investment
@@ -289,46 +172,15 @@ export declare const OptionApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
-    /**
-     * Delete an existing impact by its ID.
-     * @summary Delete an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
      * @summary Delete an option for this investment
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Retrieve a specific impact for the option.
-     * @summary Get an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
      * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
-    /**
-     * Retrieve a paginated list of all impacts for a specific option.
-     * @summary List impacts for this option
      * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {number} [offset] Number of records to skip
-     * @param {number} [limit] Max number of records to return
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ImpactAPIResponse>>;
+    deleteOptionForInvestment(investmentId: string, optionId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -341,13 +193,13 @@ export declare const OptionApiFactory: (configuration?: Configuration, 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.
      * @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} investmentId UUID of the investment
      * @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>>;
+    getOptionKpis(optionId: string, investmentId: 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
@@ -367,17 +219,6 @@ export declare const OptionApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionOverviewResponse>>;
-    /**
-     * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
-     * @summary Partially update an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {ImpactUpdate} impactUpdate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
     /**
      * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an option for this investment
@@ -393,16 +234,6 @@ export declare const OptionApiFactory: (configuration?: Configuration, basePath?
  * OptionApi - object-oriented interface
  */
 export declare class OptionApi extends BaseAPI {
-    /**
-     * Create a new impact under this option.
-     * @summary Create an impact for this option
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {ImpactCreate} impactCreate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
     /**
      * Create a new option under this investment.
      * @summary Create an option for this investment
@@ -412,46 +243,15 @@ export declare class OptionApi extends BaseAPI {
      * @throws {RequiredError}
      */
     createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
-    /**
-     * Delete an existing impact by its ID.
-     * @summary Delete an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
      * @summary Delete an option for this investment
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Retrieve a specific impact for the option.
-     * @summary Get an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
      * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
-    /**
-     * Retrieve a paginated list of all impacts for a specific option.
-     * @summary List impacts for this option
      * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {number} [offset] Number of records to skip
-     * @param {number} [limit] Max number of records to return
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse[], any, {}>>;
+    deleteOptionForInvestment(investmentId: string, optionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -464,13 +264,13 @@ export declare class OptionApi extends BaseAPI {
     /**
      * 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.
      * @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} investmentId UUID of the investment
      * @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, {}>>;
+    getOptionKpis(optionId: string, investmentId: 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
@@ -490,17 +290,6 @@ export declare class OptionApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionOverviewResponse[], any, {}>>;
-    /**
-     * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
-     * @summary Partially update an impact for this option
-     * @param {string} impactId UUID of the impact
-     * @param {string} optionId UUID of the option
-     * @param {string} investmentId UUID of the investment
-     * @param {ImpactUpdate} impactUpdate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
     /**
      * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an option for this investment