@openshift-migration-advisor/planner-sdk 0.9.0 → 0.10.0

package/dist/esm/models/OsDiskEstimationEntry.js

@@ -0,0 +1,55 @@
+/* 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: undefined
+ *
+ *
+ * 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 { SchemaEstimationResultFromJSON, SchemaEstimationResultToJSON, } from './SchemaEstimationResult.js';
+/**
+ * Check if a given object implements the OsDiskEstimationEntry interface.
+ */
+export function instanceOfOsDiskEstimationEntry(value) {
+    if (!('score' in value) || value['score'] === undefined)
+        return false;
+    if (!('vmCount' in value) || value['vmCount'] === undefined)
+        return false;
+    if (!('totalDiskSizeTB' in value) || value['totalDiskSizeTB'] === undefined)
+        return false;
+    return true;
+}
+export function OsDiskEstimationEntryFromJSON(json) {
+    return OsDiskEstimationEntryFromJSONTyped(json, false);
+}
+export function OsDiskEstimationEntryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'score': json['score'],
+        'vmCount': json['vmCount'],
+        'totalDiskSizeTB': json['totalDiskSizeTB'],
+        'estimation': json['estimation'] == null ? undefined : (mapValues(json['estimation'], SchemaEstimationResultFromJSON)),
+    };
+}
+export function OsDiskEstimationEntryToJSON(json) {
+    return OsDiskEstimationEntryToJSONTyped(json, false);
+}
+export function OsDiskEstimationEntryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'score': value['score'],
+        'vmCount': value['vmCount'],
+        'totalDiskSizeTB': value['totalDiskSizeTB'],
+        'estimation': value['estimation'] == null ? undefined : (mapValues(value['estimation'], SchemaEstimationResultToJSON)),
+    };
+}

package/dist/esm/models/index.d.ts

@@ -12,6 +12,7 @@ export * from './ComplexityOSScoreEntry.js';
 export * from './Datastore.js';
 export * from './DiskSizeTierSummary.js';
 export * from './DiskTypeSummary.js';
+export * from './EstimationContext.js';
 export * from './EstimationDetail.js';
 export * from './Histogram.js';
 export * from './Host.js';
@@ -26,10 +27,12 @@ export * from './JobStatus.js';
 export * from './Label.js';
 export * from './MigrationComplexityRequest.js';
 export * from './MigrationComplexityResponse.js';
+export * from './MigrationEstimationByComplexityResponse.js';
 export * from './MigrationEstimationRequest.js';
 export * from './MigrationIssue.js';
 export * from './ModelError.js';
 export * from './Network.js';
+export * from './OsDiskEstimationEntry.js';
 export * from './OsInfo.js';
 export * from './PresignedUrl.js';
 export * from './SchemaEstimationResult.js';

package/dist/esm/models/index.js

@@ -14,6 +14,7 @@ export * from './ComplexityOSScoreEntry.js';
 export * from './Datastore.js';
 export * from './DiskSizeTierSummary.js';
 export * from './DiskTypeSummary.js';
+export * from './EstimationContext.js';
 export * from './EstimationDetail.js';
 export * from './Histogram.js';
 export * from './Host.js';
@@ -28,10 +29,12 @@ export * from './JobStatus.js';
 export * from './Label.js';
 export * from './MigrationComplexityRequest.js';
 export * from './MigrationComplexityResponse.js';
+export * from './MigrationEstimationByComplexityResponse.js';
 export * from './MigrationEstimationRequest.js';
 export * from './MigrationIssue.js';
 export * from './ModelError.js';
 export * from './Network.js';
+export * from './OsDiskEstimationEntry.js';
 export * from './OsInfo.js';
 export * from './PresignedUrl.js';
 export * from './SchemaEstimationResult.js';

package/dist/models/ComplexityOSNameEntry.d.ts

