@openshift-migration-advisor/planner-sdk 0.11.0-92891f5da8a7 → 0.11.0-ca05f2d33650

package/dist/models/PartnerRequest.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { PartnerRequestStatus } from './PartnerRequestStatus.js';
+import type { PartnerSummary } from './PartnerSummary.js';
 /**
  *
  * @export
@@ -30,10 +31,10 @@ export interface PartnerRequest {
     username: string;
     /**
      *
-     * @type {string}
+     * @type {PartnerSummary}
      * @memberof PartnerRequest
      */
-    partnerId: string;
+    partner: PartnerSummary;
     /**
      *
      * @type {PartnerRequestStatus}
@@ -88,6 +89,12 @@ export interface PartnerRequest {
      * @memberof PartnerRequest
      */
     terminatedAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof PartnerRequest
+     */
+    createdAt: Date;
 }
 /**
  * Check if a given object implements the PartnerRequest interface.

package/dist/models/PartnerRequest.js

@@ -19,6 +19,7 @@ exports.PartnerRequestFromJSONTyped = PartnerRequestFromJSONTyped;
 exports.PartnerRequestToJSON = PartnerRequestToJSON;
 exports.PartnerRequestToJSONTyped = PartnerRequestToJSONTyped;
 const PartnerRequestStatus_js_1 = require("./PartnerRequestStatus.js");
+const PartnerSummary_js_1 = require("./PartnerSummary.js");
 /**
  * Check if a given object implements the PartnerRequest interface.
  */
@@ -27,7 +28,7 @@ function instanceOfPartnerRequest(value) {
         return false;
     if (!('username' in value) || value['username'] === undefined)
         return false;
-    if (!('partnerId' in value) || value['partnerId'] === undefined)
+    if (!('partner' in value) || value['partner'] === undefined)
         return false;
     if (!('requestStatus' in value) || value['requestStatus'] === undefined)
         return false;
@@ -41,6 +42,8 @@ function instanceOfPartnerRequest(value) {
         return false;
     if (!('location' in value) || value['location'] === undefined)
         return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
     return true;
 }
 function PartnerRequestFromJSON(json) {
@@ -53,7 +56,7 @@ function PartnerRequestFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'username': json['username'],
-        'partnerId': json['partnerId'],
+        'partner': (0, PartnerSummary_js_1.PartnerSummaryFromJSON)(json['partner']),
         'requestStatus': (0, PartnerRequestStatus_js_1.PartnerRequestStatusFromJSON)(json['requestStatus']),
         'name': json['name'],
         'contactName': json['contactName'],
@@ -63,6 +66,7 @@ function PartnerRequestFromJSONTyped(json, ignoreDiscriminator) {
         'reason': json['reason'] == null ? undefined : json['reason'],
         'acceptedAt': json['acceptedAt'] == null ? undefined : (new Date(json['acceptedAt'])),
         'terminatedAt': json['terminatedAt'] == null ? undefined : (new Date(json['terminatedAt'])),
+        'createdAt': (new Date(json['createdAt'])),
     };
 }
 function PartnerRequestToJSON(json) {
@@ -75,7 +79,7 @@ function PartnerRequestToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'username': value['username'],
-        'partnerId': value['partnerId'],
+        'partner': (0, PartnerSummary_js_1.PartnerSummaryToJSON)(value['partner']),
         'requestStatus': (0, PartnerRequestStatus_js_1.PartnerRequestStatusToJSON)(value['requestStatus']),
         'name': value['name'],
         'contactName': value['contactName'],
@@ -85,5 +89,6 @@ function PartnerRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'reason': value['reason'],
         'acceptedAt': value['acceptedAt'] == null ? value['acceptedAt'] : value['acceptedAt'].toISOString(),
         'terminatedAt': value['terminatedAt'] == null ? value['terminatedAt'] : value['terminatedAt'].toISOString(),
+        'createdAt': value['createdAt'].toISOString(),
     };
 }

package/dist/models/PartnerSummary.d.ts

