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

package/docs/Ipv4Config.md

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

@@ -0,0 +1,41 @@
+
+# Job
+
+Background job for async assessment creation
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`status` | [JobStatus](JobStatus.md)
+`error` | string
+`assessmentId` | string
+
+## Example
+
+```typescript
+import type { Job } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "error": null,
+  "assessmentId": null,
+} satisfies Job
+
+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 Job
+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/JobApi.md

@@ -0,0 +1,229 @@
+# JobApi
+
+All URIs are relative to *https://raw.githubusercontent.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cancelJob**](JobApi.md#canceljob) | **DELETE** /api/v1/assessments/jobs/{id} |  |
+| [**createRVToolsAssessment**](JobApi.md#creatervtoolsassessment) | **POST** /api/v1/assessments/rvtools |  |
+| [**getJob**](JobApi.md#getjob) | **GET** /api/v1/assessments/jobs/{id} |  |
+
+
+
+## cancelJob
+
+> Job cancelJob(id)
+
+
+
+Cancel a job
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CancelJobRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new JobApi();
+
+  const body = {
+    // number | ID of the job
+    id: 789,
+  } satisfies CancelJobRequest;
+
+  try {
+    const data = await api.cancelJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | ID of the job | [Defaults to `undefined`] |
+
+### Return type
+
+[**Job**](Job.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 |  -  |
+| **409** | Conflict |  -  |
+| **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)
+
+
+## createRVToolsAssessment
+
+> Job createRVToolsAssessment(name, file)
+
+
+
+Create an assessment from RVTools file asynchronously
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CreateRVToolsAssessmentRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new JobApi();
+
+  const body = {
+    // string | Name of the assessment
+    name: name_example,
+    // Blob | File upload for assessment data
+    file: BINARY_DATA_HERE,
+  } satisfies CreateRVToolsAssessmentRequest;
+
+  try {
+    const data = await api.createRVToolsAssessment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **name** | `string` | Name of the assessment | [Defaults to `undefined`] |
+| **file** | `Blob` | File upload for assessment data | [Defaults to `undefined`] |
+
+### Return type
+
+[**Job**](Job.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Accepted - Job 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)
+
+
+## getJob
+
+> Job getJob(id)
+
+
+
+Get job status
+
+### Example
+
+```ts
+import {
+  Configuration,
+  JobApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetJobRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new JobApi();
+
+  const body = {
+    // number | ID of the job
+    id: 789,
+  } satisfies GetJobRequest;
+
+  try {
+    const data = await api.getJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | ID of the job | [Defaults to `undefined`] |
+
+### Return type
+
+[**Job**](Job.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)
+

package/docs/JobStatus.md

@@ -0,0 +1,33 @@
+
+# JobStatus
+
+Job status:  * `pending` - Job is queued  * `parsing` - Parsing RVTools Excel file  * `validating` - Running OPA VM validations  * `completed` - Assessment created successfully  * `failed` - Job failed with error  * `cancelled` - Job was cancelled 
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { JobStatus } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies JobStatus
+
+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 JobStatus
+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/Label.md

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

@@ -0,0 +1,40 @@
+
+# MigrationIssue
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`label` | string
+`assessment` | string
+`count` | number
+
+## Example
+
+```typescript
+import type { MigrationIssue } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "label": null,
+  "assessment": null,
+  "count": null,
+} satisfies MigrationIssue
+
+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 MigrationIssue
+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/ModelError.md

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

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

@@ -0,0 +1,38 @@
+
+# OsInfo
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`supported` | boolean
+`upgradeRecommendation` | string
+
+## Example
+
+```typescript
+import type { OsInfo } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": null,
+  "supported": null,
+  "upgradeRecommendation": null,
+} satisfies OsInfo
+
+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 OsInfo
+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/PresignedUrl.md

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

@@ -0,0 +1,37 @@
+
+# SizingOverCommitRatio
+
+Over-commit ratios
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cpu` | number
+`memory` | number
+
+## Example
+
+```typescript
+import type { SizingOverCommitRatio } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cpu": null,
+  "memory": null,
+} satisfies SizingOverCommitRatio
+
+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 SizingOverCommitRatio
+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/SizingResourceConsumption.md

@@ -0,0 +1,41 @@
+
+# SizingResourceConsumption
+
+Resource consumption across the cluster
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cpu` | number
+`memory` | number
+`limits` | [SizingResourceLimits](SizingResourceLimits.md)
+`overCommitRatio` | [SizingOverCommitRatio](SizingOverCommitRatio.md)
+
+## Example
+
+```typescript
+import type { SizingResourceConsumption } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cpu": null,
+  "memory": null,
+  "limits": null,
+  "overCommitRatio": null,
+} satisfies SizingResourceConsumption
+
+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 SizingResourceConsumption
+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/SizingResourceLimits.md

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