@openshift-migration-advisor/planner-sdk 0.10.0-fa4e0ff47672 → 0.11.0-7cc84aae7ba0

package/dist/models/PartnerRequest.js

@@ -0,0 +1,89 @@
+"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.instanceOfPartnerRequest = instanceOfPartnerRequest;
+exports.PartnerRequestFromJSON = PartnerRequestFromJSON;
+exports.PartnerRequestFromJSONTyped = PartnerRequestFromJSONTyped;
+exports.PartnerRequestToJSON = PartnerRequestToJSON;
+exports.PartnerRequestToJSONTyped = PartnerRequestToJSONTyped;
+const PartnerRequestStatus_js_1 = require("./PartnerRequestStatus.js");
+/**
+ * Check if a given object implements the PartnerRequest interface.
+ */
+function instanceOfPartnerRequest(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('username' in value) || value['username'] === undefined)
+        return false;
+    if (!('partnerId' in value) || value['partnerId'] === undefined)
+        return false;
+    if (!('requestStatus' in value) || value['requestStatus'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('contactName' in value) || value['contactName'] === undefined)
+        return false;
+    if (!('contactPhone' in value) || value['contactPhone'] === undefined)
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    if (!('location' in value) || value['location'] === undefined)
+        return false;
+    return true;
+}
+function PartnerRequestFromJSON(json) {
+    return PartnerRequestFromJSONTyped(json, false);
+}
+function PartnerRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'username': json['username'],
+        'partnerId': json['partnerId'],
+        'requestStatus': (0, PartnerRequestStatus_js_1.PartnerRequestStatusFromJSON)(json['requestStatus']),
+        'name': json['name'],
+        'contactName': json['contactName'],
+        'contactPhone': json['contactPhone'],
+        'email': json['email'],
+        'location': json['location'],
+        'reason': json['reason'] == null ? undefined : json['reason'],
+        'acceptedAt': json['acceptedAt'] == null ? undefined : (new Date(json['acceptedAt'])),
+        'terminatedAt': json['terminatedAt'] == null ? undefined : (new Date(json['terminatedAt'])),
+    };
+}
+function PartnerRequestToJSON(json) {
+    return PartnerRequestToJSONTyped(json, false);
+}
+function PartnerRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'username': value['username'],
+        'partnerId': value['partnerId'],
+        'requestStatus': (0, PartnerRequestStatus_js_1.PartnerRequestStatusToJSON)(value['requestStatus']),
+        'name': value['name'],
+        'contactName': value['contactName'],
+        'contactPhone': value['contactPhone'],
+        'email': value['email'],
+        'location': value['location'],
+        'reason': value['reason'],
+        'acceptedAt': value['acceptedAt'] == null ? value['acceptedAt'] : value['acceptedAt'].toISOString(),
+        'terminatedAt': value['terminatedAt'] == null ? value['terminatedAt'] : value['terminatedAt'].toISOString(),
+    };
+}

package/dist/models/PartnerRequestCreate.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 PartnerRequestCreate
+ */
+export interface PartnerRequestCreate {
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerRequestCreate
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerRequestCreate
+     */
+    contactName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerRequestCreate
+     */
+    contactPhone: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerRequestCreate
+     */
+    email: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerRequestCreate
+     */
+    location: string;
+}
+/**
+ * Check if a given object implements the PartnerRequestCreate interface.
+ */
+export declare function instanceOfPartnerRequestCreate(value: object): value is PartnerRequestCreate;
+export declare function PartnerRequestCreateFromJSON(json: any): PartnerRequestCreate;
+export declare function PartnerRequestCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerRequestCreate;
+export declare function PartnerRequestCreateToJSON(json: any): PartnerRequestCreate;
+export declare function PartnerRequestCreateToJSONTyped(value?: PartnerRequestCreate | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PartnerRequestCreate.js

@@ -0,0 +1,66 @@
+"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.instanceOfPartnerRequestCreate = instanceOfPartnerRequestCreate;
+exports.PartnerRequestCreateFromJSON = PartnerRequestCreateFromJSON;
+exports.PartnerRequestCreateFromJSONTyped = PartnerRequestCreateFromJSONTyped;
+exports.PartnerRequestCreateToJSON = PartnerRequestCreateToJSON;
+exports.PartnerRequestCreateToJSONTyped = PartnerRequestCreateToJSONTyped;
+/**
+ * Check if a given object implements the PartnerRequestCreate interface.
+ */
+function instanceOfPartnerRequestCreate(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('contactName' in value) || value['contactName'] === undefined)
+        return false;
+    if (!('contactPhone' in value) || value['contactPhone'] === undefined)
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    if (!('location' in value) || value['location'] === undefined)
+        return false;
+    return true;
+}
+function PartnerRequestCreateFromJSON(json) {
+    return PartnerRequestCreateFromJSONTyped(json, false);
+}
+function PartnerRequestCreateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'contactName': json['contactName'],
+        'contactPhone': json['contactPhone'],
+        'email': json['email'],
+        'location': json['location'],
+    };
+}
+function PartnerRequestCreateToJSON(json) {
+    return PartnerRequestCreateToJSONTyped(json, false);
+}
+function PartnerRequestCreateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'contactName': value['contactName'],
+        'contactPhone': value['contactPhone'],
+        'email': value['email'],
+        'location': value['location'],
+    };
+}