@@ -0,0 +1,50 @@
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface PartnerSummary
+ */
+export interface PartnerSummary {
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerSummary
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerSummary
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerSummary
+     */
+    company: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerSummary
+     */
+    icon: string;
+}
+/**
+ * Check if a given object implements the PartnerSummary interface.
+ */
+export declare function instanceOfPartnerSummary(value: object): value is PartnerSummary;
+export declare function PartnerSummaryFromJSON(json: any): PartnerSummary;
+export declare function PartnerSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerSummary;
+export declare function PartnerSummaryToJSON(json: any): PartnerSummary;
+export declare function PartnerSummaryToJSONTyped(value?: PartnerSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PartnerSummary.js

@@ -0,0 +1,62 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenShift Migration Advisor API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1alpha1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPartnerSummary = instanceOfPartnerSummary;
+exports.PartnerSummaryFromJSON = PartnerSummaryFromJSON;
+exports.PartnerSummaryFromJSONTyped = PartnerSummaryFromJSONTyped;
+exports.PartnerSummaryToJSON = PartnerSummaryToJSON;
+exports.PartnerSummaryToJSONTyped = PartnerSummaryToJSONTyped;
+/**
+ * Check if a given object implements the PartnerSummary interface.
+ */
+function instanceOfPartnerSummary(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('company' in value) || value['company'] === undefined)
+        return false;
+    if (!('icon' in value) || value['icon'] === undefined)
+        return false;
+    return true;
+}
+function PartnerSummaryFromJSON(json) {
+    return PartnerSummaryFromJSONTyped(json, false);
+}
+function PartnerSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'company': json['company'],
+        'icon': json['icon'],
+    };
+}
+function PartnerSummaryToJSON(json) {
+    return PartnerSummaryToJSONTyped(json, false);
+}
+function PartnerSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'company': value['company'],
+        'icon': value['icon'],
+    };
+}

package/dist/models/index.d.ts

@@ -47,6 +47,7 @@ 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 './SizingOverCommitRatio.js';

package/dist/models/index.js

@@ -65,6 +65,7 @@ __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("./SizingOverCommitRatio.js"), exports);

package/docs/AssessmentApi.md

@@ -13,6 +13,8 @@ All URIs are relative to *https://raw.githubusercontent.com*
 | [**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} |  |
 
 
@@ -676,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/PartnerRequest.md

@@ -8,7 +8,7 @@ Name | Type
 ------------ | -------------
 `id` | string
 `username` | string
-`partnerId` | string
+`partner` | [PartnerSummary](PartnerSummary.md)
 `requestStatus` | [PartnerRequestStatus](PartnerRequestStatus.md)
 `name` | string
 `contactName` | string
@@ -18,6 +18,7 @@ Name | Type
 `reason` | string
 `acceptedAt` | Date
 `terminatedAt` | Date
+`createdAt` | Date
 
 ## Example
 
@@ -28,7 +29,7 @@ import type { PartnerRequest } from '@openshift-migration-advisor/planner-sdk'
 const example = {
   "id": null,
   "username": null,
-  "partnerId": null,
+  "partner": null,
   "requestStatus": null,
   "name": null,
   "contactName": null,
@@ -38,6 +39,7 @@ const example = {
   "reason": null,
   "acceptedAt": null,
   "terminatedAt": null,
+  "createdAt": null,
 } satisfies PartnerRequest
 
 console.log(example)

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/package.json

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

package/src/apis/AssessmentApi.ts

@@ -26,6 +26,7 @@ import type {
   MigrationEstimationByComplexityResponse,
   MigrationEstimationRequest,
   MigrationEstimationResponse,
+  Status,
 } from '../models/index.js';
 import {
     AssessmentFromJSON,
@@ -50,6 +51,8 @@ import {
     MigrationEstimationRequestToJSON,
     MigrationEstimationResponseFromJSON,
     MigrationEstimationResponseToJSON,
+    StatusFromJSON,
+    StatusToJSON,
 } from '../models/index.js';
 
 export interface CalculateAssessmentClusterRequirementsRequest {
@@ -93,6 +96,14 @@ export interface ListAssessmentsRequest {
     sourceId?: string;
 }
 
+export interface ShareAssessmentRequest {
+    id: string;
+}
+
+export interface UnshareAssessmentRequest {
+    id: string;
+}
+
 export interface UpdateAssessmentRequest {
     id: string;
     assessmentUpdate: AssessmentUpdate;
@@ -313,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
@@ -798,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
      */