@openshift-migration-advisor/planner-sdk 0.17.0 → 0.18.0-ca1dcff279a4

package/docs/StorageIoConfiguration.md

@@ -0,0 +1,40 @@
+
+# StorageIoConfiguration
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`congestionThreshold` | number
+`congestionThresholdMode` | string
+`percentOfPeakThroughput` | number
+
+## Example
+
+```typescript
+import type { StorageIoConfiguration } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "congestionThreshold": null,
+  "congestionThresholdMode": null,
+  "percentOfPeakThroughput": null,
+} satisfies StorageIoConfiguration
+
+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 StorageIoConfiguration
+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/VMs.md

@@ -28,6 +28,7 @@ Name | Type
 `osInfo` | [{ [key: string]: OsInfo; }](OsInfo.md)
 `notMigratableReasons` | [Array<MigrationIssue>](MigrationIssue.md)
 `migrationWarnings` | [Array<MigrationIssue>](MigrationIssue.md)
+`issuesBreakdown` | [IssuesBreakdown](IssuesBreakdown.md)
 
 ## Example
 
@@ -58,6 +59,7 @@ const example = {
   "osInfo": null,
   "notMigratableReasons": null,
   "migrationWarnings": null,
+  "issuesBreakdown": null,
 } satisfies VMs
 
 console.log(example)

package/docs/VMwareSubscriptionInput.md

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

@@ -0,0 +1,40 @@
+
+# VMwareVersionCountsInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`perpetualLicensesCount` | number
+`coresLicensingCount` | number
+`environmentCount` | number
+`otherNodesCount` | number
+
+## Example
+
+```typescript
+import type { VMwareVersionCountsInput } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "perpetualLicensesCount": null,
+  "coresLicensingCount": null,
+  "environmentCount": null,
+  "otherNodesCount": null,
+} satisfies VMwareVersionCountsInput
+
+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 VMwareVersionCountsInput
+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/VsphereCoreInput.md

