@openshift-migration-advisor/planner-sdk 0.4.0-190ea33a47ea

package/docs/Snapshot.md

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

@@ -0,0 +1,50 @@
+
+# Source
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`inventory` | [Inventory](Inventory.md)
+`createdAt` | Date
+`updatedAt` | Date
+`onPremises` | boolean
+`agent` | [Agent](Agent.md)
+`labels` | [Array<Label>](Label.md)
+`infra` | [SourceInfra](SourceInfra.md)
+
+## Example
+
+```typescript
+import type { Source } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "inventory": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "onPremises": null,
+  "agent": null,
+  "labels": null,
+  "infra": null,
+} satisfies Source
+
+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 Source
+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/SourceApi.md

@@ -0,0 +1,501 @@
+# SourceApi
+
+All URIs are relative to *https://raw.githubusercontent.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createSource**](SourceApi.md#createsource) | **POST** /api/v1/sources |  |
+| [**deleteSource**](SourceApi.md#deletesource) | **DELETE** /api/v1/sources/{id} |  |
+| [**deleteSources**](SourceApi.md#deletesources) | **DELETE** /api/v1/sources |  |
+| [**getSource**](SourceApi.md#getsource) | **GET** /api/v1/sources/{id} |  |
+| [**listSources**](SourceApi.md#listsources) | **GET** /api/v1/sources |  |
+| [**updateInventory**](SourceApi.md#updateinventory) | **PUT** /api/v1/sources/{id}/inventory |  |
+| [**updateSource**](SourceApi.md#updatesource) | **PUT** /api/v1/sources/{id} |  |
+
+
+
+## createSource
+
+> Source createSource(sourceCreate)
+
+
+
+Create a source
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SourceApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CreateSourceRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new SourceApi();
+
+  const body = {
+    // SourceCreate
+    sourceCreate: ...,
+  } satisfies CreateSourceRequest;
+
+  try {
+    const data = await api.createSource(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sourceCreate** | [SourceCreate](SourceCreate.md) |  | |
+
+### Return type
+
+[**Source**](Source.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)
+
+
+## deleteSource
+
+> Source deleteSource(id)
+
+
+
+Delete a source
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SourceApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { DeleteSourceRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new SourceApi();
+
+  const body = {
+    // string | ID of the source
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteSourceRequest;
+
+  try {
+    const data = await api.deleteSource(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
+
+[**Source**](Source.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** | NotFound |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteSources
+
+> Status deleteSources()
+
+
+
+delete a collection of sources
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SourceApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { DeleteSourcesRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new SourceApi();
+
+  try {
+    const data = await api.deleteSources();
+    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
+
+[**Status**](Status.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)
+
+
+## getSource
+
+> Source getSource(id)
+
+
+
+Get the specified source
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SourceApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetSourceRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new SourceApi();
+
+  const body = {
+    // string | ID of the source
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetSourceRequest;
+
+  try {
+    const data = await api.getSource(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
+
+[**Source**](Source.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)
+
+
+## listSources
+
+> Array<Source> listSources()
+
+
+
+List sources
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SourceApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { ListSourcesRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new SourceApi();
+
+  try {
+    const data = await api.listSources();
+    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
+
+[**Array<Source>**](Source.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)
+
+
+## updateInventory
+
+> Source updateInventory(id, updateInventory)
+
+
+
+Update inventory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SourceApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { UpdateInventoryRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new SourceApi();
+
+  const body = {
+    // string | ID of the source
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateInventory
+    updateInventory: ...,
+  } satisfies UpdateInventoryRequest;
+
+  try {
+    const data = await api.updateInventory(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`] |
+| **updateInventory** | [UpdateInventory](UpdateInventory.md) |  | |
+
+### Return type
+
+[**Source**](Source.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated source inventory |  -  |
+| **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)
+
+
+## updateSource
+
+> Source updateSource(id, sourceUpdate)
+
+
+
+Update source
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SourceApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { UpdateSourceRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new SourceApi();
+
+  const body = {
+    // string | ID of the source
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // SourceUpdate
+    sourceUpdate: ...,
+  } satisfies UpdateSourceRequest;
+
+  try {
+    const data = await api.updateSource(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`] |
+| **sourceUpdate** | [SourceUpdate](SourceUpdate.md) |  | |
+
+### Return type
+
+[**Source**](Source.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated source |  -  |
+| **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/SourceCreate.md

@@ -0,0 +1,44 @@
+
+# SourceCreate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`sshPublicKey` | string
+`proxy` | [AgentProxy](AgentProxy.md)
+`certificateChain` | string
+`network` | [VmNetwork](VmNetwork.md)
+`labels` | [Array<Label>](Label.md)
+
+## Example
+
+```typescript
+import type { SourceCreate } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "sshPublicKey": null,
+  "proxy": null,
+  "certificateChain": null,
+  "network": null,
+  "labels": null,
+} satisfies SourceCreate
+
+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 SourceCreate
+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/SourceInfra.md

@@ -0,0 +1,38 @@
+
+# SourceInfra
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`proxy` | [AgentProxy](AgentProxy.md)
+`sshPublicKey` | string
+`vmNetwork` | [VmNetwork](VmNetwork.md)
+
+## Example
+
+```typescript
+import type { SourceInfra } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "proxy": null,
+  "sshPublicKey": null,
+  "vmNetwork": null,
+} satisfies SourceInfra
+
+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 SourceInfra
+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/SourceUpdate.md

@@ -0,0 +1,44 @@
+
+# SourceUpdate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`labels` | [Array<Label>](Label.md)
+`sshPublicKey` | string
+`certificateChain` | string
+`proxy` | [AgentProxy](AgentProxy.md)
+`network` | [VmNetwork](VmNetwork.md)
+
+## Example
+
+```typescript
+import type { SourceUpdate } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "labels": null,
+  "sshPublicKey": null,
+  "certificateChain": null,
+  "proxy": null,
+  "network": null,
+} satisfies SourceUpdate
+
+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 SourceUpdate
+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)
+
+