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

package/docs/Datastore.md

@@ -0,0 +1,50 @@
+
+# Datastore
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`totalCapacityGB` | number
+`freeCapacityGB` | number
+`vendor` | string
+`diskId` | string
+`hardwareAcceleratedMove` | boolean
+`protocolType` | string
+`model` | string
+`hostId` | string
+
+## Example
+
+```typescript
+import type { Datastore } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "totalCapacityGB": null,
+  "freeCapacityGB": null,
+  "vendor": null,
+  "diskId": null,
+  "hardwareAcceleratedMove": null,
+  "protocolType": null,
+  "model": null,
+  "hostId": null,
+} satisfies Datastore
+
+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 Datastore
+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/DiskSizeTierSummary.md

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

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

@@ -0,0 +1,68 @@
+# HealthApi
+
+All URIs are relative to *https://raw.githubusercontent.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**health**](HealthApi.md#health) | **GET** /health |  |
+
+
+
+## health
+
+> health()
+
+
+
+health check
+
+### Example
+
+```ts
+import {
+  Configuration,
+  HealthApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { HealthRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new HealthApi();
+
+  try {
+    const data = await api.health();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+
+[[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/Histogram.md

@@ -0,0 +1,38 @@
+
+# Histogram
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`minValue` | number
+`step` | number
+`data` | Array<number>
+
+## Example
+
+```typescript
+import type { Histogram } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "minValue": null,
+  "step": null,
+  "data": null,
+} satisfies Histogram
+
+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 Histogram
+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/Host.md

@@ -0,0 +1,44 @@
+
+# Host
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`vendor` | string
+`model` | string
+`cpuCores` | number
+`cpuSockets` | number
+`memoryMB` | number
+
+## Example
+
+```typescript
+import type { Host } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "vendor": null,
+  "model": null,
+  "cpuCores": null,
+  "cpuSockets": null,
+  "memoryMB": null,
+} satisfies Host
+
+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 Host
+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/ImageApi.md

@@ -0,0 +1,152 @@
+# ImageApi
+
+All URIs are relative to *https://raw.githubusercontent.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getSourceDownloadURL**](ImageApi.md#getsourcedownloadurl) | **GET** /api/v1/sources/{id}/image-url |  |
+| [**headImage**](ImageApi.md#headimage) | **HEAD** /api/v1/sources/{id}/image |  |
+
+
+
+## getSourceDownloadURL
+
+> PresignedUrl getSourceDownloadURL(id)
+
+
+
+Get the OVA image via URL
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ImageApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetSourceDownloadURLRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new ImageApi();
+
+  const body = {
+    // string | Source id
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetSourceDownloadURLRequest;
+
+  try {
+    const data = await api.getSourceDownloadURL(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Source id | [Defaults to `undefined`] |
+
+### Return type
+
+[**PresignedUrl**](PresignedUrl.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | URL to download OVA image |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | NotFound |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## headImage
+
+> headImage(id)
+
+
+
+Head the OVA image
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ImageApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { HeadImageRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new ImageApi();
+
+  const body = {
+    // string | Id of the source
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies HeadImageRequest;
+
+  try {
+    const data = await api.headImage(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 source | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### 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/Info.md

@@ -0,0 +1,37 @@
+
+# Info
+
+Migration planner information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`gitCommit` | string
+`versionName` | string
+
+## Example
+
+```typescript
+import type { Info } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "gitCommit": c5a1661465a25b17ceeeb77d1ec40deb57d8da44,
+  "versionName": 0.1.4-40-gc5a1661,
+} satisfies Info
+
+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 Info
+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/InfoApi.md

@@ -0,0 +1,69 @@
+# InfoApi
+
+All URIs are relative to *https://raw.githubusercontent.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getInfo**](InfoApi.md#getinfo) | **GET** /api/v1/info |  |
+
+
+
+## getInfo
+
+> Info getInfo()
+
+
+
+Get migration planner information
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InfoApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetInfoRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new InfoApi();
+
+  try {
+    const data = await api.getInfo();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Info**](Info.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 |  -  |
+| **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/Infra.md

@@ -0,0 +1,56 @@
+
+# Infra
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalHosts` | number
+`totalDatacenters` | number
+`totalClusters` | number
+`clustersPerDatacenter` | Array<number>
+`cpuOverCommitment` | number
+`memoryOverCommitment` | number
+`hosts` | [Array<Host>](Host.md)
+`hostsPerCluster` | Array<number>
+`vmsPerCluster` | Array<number>
+`hostPowerStates` | { [key: string]: number; }
+`networks` | [Array<Network>](Network.md)
+`datastores` | [Array<Datastore>](Datastore.md)
+
+## Example
+
+```typescript
+import type { Infra } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalHosts": null,
+  "totalDatacenters": null,
+  "totalClusters": null,
+  "clustersPerDatacenter": null,
+  "cpuOverCommitment": null,
+  "memoryOverCommitment": null,
+  "hosts": null,
+  "hostsPerCluster": null,
+  "vmsPerCluster": null,
+  "hostPowerStates": null,
+  "networks": null,
+  "datastores": null,
+} satisfies Infra
+
+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 Infra
+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/Inventory.md

@@ -0,0 +1,38 @@
+
+# Inventory
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`vcenterId` | string
+`clusters` | [{ [key: string]: InventoryData; }](InventoryData.md)
+`vcenter` | [InventoryData](InventoryData.md)
+
+## Example
+
+```typescript
+import type { Inventory } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "vcenterId": null,
+  "clusters": null,
+  "vcenter": null,
+} satisfies Inventory
+
+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 Inventory
+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/InventoryData.md

@@ -0,0 +1,38 @@
+
+# InventoryData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`vcenter` | [VCenter](VCenter.md)
+`vms` | [VMs](VMs.md)
+`infra` | [Infra](Infra.md)
+
+## Example
+
+```typescript
+import type { InventoryData } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "vcenter": null,
+  "vms": null,
+  "infra": null,
+} satisfies InventoryData
+
+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 InventoryData
+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/InventoryTotals.md

@@ -0,0 +1,39 @@
+
+# InventoryTotals
+
+Inventory totals for the cluster
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalVMs` | number
+`totalCPU` | number
+`totalMemory` | number
+
+## Example
+
+```typescript
+import type { InventoryTotals } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalVMs": null,
+  "totalCPU": null,
+  "totalMemory": null,
+} satisfies InventoryTotals
+
+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 InventoryTotals
+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)
+
+