@@ -23,7 +23,7 @@ export interface ComplexityOSNameEntry {
      */
     osName: string;
     /**
-     * Complexity score assigned by ClassifyOS. 0 = unclassified, 1 = least complex, 4 = most complex.
+     * Complexity score assigned by ClassifyOS. 0 = unknown, 1 = least complex, 4 = most complex.
      *
      * @type {number}
      * @memberof ComplexityOSNameEntry

package/dist/models/ComplexityOSScoreEntry.d.ts

@@ -16,7 +16,7 @@
  */
 export interface ComplexityOSScoreEntry {
     /**
-     * Complexity score from 0 to 4, where 1 indicates the least complex OS to migrate and 0 indicates an OS that could not be classified.
+     * Complexity score from 0 to 4, where 1 indicates the least complex OS to migrate and 0 indicates an OS with unknown complexity.
      *
      * @type {number}
      * @memberof ComplexityOSScoreEntry

package/dist/models/EstimationContext.d.ts

@@ -0,0 +1,40 @@
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: undefined
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface EstimationContext
+ */
+export interface EstimationContext {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof EstimationContext
+     */
+    schemas?: Array<string>;
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof EstimationContext
+     */
+    params?: {
+        [key: string]: number;
+    };
+}
+/**
+ * Check if a given object implements the EstimationContext interface.
+ */
+export declare function instanceOfEstimationContext(value: object): value is EstimationContext;
+export declare function EstimationContextFromJSON(json: any): EstimationContext;
+export declare function EstimationContextFromJSONTyped(json: any, ignoreDiscriminator: boolean): EstimationContext;
+export declare function EstimationContextToJSON(json: any): EstimationContext;
+export declare function EstimationContextToJSONTyped(value?: EstimationContext | null, ignoreDiscriminator?: boolean): any;

package/dist/models/EstimationContext.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: undefined
+ *
+ *
+ * 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.instanceOfEstimationContext = instanceOfEstimationContext;
+exports.EstimationContextFromJSON = EstimationContextFromJSON;
+exports.EstimationContextFromJSONTyped = EstimationContextFromJSONTyped;
+exports.EstimationContextToJSON = EstimationContextToJSON;
+exports.EstimationContextToJSONTyped = EstimationContextToJSONTyped;
+/**
+ * Check if a given object implements the EstimationContext interface.
+ */
+function instanceOfEstimationContext(value) {
+    return true;
+}
+function EstimationContextFromJSON(json) {
+    return EstimationContextFromJSONTyped(json, false);
+}
+function EstimationContextFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'schemas': json['schemas'] == null ? undefined : json['schemas'],
+        'params': json['params'] == null ? undefined : json['params'],
+    };
+}
+function EstimationContextToJSON(json) {
+    return EstimationContextToJSONTyped(json, false);
+}
+function EstimationContextToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'schemas': value['schemas'],
+        'params': value['params'],
+    };
+}

package/dist/models/MigrationComplexityResponse.d.ts

