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

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

@@ -0,0 +1,279 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ *
+ *
+ * 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 { PortfolioBulkDeleteRequest } from '../models';
+import type { PortfolioCreate } from '../models';
+import type { PortfolioOverviewItemResponse } from '../models';
+import type { PortfolioResponse } from '../models';
+import type { PortfolioUpdate } from '../models';
+/**
+ * PortfolioApi - axios parameter creator
+ */
+export declare const PortfolioApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Delete multiple portfolios by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no portfolios are deleted. Associated portfolio-investment links are also deleted via cascade.
+     * @summary Bulk delete portfolios
+     * @param {PortfolioBulkDeleteRequest} portfolioBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkDeletePortfolios: (portfolioBulkDeleteRequest: PortfolioBulkDeleteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete an existing portfolio by its ID. Associated portfolio-investment links are also deleted via cascade.
+     * @summary Delete a portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePortfolio: (portfolioId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a single portfolio by its ID.
+     * @summary Get a portfolio by ID
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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.
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPortfolioOverview: (valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all portfolios.
+     * @summary List portfolios
+     * @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}
+     */
+    getPortfolios: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update one or more fields of an existing portfolio. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioUpdate} portfolioUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchPortfolio: (portfolioId: string, portfolioUpdate: PortfolioUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a new portfolio.
+     * @summary Create a portfolio
+     * @param {PortfolioCreate} portfolioCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postPortfolio: (portfolioCreate: PortfolioCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PortfolioApi - functional programming interface
+ */
+export declare const PortfolioApiFp: (configuration?: Configuration) => {
+    /**
+     * Delete multiple portfolios by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no portfolios are deleted. Associated portfolio-investment links are also deleted via cascade.
+     * @summary Bulk delete portfolios
+     * @param {PortfolioBulkDeleteRequest} portfolioBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkDeletePortfolios(portfolioBulkDeleteRequest: PortfolioBulkDeleteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Delete an existing portfolio by its ID. Associated portfolio-investment links are also deleted via cascade.
+     * @summary Delete a portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePortfolio(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve a single portfolio by its ID.
+     * @summary Get a portfolio by ID
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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.
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioOverviewItemResponse>>>;
+    /**
+     * Retrieve a paginated list of all portfolios.
+     * @summary List portfolios
+     * @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}
+     */
+    getPortfolios(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioResponse>>>;
+    /**
+     * Update one or more fields of an existing portfolio. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioUpdate} portfolioUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchPortfolio(portfolioId: string, portfolioUpdate: PortfolioUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioResponse>>;
+    /**
+     * Create a new portfolio.
+     * @summary Create a portfolio
+     * @param {PortfolioCreate} portfolioCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postPortfolio(portfolioCreate: PortfolioCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioResponse>>;
+};
+/**
+ * PortfolioApi - factory interface
+ */
+export declare const PortfolioApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Delete multiple portfolios by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no portfolios are deleted. Associated portfolio-investment links are also deleted via cascade.
+     * @summary Bulk delete portfolios
+     * @param {PortfolioBulkDeleteRequest} portfolioBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkDeletePortfolios(portfolioBulkDeleteRequest: PortfolioBulkDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Delete an existing portfolio by its ID. Associated portfolio-investment links are also deleted via cascade.
+     * @summary Delete a portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePortfolio(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieve a single portfolio by its ID.
+     * @summary Get a portfolio by ID
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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.
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioOverviewItemResponse>>;
+    /**
+     * Retrieve a paginated list of all portfolios.
+     * @summary List portfolios
+     * @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}
+     */
+    getPortfolios(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioResponse>>;
+    /**
+     * Update one or more fields of an existing portfolio. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioUpdate} portfolioUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchPortfolio(portfolioId: string, portfolioUpdate: PortfolioUpdate, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioResponse>;
+    /**
+     * Create a new portfolio.
+     * @summary Create a portfolio
+     * @param {PortfolioCreate} portfolioCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postPortfolio(portfolioCreate: PortfolioCreate, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioResponse>;
+};
+/**
+ * PortfolioApi - object-oriented interface
+ */
+export declare class PortfolioApi extends BaseAPI {
+    /**
+     * Delete multiple portfolios by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no portfolios are deleted. Associated portfolio-investment links are also deleted via cascade.
+     * @summary Bulk delete portfolios
+     * @param {PortfolioBulkDeleteRequest} portfolioBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkDeletePortfolios(portfolioBulkDeleteRequest: PortfolioBulkDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Delete an existing portfolio by its ID. Associated portfolio-investment links are also deleted via cascade.
+     * @summary Delete a portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePortfolio(portfolioId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieve a single portfolio by its ID.
+     * @summary Get a portfolio by ID
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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.
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioOverviewItemResponse[], any, {}>>;
+    /**
+     * Retrieve a paginated list of all portfolios.
+     * @summary List portfolios
+     * @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}
+     */
+    getPortfolios(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioResponse[], any, {}>>;
+    /**
+     * Update one or more fields of an existing portfolio. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioUpdate} portfolioUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchPortfolio(portfolioId: string, portfolioUpdate: PortfolioUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioResponse, any, {}>>;
+    /**
+     * Create a new portfolio.
+     * @summary Create a portfolio
+     * @param {PortfolioCreate} portfolioCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postPortfolio(portfolioCreate: PortfolioCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioResponse, any, {}>>;
+}