@openshift-migration-advisor/planner-sdk 0.10.0 → 0.11.0-7cc84aae7ba0

package/docs/AccountApi.md

@@ -0,0 +1,734 @@
+# AccountApi
+
+All URIs are relative to *https://raw.githubusercontent.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createGroup**](AccountApi.md#creategroup) | **POST** /api/v1/groups |  |
+| [**createGroupMember**](AccountApi.md#creategroupmember) | **POST** /api/v1/groups/{id}/members |  |
+| [**deleteGroup**](AccountApi.md#deletegroup) | **DELETE** /api/v1/groups/{id} |  |
+| [**getGroup**](AccountApi.md#getgroup) | **GET** /api/v1/groups/{id} |  |
+| [**getIdentity**](AccountApi.md#getidentity) | **GET** /api/v1/identity |  |
+| [**listGroupMembers**](AccountApi.md#listgroupmembers) | **GET** /api/v1/groups/{id}/members |  |
+| [**listGroups**](AccountApi.md#listgroups) | **GET** /api/v1/groups |  |
+| [**removeGroupMember**](AccountApi.md#removegroupmember) | **DELETE** /api/v1/groups/{id}/members/{username} |  |
+| [**updateGroup**](AccountApi.md#updategroup) | **PUT** /api/v1/groups/{id} |  |
+| [**updateGroupMember**](AccountApi.md#updategroupmember) | **PUT** /api/v1/groups/{id}/members/{username} |  |
+
+
+
+## createGroup
+
+> Group createGroup(groupCreate)
+
+
+
+Create a group
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CreateGroupRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AccountApi();
+
+  const body = {
+    // GroupCreate
+    groupCreate: ...,
+  } satisfies CreateGroupRequest;
+
+  try {
+    const data = await api.createGroup(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **groupCreate** | [GroupCreate](GroupCreate.md) |  | |
+
+### Return type
+
+[**Group**](Group.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)
+
+
+## createGroupMember
+
+> Member createGroupMember(id, memberCreate)
+
+
+
+Create a member in a group
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CreateGroupMemberRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AccountApi();
+
+  const body = {
+    // string | ID of the group
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // MemberCreate
+    memberCreate: ...,
+  } satisfies CreateGroupMemberRequest;
+
+  try {
+    const data = await api.createGroupMember(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 group | [Defaults to `undefined`] |
+| **memberCreate** | [MemberCreate](MemberCreate.md) |  | |
+
+### Return type
+
+[**Member**](Member.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 |  -  |
+| **404** | Not Found |  -  |
+| **409** | Conflict |  -  |
+| **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)
+
+
+## deleteGroup
+
+> Group deleteGroup(id)
+
+
+
+Delete a group
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { DeleteGroupRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AccountApi();
+
+  const body = {
+    // string | ID of the group
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteGroupRequest;
+
+  try {
+    const data = await api.deleteGroup(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 group | [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 |  -  |
+| **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)
+
+
+## getGroup
+
+> Group getGroup(id)
+
+
+
+Get a group by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetGroupRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AccountApi();
+
+  const body = {
+    // string | ID of the group
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetGroupRequest;
+
+  try {
+    const data = await api.getGroup(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 group | [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 |  -  |
+| **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)
+
+
+## getIdentity
+
+> Identity getIdentity()
+
+
+
+Returns the authenticated user\'s profile. If a local account exists, returns stored user data. Otherwise returns a synthesized regular user.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { GetIdentityRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AccountApi();
+
+  try {
+    const data = await api.getIdentity();
+    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
+
+[**Identity**](Identity.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)
+
+
+## listGroupMembers
+
+> Array<Member> listGroupMembers(id)
+
+
+
+List members in a group
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { ListGroupMembersRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AccountApi();
+
+  const body = {
+    // string | ID of the group
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ListGroupMembersRequest;
+
+  try {
+    const data = await api.listGroupMembers(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 group | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<Member>**](Member.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 |  -  |
+| **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)
+
+
+## listGroups
+
+> Array<Group> listGroups(kind, name, company)
+
+
+
+List all groups
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { ListGroupsRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AccountApi();
+
+  const body = {
+    // 'partner' | 'admin' | Filter by group kind (optional)
+    kind: kind_example,
+    // string | Filter by name (case-insensitive partial match) (optional)
+    name: name_example,
+    // string | Filter by company (case-insensitive partial match) (optional)
+    company: company_example,
+  } satisfies ListGroupsRequest;
+
+  try {
+    const data = await api.listGroups(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **kind** | `partner`, `admin` | Filter by group kind | [Optional] [Defaults to `undefined`] [Enum: partner, admin] |
+| **name** | `string` | Filter by name (case-insensitive partial match) | [Optional] [Defaults to `undefined`] |
+| **company** | `string` | Filter by company (case-insensitive partial match) | [Optional] [Defaults to `undefined`] |
+
+### 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)
+
+
+## removeGroupMember
+
+> removeGroupMember(id, username)
+
+
+
+Delete the member record from the specified group. Because a member must always belong to a group, this operation permanently deletes the member — not just the membership. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { RemoveGroupMemberRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AccountApi();
+
+  const body = {
+    // string | ID of the group
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Username of the member
+    username: username_example,
+  } satisfies RemoveGroupMemberRequest;
+
+  try {
+    const data = await api.removeGroupMember(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 group | [Defaults to `undefined`] |
+| **username** | `string` | Username of the member | [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 |  -  |
+| **400** | Bad Request |  -  |
+| **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)
+
+
+## updateGroup
+
+> Group updateGroup(id, groupUpdate)
+
+
+
+Update a group
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { UpdateGroupRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AccountApi();
+
+  const body = {
+    // string | ID of the group
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // GroupUpdate
+    groupUpdate: ...,
+  } satisfies UpdateGroupRequest;
+
+  try {
+    const data = await api.updateGroup(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 group | [Defaults to `undefined`] |
+| **groupUpdate** | [GroupUpdate](GroupUpdate.md) |  | |
+
+### Return type
+
+[**Group**](Group.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 |  -  |
+| **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)
+
+
+## updateGroupMember
+
+> Member updateGroupMember(id, username, memberUpdate)
+
+
+
+Update a member in a group
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { UpdateGroupMemberRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AccountApi();
+
+  const body = {
+    // string | ID of the group
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Username of the member
+    username: username_example,
+    // MemberUpdate
+    memberUpdate: ...,
+  } satisfies UpdateGroupMemberRequest;
+
+  try {
+    const data = await api.updateGroupMember(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 group | [Defaults to `undefined`] |
+| **username** | `string` | Username of the member | [Defaults to `undefined`] |
+| **memberUpdate** | [MemberUpdate](MemberUpdate.md) |  | |
+
+### Return type
+
+[**Member**](Member.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 |  -  |
+| **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)
+