@@ -26,7 +26,7 @@ export interface MigrationComplexityResponse {
      */
     complexityByDisk: Array<ComplexityDiskScoreEntry>;
     /**
-     * OS complexity scores, one entry per score level (0-4). Score 1 indicates the least complex OS to migrate; score 0 indicates an OS that could not be classified. All five score levels are always present.
+     * OS complexity scores, one entry per score level (0-4). Score 1 indicates the least complex OS to migrate; score 0 indicates an OS with unknown complexity. All five score levels are always present.
      *
      * @type {Array<ComplexityOSScoreEntry>}
      * @memberof MigrationComplexityResponse
@@ -42,7 +42,7 @@ export interface MigrationComplexityResponse {
         [key: string]: number;
     };
     /**
-     * Per-OS-name score for every OS found in this cluster's inventory. Keys are the OS name strings exactly as they appear in vms.osInfo; values are the numeric complexity score assigned by ClassifyOS (0 = unclassified, 1-4 = increasing complexity). The map contains one entry per distinct OS name in the cluster, regardless of how many VMs run it.
+     * Per-OS-name score for every OS found in this cluster's inventory. Keys are the OS name strings exactly as they appear in vms.osInfo; values are the numeric complexity score assigned by ClassifyOS (0 = unknown, 1-4 = increasing complexity). The map contains one entry per distinct OS name in the cluster, regardless of how many VMs run it.
      *
      * @type {{ [key: string]: number; }}
      * @memberof MigrationComplexityResponse

package/dist/models/MigrationEstimationByComplexityResponse.d.ts

@@ -0,0 +1,50 @@
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: undefined
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { OsDiskEstimationEntry } from './OsDiskEstimationEntry.js';
+import type { EstimationContext } from './EstimationContext.js';
+/**
+ *
+ * @export
+ * @interface MigrationEstimationByComplexityResponse
+ */
+export interface MigrationEstimationByComplexityResponse {
+    /**
+     * Combined OS+Disk complexity distribution with per-bucket estimation. All 5 score levels (0-4) always present.
+     * @type {Array<OsDiskEstimationEntry>}
+     * @memberof MigrationEstimationByComplexityResponse
+     */
+    complexityByOsDisk: Array<OsDiskEstimationEntry>;
+    /**
+     * Decision matrix: outer keys are OS scores (0-4), inner keys are disk scores (1-4), values are combined scores.
+     * @type {{ [key: string]: { [key: string]: number; }; }}
+     * @memberof MigrationEstimationByComplexityResponse
+     */
+    complexityMatrix: {
+        [key: string]: {
+            [key: string]: number;
+        };
+    };
+    /**
+     *
+     * @type {EstimationContext}
+     * @memberof MigrationEstimationByComplexityResponse
+     */
+    estimationContext?: EstimationContext;
+}
+/**
+ * Check if a given object implements the MigrationEstimationByComplexityResponse interface.
+ */
+export declare function instanceOfMigrationEstimationByComplexityResponse(value: object): value is MigrationEstimationByComplexityResponse;
+export declare function MigrationEstimationByComplexityResponseFromJSON(json: any): MigrationEstimationByComplexityResponse;
+export declare function MigrationEstimationByComplexityResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MigrationEstimationByComplexityResponse;
+export declare function MigrationEstimationByComplexityResponseToJSON(json: any): MigrationEstimationByComplexityResponse;
+export declare function MigrationEstimationByComplexityResponseToJSONTyped(value?: MigrationEstimationByComplexityResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/MigrationEstimationByComplexityResponse.js

@@ -0,0 +1,58 @@
+"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: undefined
+ *
+ *
+ * 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.instanceOfMigrationEstimationByComplexityResponse = instanceOfMigrationEstimationByComplexityResponse;
+exports.MigrationEstimationByComplexityResponseFromJSON = MigrationEstimationByComplexityResponseFromJSON;
+exports.MigrationEstimationByComplexityResponseFromJSONTyped = MigrationEstimationByComplexityResponseFromJSONTyped;
+exports.MigrationEstimationByComplexityResponseToJSON = MigrationEstimationByComplexityResponseToJSON;
+exports.MigrationEstimationByComplexityResponseToJSONTyped = MigrationEstimationByComplexityResponseToJSONTyped;
+const OsDiskEstimationEntry_js_1 = require("./OsDiskEstimationEntry.js");
+const EstimationContext_js_1 = require("./EstimationContext.js");
+/**
+ * Check if a given object implements the MigrationEstimationByComplexityResponse interface.
+ */
+function instanceOfMigrationEstimationByComplexityResponse(value) {
+    if (!('complexityByOsDisk' in value) || value['complexityByOsDisk'] === undefined)
+        return false;
+    if (!('complexityMatrix' in value) || value['complexityMatrix'] === undefined)
+        return false;
+    return true;
+}
+function MigrationEstimationByComplexityResponseFromJSON(json) {
+    return MigrationEstimationByComplexityResponseFromJSONTyped(json, false);
+}
+function MigrationEstimationByComplexityResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'complexityByOsDisk': (json['complexityByOsDisk'].map(OsDiskEstimationEntry_js_1.OsDiskEstimationEntryFromJSON)),
+        'complexityMatrix': json['complexityMatrix'],
+        'estimationContext': json['estimationContext'] == null ? undefined : (0, EstimationContext_js_1.EstimationContextFromJSON)(json['estimationContext']),
+    };
+}
+function MigrationEstimationByComplexityResponseToJSON(json) {
+    return MigrationEstimationByComplexityResponseToJSONTyped(json, false);
+}
+function MigrationEstimationByComplexityResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'complexityByOsDisk': (value['complexityByOsDisk'].map(OsDiskEstimationEntry_js_1.OsDiskEstimationEntryToJSON)),
+        'complexityMatrix': value['complexityMatrix'],
+        'estimationContext': (0, EstimationContext_js_1.EstimationContextToJSON)(value['estimationContext']),
+    };
+}

package/dist/models/OsDiskEstimationEntry.d.ts

