@openshift-migration-advisor/planner-sdk 0.5.0 → 0.5.1-b1cf34547cfc

package/dist/models/EstimationDetail.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Migration Planner 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.
+ */
+/**
+ * Detailed estimation result from a single calculator
+ * @export
+ * @interface EstimationDetail
+ */
+export interface EstimationDetail {
+    /**
+     * Estimated duration for this component (formatted as duration string)
+     * @type {string}
+     * @memberof EstimationDetail
+     */
+    duration: string;
+    /**
+     * Explanation of how the estimation was calculated
+     * @type {string}
+     * @memberof EstimationDetail
+     */
+    reason: string;
+}
+/**
+ * Check if a given object implements the EstimationDetail interface.
+ */
+export declare function instanceOfEstimationDetail(value: object): value is EstimationDetail;
+export declare function EstimationDetailFromJSON(json: any): EstimationDetail;
+export declare function EstimationDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): EstimationDetail;
+export declare function EstimationDetailToJSON(json: any): EstimationDetail;
+export declare function EstimationDetailToJSONTyped(value?: EstimationDetail | null, ignoreDiscriminator?: boolean): any;

package/dist/models/EstimationDetail.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Migration Planner 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.instanceOfEstimationDetail = instanceOfEstimationDetail;
+exports.EstimationDetailFromJSON = EstimationDetailFromJSON;
+exports.EstimationDetailFromJSONTyped = EstimationDetailFromJSONTyped;
+exports.EstimationDetailToJSON = EstimationDetailToJSON;
+exports.EstimationDetailToJSONTyped = EstimationDetailToJSONTyped;
+/**
+ * Check if a given object implements the EstimationDetail interface.
+ */
+function instanceOfEstimationDetail(value) {
+    if (!('duration' in value) || value['duration'] === undefined)
+        return false;
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    return true;
+}
+function EstimationDetailFromJSON(json) {
+    return EstimationDetailFromJSONTyped(json, false);
+}
+function EstimationDetailFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'duration': json['duration'],
+        'reason': json['reason'],
+    };
+}
+function EstimationDetailToJSON(json) {
+    return EstimationDetailToJSONTyped(json, false);
+}
+function EstimationDetailToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'duration': value['duration'],
+        'reason': value['reason'],
+    };
+}

package/dist/models/MigrationEstimationRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Migration Planner 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.
+ */
+/**
+ * Request payload for calculating migration time estimation
+ * @export
+ * @interface MigrationEstimationRequest
+ */
+export interface MigrationEstimationRequest {
+    /**
+     * ID of the cluster to calculate migration estimation for
+     * @type {string}
+     * @memberof MigrationEstimationRequest
+     */
+    clusterId: string;
+}
+/**
+ * Check if a given object implements the MigrationEstimationRequest interface.
+ */
+export declare function instanceOfMigrationEstimationRequest(value: object): value is MigrationEstimationRequest;
+export declare function MigrationEstimationRequestFromJSON(json: any): MigrationEstimationRequest;
+export declare function MigrationEstimationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): MigrationEstimationRequest;
+export declare function MigrationEstimationRequestToJSON(json: any): MigrationEstimationRequest;
+export declare function MigrationEstimationRequestToJSONTyped(value?: MigrationEstimationRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/MigrationEstimationRequest.js

@@ -0,0 +1,50 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Migration Planner 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.instanceOfMigrationEstimationRequest = instanceOfMigrationEstimationRequest;
+exports.MigrationEstimationRequestFromJSON = MigrationEstimationRequestFromJSON;
+exports.MigrationEstimationRequestFromJSONTyped = MigrationEstimationRequestFromJSONTyped;
+exports.MigrationEstimationRequestToJSON = MigrationEstimationRequestToJSON;
+exports.MigrationEstimationRequestToJSONTyped = MigrationEstimationRequestToJSONTyped;
+/**
+ * Check if a given object implements the MigrationEstimationRequest interface.
+ */
+function instanceOfMigrationEstimationRequest(value) {
+    if (!('clusterId' in value) || value['clusterId'] === undefined)
+        return false;
+    return true;
+}
+function MigrationEstimationRequestFromJSON(json) {
+    return MigrationEstimationRequestFromJSONTyped(json, false);
+}
+function MigrationEstimationRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'clusterId': json['clusterId'],
+    };
+}
+function MigrationEstimationRequestToJSON(json) {
+    return MigrationEstimationRequestToJSONTyped(json, false);
+}
+function MigrationEstimationRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'clusterId': value['clusterId'],
+    };
+}

