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

package/dist/esm/api/objective-weight-api.js

@@ -0,0 +1,444 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
+/**
+ * ObjectiveWeightApi - axios parameter creator
+ * @export
+ */
+export const ObjectiveWeightApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Delete an objective weight link by its composite key (framework_id, objective_id).
+         * @summary Delete an objective weight
+         * @param {string} frameworkId UUID of the value framework
+         * @param {string} objectiveId UUID of the objective
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteObjectiveWeight: (frameworkId, objectiveId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'frameworkId' is not null or undefined
+            assertParamExists('deleteObjectiveWeight', 'frameworkId', frameworkId);
+            // verify required parameter 'objectiveId' is not null or undefined
+            assertParamExists('deleteObjectiveWeight', 'objectiveId', objectiveId);
+            const localVarPath = `/objective_weight/{framework_id}/{objective_id}`
+                .replace(`{${"framework_id"}}`, encodeURIComponent(String(frameworkId)))
+                .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
+            // 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 = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Retrieve the weight for a specific objective within a specific framework.
+         * @summary Get an objective weight by framework and objective
+         * @param {string} frameworkId UUID of the value framework
+         * @param {string} objectiveId UUID of the objective
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getObjectiveWeightByKeys: (frameworkId, objectiveId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'frameworkId' is not null or undefined
+            assertParamExists('getObjectiveWeightByKeys', 'frameworkId', frameworkId);
+            // verify required parameter 'objectiveId' is not null or undefined
+            assertParamExists('getObjectiveWeightByKeys', 'objectiveId', objectiveId);
+            const localVarPath = `/objective_weight/{framework_id}/{objective_id}`
+                .replace(`{${"framework_id"}}`, encodeURIComponent(String(frameworkId)))
+                .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
+            // 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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Retrieve a paginated list of all objective-framework weight assignments.
+         * @summary List objective weights
+         * @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}
+         */
+        getObjectiveWeights: (offset, limit, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/objective_weight/`;
+            // 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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            if (offset !== undefined) {
+                localVarQueryParameter['offset'] = offset;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Update the weight of an objective within a value framework. Identified by the composite key (framework_id, objective_id).
+         * @summary Partially update an objective weight
+         * @param {string} frameworkId UUID of the value framework
+         * @param {string} objectiveId UUID of the objective
+         * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchObjectiveWeight: (frameworkId, objectiveId, objectiveWeightUpdate, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'frameworkId' is not null or undefined
+            assertParamExists('patchObjectiveWeight', 'frameworkId', frameworkId);
+            // verify required parameter 'objectiveId' is not null or undefined
+            assertParamExists('patchObjectiveWeight', 'objectiveId', objectiveId);
+            // verify required parameter 'objectiveWeightUpdate' is not null or undefined
+            assertParamExists('patchObjectiveWeight', 'objectiveWeightUpdate', objectiveWeightUpdate);
+            const localVarPath = `/objective_weight/{framework_id}/{objective_id}`
+                .replace(`{${"framework_id"}}`, encodeURIComponent(String(frameworkId)))
+                .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
+            // 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 = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(objectiveWeightUpdate, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Assign a weight to an objective within a framework. Weight must be >= 0, defaults to 1.0.
+         * @summary Create an objective weight
+         * @param {ObjectiveWeightCreate} objectiveWeightCreate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postObjectiveWeight: (objectiveWeightCreate, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'objectiveWeightCreate' is not null or undefined
+            assertParamExists('postObjectiveWeight', 'objectiveWeightCreate', objectiveWeightCreate);
+            const localVarPath = `/objective_weight/`;
+            // 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 = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(objectiveWeightCreate, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * ObjectiveWeightApi - functional programming interface
+ * @export
+ */
+export const ObjectiveWeightApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ObjectiveWeightApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Delete an objective weight link by its composite key (framework_id, objective_id).
+         * @summary Delete an objective weight
+         * @param {string} frameworkId UUID of the value framework
+         * @param {string} objectiveId UUID of the objective
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteObjectiveWeight(frameworkId, objectiveId, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteObjectiveWeight(frameworkId, objectiveId, options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = operationServerMap['ObjectiveWeightApi.deleteObjectiveWeight']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
+        /**
+         * Retrieve the weight for a specific objective within a specific framework.
+         * @summary Get an objective weight by framework and objective
+         * @param {string} frameworkId UUID of the value framework
+         * @param {string} objectiveId UUID of the objective
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getObjectiveWeightByKeys(frameworkId, objectiveId, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getObjectiveWeightByKeys(frameworkId, objectiveId, options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = operationServerMap['ObjectiveWeightApi.getObjectiveWeightByKeys']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
+        /**
+         * Retrieve a paginated list of all objective-framework weight assignments.
+         * @summary List objective weights
+         * @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}
+         */
+        getObjectiveWeights(offset, limit, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getObjectiveWeights(offset, limit, options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = operationServerMap['ObjectiveWeightApi.getObjectiveWeights']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
+        /**
+         * Update the weight of an objective within a value framework. Identified by the composite key (framework_id, objective_id).
+         * @summary Partially update an objective weight
+         * @param {string} frameworkId UUID of the value framework
+         * @param {string} objectiveId UUID of the objective
+         * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchObjectiveWeight(frameworkId, objectiveId, objectiveWeightUpdate, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.patchObjectiveWeight(frameworkId, objectiveId, objectiveWeightUpdate, options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = operationServerMap['ObjectiveWeightApi.patchObjectiveWeight']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
+        /**
+         * Assign a weight to an objective within a framework. Weight must be >= 0, defaults to 1.0.
+         * @summary Create an objective weight
+         * @param {ObjectiveWeightCreate} objectiveWeightCreate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postObjectiveWeight(objectiveWeightCreate, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.postObjectiveWeight(objectiveWeightCreate, options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = operationServerMap['ObjectiveWeightApi.postObjectiveWeight']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * ObjectiveWeightApi - factory interface
+ * @export
+ */
+export const ObjectiveWeightApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ObjectiveWeightApiFp(configuration);
+    return {
+        /**
+         * Delete an objective weight link by its composite key (framework_id, objective_id).
+         * @summary Delete an objective weight
+         * @param {string} frameworkId UUID of the value framework
+         * @param {string} objectiveId UUID of the objective
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteObjectiveWeight(frameworkId, objectiveId, options) {
+            return localVarFp.deleteObjectiveWeight(frameworkId, objectiveId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieve the weight for a specific objective within a specific framework.
+         * @summary Get an objective weight by framework and objective
+         * @param {string} frameworkId UUID of the value framework
+         * @param {string} objectiveId UUID of the objective
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getObjectiveWeightByKeys(frameworkId, objectiveId, options) {
+            return localVarFp.getObjectiveWeightByKeys(frameworkId, objectiveId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieve a paginated list of all objective-framework weight assignments.
+         * @summary List objective weights
+         * @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}
+         */
+        getObjectiveWeights(offset, limit, options) {
+            return localVarFp.getObjectiveWeights(offset, limit, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Update the weight of an objective within a value framework. Identified by the composite key (framework_id, objective_id).
+         * @summary Partially update an objective weight
+         * @param {string} frameworkId UUID of the value framework
+         * @param {string} objectiveId UUID of the objective
+         * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchObjectiveWeight(frameworkId, objectiveId, objectiveWeightUpdate, options) {
+            return localVarFp.patchObjectiveWeight(frameworkId, objectiveId, objectiveWeightUpdate, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Assign a weight to an objective within a framework. Weight must be >= 0, defaults to 1.0.
+         * @summary Create an objective weight
+         * @param {ObjectiveWeightCreate} objectiveWeightCreate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postObjectiveWeight(objectiveWeightCreate, options) {
+            return localVarFp.postObjectiveWeight(objectiveWeightCreate, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * ObjectiveWeightApi - object-oriented interface
+ * @export
+ * @class ObjectiveWeightApi
+ * @extends {BaseAPI}
+ */
+export class ObjectiveWeightApi extends BaseAPI {
+    /**
+     * Delete an objective weight link by its composite key (framework_id, objective_id).
+     * @summary Delete an objective weight
+     * @param {string} frameworkId UUID of the value framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ObjectiveWeightApi
+     */
+    deleteObjectiveWeight(frameworkId, objectiveId, options) {
+        return ObjectiveWeightApiFp(this.configuration).deleteObjectiveWeight(frameworkId, objectiveId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Retrieve the weight for a specific objective within a specific framework.
+     * @summary Get an objective weight by framework and objective
+     * @param {string} frameworkId UUID of the value framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ObjectiveWeightApi
+     */
+    getObjectiveWeightByKeys(frameworkId, objectiveId, options) {
+        return ObjectiveWeightApiFp(this.configuration).getObjectiveWeightByKeys(frameworkId, objectiveId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Retrieve a paginated list of all objective-framework weight assignments.
+     * @summary List objective weights
+     * @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}
+     * @memberof ObjectiveWeightApi
+     */
+    getObjectiveWeights(offset, limit, options) {
+        return ObjectiveWeightApiFp(this.configuration).getObjectiveWeights(offset, limit, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Update the weight of an objective within a value framework. Identified by the composite key (framework_id, objective_id).
+     * @summary Partially update an objective weight
+     * @param {string} frameworkId UUID of the value framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ObjectiveWeightApi
+     */
+    patchObjectiveWeight(frameworkId, objectiveId, objectiveWeightUpdate, options) {
+        return ObjectiveWeightApiFp(this.configuration).patchObjectiveWeight(frameworkId, objectiveId, objectiveWeightUpdate, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Assign a weight to an objective within a framework. Weight must be >= 0, defaults to 1.0.
+     * @summary Create an objective weight
+     * @param {ObjectiveWeightCreate} objectiveWeightCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ObjectiveWeightApi
+     */
+    postObjectiveWeight(objectiveWeightCreate, options) {
+        return ObjectiveWeightApiFp(this.configuration).postObjectiveWeight(objectiveWeightCreate, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/dist/esm/api/value-framework-api.d.ts

@@ -0,0 +1,216 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev2
+ *
+ *
+ * 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 { RequestArgs, BaseAPI } from '../base';
+import { ValueFrameworkCreate } from '../models';
+import { ValueFrameworkResponse } from '../models';
+import { ValueFrameworkUpdate } from '../models';
+/**
+ * ValueFrameworkApi - axios parameter creator
+ * @export
+ */
+export declare const ValueFrameworkApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
+     * @summary Delete a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteValueFramework: (valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a single value framework by its ID.
+     * @summary Get a value framework by ID
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getValueFrameworkById: (valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all value frameworks.
+     * @summary List value frameworks
+     * @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}
+     */
+    getValueFrameworks: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ValueFrameworkUpdate} valueFrameworkUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchValueFramework: (valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a new value framework. Name must be unique and non-empty.
+     * @summary Create a value framework
+     * @param {ValueFrameworkCreate} valueFrameworkCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postValueFramework: (valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ValueFrameworkApi - functional programming interface
+ * @export
+ */
+export declare const ValueFrameworkApiFp: (configuration?: Configuration) => {
+    /**
+     * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
+     * @summary Delete a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve a single value framework by its ID.
+     * @summary Get a value framework by ID
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValueFrameworkResponse>>;
+    /**
+     * Retrieve a paginated list of all value frameworks.
+     * @summary List value frameworks
+     * @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}
+     */
+    getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ValueFrameworkResponse>>>;
+    /**
+     * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ValueFrameworkUpdate} valueFrameworkUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValueFrameworkResponse>>;
+    /**
+     * Create a new value framework. Name must be unique and non-empty.
+     * @summary Create a value framework
+     * @param {ValueFrameworkCreate} valueFrameworkCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValueFrameworkResponse>>;
+};
+/**
+ * ValueFrameworkApi - factory interface
+ * @export
+ */
+export declare const ValueFrameworkApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
+     * @summary Delete a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteValueFramework(valueFrameworkId: string, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieve a single value framework by its ID.
+     * @summary Get a value framework by ID
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getValueFrameworkById(valueFrameworkId: string, options?: any): AxiosPromise<ValueFrameworkResponse>;
+    /**
+     * Retrieve a paginated list of all value frameworks.
+     * @summary List value frameworks
+     * @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}
+     */
+    getValueFrameworks(offset?: number, limit?: number, options?: any): AxiosPromise<Array<ValueFrameworkResponse>>;
+    /**
+     * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ValueFrameworkUpdate} valueFrameworkUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: any): AxiosPromise<ValueFrameworkResponse>;
+    /**
+     * Create a new value framework. Name must be unique and non-empty.
+     * @summary Create a value framework
+     * @param {ValueFrameworkCreate} valueFrameworkCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?: any): AxiosPromise<ValueFrameworkResponse>;
+};
+/**
+ * ValueFrameworkApi - object-oriented interface
+ * @export
+ * @class ValueFrameworkApi
+ * @extends {BaseAPI}
+ */
+export declare class ValueFrameworkApi extends BaseAPI {
+    /**
+     * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
+     * @summary Delete a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ValueFrameworkApi
+     */
+    deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieve a single value framework by its ID.
+     * @summary Get a value framework by ID
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ValueFrameworkApi
+     */
+    getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse, any, {}>>;
+    /**
+     * Retrieve a paginated list of all value frameworks.
+     * @summary List value frameworks
+     * @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}
+     * @memberof ValueFrameworkApi
+     */
+    getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse[], any, {}>>;
+    /**
+     * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ValueFrameworkUpdate} valueFrameworkUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ValueFrameworkApi
+     */
+    patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse, any, {}>>;
+    /**
+     * Create a new value framework. Name must be unique and non-empty.
+     * @summary Create a value framework
+     * @param {ValueFrameworkCreate} valueFrameworkCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ValueFrameworkApi
+     */
+    postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse, any, {}>>;
+}