@@ -0,0 +1,53 @@
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: undefined
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { SchemaEstimationResult } from './SchemaEstimationResult.js';
+/**
+ *
+ * @export
+ * @interface OsDiskEstimationEntry
+ */
+export interface OsDiskEstimationEntry {
+    /**
+     * Combined OS+Disk complexity score (0-4).
+     * @type {number}
+     * @memberof OsDiskEstimationEntry
+     */
+    score: number;
+    /**
+     * Number of VMs at this complexity level.
+     * @type {number}
+     * @memberof OsDiskEstimationEntry
+     */
+    vmCount: number;
+    /**
+     * Total provisioned disk across VMs in this bucket (decimal TB). 0.0 when ComplexityDistribution is absent from the inventory.
+     * @type {number}
+     * @memberof OsDiskEstimationEntry
+     */
+    totalDiskSizeTB: number;
+    /**
+     * Full estimation breakdown keyed by schema name. Absent for empty buckets (vmCount == 0).
+     * @type {{ [key: string]: SchemaEstimationResult; }}
+     * @memberof OsDiskEstimationEntry
+     */
+    estimation?: {
+        [key: string]: SchemaEstimationResult;
+    };
+}
+/**
+ * Check if a given object implements the OsDiskEstimationEntry interface.
+ */
+export declare function instanceOfOsDiskEstimationEntry(value: object): value is OsDiskEstimationEntry;
+export declare function OsDiskEstimationEntryFromJSON(json: any): OsDiskEstimationEntry;
+export declare function OsDiskEstimationEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): OsDiskEstimationEntry;
+export declare function OsDiskEstimationEntryToJSON(json: any): OsDiskEstimationEntry;
+export declare function OsDiskEstimationEntryToJSONTyped(value?: OsDiskEstimationEntry | null, ignoreDiscriminator?: boolean): any;

package/dist/models/OsDiskEstimationEntry.js