package/dist/models/MigrationEstimationResponse.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Migration Planner 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 { EstimationDetail } from './EstimationDetail.js';
+/**
+ * Migration time estimation results
+ * @export
+ * @interface MigrationEstimationResponse
+ */
+export interface MigrationEstimationResponse {
+    /**
+     * Total estimated migration duration (formatted as duration string, e.g., "2h30m")
+     * @type {string}
+     * @memberof MigrationEstimationResponse
+     */
+    totalDuration: string;
+    /**
+     * Breakdown of estimation by calculator
+     * @type {{ [key: string]: EstimationDetail; }}
+     * @memberof MigrationEstimationResponse
+     */
+    breakdown: {
+        [key: string]: EstimationDetail;
+    };
+}
+/**
+ * Check if a given object implements the MigrationEstimationResponse interface.
+ */
+export declare function instanceOfMigrationEstimationResponse(value: object): value is MigrationEstimationResponse;
+export declare function MigrationEstimationResponseFromJSON(json: any): MigrationEstimationResponse;
+export declare function MigrationEstimationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MigrationEstimationResponse;
+export declare function MigrationEstimationResponseToJSON(json: any): MigrationEstimationResponse;
+export declare function MigrationEstimationResponseToJSONTyped(value?: MigrationEstimationResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/MigrationEstimationResponse.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Migration Planner 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.instanceOfMigrationEstimationResponse = instanceOfMigrationEstimationResponse;
+exports.MigrationEstimationResponseFromJSON = MigrationEstimationResponseFromJSON;
+exports.MigrationEstimationResponseFromJSONTyped = MigrationEstimationResponseFromJSONTyped;
+exports.MigrationEstimationResponseToJSON = MigrationEstimationResponseToJSON;
+exports.MigrationEstimationResponseToJSONTyped = MigrationEstimationResponseToJSONTyped;
+const runtime_js_1 = require("../runtime.js");
+const EstimationDetail_js_1 = require("./EstimationDetail.js");
+/**
+ * Check if a given object implements the MigrationEstimationResponse interface.
+ */
+function instanceOfMigrationEstimationResponse(value) {
+    if (!('totalDuration' in value) || value['totalDuration'] === undefined)
+        return false;
+    if (!('breakdown' in value) || value['breakdown'] === undefined)
+        return false;
+    return true;
+}
+function MigrationEstimationResponseFromJSON(json) {
+    return MigrationEstimationResponseFromJSONTyped(json, false);
+}
+function MigrationEstimationResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalDuration': json['totalDuration'],
+        'breakdown': ((0, runtime_js_1.mapValues)(json['breakdown'], EstimationDetail_js_1.EstimationDetailFromJSON)),
+    };
+}
+function MigrationEstimationResponseToJSON(json) {
+    return MigrationEstimationResponseToJSONTyped(json, false);
+}
+function MigrationEstimationResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'totalDuration': value['totalDuration'],
+        'breakdown': ((0, runtime_js_1.mapValues)(value['breakdown'], EstimationDetail_js_1.EstimationDetailToJSON)),
+    };
+}

package/dist/models/ModelError.d.ts

@@ -21,12 +21,6 @@ export interface ModelError {
      * @memberof ModelError
      */
     message: string;
-    /**
-     * Id of the request generating the error
-     * @type {string}
-     * @memberof ModelError
-     */
-    requestId?: string;
 }
 /**
  * Check if a given object implements the ModelError interface.

package/dist/models/ModelError.js

@@ -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/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/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/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/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)
+
+

package/docs/MigrationEstimationResponse.md

@@ -0,0 +1,37 @@
+
+# MigrationEstimationResponse
+
+Migration time estimation results
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalDuration` | string
+`breakdown` | [{ [key: string]: EstimationDetail; }](EstimationDetail.md)
+
+## Example
+
+```typescript
+import type { MigrationEstimationResponse } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalDuration": 4h30m0s,
+  "breakdown": null,
+} satisfies MigrationEstimationResponse
+
+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 MigrationEstimationResponse
+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/ModelError.md

@@ -7,7 +7,6 @@
 Name | Type
 ------------ | -------------
 `message` | string
-`requestId` | string
 
 ## Example
 
@@ -17,7 +16,6 @@ import type { ModelError } from '@openshift-migration-advisor/planner-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "message": null,
-  "requestId": null,
 } satisfies ModelError
 
 console.log(example)

package/package.json

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