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

package/dist/models/SubResource.js

@@ -0,0 +1,50 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSubResource = instanceOfSubResource;
+exports.SubResourceFromJSON = SubResourceFromJSON;
+exports.SubResourceFromJSONTyped = SubResourceFromJSONTyped;
+exports.SubResourceToJSON = SubResourceToJSON;
+exports.SubResourceToJSONTyped = SubResourceToJSONTyped;
+/**
+ * Check if a given object implements the SubResource interface.
+ */
+function instanceOfSubResource(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    return true;
+}
+function SubResourceFromJSON(json) {
+    return SubResourceFromJSONTyped(json, false);
+}
+function SubResourceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+    };
+}
+function SubResourceToJSON(json) {
+    return SubResourceToJSONTyped(json, false);
+}
+function SubResourceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+    };
+}

package/dist/models/index.d.ts

@@ -9,6 +9,9 @@ export * from './AssessmentForm.js';
 export * from './AssessmentSharing.js';
 export * from './AssessmentSubsetInventory.js';
 export * from './AssessmentUpdate.js';
+export * from './AssessmentV2.js';
+export * from './AssessmentV2Summary.js';
+export * from './AssessmentVCenterV2.js';
 export * from './ClusterFeatures.js';
 export * from './ClusterRequirementsRequest.js';
 export * from './ClusterRequirementsResponse.js';
@@ -39,6 +42,7 @@ export * from './Infra.js';
 export * from './Inventory.js';
 export * from './InventoryData.js';
 export * from './InventoryTotals.js';
+export * from './InventoryV2.js';
 export * from './Ipv4Config.js';
 export * from './IssuesBreakdown.js';
 export * from './Job.js';
@@ -81,6 +85,7 @@ export * from './StandaloneClusterRequirementsRequest.js';
 export * from './StandaloneClusterRequirementsResponse.js';
 export * from './Status.js';
 export * from './StorageIoConfiguration.js';
+export * from './SubResource.js';
 export * from './UpdateInventory.js';
 export * from './VCenter.js';
 export * from './VMResourceBreakdown.js';

package/dist/models/index.js

@@ -27,6 +27,9 @@ __exportStar(require("./AssessmentForm.js"), exports);
 __exportStar(require("./AssessmentSharing.js"), exports);
 __exportStar(require("./AssessmentSubsetInventory.js"), exports);
 __exportStar(require("./AssessmentUpdate.js"), exports);
+__exportStar(require("./AssessmentV2.js"), exports);
+__exportStar(require("./AssessmentV2Summary.js"), exports);
+__exportStar(require("./AssessmentVCenterV2.js"), exports);
 __exportStar(require("./ClusterFeatures.js"), exports);
 __exportStar(require("./ClusterRequirementsRequest.js"), exports);
 __exportStar(require("./ClusterRequirementsResponse.js"), exports);
@@ -57,6 +60,7 @@ __exportStar(require("./Infra.js"), exports);
 __exportStar(require("./Inventory.js"), exports);
 __exportStar(require("./InventoryData.js"), exports);
 __exportStar(require("./InventoryTotals.js"), exports);
+__exportStar(require("./InventoryV2.js"), exports);
 __exportStar(require("./Ipv4Config.js"), exports);
 __exportStar(require("./IssuesBreakdown.js"), exports);
 __exportStar(require("./Job.js"), exports);
@@ -99,6 +103,7 @@ __exportStar(require("./StandaloneClusterRequirementsRequest.js"), exports);
 __exportStar(require("./StandaloneClusterRequirementsResponse.js"), exports);
 __exportStar(require("./Status.js"), exports);
 __exportStar(require("./StorageIoConfiguration.js"), exports);
+__exportStar(require("./SubResource.js"), exports);
 __exportStar(require("./UpdateInventory.js"), exports);
 __exportStar(require("./VCenter.js"), exports);
 __exportStar(require("./VMResourceBreakdown.js"), exports);

package/docs/AssessmentApi.md

