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

package/dist/esm/api/objective-weight-api.d.ts

@@ -0,0 +1,225 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * 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 { ObjectiveWeightCreate } from '../models';
+import type { ObjectiveWeightResponse } from '../models';
+import type { ObjectiveWeightUpdate } from '../models';
+/**
+ * ObjectiveWeightApi - axios parameter creator
+ */
+export declare const ObjectiveWeightApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Assign a weight to an objective within this framework.
+     * @summary Create an objective weight for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightCreate} objectiveWeightCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createObjectiveWeightForFramework: (valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Remove an objective weight from this framework.
+     * @summary Delete an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve the weight for a specific objective within this framework.
+     * @summary Get an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific framework.
+     * @summary List objective weights for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {number} [offset] Number of records to skip
+     * @param {number} [limit] Max number of records to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightsForFramework: (valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update the weight of an objective within this value framework.
+     * @summary Partially update an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ObjectiveWeightApi - functional programming interface
+ */
+export declare const ObjectiveWeightApiFp: (configuration?: Configuration) => {
+    /**
+     * Assign a weight to an objective within this framework.
+     * @summary Create an objective weight for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightCreate} objectiveWeightCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
+    /**
+     * Remove an objective weight from this framework.
+     * @summary Delete an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve the weight for a specific objective within this framework.
+     * @summary Get an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific framework.
+     * @summary List objective weights for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {number} [offset] Number of records to skip
+     * @param {number} [limit] Max number of records to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectiveWeightResponse>>>;
+    /**
+     * Update the weight of an objective within this value framework.
+     * @summary Partially update an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
+};
+/**
+ * ObjectiveWeightApi - factory interface
+ */
+export declare const ObjectiveWeightApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Assign a weight to an objective within this framework.
+     * @summary Create an objective weight for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightCreate} objectiveWeightCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse>;
+    /**
+     * Remove an objective weight from this framework.
+     * @summary Delete an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieve the weight for a specific objective within this framework.
+     * @summary Get an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific framework.
+     * @summary List objective weights for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {number} [offset] Number of records to skip
+     * @param {number} [limit] Max number of records to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectiveWeightResponse>>;
+    /**
+     * Update the weight of an objective within this value framework.
+     * @summary Partially update an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse>;
+};
+/**
+ * ObjectiveWeightApi - object-oriented interface
+ */
+export declare class ObjectiveWeightApi extends BaseAPI {
+    /**
+     * Assign a weight to an objective within this framework.
+     * @summary Create an objective weight for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightCreate} objectiveWeightCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
+    /**
+     * Remove an objective weight from this framework.
+     * @summary Delete an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieve the weight for a specific objective within this framework.
+     * @summary Get an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific framework.
+     * @summary List objective weights for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {number} [offset] Number of records to skip
+     * @param {number} [limit] Max number of records to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse[], any, {}>>;
+    /**
+     * Update the weight of an objective within this value framework.
+     * @summary Partially update an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
+}