@openshift-migration-advisor/planner-sdk 0.27.0 → 0.28.0-e15db54db2a1

package/docs/JobApi.md

@@ -6,7 +6,9 @@ All URIs are relative to *https://raw.githubusercontent.com*
 |------------- | ------------- | -------------|
 | [**cancelJob**](JobApi.md#canceljob) | **DELETE** /api/v1/assessments/jobs/{id} |  |
 | [**createRVToolsAssessment**](JobApi.md#creatervtoolsassessment) | **POST** /api/v1/assessments/rvtools |  |
+| [**createRVToolsAssessmentV2**](JobApi.md#creatervtoolsassessmentv2) | **POST** /api/v2/assessments/rvtools |  |
 | [**getJob**](JobApi.md#getjob) | **GET** /api/v1/assessments/jobs/{id} |  |
+| [**uploadRvtoolsToAssessment**](JobApi.md#uploadrvtoolstoassessment) | **PUT** /api/v2/assessments/{id}/rvtools |  |
 
 
 
@@ -156,6 +158,81 @@ 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)
 
 
+## createRVToolsAssessmentV2
+
+> Job createRVToolsAssessmentV2(name, file)
+
+
+
+Create an assessment from RVTools file asynchronously
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CreateRVToolsAssessmentV2Request } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new JobApi();
+
+  const body = {
+    // string | Name of the assessment
+    name: name_example,
+    // Blob | File upload for assessment data
+    file: BINARY_DATA_HERE,
+  } satisfies CreateRVToolsAssessmentV2Request;
+
+  try {
+    const data = await api.createRVToolsAssessmentV2(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Name of the assessment | [Defaults to `undefined`] |
+| **file** | `Blob` | File upload for assessment data | [Defaults to `undefined`] |
+
+### Return type
+
+[**Job**](Job.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Accepted - Job created |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | NotFound |  -  |
+| **500** | Internal error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getJob
 
 > Job getJob(id)
@@ -227,3 +304,76 @@ 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)
 
+
+## uploadRvtoolsToAssessment
+
+> Job uploadRvtoolsToAssessment(id, file)
+
+
+
+Uploads additional RVTools data to an existing assessment and aggregates it into the main inventory asynchronously.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { UploadRvtoolsToAssessmentRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new JobApi();
+
+  const body = {
+    // string | ID of the assessment
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Blob | Rvtools extending the exising assessment
+    file: BINARY_DATA_HERE,
+  } satisfies UploadRvtoolsToAssessmentRequest;
+
+  try {
+    const data = await api.uploadRvtoolsToAssessment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | ID of the assessment | [Defaults to `undefined`] |
+| **file** | `Blob` | Rvtools extending the exising assessment | [Defaults to `undefined`] |
+
+### Return type
+
+[**Job**](Job.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Accepted - Job created |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **500** | Internal error |  -  |
+
+[[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/SubResource.md

@@ -0,0 +1,34 @@
+
+# SubResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+
+## Example
+
+```typescript
+import type { SubResource } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+} satisfies SubResource
+
+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 SubResource
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openshift-migration-advisor/planner-sdk",
-  "version": "0.27.0",
+  "version": "0.28.0-e15db54db2a1",
   "description": "OpenAPI client for @openshift-migration-advisor/planner-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AssessmentApi.ts

@@ -28,6 +28,21 @@ import {
     AssessmentUpdateFromJSON,
     AssessmentUpdateToJSON,
 } from '../models/AssessmentUpdate.js';
+import {
+    type AssessmentV2,
+    AssessmentV2FromJSON,
+    AssessmentV2ToJSON,
+} from '../models/AssessmentV2.js';
+import {
+    type AssessmentV2Summary,
+    AssessmentV2SummaryFromJSON,
+    AssessmentV2SummaryToJSON,
+} from '../models/AssessmentV2Summary.js';
+import {
+    type AssessmentVCenterV2,
+    AssessmentVCenterV2FromJSON,
+    AssessmentVCenterV2ToJSON,
+} from '../models/AssessmentVCenterV2.js';
 import {
     type ClusterRequirementsRequest,
     ClusterRequirementsRequestFromJSON,
@@ -48,6 +63,11 @@ import {
     EnhancementDataFromJSON,
     EnhancementDataToJSON,
 } from '../models/EnhancementData.js';
+import {
+    type InventoryData,
+    InventoryDataFromJSON,
+    InventoryDataToJSON,
+} from '../models/InventoryData.js';
 import {
     type MigrationComplexityRequest,
     MigrationComplexityRequestFromJSON,
@@ -162,6 +182,39 @@ export interface GetAssessmentEnhancementDataRequest {
     id: string;
 }
 
+export interface GetAssessmentV2Request {
+    /**
+     * ID of the assessment
+     */
+    id: string;
+}
+
+export interface GetVcenterRequest {
+    /**
+     * ID of the assessment
+     */
+    id: string;
+    /**
+     * ID of the vcenter
+     */
+    vid: string;
+}
+
+export interface GetVcenterClusterRequest {
+    /**
+     * ID of the assessment
+     */
+    id: string;
+    /**
+     * ID of the vcenter
+     */
+    vid: string;
+    /**
+     * ID of the cluster
+     */
+    cid: string;
+}
+
 export interface SaveAssessmentEnhancementDataRequest {
     /**
      * ID of the assessment
@@ -413,6 +466,78 @@ export interface AssessmentApiInterface {
      */
     getAssessmentEnhancementData(requestParameters: GetAssessmentEnhancementDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnhancementData>;
 
+    /**
+     * Creates request options for getAssessmentV2 without sending the request
+     * @param {string} id ID of the assessment
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getAssessmentV2RequestOpts(requestParameters: GetAssessmentV2Request): Promise<runtime.RequestOpts>;
+
+    /**
+     * Get the specified assessment inventory
+     * @param {string} id ID of the assessment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getAssessmentV2Raw(requestParameters: GetAssessmentV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssessmentV2>>;
+
+    /**
+     * Get the specified assessment inventory
+     */
+    getAssessmentV2(requestParameters: GetAssessmentV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssessmentV2>;
+
+    /**
+     * Creates request options for getVcenter without sending the request
+     * @param {string} id ID of the assessment
+     * @param {string} vid ID of the vcenter
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getVcenterRequestOpts(requestParameters: GetVcenterRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Get the specified vcenter assessment inventory
+     * @param {string} id ID of the assessment
+     * @param {string} vid ID of the vcenter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getVcenterRaw(requestParameters: GetVcenterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssessmentVCenterV2>>;
+
+    /**
+     * Get the specified vcenter assessment inventory
+     */
+    getVcenter(requestParameters: GetVcenterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssessmentVCenterV2>;
+
+    /**
+     * Creates request options for getVcenterCluster without sending the request
+     * @param {string} id ID of the assessment
+     * @param {string} vid ID of the vcenter
+     * @param {string} cid ID of the cluster
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getVcenterClusterRequestOpts(requestParameters: GetVcenterClusterRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Get the specified cluster assessment inventory
+     * @param {string} id ID of the assessment
+     * @param {string} vid ID of the vcenter
+     * @param {string} cid ID of the cluster
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getVcenterClusterRaw(requestParameters: GetVcenterClusterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InventoryData>>;
+
+    /**
+     * Get the specified cluster assessment inventory
+     */
+    getVcenterCluster(requestParameters: GetVcenterClusterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InventoryData>;
+
     /**
      * Creates request options for listAssessments without sending the request
      * @throws {RequiredError}
@@ -433,6 +558,26 @@ export interface AssessmentApiInterface {
      */
     listAssessments(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Assessment>>;
 
+    /**
+     * Creates request options for listAssessmentsV2 without sending the request
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    listAssessmentsV2RequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * List assessments
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    listAssessmentsV2Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AssessmentV2Summary>>>;
+
+    /**
+     * List assessments
+     */
+    listAssessmentsV2(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AssessmentV2Summary>>;
+
     /**
      * Creates request options for saveAssessmentEnhancementData without sending the request
      * @param {string} id ID of the assessment
@@ -990,6 +1135,165 @@ export class AssessmentApi extends runtime.BaseAPI implements AssessmentApiInter
         return await response.value();
     }
 
+    /**
+     * Creates request options for getAssessmentV2 without sending the request
+     */
+    async getAssessmentV2RequestOpts(requestParameters: GetAssessmentV2Request): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getAssessmentV2().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v2/assessments/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the specified assessment inventory
+     */
+    async getAssessmentV2Raw(requestParameters: GetAssessmentV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssessmentV2>> {
+        const requestOptions = await this.getAssessmentV2RequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AssessmentV2FromJSON(jsonValue));
+    }
+
+    /**
+     * Get the specified assessment inventory
+     */
+    async getAssessmentV2(requestParameters: GetAssessmentV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssessmentV2> {
+        const response = await this.getAssessmentV2Raw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getVcenter without sending the request
+     */
+    async getVcenterRequestOpts(requestParameters: GetVcenterRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getVcenter().'
+            );
+        }
+
+        if (requestParameters['vid'] == null) {
+            throw new runtime.RequiredError(
+                'vid',
+                'Required parameter "vid" was null or undefined when calling getVcenter().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v2/assessments/{id}/vcenters/{vid}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+        urlPath = urlPath.replace('{vid}', encodeURIComponent(String(requestParameters['vid'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the specified vcenter assessment inventory
+     */
+    async getVcenterRaw(requestParameters: GetVcenterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssessmentVCenterV2>> {
+        const requestOptions = await this.getVcenterRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AssessmentVCenterV2FromJSON(jsonValue));
+    }
+
+    /**
+     * Get the specified vcenter assessment inventory
+     */
+    async getVcenter(requestParameters: GetVcenterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssessmentVCenterV2> {
+        const response = await this.getVcenterRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getVcenterCluster without sending the request
+     */
+    async getVcenterClusterRequestOpts(requestParameters: GetVcenterClusterRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getVcenterCluster().'
+            );
+        }
+
+        if (requestParameters['vid'] == null) {
+            throw new runtime.RequiredError(
+                'vid',
+                'Required parameter "vid" was null or undefined when calling getVcenterCluster().'
+            );
+        }
+
+        if (requestParameters['cid'] == null) {
+            throw new runtime.RequiredError(
+                'cid',
+                'Required parameter "cid" was null or undefined when calling getVcenterCluster().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v2/assessments/{id}/vcenters/{vid}/clusters/{cid}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+        urlPath = urlPath.replace('{vid}', encodeURIComponent(String(requestParameters['vid'])));
+        urlPath = urlPath.replace('{cid}', encodeURIComponent(String(requestParameters['cid'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the specified cluster assessment inventory
+     */
+    async getVcenterClusterRaw(requestParameters: GetVcenterClusterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InventoryData>> {
+        const requestOptions = await this.getVcenterClusterRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InventoryDataFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the specified cluster assessment inventory
+     */
+    async getVcenterCluster(requestParameters: GetVcenterClusterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InventoryData> {
+        const response = await this.getVcenterClusterRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for listAssessments without sending the request
      */
@@ -1027,6 +1331,43 @@ export class AssessmentApi extends runtime.BaseAPI implements AssessmentApiInter
         return await response.value();
     }
 
+    /**
+     * Creates request options for listAssessmentsV2 without sending the request
+     */
+    async listAssessmentsV2RequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v2/assessments`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List assessments
+     */
+    async listAssessmentsV2Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AssessmentV2Summary>>> {
+        const requestOptions = await this.listAssessmentsV2RequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(AssessmentV2SummaryFromJSON));
+    }
+
+    /**
+     * List assessments
+     */
+    async listAssessmentsV2(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AssessmentV2Summary>> {
+        const response = await this.listAssessmentsV2Raw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for saveAssessmentEnhancementData without sending the request
      */