@openshift-migration-advisor/planner-sdk 0.5.0 → 0.5.1-0ae313a75a60

package/dist/models/ModelError.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined
@@ -35,7 +35,6 @@ function ModelErrorFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'message': json['message'],
-        'requestId': json['requestId'] == null ? undefined : json['requestId'],
     };
 }
 function ModelErrorToJSON(json) {
@@ -47,6 +46,5 @@ function ModelErrorToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'message': value['message'],
-        'requestId': value['requestId'],
     };
 }

package/dist/models/Network.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/Network.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/OsInfo.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/OsInfo.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/PresignedUrl.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/PresignedUrl.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SizingOverCommitRatio.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SizingOverCommitRatio.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SizingResourceConsumption.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SizingResourceConsumption.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SizingResourceLimits.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SizingResourceLimits.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/Snapshot.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/Snapshot.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/Source.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/Source.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SourceCreate.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SourceCreate.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SourceInfra.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SourceInfra.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SourceUpdate.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/SourceUpdate.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/Status.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/Status.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/UpdateInventory.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/UpdateInventory.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/VCenter.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/VCenter.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/VMResourceBreakdown.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/VMResourceBreakdown.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/VMs.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/VMs.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/VmNetwork.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/VmNetwork.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/models/index.d.ts

@@ -9,6 +9,7 @@ export * from './ClusterSizing.js';
 export * from './Datastore.js';
 export * from './DiskSizeTierSummary.js';
 export * from './DiskTypeSummary.js';
+export * from './EstimationDetail.js';
 export * from './Histogram.js';
 export * from './Host.js';
 export * from './Info.js';
@@ -20,6 +21,8 @@ export * from './Ipv4Config.js';
 export * from './Job.js';
 export * from './JobStatus.js';
 export * from './Label.js';
+export * from './MigrationEstimationRequest.js';
+export * from './MigrationEstimationResponse.js';
 export * from './MigrationIssue.js';
 export * from './ModelError.js';
 export * from './Network.js';

package/dist/models/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./ClusterSizing.js"), exports);
 __exportStar(require("./Datastore.js"), exports);
 __exportStar(require("./DiskSizeTierSummary.js"), exports);
 __exportStar(require("./DiskTypeSummary.js"), exports);
+__exportStar(require("./EstimationDetail.js"), exports);
 __exportStar(require("./Histogram.js"), exports);
 __exportStar(require("./Host.js"), exports);
 __exportStar(require("./Info.js"), exports);
@@ -38,6 +39,8 @@ __exportStar(require("./Ipv4Config.js"), exports);
 __exportStar(require("./Job.js"), exports);
 __exportStar(require("./JobStatus.js"), exports);
 __exportStar(require("./Label.js"), exports);
+__exportStar(require("./MigrationEstimationRequest.js"), exports);
+__exportStar(require("./MigrationEstimationResponse.js"), exports);
 __exportStar(require("./MigrationIssue.js"), exports);
 __exportStar(require("./ModelError.js"), exports);
 __exportStar(require("./Network.js"), exports);

package/dist/runtime.d.ts

@@ -1,5 +1,5 @@
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined

package/dist/runtime.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Migration Planner API
+ * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: undefined
@@ -232,6 +232,11 @@ class ResponseError extends Error {
         super(msg);
         this.response = response;
         this.name = "ResponseError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 exports.ResponseError = ResponseError;
@@ -240,6 +245,11 @@ class FetchError extends Error {
         super(msg);
         this.cause = cause;
         this.name = "FetchError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 exports.FetchError = FetchError;
@@ -248,6 +258,11 @@ class RequiredError extends Error {
         super(msg);
         this.field = field;
         this.name = "RequiredError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 exports.RequiredError = RequiredError;

package/docs/AssessmentApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://raw.githubusercontent.com*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**calculateAssessmentClusterRequirements**](AssessmentApi.md#calculateassessmentclusterrequirements) | **POST** /api/v1/assessments/{id}/cluster-requirements |  |
+| [**calculateMigrationEstimation**](AssessmentApi.md#calculatemigrationestimation) | **POST** /api/v1/assessments/{id}/migration-estimation |  |
 | [**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} |  |
@@ -89,6 +90,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)
 
 
+## calculateMigrationEstimation
+
+> MigrationEstimationResponse calculateMigrationEstimation(id, migrationEstimationRequest)
+
+
+
+Calculate migration time estimation for an assessment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CalculateMigrationEstimationRequest } 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: {"clusterId":"domain-c8"},
+  } satisfies CalculateMigrationEstimationRequest;
+
+  try {
+    const data = await api.calculateMigrationEstimation(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
+
+[**MigrationEstimationResponse**](MigrationEstimationResponse.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 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/ClusterRequirementsRequest.md

@@ -14,6 +14,8 @@ Name | Type
 `workerNodeMemory` | number
 `workerNodeThreads` | number
 `controlPlaneSchedulable` | boolean
+`controlPlaneCPU` | number
+`controlPlaneMemory` | number
 
 ## Example
 
@@ -29,6 +31,8 @@ const example = {
   "workerNodeMemory": null,
   "workerNodeThreads": null,
   "controlPlaneSchedulable": null,
+  "controlPlaneCPU": null,
+  "controlPlaneMemory": null,
 } satisfies ClusterRequirementsRequest
 
 console.log(example)

package/docs/EstimationDetail.md

@@ -0,0 +1,37 @@
+
+# EstimationDetail
+
+Detailed estimation result from a single calculator
+
+## Properties
+
+Name | Type
+------------ | -------------
+`duration` | string
+`reason` | string
+
+## Example
+
+```typescript
+import type { EstimationDetail } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "duration": 3h40m0s,
+  "reason": 1000.00 GB at 110 minutes per 500GB,
+} satisfies EstimationDetail
+
+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 EstimationDetail
+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/Info.md

@@ -1,7 +1,7 @@
 
 # Info
 
-Migration planner information
+OpenShift Migration Advisor information
 
 ## Properties
 

package/docs/InfoApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *https://raw.githubusercontent.com*
 
 
 
-Get migration planner information
+Get OpenShift Migration Advisor information
 
 ### Example
 

package/docs/MigrationEstimationRequest.md

@@ -0,0 +1,35 @@
+
+# MigrationEstimationRequest
+
+Request payload for calculating migration time estimation
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clusterId` | string
+
+## Example
+
+```typescript
+import type { MigrationEstimationRequest } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "clusterId": domain-c8,
+} satisfies MigrationEstimationRequest
+
+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 MigrationEstimationRequest
+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)
+
+