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

package/docs/PartnerRequest.md

@@ -0,0 +1,58 @@
+
+# PartnerRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`username` | string
+`partner` | [PartnerSummary](PartnerSummary.md)
+`requestStatus` | [PartnerRequestStatus](PartnerRequestStatus.md)
+`name` | string
+`contactName` | string
+`contactPhone` | string
+`email` | string
+`location` | string
+`reason` | string
+`acceptedAt` | Date
+`terminatedAt` | Date
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { PartnerRequest } from '@openshift-migration-advisor/planner-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "username": null,
+  "partner": null,
+  "requestStatus": null,
+  "name": null,
+  "contactName": null,
+  "contactPhone": null,
+  "email": null,
+  "location": null,
+  "reason": null,
+  "acceptedAt": null,
+  "terminatedAt": null,
+  "createdAt": null,
+} satisfies PartnerRequest
+
+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 PartnerRequest
+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/PartnerRequestCreate.md

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

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

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

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

@@ -151,7 +151,7 @@ No authorization required
 | **401** | Unauthorized |  -  |
 | **403** | Forbidden |  -  |
 | **404** | NotFound |  -  |
-| **500** | 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/VMs.md

@@ -12,6 +12,7 @@ Name | Type
 `totalWithSharedDisks` | number
 `cpuCores` | [VMResourceBreakdown](VMResourceBreakdown.md)
 `diskSizeTier` | [{ [key: string]: DiskSizeTierSummary; }](DiskSizeTierSummary.md)
+`diskComplexityTier` | [{ [key: string]: DiskSizeTierSummary; }](DiskSizeTierSummary.md)
 `diskTypes` | [{ [key: string]: DiskTypeSummary; }](DiskTypeSummary.md)
 `distributionByCpuTier` | { [key: string]: number; }
 `distributionByMemoryTier` | { [key: string]: number; }
