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

package/src/apis/AssessmentApi.ts

@@ -20,6 +20,8 @@ import type {
   AssessmentUpdate,
   ClusterRequirementsRequest,
   ClusterRequirementsResponse,
+  MigrationEstimationRequest,
+  MigrationEstimationResponse,
 } from '../models/index.js';
 import {
     AssessmentFromJSON,
@@ -32,6 +34,10 @@ import {
     ClusterRequirementsRequestToJSON,
     ClusterRequirementsResponseFromJSON,
     ClusterRequirementsResponseToJSON,
+    MigrationEstimationRequestFromJSON,
+    MigrationEstimationRequestToJSON,
+    MigrationEstimationResponseFromJSON,
+    MigrationEstimationResponseToJSON,
 } from '../models/index.js';
 
 export interface CalculateAssessmentClusterRequirementsRequest {
@@ -39,6 +45,11 @@ export interface CalculateAssessmentClusterRequirementsRequest {
     clusterRequirementsRequest: ClusterRequirementsRequest;
 }
 
+export interface CalculateMigrationEstimationRequest {
+    id: string;
+    migrationEstimationRequest: MigrationEstimationRequest;
+}
+
 export interface CreateAssessmentRequest {
     assessmentForm: AssessmentForm;
 }
@@ -91,6 +102,30 @@ export interface AssessmentApiInterface {
      */
     calculateAssessmentClusterRequirements(requestParameters: CalculateAssessmentClusterRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClusterRequirementsResponse>;
 
+    /**
+     * Creates request options for calculateMigrationEstimation without sending the request
+     * @param {string} id ID of the assessment
+     * @param {MigrationEstimationRequest} migrationEstimationRequest 
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    calculateMigrationEstimationRequestOpts(requestParameters: CalculateMigrationEstimationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Calculate migration time estimation for an assessment
+     * @param {string} id ID of the assessment
+     * @param {MigrationEstimationRequest} migrationEstimationRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    calculateMigrationEstimationRaw(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MigrationEstimationResponse>>;
+
+    /**
+     * Calculate migration time estimation for an assessment
+     */
+    calculateMigrationEstimation(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MigrationEstimationResponse>;
+
     /**
      * Creates request options for createAssessment without sending the request
      * @param {AssessmentForm} assessmentForm 
@@ -265,6 +300,61 @@ export class AssessmentApi extends runtime.BaseAPI implements AssessmentApiInter
         return await response.value();
     }
 
+    /**
+     * Creates request options for calculateMigrationEstimation without sending the request
+     */
+    async calculateMigrationEstimationRequestOpts(requestParameters: CalculateMigrationEstimationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling calculateMigrationEstimation().'
+            );
+        }
+
+        if (requestParameters['migrationEstimationRequest'] == null) {
+            throw new runtime.RequiredError(
+                'migrationEstimationRequest',
+                'Required parameter "migrationEstimationRequest" was null or undefined when calling calculateMigrationEstimation().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/api/v1/assessments/{id}/migration-estimation`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: MigrationEstimationRequestToJSON(requestParameters['migrationEstimationRequest']),
+        };
+    }
+
+    /**
+     * Calculate migration time estimation for an assessment
+     */
+    async calculateMigrationEstimationRaw(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MigrationEstimationResponse>> {
+        const requestOptions = await this.calculateMigrationEstimationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MigrationEstimationResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Calculate migration time estimation for an assessment
+     */
+    async calculateMigrationEstimation(requestParameters: CalculateMigrationEstimationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MigrationEstimationResponse> {
+        const response = await this.calculateMigrationEstimationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for createAssessment without sending the request
      */

package/src/models/EstimationDetail.ts

@@ -0,0 +1,75 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime.js';
+/**
+ * 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 function instanceOfEstimationDetail(value: object): value is EstimationDetail {
+    if (!('duration' in value) || value['duration'] === undefined) return false;
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    return true;
+}
+
+export function EstimationDetailFromJSON(json: any): EstimationDetail {
+    return EstimationDetailFromJSONTyped(json, false);
+}
+
+export function EstimationDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): EstimationDetail {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'duration': json['duration'],
+        'reason': json['reason'],
+    };
+}
+
+export function EstimationDetailToJSON(json: any): EstimationDetail {
+    return EstimationDetailToJSONTyped(json, false);
+}
+
+export function EstimationDetailToJSONTyped(value?: EstimationDetail | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'duration': value['duration'],
+        'reason': value['reason'],
+    };
+}
+

package/src/models/MigrationEstimationRequest.ts

@@ -0,0 +1,66 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime.js';
+/**
+ * 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 function instanceOfMigrationEstimationRequest(value: object): value is MigrationEstimationRequest {
+    if (!('clusterId' in value) || value['clusterId'] === undefined) return false;
+    return true;
+}
+
+export function MigrationEstimationRequestFromJSON(json: any): MigrationEstimationRequest {
+    return MigrationEstimationRequestFromJSONTyped(json, false);
+}
+
+export function MigrationEstimationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): MigrationEstimationRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'clusterId': json['clusterId'],
+    };
+}
+
+export function MigrationEstimationRequestToJSON(json: any): MigrationEstimationRequest {
+    return MigrationEstimationRequestToJSONTyped(json, false);
+}
+
+export function MigrationEstimationRequestToJSONTyped(value?: MigrationEstimationRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'clusterId': value['clusterId'],
+    };
+}
+

package/src/models/MigrationEstimationResponse.ts

@@ -0,0 +1,83 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime.js';
+import type { EstimationDetail } from './EstimationDetail.js';
+import {
+    EstimationDetailFromJSON,
+    EstimationDetailFromJSONTyped,
+    EstimationDetailToJSON,
+    EstimationDetailToJSONTyped,
+} 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 function instanceOfMigrationEstimationResponse(value: object): value is MigrationEstimationResponse {
+    if (!('totalDuration' in value) || value['totalDuration'] === undefined) return false;
+    if (!('breakdown' in value) || value['breakdown'] === undefined) return false;
+    return true;
+}
+
+export function MigrationEstimationResponseFromJSON(json: any): MigrationEstimationResponse {
+    return MigrationEstimationResponseFromJSONTyped(json, false);
+}
+
+export function MigrationEstimationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MigrationEstimationResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'totalDuration': json['totalDuration'],
+        'breakdown': (mapValues(json['breakdown'], EstimationDetailFromJSON)),
+    };
+}
+
+export function MigrationEstimationResponseToJSON(json: any): MigrationEstimationResponse {
+    return MigrationEstimationResponseToJSONTyped(json, false);
+}
+
+export function MigrationEstimationResponseToJSONTyped(value?: MigrationEstimationResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'totalDuration': value['totalDuration'],
+        'breakdown': (mapValues(value['breakdown'], EstimationDetailToJSON)),
+    };
+}
+

package/src/models/ModelError.ts

@@ -25,12 +25,6 @@ export interface ModelError {
      * @memberof ModelError
      */
     message: string;
-    /**
-     * Id of the request generating the error
-     * @type {string}
-     * @memberof ModelError
-     */
-    requestId?: string;
 }
 
 /**
@@ -52,7 +46,6 @@ export function ModelErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean)
     return {
         
         'message': json['message'],
-        'requestId': json['requestId'] == null ? undefined : json['requestId'],
     };
 }
 
@@ -68,7 +61,6 @@ export function ModelErrorToJSONTyped(value?: ModelError | null, ignoreDiscrimin
     return {
         
         'message': value['message'],
-        'requestId': value['requestId'],
     };
 }
 

package/src/models/index.ts

@@ -11,6 +11,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';
@@ -22,6 +23,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';