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

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/Group.md

@@ -0,0 +1,48 @@
+
+# Group
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`kind` | string
+`icon` | string
+`company` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { Group } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "kind": null,
+  "icon": null,
+  "company": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies Group
+
+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 Group
+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/GroupCreate.md

@@ -0,0 +1,42 @@
+
+# GroupCreate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`kind` | string
+`icon` | string
+`company` | string
+
+## Example
+
+```typescript
+import type { GroupCreate } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "kind": null,
+  "icon": null,
+  "company": null,
+} satisfies GroupCreate
+
+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 GroupCreate
+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/GroupUpdate.md

@@ -0,0 +1,40 @@
+
+# GroupUpdate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`icon` | string
+`company` | string
+
+## Example
+
+```typescript
+import type { GroupUpdate } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "icon": null,
+  "company": null,
+} satisfies GroupUpdate
+
+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 GroupUpdate
+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/Identity.md

@@ -0,0 +1,40 @@
+
+# Identity
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`kind` | string
+`groupId` | string
+`partnerId` | string
+
+## Example
+
+```typescript
+import type { Identity } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+  "kind": null,
+  "groupId": null,
+  "partnerId": null,
+} satisfies Identity
+
+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 Identity
+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/Member.md

@@ -0,0 +1,42 @@
+
+# Member
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`email` | string
+`groupId` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { Member } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+  "email": null,
+  "groupId": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies Member
+
+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 Member
+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/MemberCreate.md

@@ -0,0 +1,36 @@
+
+# MemberCreate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`email` | string
+
+## Example
+
+```typescript
+import type { MemberCreate } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+  "email": null,
+} satisfies MemberCreate
+
+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 MemberCreate
+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/MemberUpdate.md

@@ -0,0 +1,34 @@
+
+# MemberUpdate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+
+## Example
+
+```typescript
+import type { MemberUpdate } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": null,
+} satisfies MemberUpdate
+
+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 MemberUpdate
+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)
+
+

package/docs/OsDiskEstimationEntry.md

@@ -0,0 +1,40 @@
+
+# OsDiskEstimationEntry
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`score` | number
+`vmCount` | number
+`totalDiskSizeTB` | number
+`estimation` | [{ [key: string]: SchemaEstimationResult; }](SchemaEstimationResult.md)
+
+## Example
+
+```typescript
+import type { OsDiskEstimationEntry } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "score": null,
+  "vmCount": null,
+  "totalDiskSizeTB": null,
+  "estimation": null,
+} satisfies OsDiskEstimationEntry
+
+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 OsDiskEstimationEntry
+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/package.json

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