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

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)
+
+

package/docs/PartnerApi.md

@@ -0,0 +1,636 @@
+# PartnerApi
+
+All URIs are relative to *https://raw.githubusercontent.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cancelPartnerRequest**](PartnerApi.md#cancelpartnerrequest) | **DELETE** /api/v1/partners/requests/{id} |  |
+| [**createPartnerRequest**](PartnerApi.md#createpartnerrequest) | **POST** /api/v1/partners/{id}/request |  |
+| [**getPartner**](PartnerApi.md#getpartner) | **GET** /api/v1/partners/{id} |  |
+| [**leavePartner**](PartnerApi.md#leavepartner) | **DELETE** /api/v1/partners/{id} |  |
+| [**listCustomers**](PartnerApi.md#listcustomers) | **GET** /api/v1/customers |  |
+| [**listPartnerRequests**](PartnerApi.md#listpartnerrequests) | **GET** /api/v1/partners/requests |  |
+| [**listPartners**](PartnerApi.md#listpartners) | **GET** /api/v1/partners |  |
+| [**removeCustomer**](PartnerApi.md#removecustomer) | **DELETE** /api/v1/customers/{username} |  |
+| [**updatePartnerRequest**](PartnerApi.md#updatepartnerrequest) | **PUT** /api/v1/partners/requests/{id} |  |
+
+
+
+## cancelPartnerRequest
+
+> cancelPartnerRequest(id)
+
+
+
+Cancel a pending partner request
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PartnerApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CancelPartnerRequestRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new PartnerApi();
+
+  const body = {
+    // string | Partner request ID
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies CancelPartnerRequestRequest;
+
+  try {
+    const data = await api.cancelPartnerRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Partner request ID | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### 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 |  -  |
+| **404** | 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)
+
+
+## createPartnerRequest
+
+> PartnerRequest createPartnerRequest(id, partnerRequestCreate)
+
+
+
+Submit a partner request. Only regular users can make this request.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PartnerApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CreatePartnerRequestRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new PartnerApi();
+
+  const body = {
+    // string | Partner group ID
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PartnerRequestCreate
+    partnerRequestCreate: ...,
+  } satisfies CreatePartnerRequestRequest;
+
+  try {
+    const data = await api.createPartnerRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Partner group ID | [Defaults to `undefined`] |
+| **partnerRequestCreate** | [PartnerRequestCreate](PartnerRequestCreate.md) |  | |
+
+### Return type
+
+[**PartnerRequest**](PartnerRequest.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 |  -  |
+| **403** | Forbidden |  -  |
+| **404** | 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)
+
+
+## getPartner
+
+> Group getPartner(id)
+
+
+
+Get my partner organization details
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PartnerApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetPartnerRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new PartnerApi();
+
+  const body = {
+    // string | Partner group ID
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetPartnerRequest;
+
+  try {
+    const data = await api.getPartner(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Partner group ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**Group**](Group.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 |  -  |
+| **403** | Forbidden |  -  |
+| **404** | 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)
+
+
+## leavePartner
+
+> leavePartner(id)
+
+
+
+Leave partner organization
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PartnerApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { LeavePartnerRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new PartnerApi();
+
+  const body = {
+    // string | Partner group ID
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies LeavePartnerRequest;
+
+  try {
+    const data = await api.leavePartner(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Partner group ID | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### 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 |  -  |
+| **403** | Forbidden |  -  |
+| **404** | 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)
+
+
+## listCustomers
+
+> Array<Customer> listCustomers()
+
+
+
+List customers for my partner organization
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PartnerApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { ListCustomersRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new PartnerApi();
+
+  try {
+    const data = await api.listCustomers();
+    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<Customer>**](Customer.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 |  -  |
+| **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)
+
+
+## listPartnerRequests
+
+> Array<PartnerRequest> listPartnerRequests()
+
+
+
+List my partner requests
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PartnerApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { ListPartnerRequestsRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new PartnerApi();
+
+  try {
+    const data = await api.listPartnerRequests();
+    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<PartnerRequest>**](PartnerRequest.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)
+
+
+## listPartners
+
+> Array<Group> listPartners()
+
+
+
+List available partner organizations
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PartnerApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { ListPartnersRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new PartnerApi();
+
+  try {
+    const data = await api.listPartners();
+    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<Group>**](Group.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)
+
+
+## removeCustomer
+
+> removeCustomer(username)
+
+
+
+Remove a customer from partner organization
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PartnerApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { RemoveCustomerRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new PartnerApi();
+
+  const body = {
+    // string | Customer username
+    username: username_example,
+  } satisfies RemoveCustomerRequest;
+
+  try {
+    const data = await api.removeCustomer(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **username** | `string` | Customer username | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### 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** | 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)
+
+
+## updatePartnerRequest
+
+> PartnerRequest updatePartnerRequest(id, partnerRequestUpdate)
+
+
+
+Accept or reject a customer request
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PartnerApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { UpdatePartnerRequestRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new PartnerApi();
+
+  const body = {
+    // string | Partner request ID
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PartnerRequestUpdate
+    partnerRequestUpdate: ...,
+  } satisfies UpdatePartnerRequestRequest;
+
+  try {
+    const data = await api.updatePartnerRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Partner request ID | [Defaults to `undefined`] |
+| **partnerRequestUpdate** | [PartnerRequestUpdate](PartnerRequestUpdate.md) |  | |
+
+### Return type
+
+[**PartnerRequest**](PartnerRequest.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | 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)
+