@@ -41,6 +42,7 @@ const example = {
   "totalWithSharedDisks": null,
   "cpuCores": null,
   "diskSizeTier": null,
+  "diskComplexityTier": null,
   "diskTypes": null,
   "distributionByCpuTier": null,
   "distributionByMemoryTier": null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openshift-migration-advisor/planner-sdk",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "OpenAPI client for @openshift-migration-advisor/planner-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AccountApi.ts

@@ -4,7 +4,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/src/apis/AssessmentApi.ts

@@ -4,7 +4,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).
@@ -20,11 +20,13 @@ import type {
   AssessmentUpdate,
   ClusterRequirementsRequest,
   ClusterRequirementsResponse,
+  ClusterRequirementsStoredInput,
   MigrationComplexityRequest,
   MigrationComplexityResponse,
   MigrationEstimationByComplexityResponse,
   MigrationEstimationRequest,
   MigrationEstimationResponse,
+  Status,
 } from '../models/index.js';
 import {
     AssessmentFromJSON,
@@ -37,6 +39,8 @@ import {
     ClusterRequirementsRequestToJSON,
     ClusterRequirementsResponseFromJSON,
     ClusterRequirementsResponseToJSON,
+    ClusterRequirementsStoredInputFromJSON,
+    ClusterRequirementsStoredInputToJSON,
     MigrationComplexityRequestFromJSON,
     MigrationComplexityRequestToJSON,
     MigrationComplexityResponseFromJSON,
@@ -47,6 +51,8 @@ import {
     MigrationEstimationRequestToJSON,
     MigrationEstimationResponseFromJSON,
     MigrationEstimationResponseToJSON,
+    StatusFromJSON,
+    StatusToJSON,
 } from '../models/index.js';
 
 export interface CalculateAssessmentClusterRequirementsRequest {
@@ -81,10 +87,23 @@ export interface GetAssessmentRequest {
     id: string;
 }
 
+export interface GetAssessmentClusterRequirementsStoredInputRequest {
+    id: string;
+    clusterId: string;
+}
+
 export interface ListAssessmentsRequest {
     sourceId?: string;
 }
 
+export interface ShareAssessmentRequest {
+    id: string;
+}
+
+export interface UnshareAssessmentRequest {
+    id: string;
+}
+
 export interface UpdateAssessmentRequest {
     id: string;
     assessmentUpdate: AssessmentUpdate;
@@ -259,6 +278,30 @@ export interface AssessmentApiInterface {
      */
     getAssessment(requestParameters: GetAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Assessment>;
 
+    /**
+     * Creates request options for getAssessmentClusterRequirementsStoredInput without sending the request
+     * @param {string} id ID of the assessment
+     * @param {string} clusterId ID of the VMware cluster
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getAssessmentClusterRequirementsStoredInputRequestOpts(requestParameters: GetAssessmentClusterRequirementsStoredInputRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Get stored cluster requirements input for an assessment cluster
+     * @param {string} id ID of the assessment
+     * @param {string} clusterId ID of the VMware cluster
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getAssessmentClusterRequirementsStoredInputRaw(requestParameters: GetAssessmentClusterRequirementsStoredInputRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClusterRequirementsStoredInput>>;
+
+    /**
+     * Get stored cluster requirements input for an assessment cluster
+     */
+    getAssessmentClusterRequirementsStoredInput(requestParameters: GetAssessmentClusterRequirementsStoredInputRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClusterRequirementsStoredInput>;
+
     /**
      * Creates request options for listAssessments without sending the request
      * @param {string} [sourceId] Filter assessments by source ID
@@ -281,6 +324,50 @@ export interface AssessmentApiInterface {
      */
     listAssessments(requestParameters: ListAssessmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Assessment>>;
 
+    /**
+     * Creates request options for shareAssessment without sending the request
+     * @param {string} id ID of the assessment
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    shareAssessmentRequestOpts(requestParameters: ShareAssessmentRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Share an assessment with the user\'s partner organization
+     * @param {string} id ID of the assessment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    shareAssessmentRaw(requestParameters: ShareAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Status>>;
+
+    /**
+     * Share an assessment with the user\'s partner organization
+     */
+    shareAssessment(requestParameters: ShareAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Status>;
+
+    /**
+     * Creates request options for unshareAssessment without sending the request
+     * @param {string} id ID of the assessment
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    unshareAssessmentRequestOpts(requestParameters: UnshareAssessmentRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Unshare an assessment from the user\'s partner organization
+     * @param {string} id ID of the assessment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    unshareAssessmentRaw(requestParameters: UnshareAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Status>>;
+
+    /**
+     * Unshare an assessment from the user\'s partner organization
+     */
+    unshareAssessment(requestParameters: UnshareAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Status>;
+
     /**
      * Creates request options for updateAssessment without sending the request
      * @param {string} id ID of the assessment
@@ -669,6 +756,62 @@ export class AssessmentApi extends runtime.BaseAPI implements AssessmentApiInter
         return await response.value();
     }
 
+    /**
+     * Creates request options for getAssessmentClusterRequirementsStoredInput without sending the request
+     */
+    async getAssessmentClusterRequirementsStoredInputRequestOpts(requestParameters: GetAssessmentClusterRequirementsStoredInputRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getAssessmentClusterRequirementsStoredInput().'
+            );
+        }
+
+        if (requestParameters['clusterId'] == null) {
+            throw new runtime.RequiredError(
+                'clusterId',
+                'Required parameter "clusterId" was null or undefined when calling getAssessmentClusterRequirementsStoredInput().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['clusterId'] != null) {
+            queryParameters['clusterId'] = requestParameters['clusterId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v1/assessments/{id}/cluster-requirements/stored-input`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get stored cluster requirements input for an assessment cluster
+     */
+    async getAssessmentClusterRequirementsStoredInputRaw(requestParameters: GetAssessmentClusterRequirementsStoredInputRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClusterRequirementsStoredInput>> {
+        const requestOptions = await this.getAssessmentClusterRequirementsStoredInputRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ClusterRequirementsStoredInputFromJSON(jsonValue));
+    }
+
+    /**
+     * Get stored cluster requirements input for an assessment cluster
+     */
+    async getAssessmentClusterRequirementsStoredInput(requestParameters: GetAssessmentClusterRequirementsStoredInputRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClusterRequirementsStoredInput> {
+        const response = await this.getAssessmentClusterRequirementsStoredInputRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for listAssessments without sending the request
      */
@@ -710,6 +853,96 @@ export class AssessmentApi extends runtime.BaseAPI implements AssessmentApiInter
         return await response.value();
     }
 
+    /**
+     * Creates request options for shareAssessment without sending the request
+     */
+    async shareAssessmentRequestOpts(requestParameters: ShareAssessmentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling shareAssessment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v1/assessments/{id}/share`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Share an assessment with the user\'s partner organization
+     */
+    async shareAssessmentRaw(requestParameters: ShareAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Status>> {
+        const requestOptions = await this.shareAssessmentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StatusFromJSON(jsonValue));
+    }
+
+    /**
+     * Share an assessment with the user\'s partner organization
+     */
+    async shareAssessment(requestParameters: ShareAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Status> {
+        const response = await this.shareAssessmentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for unshareAssessment without sending the request
+     */
+    async unshareAssessmentRequestOpts(requestParameters: UnshareAssessmentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling unshareAssessment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v1/assessments/{id}/share`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Unshare an assessment from the user\'s partner organization
+     */
+    async unshareAssessmentRaw(requestParameters: UnshareAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Status>> {
+        const requestOptions = await this.unshareAssessmentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StatusFromJSON(jsonValue));
+    }
+
+    /**
+     * Unshare an assessment from the user\'s partner organization
+     */
+    async unshareAssessment(requestParameters: UnshareAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Status> {
+        const response = await this.unshareAssessmentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for updateAssessment without sending the request
      */

package/src/apis/HealthApi.ts

@@ -4,7 +4,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/src/apis/ImageApi.ts

@@ -4,7 +4,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/src/apis/InfoApi.ts

@@ -4,7 +4,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/src/apis/JobApi.ts

@@ -4,7 +4,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).