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

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

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -11,218 +11,215 @@
  */
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
-import { RequestArgs, BaseAPI } from '../base';
-import { ObjectiveWeightCreate } from '../models';
-import { ObjectiveWeightResponse } from '../models';
-import { ObjectiveWeightUpdate } from '../models';
+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
  */
 export declare const ObjectiveWeightApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * 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
+     * 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}
      */
-    deleteObjectiveWeight: (frameworkId: string, objectiveId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    deleteObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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
+     * 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}
      */
-    getObjectiveWeightByKeys: (frameworkId: string, objectiveId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieve a paginated list of all objective-framework weight assignments.
-     * @summary List objective weights
+     * 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}
      */
-    getObjectiveWeights: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getObjectiveWeightsForFramework: (valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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
+     * 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}
      */
-    patchObjectiveWeight: (frameworkId: string, objectiveId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * 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: ObjectiveWeightCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    patchObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ObjectiveWeightApi - functional programming interface
- * @export
  */
 export declare const ObjectiveWeightApiFp: (configuration?: Configuration) => {
     /**
-     * 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
+     * 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}
      */
-    deleteObjectiveWeight(frameworkId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * 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
+     * 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}
      */
-    getObjectiveWeightByKeys(frameworkId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
+    getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
     /**
-     * Retrieve a paginated list of all objective-framework weight assignments.
-     * @summary List objective weights
+     * 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}
      */
-    getObjectiveWeights(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectiveWeightResponse>>>;
+    getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectiveWeightResponse>>>;
     /**
-     * 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
+     * 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}
      */
-    patchObjectiveWeight(frameworkId: string, objectiveId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
-    /**
-     * 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: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
+    patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
 };
 /**
  * ObjectiveWeightApi - factory interface
- * @export
  */
 export declare const ObjectiveWeightApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * 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
+     * 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}
      */
-    deleteObjectiveWeight(frameworkId: string, objectiveId: string, options?: any): AxiosPromise<void>;
+    deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     * 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
+     * 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}
      */
-    getObjectiveWeightByKeys(frameworkId: string, objectiveId: string, options?: any): AxiosPromise<ObjectiveWeightResponse>;
+    getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse>;
     /**
-     * Retrieve a paginated list of all objective-framework weight assignments.
-     * @summary List objective weights
+     * 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}
      */
-    getObjectiveWeights(offset?: number, limit?: number, options?: any): AxiosPromise<Array<ObjectiveWeightResponse>>;
+    getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectiveWeightResponse>>;
     /**
-     * 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
+     * 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}
      */
-    patchObjectiveWeight(frameworkId: string, objectiveId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: any): AxiosPromise<ObjectiveWeightResponse>;
-    /**
-     * 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: ObjectiveWeightCreate, options?: any): AxiosPromise<ObjectiveWeightResponse>;
+    patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse>;
 };
 /**
  * ObjectiveWeightApi - object-oriented interface
- * @export
- * @class ObjectiveWeightApi
- * @extends {BaseAPI}
  */
 export declare 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
+     * 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}
-     * @memberof ObjectiveWeightApi
      */
-    deleteObjectiveWeight(frameworkId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
-     * 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
+     * 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}
-     * @memberof ObjectiveWeightApi
      */
-    getObjectiveWeightByKeys(frameworkId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
+    getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
     /**
-     * Retrieve a paginated list of all objective-framework weight assignments.
-     * @summary List objective weights
+     * 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}
-     * @memberof ObjectiveWeightApi
      */
-    getObjectiveWeights(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse[], any, {}>>;
+    getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse[], any, {}>>;
     /**
-     * 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
+     * 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}
-     * @memberof ObjectiveWeightApi
-     */
-    patchObjectiveWeight(frameworkId: string, objectiveId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
-    /**
-     * 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: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
+    patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
 }