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

package/dist/api/metric-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 { MetricCreate } from '../models';
+import type { MetricResponse } from '../models';
+import type { MetricUpdate } from '../models';
+/**
+ * MetricApi - axios parameter creator
+ */
+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 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}
+     */
+    deleteMetricForObjective: (metricId: string, objectiveId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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}
+     */
+    getMetricForObjective: (metricId: string, objectiveId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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}
+     */
+    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 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}
+     */
+    patchMetricForObjective: (metricId: string, objectiveId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MetricApi - functional programming interface
+ */
+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 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}
+     */
+    deleteMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * 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}
+     */
+    getMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricResponse>>;
+    /**
+     * 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}
+     */
+    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 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}
+     */
+    patchMetricForObjective(metricId: string, objectiveId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricResponse>>;
+};
+/**
+ * MetricApi - factory interface
+ */
+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 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}
+     */
+    deleteMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * 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}
+     */
+    getMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): AxiosPromise<MetricResponse>;
+    /**
+     * 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}
+     */
+    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 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}
+     */
+    patchMetricForObjective(metricId: string, objectiveId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig): AxiosPromise<MetricResponse>;
+};
+/**
+ * MetricApi - object-oriented interface
+ */
+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 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}
+     */
+    deleteMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * 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}
+     */
+    getMetricForObjective(metricId: string, objectiveId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse, any, {}>>;
+    /**
+     * 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}
+     */
+    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 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}
+     */
+    patchMetricForObjective(metricId: string, objectiveId: string, metricUpdate: MetricUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricResponse, any, {}>>;
+}