@@ -13,7 +13,11 @@ All URIs are relative to *https://raw.githubusercontent.com*
 | [**getAssessment**](AssessmentApi.md#getassessment) | **GET** /api/v1/assessments/{id} |  |
 | [**getAssessmentClusterRequirementsStoredInput**](AssessmentApi.md#getassessmentclusterrequirementsstoredinput) | **GET** /api/v1/assessments/{id}/cluster-requirements/stored-input |  |
 | [**getAssessmentEnhancementData**](AssessmentApi.md#getassessmentenhancementdata) | **GET** /api/v1/assessments/{id}/enhancement-data |  |
+| [**getAssessmentV2**](AssessmentApi.md#getassessmentv2) | **GET** /api/v2/assessments/{id} |  |
+| [**getVcenter**](AssessmentApi.md#getvcenter) | **GET** /api/v2/assessments/{id}/vcenters/{vid} |  |
+| [**getVcenterCluster**](AssessmentApi.md#getvcentercluster) | **GET** /api/v2/assessments/{id}/vcenters/{vid}/clusters/{cid} |  |
 | [**listAssessments**](AssessmentApi.md#listassessments) | **GET** /api/v1/assessments |  |
+| [**listAssessmentsV2**](AssessmentApi.md#listassessmentsv2) | **GET** /api/v2/assessments |  |
 | [**saveAssessmentEnhancementData**](AssessmentApi.md#saveassessmentenhancementdata) | **POST** /api/v1/assessments/{id}/enhancement-data |  |
 | [**shareAssessment**](AssessmentApi.md#shareassessment) | **POST** /api/v1/assessments/{id}/share |  |
 | [**unshareAssessment**](AssessmentApi.md#unshareassessment) | **DELETE** /api/v1/assessments/{id}/share |  |
@@ -682,6 +686,228 @@ 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)
 
 
+## getAssessmentV2
+
+> AssessmentV2 getAssessmentV2(id)
+
+
+
+Get the specified assessment inventory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetAssessmentV2Request } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AssessmentApi();
+
+  const body = {
+    // string | ID of the assessment
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetAssessmentV2Request;
+
+  try {
+    const data = await api.getAssessmentV2(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`] |
+
+### Return type
+
+[**AssessmentV2**](AssessmentV2.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **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)
+
+
+## getVcenter
+
+> AssessmentVCenterV2 getVcenter(id, vid)
+
+
+
+Get the specified vcenter assessment inventory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetVcenterRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AssessmentApi();
+
+  const body = {
+    // string | ID of the assessment
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | ID of the vcenter
+    vid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetVcenterRequest;
+
+  try {
+    const data = await api.getVcenter(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`] |
+| **vid** | `string` | ID of the vcenter | [Defaults to `undefined`] |
+
+### Return type
+
+[**AssessmentVCenterV2**](AssessmentVCenterV2.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **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)
+
+
+## getVcenterCluster
+
+> InventoryData getVcenterCluster(id, vid, cid)
+
+
+
+Get the specified cluster assessment inventory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetVcenterClusterRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AssessmentApi();
+
+  const body = {
+    // string | ID of the assessment
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | ID of the vcenter
+    vid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | ID of the cluster
+    cid: cid_example,
+  } satisfies GetVcenterClusterRequest;
+
+  try {
+    const data = await api.getVcenterCluster(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`] |
+| **vid** | `string` | ID of the vcenter | [Defaults to `undefined`] |
+| **cid** | `string` | ID of the cluster | [Defaults to `undefined`] |
+
+### Return type
+
+[**InventoryData**](InventoryData.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **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)
+
+
 ## listAssessments
 
 > Array<Assessment> listAssessments()
@@ -743,6 +969,67 @@ 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)
 
 
+## listAssessmentsV2
+
+> Array<AssessmentV2Summary> listAssessmentsV2()
+
+
+
+List assessments
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { ListAssessmentsV2Request } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AssessmentApi();
+
+  try {
+    const data = await api.listAssessmentsV2();
+    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
+
+[**Array<AssessmentV2Summary>**](AssessmentV2Summary.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **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)
+
+
 ## saveAssessmentEnhancementData
 
 > EnhancementData saveAssessmentEnhancementData(id, enhancementData)

package/docs/AssessmentV2.md

@@ -0,0 +1,36 @@
+
+# AssessmentV2
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [InventoryV2](InventoryV2.md)
+`vcetners` | [Array<SubResource>](SubResource.md)
+
+## Example
+
+```typescript
+import type { AssessmentV2 } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "vcetners": null,
+} satisfies AssessmentV2
+
+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 AssessmentV2
+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/AssessmentV2Summary.md

@@ -0,0 +1,58 @@
+
+# AssessmentV2Summary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`ownerFirstName` | string
+`ownerLastName` | string
+`sourceType` | string
+`datastoresCount` | number
+`hostsCount` | number
+`vmsCount` | number
+`networksCount` | number
+`sourceId` | string
+`createdAt` | Date
+`permissions` | Array<string>
+`sharing` | [AssessmentSharing](AssessmentSharing.md)
+
+## Example
+
+```typescript
+import type { AssessmentV2Summary } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "ownerFirstName": null,
+  "ownerLastName": null,
+  "sourceType": null,
+  "datastoresCount": null,
+  "hostsCount": null,
+  "vmsCount": null,
+  "networksCount": null,
+  "sourceId": null,
+  "createdAt": null,
+  "permissions": null,
+  "sharing": null,
+} satisfies AssessmentV2Summary
+
+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 AssessmentV2Summary
+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/AssessmentVCenterV2.md

@@ -0,0 +1,36 @@
+
+# AssessmentVCenterV2
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [InventoryV2](InventoryV2.md)
+`clusters` | [Array<SubResource>](SubResource.md)
+
+## Example
+
+```typescript
+import type { AssessmentVCenterV2 } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "clusters": null,
+} satisfies AssessmentVCenterV2
+
+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 AssessmentVCenterV2
+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/Datastore.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `type` | string
 `storageProtocol` | string
+`vsanSnapshotSupport` | boolean
 `totalCapacityGB` | number
 `freeCapacityGB` | number
 `vendor` | string
@@ -27,6 +28,7 @@ import type { Datastore } from '@openshift-migration-advisor/planner-sdk'
 const example = {
   "type": null,
   "storageProtocol": null,
+  "vsanSnapshotSupport": null,
   "totalCapacityGB": null,
   "freeCapacityGB": null,
   "vendor": null,

package/docs/InventoryV2.md

@@ -0,0 +1,40 @@
+
+# InventoryV2
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`data` | [InventoryData](InventoryData.md)
+`vcenterVersion` | string
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { InventoryV2 } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "data": null,
+  "vcenterVersion": null,
+  "createdAt": null,
+} satisfies InventoryV2
+
+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 InventoryV2
+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)
+
+