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

package/api/metric-costs-api.ts

@@ -0,0 +1,144 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { MetricCostsPerYearResponse } from '../models';
+/**
+ * MetricCostsApi - axios parameter creator
+ */
+export const MetricCostsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
+         * @summary List all metric costs for a metric
+         * @param {string} metricId UUID of the metric
+         * @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}
+         */
+        getCostsForMetric: async (metricId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'metricId' is not null or undefined
+            assertParamExists('getCostsForMetric', 'metricId', metricId)
+            const localVarPath = `/metric/{metric_id}/costs/`
+                .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)));
+            // 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 = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            if (offset !== undefined) {
+                localVarQueryParameter['offset'] = offset;
+            }
+
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * MetricCostsApi - functional programming interface
+ */
+export const MetricCostsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = MetricCostsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
+         * @summary List all metric costs for a metric
+         * @param {string} metricId UUID of the metric
+         * @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}
+         */
+        async getCostsForMetric(metricId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getCostsForMetric(metricId, offset, limit, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['MetricCostsApi.getCostsForMetric']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * MetricCostsApi - factory interface
+ */
+export const MetricCostsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = MetricCostsApiFp(configuration)
+    return {
+        /**
+         * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
+         * @summary List all metric costs for a metric
+         * @param {string} metricId UUID of the metric
+         * @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}
+         */
+        getCostsForMetric(metricId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>> {
+            return localVarFp.getCostsForMetric(metricId, offset, limit, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * MetricCostsApi - object-oriented interface
+ */
+export class MetricCostsApi extends BaseAPI {
+    /**
+     * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
+     * @summary List all metric costs for a metric
+     * @param {string} metricId UUID of the metric
+     * @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}
+     */
+    public getCostsForMetric(metricId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
+        return MetricCostsApiFp(this.configuration).getCostsForMetric(metricId, offset, limit, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+