package/dist/models/PartnerRequestStatus.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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
+ */
+export declare const PartnerRequestStatus: {
+    readonly Pending: "pending";
+    readonly Accepted: "accepted";
+    readonly Rejected: "rejected";
+    readonly Cancelled: "cancelled";
+};
+export type PartnerRequestStatus = typeof PartnerRequestStatus[keyof typeof PartnerRequestStatus];
+export declare function instanceOfPartnerRequestStatus(value: any): boolean;
+export declare function PartnerRequestStatusFromJSON(json: any): PartnerRequestStatus;
+export declare function PartnerRequestStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerRequestStatus;
+export declare function PartnerRequestStatusToJSON(value?: PartnerRequestStatus | null): any;
+export declare function PartnerRequestStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): PartnerRequestStatus;

package/dist/models/PartnerRequestStatus.js

@@ -0,0 +1,53 @@
+"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.PartnerRequestStatus = void 0;
+exports.instanceOfPartnerRequestStatus = instanceOfPartnerRequestStatus;
+exports.PartnerRequestStatusFromJSON = PartnerRequestStatusFromJSON;
+exports.PartnerRequestStatusFromJSONTyped = PartnerRequestStatusFromJSONTyped;
+exports.PartnerRequestStatusToJSON = PartnerRequestStatusToJSON;
+exports.PartnerRequestStatusToJSONTyped = PartnerRequestStatusToJSONTyped;
+/**
+ *
+ * @export
+ */
+exports.PartnerRequestStatus = {
+    Pending: 'pending',
+    Accepted: 'accepted',
+    Rejected: 'rejected',
+    Cancelled: 'cancelled'
+};
+function instanceOfPartnerRequestStatus(value) {
+    for (const key in exports.PartnerRequestStatus) {
+        if (Object.prototype.hasOwnProperty.call(exports.PartnerRequestStatus, key)) {
+            if (exports.PartnerRequestStatus[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function PartnerRequestStatusFromJSON(json) {
+    return PartnerRequestStatusFromJSONTyped(json, false);
+}
+function PartnerRequestStatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function PartnerRequestStatusToJSON(value) {
+    return value;
+}
+function PartnerRequestStatusToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/PartnerRequestUpdate.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { PartnerRequestStatus } from './PartnerRequestStatus.js';
+/**
+ *
+ * @export
+ * @interface PartnerRequestUpdate
+ */
+export interface PartnerRequestUpdate {
+    /**
+     *
+     * @type {PartnerRequestStatus}
+     * @memberof PartnerRequestUpdate
+     */
+    status: PartnerRequestStatus;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerRequestUpdate
+     */
+    reason?: string;
+}
+/**
+ * Check if a given object implements the PartnerRequestUpdate interface.
+ */
+export declare function instanceOfPartnerRequestUpdate(value: object): value is PartnerRequestUpdate;
+export declare function PartnerRequestUpdateFromJSON(json: any): PartnerRequestUpdate;
+export declare function PartnerRequestUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerRequestUpdate;
+export declare function PartnerRequestUpdateToJSON(json: any): PartnerRequestUpdate;
+export declare function PartnerRequestUpdateToJSONTyped(value?: PartnerRequestUpdate | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PartnerRequestUpdate.js

@@ -0,0 +1,53 @@
+"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.instanceOfPartnerRequestUpdate = instanceOfPartnerRequestUpdate;
+exports.PartnerRequestUpdateFromJSON = PartnerRequestUpdateFromJSON;
+exports.PartnerRequestUpdateFromJSONTyped = PartnerRequestUpdateFromJSONTyped;
+exports.PartnerRequestUpdateToJSON = PartnerRequestUpdateToJSON;
+exports.PartnerRequestUpdateToJSONTyped = PartnerRequestUpdateToJSONTyped;
+const PartnerRequestStatus_js_1 = require("./PartnerRequestStatus.js");
+/**
+ * Check if a given object implements the PartnerRequestUpdate interface.
+ */
+function instanceOfPartnerRequestUpdate(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+function PartnerRequestUpdateFromJSON(json) {
+    return PartnerRequestUpdateFromJSONTyped(json, false);
+}
+function PartnerRequestUpdateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': (0, PartnerRequestStatus_js_1.PartnerRequestStatusFromJSON)(json['status']),
+        'reason': json['reason'] == null ? undefined : json['reason'],
+    };
+}
+function PartnerRequestUpdateToJSON(json) {
+    return PartnerRequestUpdateToJSONTyped(json, false);
+}
+function PartnerRequestUpdateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': (0, PartnerRequestStatus_js_1.PartnerRequestStatusToJSON)(value['status']),
+        'reason': value['reason'],
+    };
+}

package/dist/models/index.d.ts

@@ -36,11 +36,16 @@ export * from './MigrationComplexityRequest.js';
 export * from './MigrationComplexityResponse.js';
 export * from './MigrationEstimationByComplexityResponse.js';
 export * from './MigrationEstimationRequest.js';
+export * from './MigrationEstimationResponse.js';
 export * from './MigrationIssue.js';
 export * from './ModelError.js';
 export * from './Network.js';
 export * from './OsDiskEstimationEntry.js';
 export * from './OsInfo.js';
+export * from './PartnerRequest.js';
+export * from './PartnerRequestCreate.js';
+export * from './PartnerRequestStatus.js';
+export * from './PartnerRequestUpdate.js';
 export * from './PresignedUrl.js';
 export * from './SchemaEstimationResult.js';
 export * from './SizingOverCommitRatio.js';

package/dist/models/index.js

@@ -54,11 +54,16 @@ __exportStar(require("./MigrationComplexityRequest.js"), exports);
 __exportStar(require("./MigrationComplexityResponse.js"), exports);
 __exportStar(require("./MigrationEstimationByComplexityResponse.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);
 __exportStar(require("./OsDiskEstimationEntry.js"), exports);
 __exportStar(require("./OsInfo.js"), exports);
+__exportStar(require("./PartnerRequest.js"), exports);
+__exportStar(require("./PartnerRequestCreate.js"), exports);
+__exportStar(require("./PartnerRequestStatus.js"), exports);
+__exportStar(require("./PartnerRequestUpdate.js"), exports);
 __exportStar(require("./PresignedUrl.js"), exports);
 __exportStar(require("./SchemaEstimationResult.js"), exports);
 __exportStar(require("./SizingOverCommitRatio.js"), exports);

package/docs/AssessmentApi.md

@@ -169,7 +169,7 @@ No authorization required
 
 ## calculateMigrationEstimation
 
-> { [key: string]: SchemaEstimationResult; } calculateMigrationEstimation(id, migrationEstimationRequest)
+> MigrationEstimationResponse calculateMigrationEstimation(id, migrationEstimationRequest)
 
 
 
@@ -217,7 +217,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**{ [key: string]: SchemaEstimationResult; }**](SchemaEstimationResult.md)
+[**MigrationEstimationResponse**](MigrationEstimationResponse.md)
 
 ### Authorization
 

package/docs/MigrationEstimationResponse.md

@@ -0,0 +1,37 @@
+
+# MigrationEstimationResponse
+
+Migration estimation result, including per-schema results and the parameters used. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`estimation` | [{ [key: string]: SchemaEstimationResult; }](SchemaEstimationResult.md)
+`estimationContext` | [EstimationContext](EstimationContext.md)
+
+## Example
+
+```typescript
+import type { MigrationEstimationResponse } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "estimation": null,
+  "estimationContext": 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)
+
+