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

package/api/budget-api.ts

@@ -0,0 +1,835 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { BudgetBulkDeleteRequest } from '../models';
+// @ts-ignore
+import type { BudgetCreate } from '../models';
+// @ts-ignore
+import type { BudgetInvestmentResponse } from '../models';
+// @ts-ignore
+import type { BudgetLinkOptionsRequest } from '../models';
+// @ts-ignore
+import type { BudgetOptionResponse } from '../models';
+// @ts-ignore
+import type { BudgetOverviewResponse } from '../models';
+// @ts-ignore
+import type { BudgetResponse } from '../models';
+// @ts-ignore
+import type { BudgetUpdate } from '../models';
+/**
+ * BudgetApi - axios parameter creator
+ */
+export const BudgetApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 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: async (budgetBulkDeleteRequest: BudgetBulkDeleteRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'budgetBulkDeleteRequest' is not null or undefined
+            assertParamExists('bulkDeleteBudgets', 'budgetBulkDeleteRequest', budgetBulkDeleteRequest)
+            const localVarPath = `/budget/bulk`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(budgetBulkDeleteRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: async (budgetId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'budgetId' is not null or undefined
+            assertParamExists('deleteBudget', 'budgetId', budgetId)
+            const localVarPath = `/budget/{budget_id}`
+                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: async (budgetId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'budgetId' is not null or undefined
+            assertParamExists('getBudgetById', 'budgetId', budgetId)
+            const localVarPath = `/budget/{budget_id}`
+                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: async (budgetId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'budgetId' is not null or undefined
+            assertParamExists('getBudgetInvestments', 'budgetId', budgetId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getBudgetInvestments', 'valueFrameworkId', valueFrameworkId)
+            const localVarPath = `/budget/{budget_id}/investments`
+                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: async (budgetId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'budgetId' is not null or undefined
+            assertParamExists('getBudgetOptions', 'budgetId', budgetId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getBudgetOptions', 'valueFrameworkId', valueFrameworkId)
+            const localVarPath = `/budget/{budget_id}/options`
+                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: async (budgetId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'budgetId' is not null or undefined
+            assertParamExists('getBudgetOverview', 'budgetId', budgetId)
+            const localVarPath = `/budget/{budget_id}/overview`
+                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: async (offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/budget/`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            if (offset !== undefined) {
+                localVarQueryParameter['offset'] = offset;
+            }
+
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: async (budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'budgetId' is not null or undefined
+            assertParamExists('linkOptionsToBudget', 'budgetId', budgetId)
+            // verify required parameter 'budgetLinkOptionsRequest' is not null or undefined
+            assertParamExists('linkOptionsToBudget', 'budgetLinkOptionsRequest', budgetLinkOptionsRequest)
+            const localVarPath = `/budget/{budget_id}/link-options`
+                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(budgetLinkOptionsRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: async (budgetId: string, budgetUpdate: BudgetUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'budgetId' is not null or undefined
+            assertParamExists('patchBudget', 'budgetId', budgetId)
+            // verify required parameter 'budgetUpdate' is not null or undefined
+            assertParamExists('patchBudget', 'budgetUpdate', budgetUpdate)
+            const localVarPath = `/budget/{budget_id}`
+                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(budgetUpdate, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Create a new budget.
+         * @summary Create a budget
+         * @param {BudgetCreate} budgetCreate 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postBudget: async (budgetCreate: BudgetCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'budgetCreate' is not null or undefined
+            assertParamExists('postBudget', 'budgetCreate', budgetCreate)
+            const localVarPath = `/budget/`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(budgetCreate, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * BudgetApi - functional programming interface
+ */
+export const BudgetApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = BudgetApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 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}
+         */
+        async bulkDeleteBudgets(budgetBulkDeleteRequest: BudgetBulkDeleteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.bulkDeleteBudgets(budgetBulkDeleteRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BudgetApi.bulkDeleteBudgets']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 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}
+         */
+        async deleteBudget(budgetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBudget(budgetId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BudgetApi.deleteBudget']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 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}
+         */
+        async getBudgetById(budgetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BudgetResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getBudgetById(budgetId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BudgetApi.getBudgetById']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 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}
+         */
+        async getBudgetInvestments(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetInvestmentResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getBudgetInvestments(budgetId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BudgetApi.getBudgetInvestments']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 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}
+         */
+        async getBudgetOptions(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetOptionResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getBudgetOptions(budgetId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BudgetApi.getBudgetOptions']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 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}
+         */
+        async getBudgetOverview(budgetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BudgetOverviewResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getBudgetOverview(budgetId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BudgetApi.getBudgetOverview']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 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}
+         */
+        async getBudgets(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getBudgets(offset, limit, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BudgetApi.getBudgets']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 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}
+         */
+        async linkOptionsToBudget(budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.linkOptionsToBudget(budgetId, budgetLinkOptionsRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BudgetApi.linkOptionsToBudget']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 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}
+         */
+        async patchBudget(budgetId: string, budgetUpdate: BudgetUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BudgetResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.patchBudget(budgetId, budgetUpdate, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BudgetApi.patchBudget']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Create a new budget.
+         * @summary Create a budget
+         * @param {BudgetCreate} budgetCreate 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postBudget(budgetCreate: BudgetCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BudgetResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postBudget(budgetCreate, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BudgetApi.postBudget']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * BudgetApi - factory interface
+ */
+export const BudgetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = BudgetApiFp(configuration)
+    return {
+        /**
+         * 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> {
+            return localVarFp.bulkDeleteBudgets(budgetBulkDeleteRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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> {
+            return localVarFp.deleteBudget(budgetId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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 localVarFp.getBudgetById(budgetId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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 localVarFp.getBudgetInvestments(budgetId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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 localVarFp.getBudgetOptions(budgetId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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> {
+            return localVarFp.getBudgetOverview(budgetId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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>> {
+            return localVarFp.getBudgets(offset, limit, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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>> {
+            return localVarFp.linkOptionsToBudget(budgetId, budgetLinkOptionsRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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> {
+            return localVarFp.patchBudget(budgetId, budgetUpdate, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 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> {
+            return localVarFp.postBudget(budgetCreate, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * BudgetApi - object-oriented interface
+ */
+export 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}
+     */
+    public bulkDeleteBudgets(budgetBulkDeleteRequest: BudgetBulkDeleteRequest, options?: RawAxiosRequestConfig) {
+        return BudgetApiFp(this.configuration).bulkDeleteBudgets(budgetBulkDeleteRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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}
+     */
+    public deleteBudget(budgetId: string, options?: RawAxiosRequestConfig) {
+        return BudgetApiFp(this.configuration).deleteBudget(budgetId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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}
+     */
+    public getBudgetById(budgetId: string, options?: RawAxiosRequestConfig) {
+        return BudgetApiFp(this.configuration).getBudgetById(budgetId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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}
+     */
+    public getBudgetInvestments(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return BudgetApiFp(this.configuration).getBudgetInvestments(budgetId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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}
+     */
+    public getBudgetOptions(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return BudgetApiFp(this.configuration).getBudgetOptions(budgetId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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}
+     */
+    public getBudgetOverview(budgetId: string, options?: RawAxiosRequestConfig) {
+        return BudgetApiFp(this.configuration).getBudgetOverview(budgetId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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}
+     */
+    public getBudgets(offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
+        return BudgetApiFp(this.configuration).getBudgets(offset, limit, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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}
+     */
+    public linkOptionsToBudget(budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options?: RawAxiosRequestConfig) {
+        return BudgetApiFp(this.configuration).linkOptionsToBudget(budgetId, budgetLinkOptionsRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 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}
+     */
+    public patchBudget(budgetId: string, budgetUpdate: BudgetUpdate, options?: RawAxiosRequestConfig) {
+        return BudgetApiFp(this.configuration).patchBudget(budgetId, budgetUpdate, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Create a new budget.
+     * @summary Create a budget
+     * @param {BudgetCreate} budgetCreate 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public postBudget(budgetCreate: BudgetCreate, options?: RawAxiosRequestConfig) {
+        return BudgetApiFp(this.configuration).postBudget(budgetCreate, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+