Merge pull request #105 from TaskarCenterAtUW/feature-generate-api-client

github-actions[bot] · web-flow · commit 80e892cffae6 · 2025-02-20T07:09:25.000Z
system:auto generated API client
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-## tdei-client@1.1.81
+## tdei-client@1.1.82
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install tdei-client@1.1.81 --save
+npm install tdei-client@1.1.82 --save
 ```
 
 _unPublished (not recommended):_
diff --git a/apis/metrics-api.ts b/apis/metrics-api.ts
@@ -79,11 +79,17 @@ export const MetricsApiAxiosParamCreator = function (configuration?: Configurati
         /**
          * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
          * @summary Gets the Service metrics
+         * @param {string} tdei_project_group_id Project Group id of the dataset.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        serviceMetrics: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/api/v1/service-metrics/{tdei_project_group_id}`;
+        serviceMetrics: async (tdei_project_group_id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'tdei_project_group_id' is not null or undefined
+            if (tdei_project_group_id === null || tdei_project_group_id === undefined) {
+                throw new RequiredError('tdei_project_group_id','Required parameter tdei_project_group_id was null or undefined when calling serviceMetrics.');
+            }
+            const localVarPath = `/api/v1/service-metrics/{tdei_project_group_id}`
+                .replace(`{${"tdei_project_group_id"}}`, encodeURIComponent(String(tdei_project_group_id)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, 'https://example.com');
             let baseOptions;
@@ -203,11 +209,12 @@ export const MetricsApiFp = function(configuration?: Configuration) {
         /**
          * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
          * @summary Gets the Service metrics
+         * @param {string} tdei_project_group_id Project Group id of the dataset.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async serviceMetrics(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<any>>> {
-            const localVarAxiosArgs = await MetricsApiAxiosParamCreator(configuration).serviceMetrics(options);
+        async serviceMetrics(tdei_project_group_id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<any>>> {
+            const localVarAxiosArgs = await MetricsApiAxiosParamCreator(configuration).serviceMetrics(tdei_project_group_id, options);
             return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
                 const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
                 return axios.request(axiosRequestArgs);
@@ -247,11 +254,12 @@ export const MetricsApiFactory = function (configuration?: Configuration, basePa
         /**
          * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
          * @summary Gets the Service metrics
+         * @param {string} tdei_project_group_id Project Group id of the dataset.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async serviceMetrics(options?: AxiosRequestConfig): Promise<AxiosResponse<any>> {
-            return MetricsApiFp(configuration).serviceMetrics(options).then((request) => request(axios, basePath));
+        async serviceMetrics(tdei_project_group_id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<any>> {
+            return MetricsApiFp(configuration).serviceMetrics(tdei_project_group_id, options).then((request) => request(axios, basePath));
         },
         /**
          * Retrieves metrics related to the system and datasets within the TDEI platform. This endpoint provides an overview of usage statistics including the total number of users, services, and project groups, as well as a breakdown of services by type. Additionally, it gives details on dataset uploads, such as the total number of uploads and their cumulative size in megabytes.
@@ -285,12 +293,13 @@ export class MetricsApi extends BaseAPI {
     /**
      * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
      * @summary Gets the Service metrics
+     * @param {string} tdei_project_group_id Project Group id of the dataset.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MetricsApi
      */
-    public async serviceMetrics(options?: AxiosRequestConfig) : Promise<AxiosResponse<any>> {
-        return MetricsApiFp(this.configuration).serviceMetrics(options).then((request) => request(this.axios, this.basePath));
+    public async serviceMetrics(tdei_project_group_id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<any>> {
+        return MetricsApiFp(this.configuration).serviceMetrics(tdei_project_group_id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Retrieves metrics related to the system and datasets within the TDEI platform. This endpoint provides an overview of usage statistics including the total number of users, services, and project groups, as well as a breakdown of services by type. Additionally, it gives details on dataset uploads, such as the total number of uploads and their cumulative size in megabytes.
diff --git a/dist/apis/metrics-api.d.ts b/dist/apis/metrics-api.d.ts
@@ -27,10 +27,11 @@ export declare const MetricsApiAxiosParamCreator: (configuration?: Configuration
     /**
      * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
      * @summary Gets the Service metrics
+     * @param {string} tdei_project_group_id Project Group id of the dataset.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    serviceMetrics: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    serviceMetrics: (tdei_project_group_id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieves metrics related to the system and datasets within the TDEI platform. This endpoint provides an overview of usage statistics including the total number of users, services, and project groups, as well as a breakdown of services by type. Additionally, it gives details on dataset uploads, such as the total number of uploads and their cumulative size in megabytes.
      * @summary Gets the system metrics
@@ -54,10 +55,11 @@ export declare const MetricsApiFp: (configuration?: Configuration) => {
     /**
      * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
      * @summary Gets the Service metrics
+     * @param {string} tdei_project_group_id Project Group id of the dataset.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    serviceMetrics(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<any>>>;
+    serviceMetrics(tdei_project_group_id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<any>>>;
     /**
      * Retrieves metrics related to the system and datasets within the TDEI platform. This endpoint provides an overview of usage statistics including the total number of users, services, and project groups, as well as a breakdown of services by type. Additionally, it gives details on dataset uploads, such as the total number of uploads and their cumulative size in megabytes.
      * @summary Gets the system metrics
@@ -81,10 +83,11 @@ export declare const MetricsApiFactory: (configuration?: Configuration, basePath
     /**
      * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
      * @summary Gets the Service metrics
+     * @param {string} tdei_project_group_id Project Group id of the dataset.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    serviceMetrics(options?: AxiosRequestConfig): Promise<AxiosResponse<any>>;
+    serviceMetrics(tdei_project_group_id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<any>>;
     /**
      * Retrieves metrics related to the system and datasets within the TDEI platform. This endpoint provides an overview of usage statistics including the total number of users, services, and project groups, as well as a breakdown of services by type. Additionally, it gives details on dataset uploads, such as the total number of uploads and their cumulative size in megabytes.
      * @summary Gets the system metrics
@@ -111,11 +114,12 @@ export declare class MetricsApi extends BaseAPI {
     /**
      * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
      * @summary Gets the Service metrics
+     * @param {string} tdei_project_group_id Project Group id of the dataset.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MetricsApi
      */
-    serviceMetrics(options?: AxiosRequestConfig): Promise<AxiosResponse<any>>;
+    serviceMetrics(tdei_project_group_id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<any>>;
     /**
      * Retrieves metrics related to the system and datasets within the TDEI platform. This endpoint provides an overview of usage statistics including the total number of users, services, and project groups, as well as a breakdown of services by type. Additionally, it gives details on dataset uploads, such as the total number of uploads and their cumulative size in megabytes.
      * @summary Gets the system metrics
diff --git a/dist/apis/metrics-api.js b/dist/apis/metrics-api.js
@@ -159,17 +159,23 @@ var MetricsApiAxiosParamCreator = function (configuration) {
         /**
          * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
          * @summary Gets the Service metrics
+         * @param {string} tdei_project_group_id Project Group id of the dataset.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        serviceMetrics: function (options) {
+        serviceMetrics: function (tdei_project_group_id, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, localVarApiKeyValue, _a, accessToken, _b, query, key, key, headersFromBaseOptions;
                 return __generator(this, function (_c) {
                     switch (_c.label) {
                         case 0:
-                            localVarPath = "/api/v1/service-metrics/{tdei_project_group_id}";
+                            // verify required parameter 'tdei_project_group_id' is not null or undefined
+                            if (tdei_project_group_id === null || tdei_project_group_id === undefined) {
+                                throw new base_1.RequiredError('tdei_project_group_id', 'Required parameter tdei_project_group_id was null or undefined when calling serviceMetrics.');
+                            }
+                            localVarPath = "/api/v1/service-metrics/{tdei_project_group_id}"
+                                .replace("{".concat("tdei_project_group_id", "}"), encodeURIComponent(String(tdei_project_group_id)));
                             localVarUrlObj = new URL(localVarPath, 'https://example.com');
                             if (configuration) {
                                 baseOptions = configuration.baseOptions;
@@ -330,15 +336,16 @@ var MetricsApiFp = function (configuration) {
         /**
          * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
          * @summary Gets the Service metrics
+         * @param {string} tdei_project_group_id Project Group id of the dataset.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        serviceMetrics: function (options) {
+        serviceMetrics: function (tdei_project_group_id, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
-                        case 0: return [4 /*yield*/, (0, exports.MetricsApiAxiosParamCreator)(configuration).serviceMetrics(options)];
+                        case 0: return [4 /*yield*/, (0, exports.MetricsApiAxiosParamCreator)(configuration).serviceMetrics(tdei_project_group_id, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, function (axios, basePath) {
@@ -400,13 +407,14 @@ var MetricsApiFactory = function (configuration, basePath, axios) {
         /**
          * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
          * @summary Gets the Service metrics
+         * @param {string} tdei_project_group_id Project Group id of the dataset.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        serviceMetrics: function (options) {
+        serviceMetrics: function (tdei_project_group_id, options) {
             return __awaiter(this, void 0, void 0, function () {
                 return __generator(this, function (_a) {
-                    return [2 /*return*/, (0, exports.MetricsApiFp)(configuration).serviceMetrics(options).then(function (request) { return request(axios, basePath); })];
+                    return [2 /*return*/, (0, exports.MetricsApiFp)(configuration).serviceMetrics(tdei_project_group_id, options).then(function (request) { return request(axios, basePath); })];
                 });
             });
         },
@@ -455,15 +463,16 @@ var MetricsApi = /** @class */ (function (_super) {
     /**
      * This endpoint provides detailed metrics about datasets categorized by Project Group ID within the TDEI platform. It includes the total number of datasets and their cumulative size in megabytes for each type, such as osw, flex, and pathways.
      * @summary Gets the Service metrics
+     * @param {string} tdei_project_group_id Project Group id of the dataset.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof MetricsApi
      */
-    MetricsApi.prototype.serviceMetrics = function (options) {
+    MetricsApi.prototype.serviceMetrics = function (tdei_project_group_id, options) {
         return __awaiter(this, void 0, void 0, function () {
             var _this = this;
             return __generator(this, function (_a) {
-                return [2 /*return*/, (0, exports.MetricsApiFp)(this.configuration).serviceMetrics(options).then(function (request) { return request(_this.axios, _this.basePath); })];
+                return [2 /*return*/, (0, exports.MetricsApiFp)(this.configuration).serviceMetrics(tdei_project_group_id, options).then(function (request) { return request(_this.axios, _this.basePath); })];
             });
         });
     };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tdei-client",
-  "version": "1.1.81",
+  "version": "1.1.82",
   "description": "OpenAPI client for tdei-client",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "tdei-client",`
`3`		`- "version": "1.1.81",`
	`3`	`+ "version": "1.1.82",`
`4`	`4`	`"description": "OpenAPI client for tdei-client",`
`5`	`5`	`"author": "OpenAPI-Generator Contributors",`
`6`	`6`	`"keywords": [`