@openshift-migration-advisor/planner-sdk 0.4.0-2926c334319d

package/docs/Assessment.md

@@ -0,0 +1,48 @@
+
+# Assessment
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`ownerFirstName` | string
+`ownerLastName` | string
+`sourceType` | string
+`sourceId` | string
+`createdAt` | Date
+`snapshots` | [Array<Snapshot>](Snapshot.md)
+
+## Example
+
+```typescript
+import type { Assessment } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "ownerFirstName": null,
+  "ownerLastName": null,
+  "sourceType": null,
+  "sourceId": null,
+  "createdAt": null,
+  "snapshots": null,
+} satisfies Assessment
+
+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 Assessment
+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/AssessmentApi.md

@@ -0,0 +1,448 @@
+# AssessmentApi
+
+All URIs are relative to *https://raw.githubusercontent.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**calculateAssessmentClusterRequirements**](AssessmentApi.md#calculateassessmentclusterrequirements) | **POST** /api/v1/assessments/{id}/cluster-requirements |  |
+| [**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} |  |
+| [**listAssessments**](AssessmentApi.md#listassessments) | **GET** /api/v1/assessments |  |
+| [**updateAssessment**](AssessmentApi.md#updateassessment) | **PUT** /api/v1/assessments/{id} |  |
+
+
+
+## calculateAssessmentClusterRequirements
+
+> ClusterRequirementsResponse calculateAssessmentClusterRequirements(id, clusterRequirementsRequest)
+
+
+
+Calculate cluster requirements for an assessment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CalculateAssessmentClusterRequirementsRequest } 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,
+    // ClusterRequirementsRequest
+    clusterRequirementsRequest: ...,
+  } satisfies CalculateAssessmentClusterRequirementsRequest;
+
+  try {
+    const data = await api.calculateAssessmentClusterRequirements(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`] |
+| **clusterRequirementsRequest** | [ClusterRequirementsRequest](ClusterRequirementsRequest.md) |  | |
+
+### Return type
+
+[**ClusterRequirementsResponse**](ClusterRequirementsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Cluster requirements calculation successful |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Assessment not found |  -  |
+| **500** | Internal error |  -  |
+| **503** | Service Unavailable |  -  |
+
+[[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)
+
+
+
+Create an assessment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CreateAssessmentRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AssessmentApi();
+
+  const body = {
+    // AssessmentForm
+    assessmentForm: ...,
+  } satisfies CreateAssessmentRequest;
+
+  try {
+    const data = await api.createAssessment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assessmentForm** | [AssessmentForm](AssessmentForm.md) |  | |
+
+### Return type
+
+[**Assessment**](Assessment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Created |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **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)
+
+
+## deleteAssessment
+
+> Assessment deleteAssessment(id)
+
+
+
+Delete an assessment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { DeleteAssessmentRequest } 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,
+  } satisfies DeleteAssessmentRequest;
+
+  try {
+    const data = await api.deleteAssessment(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`] |
+
+### Return type
+
+[**Assessment**](Assessment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | NotFound |  -  |
+| **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)
+
+
+## getAssessment
+
+> Assessment getAssessment(id)
+
+
+
+Get the specified assessment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetAssessmentRequest } 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,
+  } satisfies GetAssessmentRequest;
+
+  try {
+    const data = await api.getAssessment(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`] |
+
+### Return type
+
+[**Assessment**](Assessment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | NotFound |  -  |
+| **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)
+
+
+
+List assessments
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { ListAssessmentsRequest } 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 | Filter assessments by source ID (optional)
+    sourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ListAssessmentsRequest;
+
+  try {
+    const data = await api.listAssessments(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sourceId** | `string` | Filter assessments by source ID | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<Assessment>**](Assessment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **401** | Unauthorized |  -  |
+| **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)
+
+
+## updateAssessment
+
+> Assessment updateAssessment(id, assessmentUpdate)
+
+
+
+Update an assessment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { UpdateAssessmentRequest } 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,
+    // AssessmentUpdate
+    assessmentUpdate: ...,
+  } satisfies UpdateAssessmentRequest;
+
+  try {
+    const data = await api.updateAssessment(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`] |
+| **assessmentUpdate** | [AssessmentUpdate](AssessmentUpdate.md) |  | |
+
+### Return type
+
+[**Assessment**](Assessment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | NotFound |  -  |
+| **500** | Internal Server Error |  -  |
+
+[[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/AssessmentForm.md

@@ -0,0 +1,40 @@
+
+# AssessmentForm
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`sourceType` | string
+`sourceId` | string
+`inventory` | [Inventory](Inventory.md)
+
+## Example
+
+```typescript
+import type { AssessmentForm } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "sourceType": null,
+  "sourceId": null,
+  "inventory": null,
+} satisfies AssessmentForm
+
+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 AssessmentForm
+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/AssessmentUpdate.md

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

@@ -0,0 +1,47 @@
+
+# ClusterRequirementsRequest
+
+Request payload for calculating cluster requirements
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clusterId` | string
+`cpuOverCommitRatio` | string
+`memoryOverCommitRatio` | string
+`workerNodeCPU` | number
+`workerNodeMemory` | number
+`workerNodeThreads` | number
+`controlPlaneSchedulable` | boolean
+
+## Example
+
+```typescript
+import type { ClusterRequirementsRequest } 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,
+} satisfies ClusterRequirementsRequest
+
+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 ClusterRequirementsRequest
+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/ClusterRequirementsResponse.md

@@ -0,0 +1,39 @@
+
+# ClusterRequirementsResponse
+
+Cluster requirements calculation results
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clusterSizing` | [ClusterSizing](ClusterSizing.md)
+`resourceConsumption` | [SizingResourceConsumption](SizingResourceConsumption.md)
+`inventoryTotals` | [InventoryTotals](InventoryTotals.md)
+
+## Example
+
+```typescript
+import type { ClusterRequirementsResponse } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "clusterSizing": null,
+  "resourceConsumption": null,
+  "inventoryTotals": null,
+} satisfies ClusterRequirementsResponse
+
+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 ClusterRequirementsResponse
+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/ClusterSizing.md

@@ -0,0 +1,45 @@
+
+# ClusterSizing
+
+Overall cluster sizing summary
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalNodes` | number
+`workerNodes` | number
+`controlPlaneNodes` | number
+`failoverNodes` | number
+`totalCPU` | number
+`totalMemory` | number
+
+## Example
+
+```typescript
+import type { ClusterSizing } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalNodes": null,
+  "workerNodes": null,
+  "controlPlaneNodes": null,
+  "failoverNodes": null,
+  "totalCPU": null,
+  "totalMemory": null,
+} satisfies ClusterSizing
+
+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 ClusterSizing
+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)
+
+