@openshift-migration-advisor/planner-sdk 0.11.0 → 0.12.0-7e11634ba97d

package/dist/models/VmNetwork.js

@@ -5,7 +5,7 @@
  * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: undefined
+ * The version of the OpenAPI document: v1alpha1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/index.d.ts

@@ -2,13 +2,16 @@ export * from './Agent.js';
 export * from './AgentProxy.js';
 export * from './Assessment.js';
 export * from './AssessmentForm.js';
+export * from './AssessmentSharing.js';
 export * from './AssessmentUpdate.js';
 export * from './ClusterRequirementsRequest.js';
 export * from './ClusterRequirementsResponse.js';
+export * from './ClusterRequirementsStoredInput.js';
 export * from './ClusterSizing.js';
 export * from './ComplexityDiskScoreEntry.js';
 export * from './ComplexityOSNameEntry.js';
 export * from './ComplexityOSScoreEntry.js';
+export * from './Customer.js';
 export * from './Datastore.js';
 export * from './DiskSizeTierSummary.js';
 export * from './DiskTypeSummary.js';
@@ -42,8 +45,14 @@ export * from './ModelError.js';
 export * from './Network.js';
 export * from './OsDiskEstimationEntry.js';
 export * from './OsInfo.js';
+export * from './PartnerRequest.js';
+export * from './PartnerRequestCreate.js';
+export * from './PartnerRequestStatus.js';
+export * from './PartnerRequestUpdate.js';
+export * from './PartnerSummary.js';
 export * from './PresignedUrl.js';
 export * from './SchemaEstimationResult.js';
+export * from './SharingSubject.js';
 export * from './SizingOverCommitRatio.js';
 export * from './SizingResourceConsumption.js';
 export * from './SizingResourceLimits.js';

package/dist/models/index.js

@@ -20,13 +20,16 @@ __exportStar(require("./Agent.js"), exports);
 __exportStar(require("./AgentProxy.js"), exports);
 __exportStar(require("./Assessment.js"), exports);
 __exportStar(require("./AssessmentForm.js"), exports);
+__exportStar(require("./AssessmentSharing.js"), exports);
 __exportStar(require("./AssessmentUpdate.js"), exports);
 __exportStar(require("./ClusterRequirementsRequest.js"), exports);
 __exportStar(require("./ClusterRequirementsResponse.js"), exports);
+__exportStar(require("./ClusterRequirementsStoredInput.js"), exports);
 __exportStar(require("./ClusterSizing.js"), exports);
 __exportStar(require("./ComplexityDiskScoreEntry.js"), exports);
 __exportStar(require("./ComplexityOSNameEntry.js"), exports);
 __exportStar(require("./ComplexityOSScoreEntry.js"), exports);
+__exportStar(require("./Customer.js"), exports);
 __exportStar(require("./Datastore.js"), exports);
 __exportStar(require("./DiskSizeTierSummary.js"), exports);
 __exportStar(require("./DiskTypeSummary.js"), exports);
@@ -60,8 +63,14 @@ __exportStar(require("./ModelError.js"), exports);
 __exportStar(require("./Network.js"), exports);
 __exportStar(require("./OsDiskEstimationEntry.js"), exports);
 __exportStar(require("./OsInfo.js"), exports);
+__exportStar(require("./PartnerRequest.js"), exports);
+__exportStar(require("./PartnerRequestCreate.js"), exports);
+__exportStar(require("./PartnerRequestStatus.js"), exports);
+__exportStar(require("./PartnerRequestUpdate.js"), exports);
+__exportStar(require("./PartnerSummary.js"), exports);
 __exportStar(require("./PresignedUrl.js"), exports);
 __exportStar(require("./SchemaEstimationResult.js"), exports);
+__exportStar(require("./SharingSubject.js"), exports);
 __exportStar(require("./SizingOverCommitRatio.js"), exports);
 __exportStar(require("./SizingResourceConsumption.js"), exports);
 __exportStar(require("./SizingResourceLimits.js"), exports);

package/dist/runtime.d.ts

@@ -2,7 +2,7 @@
  * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: undefined
+ * The version of the OpenAPI document: v1alpha1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime.js

@@ -5,7 +5,7 @@
  * OpenShift Migration Advisor API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: undefined
+ * The version of the OpenAPI document: v1alpha1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/Assessment.md

@@ -14,6 +14,8 @@ Name | Type
 `sourceId` | string
 `createdAt` | Date
 `snapshots` | [Array<Snapshot>](Snapshot.md)
+`permissions` | Array<string>
+`sharing` | [AssessmentSharing](AssessmentSharing.md)
 
 ## Example
 
@@ -30,6 +32,8 @@ const example = {
   "sourceId": null,
   "createdAt": null,
   "snapshots": null,
+  "permissions": null,
+  "sharing": null,
 } satisfies Assessment
 
 console.log(example)

package/docs/AssessmentApi.md

@@ -11,7 +11,10 @@ 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 |  |
+| [**shareAssessment**](AssessmentApi.md#shareassessment) | **POST** /api/v1/assessments/{id}/share |  |
+| [**unshareAssessment**](AssessmentApi.md#unshareassessment) | **DELETE** /api/v1/assessments/{id}/share |  |
 | [**updateAssessment**](AssessmentApi.md#updateassessment) | **PUT** /api/v1/assessments/{id} |  |
 
 
@@ -531,6 +534,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)
@@ -600,6 +678,150 @@ 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)
 
 
+## shareAssessment
+
+> Status shareAssessment(id)
+
+
+
+Share an assessment with the user\'s partner organization
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { ShareAssessmentRequest } 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 ShareAssessmentRequest;
+
+  try {
+    const data = await api.shareAssessment(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
+
+[**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 |  -  |
+| **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)
+
+
+## unshareAssessment
+
+> Status unshareAssessment(id)
+
+
+
+Unshare an assessment from the user\'s partner organization
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { UnshareAssessmentRequest } 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 UnshareAssessmentRequest;
+
+  try {
+    const data = await api.unshareAssessment(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
+
+[**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 |  -  |
+| **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)
+
+
 ## updateAssessment
 
 > Assessment updateAssessment(id, assessmentUpdate)

package/docs/AssessmentSharing.md

@@ -0,0 +1,38 @@
+
+# AssessmentSharing
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`isShared` | boolean
+`sharedWith` | [Array<SharingSubject>](SharingSubject.md)
+`sharedBy` | [SharingSubject](SharingSubject.md)
+
+## Example
+
+```typescript
+import type { AssessmentSharing } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "isShared": null,
+  "sharedWith": null,
+  "sharedBy": null,
+} satisfies AssessmentSharing
+
+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 AssessmentSharing
+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/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/Customer.md

@@ -0,0 +1,44 @@
+
+# Customer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`name` | string
+`contactName` | string
+`contactPhone` | string
+`email` | string
+`location` | string
+
+## Example
+
+```typescript
+import type { Customer } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+  "name": null,
+  "contactName": null,
+  "contactPhone": null,
+  "email": null,
+  "location": null,
+} satisfies Customer
+
+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 Customer
+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)
+
+