@cosmotech/aip-client 0.2.0-dev6 → 0.3.0-dev1

package/dist/api/budget-api.d.ts

@@ -0,0 +1,382 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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 { BudgetBulkDeleteRequest } from '../models';
+import type { BudgetCreate } from '../models';
+import type { BudgetInvestmentResponse } from '../models';
+import type { BudgetLinkOptionsRequest } from '../models';
+import type { BudgetOptionResponse } from '../models';
+import type { BudgetOverviewResponse } from '../models';
+import type { BudgetResponse } from '../models';
+import type { BudgetUpdate } from '../models';
+/**
+ * BudgetApi - axios parameter creator
+ */
+export declare const BudgetApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Delete multiple budgets at once. Options linked to deleted budgets will have their budget link removed (set to null).
+     * @summary Bulk delete budgets
+     * @param {BudgetBulkDeleteRequest} budgetBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkDeleteBudgets: (budgetBulkDeleteRequest: BudgetBulkDeleteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete an existing budget by its ID. Options linked to this budget will have their budget link removed (set to null).
+     * @summary Delete a budget
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBudget: (budgetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a single budget by its ID.
+     * @summary Get a budget by ID
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetById: (budgetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Return all distinct investments that have at least one option linked to this budget. Each row shows the investment\'s current preferred option data and a flag indicating whether the preferred option is the one linked to the budget. NPV is computed for the preferred option from the v_option_npv view.
+     * @summary List investments linked to this budget via options
+     * @param {string} budgetId UUID of the budget
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetInvestments: (budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Return all options linked to this budget. Rows are ordered by investment name then option name. NPV is computed from the v_option_npv view for the given value framework.
+     * @summary List options linked to this budget
+     * @param {string} budgetId UUID of the budget
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetOptions: (budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Return aggregated overview data for a budget: annual capacity, number of options linked to it, and number of distinct investments that have at least one option linked to it.
+     * @summary Get budget overview
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetOverview: (budgetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all budgets, ordered by name.
+     * @summary List all budgets
+     * @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}
+     */
+    getBudgets: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Returns the list of option IDs that were successfully linked.
+     * @summary Bulk-link options to this budget
+     * @param {string} budgetId UUID of the budget
+     * @param {BudgetLinkOptionsRequest} budgetLinkOptionsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    linkOptionsToBudget: (budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update one or more fields of an existing budget. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a budget
+     * @param {string} budgetId UUID of the budget
+     * @param {BudgetUpdate} budgetUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchBudget: (budgetId: string, budgetUpdate: BudgetUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a new budget.
+     * @summary Create a budget
+     * @param {BudgetCreate} budgetCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postBudget: (budgetCreate: BudgetCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BudgetApi - functional programming interface
+ */
+export declare const BudgetApiFp: (configuration?: Configuration) => {
+    /**
+     * Delete multiple budgets at once. Options linked to deleted budgets will have their budget link removed (set to null).
+     * @summary Bulk delete budgets
+     * @param {BudgetBulkDeleteRequest} budgetBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkDeleteBudgets(budgetBulkDeleteRequest: BudgetBulkDeleteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Delete an existing budget by its ID. Options linked to this budget will have their budget link removed (set to null).
+     * @summary Delete a budget
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBudget(budgetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve a single budget by its ID.
+     * @summary Get a budget by ID
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetById(budgetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BudgetResponse>>;
+    /**
+     * Return all distinct investments that have at least one option linked to this budget. Each row shows the investment\'s current preferred option data and a flag indicating whether the preferred option is the one linked to the budget. NPV is computed for the preferred option from the v_option_npv view.
+     * @summary List investments linked to this budget via options
+     * @param {string} budgetId UUID of the budget
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetInvestments(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetInvestmentResponse>>>;
+    /**
+     * Return all options linked to this budget. Rows are ordered by investment name then option name. NPV is computed from the v_option_npv view for the given value framework.
+     * @summary List options linked to this budget
+     * @param {string} budgetId UUID of the budget
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetOptions(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetOptionResponse>>>;
+    /**
+     * Return aggregated overview data for a budget: annual capacity, number of options linked to it, and number of distinct investments that have at least one option linked to it.
+     * @summary Get budget overview
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetOverview(budgetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BudgetOverviewResponse>>;
+    /**
+     * Retrieve a paginated list of all budgets, ordered by name.
+     * @summary List all budgets
+     * @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}
+     */
+    getBudgets(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetResponse>>>;
+    /**
+     * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Returns the list of option IDs that were successfully linked.
+     * @summary Bulk-link options to this budget
+     * @param {string} budgetId UUID of the budget
+     * @param {BudgetLinkOptionsRequest} budgetLinkOptionsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    linkOptionsToBudget(budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
+    /**
+     * Update one or more fields of an existing budget. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a budget
+     * @param {string} budgetId UUID of the budget
+     * @param {BudgetUpdate} budgetUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchBudget(budgetId: string, budgetUpdate: BudgetUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BudgetResponse>>;
+    /**
+     * Create a new budget.
+     * @summary Create a budget
+     * @param {BudgetCreate} budgetCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postBudget(budgetCreate: BudgetCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BudgetResponse>>;
+};
+/**
+ * BudgetApi - factory interface
+ */
+export declare const BudgetApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Delete multiple budgets at once. Options linked to deleted budgets will have their budget link removed (set to null).
+     * @summary Bulk delete budgets
+     * @param {BudgetBulkDeleteRequest} budgetBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkDeleteBudgets(budgetBulkDeleteRequest: BudgetBulkDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Delete an existing budget by its ID. Options linked to this budget will have their budget link removed (set to null).
+     * @summary Delete a budget
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBudget(budgetId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieve a single budget by its ID.
+     * @summary Get a budget by ID
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetById(budgetId: string, options?: RawAxiosRequestConfig): AxiosPromise<BudgetResponse>;
+    /**
+     * Return all distinct investments that have at least one option linked to this budget. Each row shows the investment\'s current preferred option data and a flag indicating whether the preferred option is the one linked to the budget. NPV is computed for the preferred option from the v_option_npv view.
+     * @summary List investments linked to this budget via options
+     * @param {string} budgetId UUID of the budget
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetInvestments(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<BudgetInvestmentResponse>>;
+    /**
+     * Return all options linked to this budget. Rows are ordered by investment name then option name. NPV is computed from the v_option_npv view for the given value framework.
+     * @summary List options linked to this budget
+     * @param {string} budgetId UUID of the budget
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetOptions(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<BudgetOptionResponse>>;
+    /**
+     * Return aggregated overview data for a budget: annual capacity, number of options linked to it, and number of distinct investments that have at least one option linked to it.
+     * @summary Get budget overview
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetOverview(budgetId: string, options?: RawAxiosRequestConfig): AxiosPromise<BudgetOverviewResponse>;
+    /**
+     * Retrieve a paginated list of all budgets, ordered by name.
+     * @summary List all budgets
+     * @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}
+     */
+    getBudgets(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<BudgetResponse>>;
+    /**
+     * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Returns the list of option IDs that were successfully linked.
+     * @summary Bulk-link options to this budget
+     * @param {string} budgetId UUID of the budget
+     * @param {BudgetLinkOptionsRequest} budgetLinkOptionsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    linkOptionsToBudget(budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+    /**
+     * Update one or more fields of an existing budget. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a budget
+     * @param {string} budgetId UUID of the budget
+     * @param {BudgetUpdate} budgetUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchBudget(budgetId: string, budgetUpdate: BudgetUpdate, options?: RawAxiosRequestConfig): AxiosPromise<BudgetResponse>;
+    /**
+     * Create a new budget.
+     * @summary Create a budget
+     * @param {BudgetCreate} budgetCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postBudget(budgetCreate: BudgetCreate, options?: RawAxiosRequestConfig): AxiosPromise<BudgetResponse>;
+};
+/**
+ * BudgetApi - object-oriented interface
+ */
+export declare class BudgetApi extends BaseAPI {
+    /**
+     * Delete multiple budgets at once. Options linked to deleted budgets will have their budget link removed (set to null).
+     * @summary Bulk delete budgets
+     * @param {BudgetBulkDeleteRequest} budgetBulkDeleteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkDeleteBudgets(budgetBulkDeleteRequest: BudgetBulkDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Delete an existing budget by its ID. Options linked to this budget will have their budget link removed (set to null).
+     * @summary Delete a budget
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBudget(budgetId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieve a single budget by its ID.
+     * @summary Get a budget by ID
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetById(budgetId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BudgetResponse, any, {}>>;
+    /**
+     * Return all distinct investments that have at least one option linked to this budget. Each row shows the investment\'s current preferred option data and a flag indicating whether the preferred option is the one linked to the budget. NPV is computed for the preferred option from the v_option_npv view.
+     * @summary List investments linked to this budget via options
+     * @param {string} budgetId UUID of the budget
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetInvestments(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BudgetInvestmentResponse[], any, {}>>;
+    /**
+     * Return all options linked to this budget. Rows are ordered by investment name then option name. NPV is computed from the v_option_npv view for the given value framework.
+     * @summary List options linked to this budget
+     * @param {string} budgetId UUID of the budget
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetOptions(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BudgetOptionResponse[], any, {}>>;
+    /**
+     * Return aggregated overview data for a budget: annual capacity, number of options linked to it, and number of distinct investments that have at least one option linked to it.
+     * @summary Get budget overview
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBudgetOverview(budgetId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BudgetOverviewResponse, any, {}>>;
+    /**
+     * Retrieve a paginated list of all budgets, ordered by name.
+     * @summary List all budgets
+     * @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}
+     */
+    getBudgets(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BudgetResponse[], any, {}>>;
+    /**
+     * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Returns the list of option IDs that were successfully linked.
+     * @summary Bulk-link options to this budget
+     * @param {string} budgetId UUID of the budget
+     * @param {BudgetLinkOptionsRequest} budgetLinkOptionsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    linkOptionsToBudget(budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
+    /**
+     * Update one or more fields of an existing budget. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a budget
+     * @param {string} budgetId UUID of the budget
+     * @param {BudgetUpdate} budgetUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchBudget(budgetId: string, budgetUpdate: BudgetUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BudgetResponse, any, {}>>;
+    /**
+     * Create a new budget.
+     * @summary Create a budget
+     * @param {BudgetCreate} budgetCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postBudget(budgetCreate: BudgetCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BudgetResponse, any, {}>>;
+}