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

package/dist/api/metric-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,206 +11,215 @@
  */
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
-import { RequestArgs, BaseAPI } from '../base';
-import { MetricCreate } from '../models';
-import { MetricResponse } from '../models';
-import { MetricUpdate } from '../models';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { MetricCreate } from '../models';
+import type { MetricResponse } from '../models';
+import type { MetricUpdate } from '../models';
 /**
  * MetricApi - axios parameter creator
- * @export
  */
 export declare const MetricApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a new metric under this objective.
+     * @summary Create a metric for this objective
+     * @param {string} objectiveId UUID of the objective
+     * @param {MetricCreate} metricCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMetricForObjective: (objectiveId: string, metricCreate: MetricCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
-     * @summary Delete a metric
+     * @summary Delete a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteMetric: (metricId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    deleteMetricForObjective: (metricId: string, objectiveId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieve a single metric by its ID.
-     * @summary Get a metric by ID
+     * Retrieve a specific metric for the objective.
+     * @summary Get a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getMetricById: (metricId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getMetricForObjective: (metricId: string, objectiveId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieve a paginated list of all metrics.
-     * @summary List metrics
+     * Retrieve a paginated list of all metrics for a specific objective.
+     * @summary List metrics for this objective
+     * @param {string} objectiveId UUID of the objective
      * @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}
      */
-    getMetrics: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getMetricsForObjective: (objectiveId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
-     * @summary Partially update a metric
+     * @summary Partially update a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {MetricUpdate} metricUpdate
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    patchMetric: (metricId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
-     * @summary Create a metric
-     * @param {MetricCreate} metricCreate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    postMetric: (metricCreate: MetricCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    patchMetricForObjective: (metricId: string, objectiveId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * MetricApi - functional programming interface
- * @export
  */
 export declare const MetricApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a new metric under this objective.
+     * @summary Create a metric for this objective
+     * @param {string} objectiveId UUID of the objective
+     * @param {MetricCreate} metricCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMetricForObjective(objectiveId: string, metricCreate: MetricCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricResponse>>;
     /**
      * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
-     * @summary Delete a metric
+     * @summary Delete a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteMetric(metricId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    deleteMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Retrieve a single metric by its ID.
-     * @summary Get a metric by ID
+     * Retrieve a specific metric for the objective.
+     * @summary Get a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getMetricById(metricId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricResponse>>;
+    getMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricResponse>>;
     /**
-     * Retrieve a paginated list of all metrics.
-     * @summary List metrics
+     * Retrieve a paginated list of all metrics for a specific objective.
+     * @summary List metrics for this objective
+     * @param {string} objectiveId UUID of the objective
      * @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}
      */
-    getMetrics(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricResponse>>>;
+    getMetricsForObjective(objectiveId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricResponse>>>;
     /**
      * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
-     * @summary Partially update a metric
+     * @summary Partially update a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {MetricUpdate} metricUpdate
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    patchMetric(metricId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricResponse>>;
-    /**
-     * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
-     * @summary Create a metric
-     * @param {MetricCreate} metricCreate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    postMetric(metricCreate: MetricCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricResponse>>;
+    patchMetricForObjective(metricId: string, objectiveId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricResponse>>;
 };
 /**
  * MetricApi - factory interface
- * @export
  */
 export declare const MetricApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a new metric under this objective.
+     * @summary Create a metric for this objective
+     * @param {string} objectiveId UUID of the objective
+     * @param {MetricCreate} metricCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMetricForObjective(objectiveId: string, metricCreate: MetricCreate, options?: RawAxiosRequestConfig): AxiosPromise<MetricResponse>;
     /**
      * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
-     * @summary Delete a metric
+     * @summary Delete a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteMetric(metricId: string, options?: any): AxiosPromise<void>;
+    deleteMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     * Retrieve a single metric by its ID.
-     * @summary Get a metric by ID
+     * Retrieve a specific metric for the objective.
+     * @summary Get a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getMetricById(metricId: string, options?: any): AxiosPromise<MetricResponse>;
+    getMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): AxiosPromise<MetricResponse>;
     /**
-     * Retrieve a paginated list of all metrics.
-     * @summary List metrics
+     * Retrieve a paginated list of all metrics for a specific objective.
+     * @summary List metrics for this objective
+     * @param {string} objectiveId UUID of the objective
      * @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}
      */
-    getMetrics(offset?: number, limit?: number, options?: any): AxiosPromise<Array<MetricResponse>>;
+    getMetricsForObjective(objectiveId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricResponse>>;
     /**
      * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
-     * @summary Partially update a metric
+     * @summary Partially update a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {MetricUpdate} metricUpdate
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    patchMetric(metricId: string, metricUpdate: MetricUpdate, options?: any): AxiosPromise<MetricResponse>;
-    /**
-     * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
-     * @summary Create a metric
-     * @param {MetricCreate} metricCreate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    postMetric(metricCreate: MetricCreate, options?: any): AxiosPromise<MetricResponse>;
+    patchMetricForObjective(metricId: string, objectiveId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig): AxiosPromise<MetricResponse>;
 };
 /**
  * MetricApi - object-oriented interface
- * @export
- * @class MetricApi
- * @extends {BaseAPI}
  */
 export declare class MetricApi extends BaseAPI {
+    /**
+     * Create a new metric under this objective.
+     * @summary Create a metric for this objective
+     * @param {string} objectiveId UUID of the objective
+     * @param {MetricCreate} metricCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMetricForObjective(objectiveId: string, metricCreate: MetricCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse, any, {}>>;
     /**
      * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
-     * @summary Delete a metric
+     * @summary Delete a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof MetricApi
      */
-    deleteMetric(metricId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    deleteMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
-     * Retrieve a single metric by its ID.
-     * @summary Get a metric by ID
+     * Retrieve a specific metric for the objective.
+     * @summary Get a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof MetricApi
      */
-    getMetricById(metricId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse, any, {}>>;
+    getMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse, any, {}>>;
     /**
-     * Retrieve a paginated list of all metrics.
-     * @summary List metrics
+     * Retrieve a paginated list of all metrics for a specific objective.
+     * @summary List metrics for this objective
+     * @param {string} objectiveId UUID of the objective
      * @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 MetricApi
      */
-    getMetrics(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse[], any, {}>>;
+    getMetricsForObjective(objectiveId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse[], any, {}>>;
     /**
      * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
-     * @summary Partially update a metric
+     * @summary Partially update a metric for this objective
      * @param {string} metricId UUID of the metric
+     * @param {string} objectiveId UUID of the objective
      * @param {MetricUpdate} metricUpdate
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof MetricApi
-     */
-    patchMetric(metricId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse, any, {}>>;
-    /**
-     * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
-     * @summary Create a metric
-     * @param {MetricCreate} metricCreate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof MetricApi
      */
-    postMetric(metricCreate: MetricCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse, any, {}>>;
+    patchMetricForObjective(metricId: string, objectiveId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse, any, {}>>;
 }