@@ -0,0 +1,38 @@
+
+# VsphereCoreInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`vmEncryptionEnabled` | boolean
+`vmEncryptionPolicy` | string
+`srmEnabled` | boolean
+
+## Example
+
+```typescript
+import type { VsphereCoreInput } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "vmEncryptionEnabled": null,
+  "vmEncryptionPolicy": null,
+  "srmEnabled": null,
+} satisfies VsphereCoreInput
+
+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 VsphereCoreInput
+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.17.0",
+  "version": "0.18.0-ca1dcff279a4",
   "description": "OpenAPI client for @openshift-migration-advisor/planner-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AccountApi.ts

@@ -50,45 +50,93 @@ import {
 } from '../models/MemberUpdate.js';
 
 export interface CreateGroupRequest {
+    /**
+     * 
+     */
     groupCreate: GroupCreate;
 }
 
 export interface CreateGroupMemberRequest {
+    /**
+     * ID of the group
+     */
     id: string;
+    /**
+     * 
+     */
     memberCreate: MemberCreate;
 }
 
 export interface DeleteGroupRequest {
+    /**
+     * ID of the group
+     */
     id: string;
 }
 
 export interface GetGroupRequest {
+    /**
+     * ID of the group
+     */
     id: string;
 }
 
 export interface ListGroupMembersRequest {
+    /**
+     * ID of the group
+     */
     id: string;
 }
 
 export interface ListGroupsRequest {
+    /**
+     * Filter by group kind
+     */
     kind?: ListGroupsKindEnum;
+    /**
+     * Filter by name (case-insensitive partial match)
+     */
     name?: string;
+    /**
+     * Filter by company (case-insensitive partial match)
+     */
     company?: string;
 }
 
 export interface RemoveGroupMemberRequest {
+    /**
+     * ID of the group
+     */
     id: string;
+    /**
+     * Username of the member
+     */
     username: string;
 }
 
 export interface UpdateGroupRequest {
+    /**
+     * ID of the group
+     */
     id: string;
+    /**
+     * 
+     */
     groupUpdate: GroupUpdate;
 }
 
 export interface UpdateGroupMemberRequest {
+    /**
+     * ID of the group
+     */
     id: string;
+    /**
+     * Username of the member
+     */
     username: string;
+    /**
+     * 
+     */
     memberUpdate: MemberUpdate;
 }
 
@@ -838,6 +886,6 @@ export class AccountApi extends runtime.BaseAPI implements AccountApiInterface {
  */
 export const ListGroupsKindEnum = {
     Partner: 'partner',
-    Admin: 'admin'
+    Admin: 'admin',
 } as const;
 export type ListGroupsKindEnum = typeof ListGroupsKindEnum[keyof typeof ListGroupsKindEnum];

package/src/apis/AssessmentApi.ts

@@ -43,6 +43,11 @@ import {
     ClusterRequirementsStoredInputFromJSON,
     ClusterRequirementsStoredInputToJSON,
 } from '../models/ClusterRequirementsStoredInput.js';
+import {
+    type EnhancementData,
+    EnhancementDataFromJSON,
+    EnhancementDataToJSON,
+} from '../models/EnhancementData.js';
 import {
     type MigrationComplexityRequest,
     MigrationComplexityRequestFromJSON,
@@ -75,56 +80,128 @@ import {
 } from '../models/Status.js';
 
 export interface CalculateAssessmentClusterRequirementsRequest {
+    /**
+     * ID of the assessment
+     */
     id: string;
+    /**
+     * 
+     */
     clusterRequirementsRequest: ClusterRequirementsRequest;
 }
 
 export interface CalculateMigrationComplexityRequest {
+    /**
+     * ID of the assessment
+     */
     id: string;
+    /**
+     * 
+     */
     migrationComplexityRequest: MigrationComplexityRequest;
 }
 
 export interface CalculateMigrationEstimationRequest {
+    /**
+     * ID of the assessment
+     */
     id: string;
+    /**
+     * 
+     */
     migrationEstimationRequest: MigrationEstimationRequest;
 }
 
 export interface CalculateMigrationEstimationByComplexityRequest {
+    /**
+     * ID of the assessment
+     */
     id: string;
+    /**
+     * 
+     */
     migrationEstimationRequest: MigrationEstimationRequest;
 }
 
 export interface CreateAssessmentRequest {
+    /**
+     * 
+     */
     assessmentForm: AssessmentForm;
 }
 
 export interface DeleteAssessmentRequest {
+    /**
+     * ID of the assessment
+     */
     id: string;
 }
 
 export interface GetAssessmentRequest {
+    /**
+     * ID of the assessment
+     */
     id: string;
 }
 
 export interface GetAssessmentClusterRequirementsStoredInputRequest {
+    /**
+     * ID of the assessment
+     */
     id: string;
+    /**
+     * ID of the VMware cluster
+     */
     clusterId: string;
 }
 
+export interface GetAssessmentEnhancementDataRequest {
+    /**
+     * ID of the assessment
+     */
+    id: string;
+}
+
 export interface ListAssessmentsRequest {
+    /**
+     * Filter assessments by source ID
+     */
     sourceId?: string;
 }
 
+export interface SaveAssessmentEnhancementDataRequest {
+    /**
+     * ID of the assessment
+     */
+    id: string;
+    /**
+     * 
+     */
+    enhancementData: EnhancementData;
+}
+
 export interface ShareAssessmentRequest {
+    /**
+     * ID of the assessment
+     */
     id: string;
 }
 
 export interface UnshareAssessmentRequest {
+    /**
+     * ID of the assessment
+     */
     id: string;
 }
 
 export interface UpdateAssessmentRequest {
+    /**
+     * ID of the assessment
+     */
     id: string;
+    /**
+     * 
+     */
     assessmentUpdate: AssessmentUpdate;
 }
 
@@ -321,6 +398,28 @@ export interface AssessmentApiInterface {
      */
     getAssessmentClusterRequirementsStoredInput(requestParameters: GetAssessmentClusterRequirementsStoredInputRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClusterRequirementsStoredInput>;
 
+    /**
+     * Creates request options for getAssessmentEnhancementData without sending the request
+     * @param {string} id ID of the assessment
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getAssessmentEnhancementDataRequestOpts(requestParameters: GetAssessmentEnhancementDataRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Get stored enhancement data for an assessment
+     * @param {string} id ID of the assessment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getAssessmentEnhancementDataRaw(requestParameters: GetAssessmentEnhancementDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnhancementData>>;
+
+    /**
+     * Get stored enhancement data for an assessment
+     */
+    getAssessmentEnhancementData(requestParameters: GetAssessmentEnhancementDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnhancementData>;
+
     /**
      * Creates request options for listAssessments without sending the request
      * @param {string} [sourceId] Filter assessments by source ID
@@ -343,6 +442,30 @@ export interface AssessmentApiInterface {
      */
     listAssessments(requestParameters: ListAssessmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Assessment>>;
 
+    /**
+     * Creates request options for saveAssessmentEnhancementData without sending the request
+     * @param {string} id ID of the assessment
+     * @param {EnhancementData} enhancementData 
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    saveAssessmentEnhancementDataRequestOpts(requestParameters: SaveAssessmentEnhancementDataRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Save enhancement data for an assessment
+     * @param {string} id ID of the assessment
+     * @param {EnhancementData} enhancementData 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    saveAssessmentEnhancementDataRaw(requestParameters: SaveAssessmentEnhancementDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnhancementData>>;
+
+    /**
+     * Save enhancement data for an assessment
+     */
+    saveAssessmentEnhancementData(requestParameters: SaveAssessmentEnhancementDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnhancementData>;
+
     /**
      * Creates request options for shareAssessment without sending the request
      * @param {string} id ID of the assessment
@@ -831,6 +954,51 @@ export class AssessmentApi extends runtime.BaseAPI implements AssessmentApiInter
         return await response.value();
     }
 
+    /**
+     * Creates request options for getAssessmentEnhancementData without sending the request
+     */
+    async getAssessmentEnhancementDataRequestOpts(requestParameters: GetAssessmentEnhancementDataRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getAssessmentEnhancementData().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v1/assessments/{id}/enhancement-data`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get stored enhancement data for an assessment
+     */
+    async getAssessmentEnhancementDataRaw(requestParameters: GetAssessmentEnhancementDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnhancementData>> {
+        const requestOptions = await this.getAssessmentEnhancementDataRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => EnhancementDataFromJSON(jsonValue));
+    }
+
+    /**
+     * Get stored enhancement data for an assessment
+     */
+    async getAssessmentEnhancementData(requestParameters: GetAssessmentEnhancementDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnhancementData> {
+        const response = await this.getAssessmentEnhancementDataRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for listAssessments without sending the request
      */
@@ -872,6 +1040,61 @@ export class AssessmentApi extends runtime.BaseAPI implements AssessmentApiInter
         return await response.value();
     }
 
+    /**
+     * Creates request options for saveAssessmentEnhancementData without sending the request
+     */
+    async saveAssessmentEnhancementDataRequestOpts(requestParameters: SaveAssessmentEnhancementDataRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling saveAssessmentEnhancementData().'
+            );
+        }
+
+        if (requestParameters['enhancementData'] == null) {
+            throw new runtime.RequiredError(
+                'enhancementData',
+                'Required parameter "enhancementData" was null or undefined when calling saveAssessmentEnhancementData().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/v1/assessments/{id}/enhancement-data`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: EnhancementDataToJSON(requestParameters['enhancementData']),
+        };
+    }
+
+    /**
+     * Save enhancement data for an assessment
+     */
+    async saveAssessmentEnhancementDataRaw(requestParameters: SaveAssessmentEnhancementDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnhancementData>> {
+        const requestOptions = await this.saveAssessmentEnhancementDataRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => EnhancementDataFromJSON(jsonValue));
+    }
+
+    /**
+     * Save enhancement data for an assessment
+     */
+    async saveAssessmentEnhancementData(requestParameters: SaveAssessmentEnhancementDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnhancementData> {
+        const response = await this.saveAssessmentEnhancementDataRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for shareAssessment without sending the request
      */

package/src/apis/ImageApi.ts

@@ -20,10 +20,16 @@ import {
 } from '../models/PresignedUrl.js';
 
 export interface GetSourceDownloadURLRequest {
+    /**
+     * Source id
+     */
     id: string;
 }
 
 export interface HeadImageRequest {
+    /**
+     * Id of the source
+     */
     id: string;
 }
 

package/src/apis/JobApi.ts

@@ -20,15 +20,27 @@ import {
 } from '../models/Job.js';
 
 export interface CancelJobRequest {
+    /**
+     * ID of the job
+     */
     id: number;
 }
 
 export interface CreateRVToolsAssessmentRequest {
+    /**
+     * Name of the assessment
+     */
     name: string;
+    /**
+     * File upload for assessment data
+     */
     file: Blob;
 }
 
 export interface GetJobRequest {
+    /**
+     * ID of the job
+     */
     id: number;
 }
 

package/src/apis/PartnerApi.ts

@@ -40,28 +40,52 @@ import {
 } from '../models/PartnerRequestUpdate.js';
 
 export interface CancelPartnerRequestRequest {
+    /**
+     * Partner request ID
+     */
     id: string;
 }
 
 export interface CreatePartnerRequestRequest {
+    /**
+     * Partner group ID
+     */
     id: string;
+    /**
+     * 
+     */
     partnerRequestCreate: PartnerRequestCreate;
 }
 
 export interface GetPartnerRequest {
+    /**
+     * Partner group ID
+     */
     id: string;
 }
 
 export interface LeavePartnerRequest {
+    /**
+     * Partner group ID
+     */
     id: string;
 }
 
 export interface RemoveCustomerRequest {
+    /**
+     * Customer username
+     */
     username: string;
 }
 
 export interface UpdatePartnerRequestRequest {
+    /**
+     * Partner request ID
+     */
     id: string;
+    /**
+     * 
+     */
     partnerRequestUpdate: PartnerRequestUpdate;
 }
 

package/src/apis/SizingApi.ts

@@ -25,6 +25,9 @@ import {
 } from '../models/StandaloneClusterRequirementsResponse.js';
 
 export interface CalculateClusterRequirementsRequest {
+    /**
+     * 
+     */
     standaloneClusterRequirementsRequest: StandaloneClusterRequirementsRequest;
 }