@openshift-migration-advisor/planner-sdk 0.10.0 → 0.11.0-72642107444

package/docs/AssessmentApi.md

@@ -11,6 +11,7 @@ All URIs are relative to *https://raw.githubusercontent.com*
 | [**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} |  |
+| [**getAssessmentClusterRequirementsStoredInput**](AssessmentApi.md#getassessmentclusterrequirementsstoredinput) | **GET** /api/v1/assessments/{id}/cluster-requirements/stored-input |  |
 | [**listAssessments**](AssessmentApi.md#listassessments) | **GET** /api/v1/assessments |  |
 | [**updateAssessment**](AssessmentApi.md#updateassessment) | **PUT** /api/v1/assessments/{id} |  |
 
@@ -169,7 +170,7 @@ No authorization required
 
 ## calculateMigrationEstimation
 
-> { [key: string]: SchemaEstimationResult; } calculateMigrationEstimation(id, migrationEstimationRequest)
+> MigrationEstimationResponse calculateMigrationEstimation(id, migrationEstimationRequest)
 
 
 
@@ -217,7 +218,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**{ [key: string]: SchemaEstimationResult; }**](SchemaEstimationResult.md)
+[**MigrationEstimationResponse**](MigrationEstimationResponse.md)
 
 ### Authorization
 
@@ -531,6 +532,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)
 
 
+## getAssessmentClusterRequirementsStoredInput
+
+> ClusterRequirementsStoredInput getAssessmentClusterRequirementsStoredInput(id, clusterId)
+
+
+
+Get stored cluster requirements input for an assessment cluster
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetAssessmentClusterRequirementsStoredInputRequest } 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,
+    // string | ID of the VMware cluster
+    clusterId: clusterId_example,
+  } satisfies GetAssessmentClusterRequirementsStoredInputRequest;
+
+  try {
+    const data = await api.getAssessmentClusterRequirementsStoredInput(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`] |
+| **clusterId** | `string` | ID of the VMware cluster | [Defaults to `undefined`] |
+
+### Return type
+
+[**ClusterRequirementsStoredInput**](ClusterRequirementsStoredInput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Stored cluster requirements input found |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Assessment or cluster requirements input 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)
+
+
 ## listAssessments
 
 > Array<Assessment> listAssessments(sourceId)

package/docs/ClusterRequirementsStoredInput.md

@@ -0,0 +1,55 @@
+
+# ClusterRequirementsStoredInput
+
+Stored cluster requirements payload for a cluster
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clusterId` | string
+`cpuOverCommitRatio` | string
+`memoryOverCommitRatio` | string
+`workerNodeCPU` | number
+`workerNodeMemory` | number
+`workerNodeThreads` | number
+`controlPlaneSchedulable` | boolean
+`controlPlaneCPU` | number
+`controlPlaneMemory` | number
+`controlPlaneNodeCount` | number
+`hostedControlPlane` | boolean
+
+## Example
+
+```typescript
+import type { ClusterRequirementsStoredInput } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "clusterId": null,
+  "cpuOverCommitRatio": null,
+  "memoryOverCommitRatio": null,
+  "workerNodeCPU": null,
+  "workerNodeMemory": null,
+  "workerNodeThreads": null,
+  "controlPlaneSchedulable": null,
+  "controlPlaneCPU": null,
+  "controlPlaneMemory": null,
+  "controlPlaneNodeCount": null,
+  "hostedControlPlane": null,
+} satisfies ClusterRequirementsStoredInput
+
+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 ClusterRequirementsStoredInput
+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/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)
+
+