@openshift-migration-advisor/agent-sdk 0.12.0-1f1dc16fb9e5 → 0.12.0-e6e9d25bdc36

package/docs/DefaultApi.md

@@ -17,7 +17,9 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
 | [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /inspector | Get inspector status |
 | [**getInspectorVddkStatus**](DefaultApi.md#getinspectorvddkstatus) | **GET** /inspector/vddk | Get VDDK status |
 | [**getInventory**](DefaultApi.md#getinventory) | **GET** /inventory | Get collected inventory |
+| [**getLatestRightsizingClusters**](DefaultApi.md#getlatestrightsizingclusters) | **GET** /cluster_rightsizing | Get cluster-level utilization aggregates for the latest completed report |
 | [**getRightsizingReport**](DefaultApi.md#getrightsizingreport) | **GET** /rightsizing/{id} | Get a specific rightsizing report with full VM metrics |
+| [**getRightsizingReportClusters**](DefaultApi.md#getrightsizingreportclusters) | **GET** /cluster_rightsizing/{report_id} | Get cluster-level utilization aggregates for a specific report |
 | [**getVM**](DefaultApi.md#getvm) | **GET** /vms/{id} | Get details about a vm |
 | [**getVMUtilization**](DefaultApi.md#getvmutilization) | **GET** /vms/{id}/utilization | Get utilization breakdown for a specific VM |
 | [**getVMs**](DefaultApi.md#getvms) | **GET** /vms | Get list of VMs with filtering and pagination |
@@ -897,6 +899,65 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getLatestRightsizingClusters
+
+> RightsizingClusterListResponse getLatestRightsizingClusters()
+
+Get cluster-level utilization aggregates for the latest completed report
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '@openshift-migration-advisor/agent-sdk';
+import type { GetLatestRightsizingClustersRequest } from '@openshift-migration-advisor/agent-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
+  const api = new DefaultApi();
+
+  try {
+    const data = await api.getLatestRightsizingClusters();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Cluster utilization aggregates |  -  |
+| **404** | No completed rightsizing report found |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getRightsizingReport
 
 > RightsizingReport getRightsizingReport(id)
@@ -964,6 +1025,73 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getRightsizingReportClusters
+
+> RightsizingClusterListResponse getRightsizingReportClusters(reportId)
+
+Get cluster-level utilization aggregates for a specific report
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '@openshift-migration-advisor/agent-sdk';
+import type { GetRightsizingReportClustersRequest } from '@openshift-migration-advisor/agent-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
+  const api = new DefaultApi();
+
+  const body = {
+    // string | Rightsizing report UUID
+    reportId: reportId_example,
+  } satisfies GetRightsizingReportClustersRequest;
+
+  try {
+    const data = await api.getRightsizingReportClusters(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
+
+### Return type
+
+[**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Cluster utilization aggregates |  -  |
+| **404** | Report not found |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getVM
 
 > VirtualMachineDetail getVM(id)

package/docs/RightsizingClusterListResponse.md

@@ -0,0 +1,36 @@
+
+# RightsizingClusterListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reportId` | string
+`clusters` | [Array<RightsizingClusterUtilization>](RightsizingClusterUtilization.md)
+
+## Example
+
+```typescript
+import type { RightsizingClusterListResponse } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reportId": null,
+  "clusters": null,
+} satisfies RightsizingClusterListResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RightsizingClusterListResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RightsizingClusterUtilization.md

@@ -0,0 +1,58 @@
+
+# RightsizingClusterUtilization
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clusterId` | string
+`vmCount` | number
+`cpuAvg` | number
+`cpuP95` | number
+`cpuMax` | number
+`memAvg` | number
+`memP95` | number
+`memMax` | number
+`disk` | number
+`confidence` | number
+`totalProvisionedCpus` | number
+`totalProvisionedMemoryMb` | number
+`totalProvisionedDiskKb` | number
+
+## Example
+
+```typescript
+import type { RightsizingClusterUtilization } from '@openshift-migration-advisor/agent-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "clusterId": null,
+  "vmCount": null,
+  "cpuAvg": null,
+  "cpuP95": null,
+  "cpuMax": null,
+  "memAvg": null,
+  "memP95": null,
+  "memMax": null,
+  "disk": null,
+  "confidence": null,
+  "totalProvisionedCpus": null,
+  "totalProvisionedMemoryMb": null,
+  "totalProvisionedDiskKb": null,
+} satisfies RightsizingClusterUtilization
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RightsizingClusterUtilization
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/VmUtilizationDetails.md

@@ -8,6 +8,9 @@ Name | Type
 ------------ | -------------
 `moid` | string
 `vmName` | string
+`provisionedCpus` | number
+`provisionedMemoryMb` | number
+`provisionedDiskKb` | number
 `cpuAvg` | number
 `cpuP95` | number
 `cpuMax` | number
@@ -28,6 +31,9 @@ import type { VmUtilizationDetails } from '@openshift-migration-advisor/agent-sd
 const example = {
   "moid": null,
   "vmName": null,
+  "provisionedCpus": null,
+  "provisionedMemoryMb": null,
+  "provisionedDiskKb": null,
   "cpuAvg": null,
   "cpuP95": null,
   "cpuMax": null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openshift-migration-advisor/agent-sdk",
-  "version": "0.12.0-1f1dc16fb9e5",
+  "version": "0.12.0-e6e9d25bdc36",
   "description": "OpenAPI client for @openshift-migration-advisor/agent-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/DefaultApi.ts

@@ -108,6 +108,11 @@ import {
     PutForecasterCredentials403ResponseFromJSON,
     PutForecasterCredentials403ResponseToJSON,
 } from '../models/PutForecasterCredentials403Response.js';
+import {
+    type RightsizingClusterListResponse,
+    RightsizingClusterListResponseFromJSON,
+    RightsizingClusterListResponseToJSON,
+} from '../models/RightsizingClusterListResponse.js';
 import {
     type RightsizingCollectRequest,
     RightsizingCollectRequestFromJSON,
@@ -224,6 +229,10 @@ export interface GetRightsizingReportRequest {
     id: string;
 }
 
+export interface GetRightsizingReportClustersRequest {
+    reportId: string;
+}
+
 export interface GetVMRequest {
     id: string;
 }
@@ -606,6 +615,27 @@ export interface DefaultApiInterface {
      */
     getInventory(requestParameters: GetInventoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetInventory200Response>;
 
+    /**
+     * Creates request options for getLatestRightsizingClusters without sending the request
+     * @throws {RequiredError}
+     * @memberof DefaultApiInterface
+     */
+    getLatestRightsizingClustersRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get cluster-level utilization aggregates for the latest completed report
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApiInterface
+     */
+    getLatestRightsizingClustersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RightsizingClusterListResponse>>;
+
+    /**
+     * Get cluster-level utilization aggregates for the latest completed report
+     */
+    getLatestRightsizingClusters(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RightsizingClusterListResponse>;
+
     /**
      * Creates request options for getRightsizingReport without sending the request
      * @param {string} id Report UUID
@@ -629,6 +659,29 @@ export interface DefaultApiInterface {
      */
     getRightsizingReport(requestParameters: GetRightsizingReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RightsizingReport>;
 
+    /**
+     * Creates request options for getRightsizingReportClusters without sending the request
+     * @param {string} reportId Rightsizing report UUID
+     * @throws {RequiredError}
+     * @memberof DefaultApiInterface
+     */
+    getRightsizingReportClustersRequestOpts(requestParameters: GetRightsizingReportClustersRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get cluster-level utilization aggregates for a specific report
+     * @param {string} reportId Rightsizing report UUID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApiInterface
+     */
+    getRightsizingReportClustersRaw(requestParameters: GetRightsizingReportClustersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RightsizingClusterListResponse>>;
+
+    /**
+     * Get cluster-level utilization aggregates for a specific report
+     */
+    getRightsizingReportClusters(requestParameters: GetRightsizingReportClustersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RightsizingClusterListResponse>;
+
     /**
      * Creates request options for getVM without sending the request
      * @param {string} id VirtualMachine id
@@ -1693,6 +1746,43 @@ export class DefaultApi extends runtime.BaseAPI implements DefaultApiInterface {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getLatestRightsizingClusters without sending the request
+     */
+    async getLatestRightsizingClustersRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/cluster_rightsizing`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get cluster-level utilization aggregates for the latest completed report
+     */
+    async getLatestRightsizingClustersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RightsizingClusterListResponse>> {
+        const requestOptions = await this.getLatestRightsizingClustersRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RightsizingClusterListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get cluster-level utilization aggregates for the latest completed report
+     */
+    async getLatestRightsizingClusters(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RightsizingClusterListResponse> {
+        const response = await this.getLatestRightsizingClustersRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getRightsizingReport without sending the request
      */
@@ -1738,6 +1828,51 @@ export class DefaultApi extends runtime.BaseAPI implements DefaultApiInterface {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getRightsizingReportClusters without sending the request
+     */
+    async getRightsizingReportClustersRequestOpts(requestParameters: GetRightsizingReportClustersRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['reportId'] == null) {
+            throw new runtime.RequiredError(
+                'reportId',
+                'Required parameter "reportId" was null or undefined when calling getRightsizingReportClusters().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/cluster_rightsizing/{report_id}`;
+        urlPath = urlPath.replace('{report_id}', encodeURIComponent(String(requestParameters['reportId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get cluster-level utilization aggregates for a specific report
+     */
+    async getRightsizingReportClustersRaw(requestParameters: GetRightsizingReportClustersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RightsizingClusterListResponse>> {
+        const requestOptions = await this.getRightsizingReportClustersRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RightsizingClusterListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get cluster-level utilization aggregates for a specific report
+     */
+    async getRightsizingReportClusters(requestParameters: GetRightsizingReportClustersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RightsizingClusterListResponse> {
+        const response = await this.getRightsizingReportClustersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getVM without sending the request
      */

package/src/models/RightsizingClusterListResponse.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Assisted Migration Agent API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime.js';
+import type { RightsizingClusterUtilization } from './RightsizingClusterUtilization.js';
+import {
+    RightsizingClusterUtilizationFromJSON,
+    RightsizingClusterUtilizationFromJSONTyped,
+    RightsizingClusterUtilizationToJSON,
+    RightsizingClusterUtilizationToJSONTyped,
+} from './RightsizingClusterUtilization.js';
+
+/**
+ * 
+ * @export
+ * @interface RightsizingClusterListResponse
+ */
+export interface RightsizingClusterListResponse {
+    /**
+     * The report ID this data was aggregated from
+     * @type {string}
+     * @memberof RightsizingClusterListResponse
+     */
+    reportId: string;
+    /**
+     * 
+     * @type {Array<RightsizingClusterUtilization>}
+     * @memberof RightsizingClusterListResponse
+     */
+    clusters: Array<RightsizingClusterUtilization>;
+}
+
+/**
+ * Check if a given object implements the RightsizingClusterListResponse interface.
+ */
+export function instanceOfRightsizingClusterListResponse(value: object): value is RightsizingClusterListResponse {
+    if (!('reportId' in value) || value['reportId'] === undefined) return false;
+    if (!('clusters' in value) || value['clusters'] === undefined) return false;
+    return true;
+}
+
+export function RightsizingClusterListResponseFromJSON(json: any): RightsizingClusterListResponse {
+    return RightsizingClusterListResponseFromJSONTyped(json, false);
+}
+
+export function RightsizingClusterListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RightsizingClusterListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'reportId': json['report_id'],
+        'clusters': ((json['clusters'] as Array<any>).map(RightsizingClusterUtilizationFromJSON)),
+    };
+}
+
+export function RightsizingClusterListResponseToJSON(json: any): RightsizingClusterListResponse {
+    return RightsizingClusterListResponseToJSONTyped(json, false);
+}
+
+export function RightsizingClusterListResponseToJSONTyped(value?: RightsizingClusterListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'report_id': value['reportId'],
+        'clusters': ((value['clusters'] as Array<any>).map(RightsizingClusterUtilizationToJSON)),
+    };
+}
+