@@ -0,0 +1,62 @@
+"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: undefined
+ *
+ *
+ * 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.instanceOfOsDiskEstimationEntry = instanceOfOsDiskEstimationEntry;
+exports.OsDiskEstimationEntryFromJSON = OsDiskEstimationEntryFromJSON;
+exports.OsDiskEstimationEntryFromJSONTyped = OsDiskEstimationEntryFromJSONTyped;
+exports.OsDiskEstimationEntryToJSON = OsDiskEstimationEntryToJSON;
+exports.OsDiskEstimationEntryToJSONTyped = OsDiskEstimationEntryToJSONTyped;
+const runtime_js_1 = require("../runtime.js");
+const SchemaEstimationResult_js_1 = require("./SchemaEstimationResult.js");
+/**
+ * Check if a given object implements the OsDiskEstimationEntry interface.
+ */
+function instanceOfOsDiskEstimationEntry(value) {
+    if (!('score' in value) || value['score'] === undefined)
+        return false;
+    if (!('vmCount' in value) || value['vmCount'] === undefined)
+        return false;
+    if (!('totalDiskSizeTB' in value) || value['totalDiskSizeTB'] === undefined)
+        return false;
+    return true;
+}
+function OsDiskEstimationEntryFromJSON(json) {
+    return OsDiskEstimationEntryFromJSONTyped(json, false);
+}
+function OsDiskEstimationEntryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'score': json['score'],
+        'vmCount': json['vmCount'],
+        'totalDiskSizeTB': json['totalDiskSizeTB'],
+        'estimation': json['estimation'] == null ? undefined : ((0, runtime_js_1.mapValues)(json['estimation'], SchemaEstimationResult_js_1.SchemaEstimationResultFromJSON)),
+    };
+}
+function OsDiskEstimationEntryToJSON(json) {
+    return OsDiskEstimationEntryToJSONTyped(json, false);
+}
+function OsDiskEstimationEntryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'score': value['score'],
+        'vmCount': value['vmCount'],
+        'totalDiskSizeTB': value['totalDiskSizeTB'],
+        'estimation': value['estimation'] == null ? undefined : ((0, runtime_js_1.mapValues)(value['estimation'], SchemaEstimationResult_js_1.SchemaEstimationResultToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -12,6 +12,7 @@ export * from './ComplexityOSScoreEntry.js';
 export * from './Datastore.js';
 export * from './DiskSizeTierSummary.js';
 export * from './DiskTypeSummary.js';
+export * from './EstimationContext.js';
 export * from './EstimationDetail.js';
 export * from './Histogram.js';
 export * from './Host.js';
@@ -26,10 +27,12 @@ export * from './JobStatus.js';
 export * from './Label.js';
 export * from './MigrationComplexityRequest.js';
 export * from './MigrationComplexityResponse.js';
+export * from './MigrationEstimationByComplexityResponse.js';
 export * from './MigrationEstimationRequest.js';
 export * from './MigrationIssue.js';
 export * from './ModelError.js';
 export * from './Network.js';
+export * from './OsDiskEstimationEntry.js';
 export * from './OsInfo.js';
 export * from './PresignedUrl.js';
 export * from './SchemaEstimationResult.js';

package/dist/models/index.js

@@ -30,6 +30,7 @@ __exportStar(require("./ComplexityOSScoreEntry.js"), exports);
 __exportStar(require("./Datastore.js"), exports);
 __exportStar(require("./DiskSizeTierSummary.js"), exports);
 __exportStar(require("./DiskTypeSummary.js"), exports);
+__exportStar(require("./EstimationContext.js"), exports);
 __exportStar(require("./EstimationDetail.js"), exports);
 __exportStar(require("./Histogram.js"), exports);
 __exportStar(require("./Host.js"), exports);
@@ -44,10 +45,12 @@ __exportStar(require("./JobStatus.js"), exports);
 __exportStar(require("./Label.js"), exports);
 __exportStar(require("./MigrationComplexityRequest.js"), exports);
 __exportStar(require("./MigrationComplexityResponse.js"), exports);
+__exportStar(require("./MigrationEstimationByComplexityResponse.js"), exports);
 __exportStar(require("./MigrationEstimationRequest.js"), exports);
 __exportStar(require("./MigrationIssue.js"), exports);
 __exportStar(require("./ModelError.js"), exports);
 __exportStar(require("./Network.js"), exports);
+__exportStar(require("./OsDiskEstimationEntry.js"), exports);
 __exportStar(require("./OsInfo.js"), exports);
 __exportStar(require("./PresignedUrl.js"), exports);
 __exportStar(require("./SchemaEstimationResult.js"), exports);

package/docs/AssessmentApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://raw.githubusercontent.com*
 | [**calculateAssessmentClusterRequirements**](AssessmentApi.md#calculateassessmentclusterrequirements) | **POST** /api/v1/assessments/{id}/cluster-requirements |  |
 | [**calculateMigrationComplexity**](AssessmentApi.md#calculatemigrationcomplexity) | **POST** /api/v1/assessments/{id}/complexity-estimation |  |
 | [**calculateMigrationEstimation**](AssessmentApi.md#calculatemigrationestimation) | **POST** /api/v1/assessments/{id}/migration-estimation |  |
+| [**calculateMigrationEstimationByComplexity**](AssessmentApi.md#calculatemigrationestimationbycomplexity) | **POST** /api/v1/assessments/{id}/migration-estimation/by-complexity |  |
 | [**createAssessment**](AssessmentApi.md#createassessment) | **POST** /api/v1/assessments |  |
 | [**deleteAssessment**](AssessmentApi.md#deleteassessment) | **DELETE** /api/v1/assessments/{id} |  |
 | [**getAssessment**](AssessmentApi.md#getassessment) | **GET** /api/v1/assessments/{id} |  |
@@ -241,6 +242,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)
 
 
+## calculateMigrationEstimationByComplexity
+
+> MigrationEstimationByComplexityResponse calculateMigrationEstimationByComplexity(id, migrationEstimationRequest)
+
+
+
+Calculate migration time estimation broken down by combined OS+Disk complexity
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CalculateMigrationEstimationByComplexityRequest } 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,
+    // MigrationEstimationRequest
+    migrationEstimationRequest: ...,
+  } satisfies CalculateMigrationEstimationByComplexityRequest;
+
+  try {
+    const data = await api.calculateMigrationEstimationByComplexity(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`] |
+| **migrationEstimationRequest** | [MigrationEstimationRequest](MigrationEstimationRequest.md) |  | |
+
+### Return type
+
+[**MigrationEstimationByComplexityResponse**](MigrationEstimationByComplexityResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Migration estimation by complexity calculation successful |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Assessment not found |  -  |
+| **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)
+
+
 ## createAssessment
 
 > Assessment createAssessment(assessmentForm)

package/docs/EstimationContext.md

@@ -0,0 +1,36 @@
+
+# EstimationContext
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`schemas` | Array<string>
+`params` | { [key: string]: number; }
+
+## Example
+
+```typescript
+import type { EstimationContext } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "schemas": null,
+  "params": null,
+} satisfies EstimationContext
+
+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 EstimationContext
+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/MigrationEstimationByComplexityResponse.md

@@ -0,0 +1,38 @@
+
+# MigrationEstimationByComplexityResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`complexityByOsDisk` | [Array<OsDiskEstimationEntry>](OsDiskEstimationEntry.md)
+`complexityMatrix` | { [key: string]: { [key: string]: number; }; }
+`estimationContext` | [EstimationContext](EstimationContext.md)
+
+## Example
+
+```typescript
+import type { MigrationEstimationByComplexityResponse } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "complexityByOsDisk": null,
+  "complexityMatrix": null,
+  "estimationContext": null,
+} satisfies MigrationEstimationByComplexityResponse
+
+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 MigrationEstimationByComplexityResponse
+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)
+
+