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

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

@@ -0,0 +1,258 @@
+/**
+ * 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 { PortfolioInvestmentBulkAddRequest } from '../models';
+import type { PortfolioInvestmentBulkAddResponse } from '../models';
+import type { PortfolioInvestmentBulkDeleteRequest } from '../models';
+import type { PortfolioInvestmentResponse } from '../models';
+/**
+ * PortfolioInvestmentApi - axios parameter creator
+ */
+export declare const PortfolioInvestmentApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Link an investment to this portfolio.
+     * @summary Add an investment to this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addInvestmentToPortfolio: (portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Add multiple investments to the portfolio in one request. Already-linked investments are skipped.
+     * @summary Bulk add investments to this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioInvestmentBulkAddRequest} portfolioInvestmentBulkAddRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkAddInvestmentsToPortfolio: (portfolioId: string, portfolioInvestmentBulkAddRequest: PortfolioInvestmentBulkAddRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Remove multiple investments from the portfolio in one request. All provided IDs must be linked to this portfolio — if any ID is not found, the request fails with 404 and no links are removed.
+     * @summary Bulk remove investments from this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioInvestmentBulkDeleteRequest} portfolioInvestmentBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkRemoveInvestmentsFromPortfolio: (portfolioId: string, portfolioInvestmentBulkDeleteRequest: PortfolioInvestmentBulkDeleteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a specific investment link within this portfolio.
+     * @summary Get an investment link in this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvestmentForPortfolio: (portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all investment links for a specific portfolio.
+     * @summary List investments in this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @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}
+     */
+    getInvestmentsForPortfolio: (portfolioId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Remove an investment from this portfolio by deleting the link.
+     * @summary Remove an investment from this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeInvestmentFromPortfolio: (portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PortfolioInvestmentApi - functional programming interface
+ */
+export declare const PortfolioInvestmentApiFp: (configuration?: Configuration) => {
+    /**
+     * Link an investment to this portfolio.
+     * @summary Add an investment to this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addInvestmentToPortfolio(portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioInvestmentResponse>>;
+    /**
+     * Add multiple investments to the portfolio in one request. Already-linked investments are skipped.
+     * @summary Bulk add investments to this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioInvestmentBulkAddRequest} portfolioInvestmentBulkAddRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkAddInvestmentsToPortfolio(portfolioId: string, portfolioInvestmentBulkAddRequest: PortfolioInvestmentBulkAddRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioInvestmentBulkAddResponse>>;
+    /**
+     * Remove multiple investments from the portfolio in one request. All provided IDs must be linked to this portfolio — if any ID is not found, the request fails with 404 and no links are removed.
+     * @summary Bulk remove investments from this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioInvestmentBulkDeleteRequest} portfolioInvestmentBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkRemoveInvestmentsFromPortfolio(portfolioId: string, portfolioInvestmentBulkDeleteRequest: PortfolioInvestmentBulkDeleteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve a specific investment link within this portfolio.
+     * @summary Get an investment link in this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvestmentForPortfolio(portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioInvestmentResponse>>;
+    /**
+     * Retrieve a paginated list of all investment links for a specific portfolio.
+     * @summary List investments in this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @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}
+     */
+    getInvestmentsForPortfolio(portfolioId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioInvestmentResponse>>>;
+    /**
+     * Remove an investment from this portfolio by deleting the link.
+     * @summary Remove an investment from this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeInvestmentFromPortfolio(portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * PortfolioInvestmentApi - factory interface
+ */
+export declare const PortfolioInvestmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Link an investment to this portfolio.
+     * @summary Add an investment to this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addInvestmentToPortfolio(portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioInvestmentResponse>;
+    /**
+     * Add multiple investments to the portfolio in one request. Already-linked investments are skipped.
+     * @summary Bulk add investments to this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioInvestmentBulkAddRequest} portfolioInvestmentBulkAddRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkAddInvestmentsToPortfolio(portfolioId: string, portfolioInvestmentBulkAddRequest: PortfolioInvestmentBulkAddRequest, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioInvestmentBulkAddResponse>;
+    /**
+     * Remove multiple investments from the portfolio in one request. All provided IDs must be linked to this portfolio — if any ID is not found, the request fails with 404 and no links are removed.
+     * @summary Bulk remove investments from this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioInvestmentBulkDeleteRequest} portfolioInvestmentBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkRemoveInvestmentsFromPortfolio(portfolioId: string, portfolioInvestmentBulkDeleteRequest: PortfolioInvestmentBulkDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieve a specific investment link within this portfolio.
+     * @summary Get an investment link in this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvestmentForPortfolio(portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioInvestmentResponse>;
+    /**
+     * Retrieve a paginated list of all investment links for a specific portfolio.
+     * @summary List investments in this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @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}
+     */
+    getInvestmentsForPortfolio(portfolioId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioInvestmentResponse>>;
+    /**
+     * Remove an investment from this portfolio by deleting the link.
+     * @summary Remove an investment from this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeInvestmentFromPortfolio(portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * PortfolioInvestmentApi - object-oriented interface
+ */
+export declare class PortfolioInvestmentApi extends BaseAPI {
+    /**
+     * Link an investment to this portfolio.
+     * @summary Add an investment to this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addInvestmentToPortfolio(portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioInvestmentResponse, any, {}>>;
+    /**
+     * Add multiple investments to the portfolio in one request. Already-linked investments are skipped.
+     * @summary Bulk add investments to this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioInvestmentBulkAddRequest} portfolioInvestmentBulkAddRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkAddInvestmentsToPortfolio(portfolioId: string, portfolioInvestmentBulkAddRequest: PortfolioInvestmentBulkAddRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioInvestmentBulkAddResponse, any, {}>>;
+    /**
+     * Remove multiple investments from the portfolio in one request. All provided IDs must be linked to this portfolio — if any ID is not found, the request fails with 404 and no links are removed.
+     * @summary Bulk remove investments from this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {PortfolioInvestmentBulkDeleteRequest} portfolioInvestmentBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkRemoveInvestmentsFromPortfolio(portfolioId: string, portfolioInvestmentBulkDeleteRequest: PortfolioInvestmentBulkDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieve a specific investment link within this portfolio.
+     * @summary Get an investment link in this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvestmentForPortfolio(portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioInvestmentResponse, any, {}>>;
+    /**
+     * Retrieve a paginated list of all investment links for a specific portfolio.
+     * @summary List investments in this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @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}
+     */
+    getInvestmentsForPortfolio(portfolioId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioInvestmentResponse[], any, {}>>;
+    /**
+     * Remove an investment from this portfolio by deleting the link.
+     * @summary Remove an investment from this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeInvestmentFromPortfolio(portfolioId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+}