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

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

@@ -0,0 +1,245 @@
+/**
+ * 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.
+ */
+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';
+/**
+ * ImpactApi - axios parameter creator
+ */
+export declare const ImpactApiAxiosParamCreator: (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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+};
+/**
+ * ImpactApi - functional programming interface
+ */
+export declare const ImpactApiFp: (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>>;
+    /**
+     * 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>>;
+    /**
+     * 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>>>;
+    /**
+     * 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>>;
+};
+/**
+ * ImpactApi - factory interface
+ */
+export declare const ImpactApiFactory: (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>;
+    /**
+     * 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>;
+    /**
+     * 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>>;
+    /**
+     * 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>;
+};
+/**
+ * ImpactApi - object-oriented interface
+ */
+export declare class ImpactApi 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, {}>>;
+    /**
+     * 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, {}>>;
+    /**
+     * 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, {}>>;
+    /**
+     * 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, {}>>;
+}