kleisterjs 2.7.0 → 2.9.0

package/docs/UserApi.md

@@ -0,0 +1,1050 @@
+# UserApi
+
+All URIs are relative to *https://try.kleister.eu/api/v1*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**attachUserToGroup**](#attachusertogroup) | **POST** /users/{user_id}/groups | Attach a group to user|
+|[**attachUserToMod**](#attachusertomod) | **POST** /users/{user_id}/mods | Attach a mod to user|
+|[**attachUserToPack**](#attachusertopack) | **POST** /users/{user_id}/packs | Attach a pack to user|
+|[**createUser**](#createuser) | **POST** /users | Create a new user|
+|[**deleteUser**](#deleteuser) | **DELETE** /users/{user_id} | Delete a specific user|
+|[**deleteUserFromGroup**](#deleteuserfromgroup) | **DELETE** /users/{user_id}/groups | Unlink a group from user|
+|[**deleteUserFromMod**](#deleteuserfrommod) | **DELETE** /users/{user_id}/mods | Unlink a mod from user|
+|[**deleteUserFromPack**](#deleteuserfrompack) | **DELETE** /users/{user_id}/packs | Unlink a pack from user|
+|[**listUserGroups**](#listusergroups) | **GET** /users/{user_id}/groups | Fetch all groups attached to user|
+|[**listUserMods**](#listusermods) | **GET** /users/{user_id}/mods | Fetch all mods attached to user|
+|[**listUserPacks**](#listuserpacks) | **GET** /users/{user_id}/packs | Fetch all packs attached to user|
+|[**listUsers**](#listusers) | **GET** /users | Fetch all available users|
+|[**permitUserGroup**](#permitusergroup) | **PUT** /users/{user_id}/groups | Update group perms for user|
+|[**permitUserMod**](#permitusermod) | **PUT** /users/{user_id}/mods | Update mod perms for user|
+|[**permitUserPack**](#permituserpack) | **PUT** /users/{user_id}/packs | Update pack perms for user|
+|[**showUser**](#showuser) | **GET** /users/{user_id} | Fetch a specific user|
+|[**updateUser**](#updateuser) | **PUT** /users/{user_id} | Update a specific user|
+
+# **attachUserToGroup**
+> Notification attachUserToGroup(permitPackGroupRequest)
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    PermitPackGroupRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let permitPackGroupRequest: PermitPackGroupRequest; //The user group data to permit
+
+const { status, data } = await apiInstance.attachUserToGroup(
+    userId,
+    permitPackGroupRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **permitPackGroupRequest** | **PermitPackGroupRequest**| The user group data to permit | |
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**Notification**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plain success message |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**412** | Resource is already attached |  -  |
+|**422** | Failed to validate request |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **attachUserToMod**
+> Notification attachUserToMod(permitGroupModRequest)
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    PermitGroupModRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let permitGroupModRequest: PermitGroupModRequest; //The user mod data to permit
+
+const { status, data } = await apiInstance.attachUserToMod(
+    userId,
+    permitGroupModRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **permitGroupModRequest** | **PermitGroupModRequest**| The user mod data to permit | |
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**Notification**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plain success message |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**412** | Resource is already attached |  -  |
+|**422** | Failed to validate request |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **attachUserToPack**
+> Notification attachUserToPack(permitGroupPackRequest)
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    PermitGroupPackRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let permitGroupPackRequest: PermitGroupPackRequest; //The user pack data to permit
+
+const { status, data } = await apiInstance.attachUserToPack(
+    userId,
+    permitGroupPackRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **permitGroupPackRequest** | **PermitGroupPackRequest**| The user pack data to permit | |
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**Notification**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plain success message |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**412** | Resource is already attached |  -  |
+|**422** | Failed to validate request |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **createUser**
+> User createUser(createUserRequest)
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    CreateUserRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let createUserRequest: CreateUserRequest; //The user data to create
+
+const { status, data } = await apiInstance.createUser(
+    createUserRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createUserRequest** | **CreateUserRequest**| The user data to create | |
+
+
+### Return type
+
+**User**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | The details for an user |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**422** | Failed to validate request |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteUser**
+> Notification deleteUser()
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+
+const { status, data } = await apiInstance.deleteUser(
+    userId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**Notification**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plain success message |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**400** | Failed to execute action for resource |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteUserFromGroup**
+> Notification deleteUserFromGroup(deletePackFromGroupRequest)
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    DeletePackFromGroupRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let deletePackFromGroupRequest: DeletePackFromGroupRequest; //The user group data to unlink
+
+const { status, data } = await apiInstance.deleteUserFromGroup(
+    userId,
+    deletePackFromGroupRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **deletePackFromGroupRequest** | **DeletePackFromGroupRequest**| The user group data to unlink | |
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**Notification**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plain success message |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**412** | Resource is not attached |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteUserFromMod**
+> Notification deleteUserFromMod(deleteGroupFromModRequest)
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    DeleteGroupFromModRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let deleteGroupFromModRequest: DeleteGroupFromModRequest; //The user mod data to unlink
+
+const { status, data } = await apiInstance.deleteUserFromMod(
+    userId,
+    deleteGroupFromModRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **deleteGroupFromModRequest** | **DeleteGroupFromModRequest**| The user mod data to unlink | |
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**Notification**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plain success message |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**412** | Resource is not attached |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteUserFromPack**
+> Notification deleteUserFromPack(deleteGroupFromPackRequest)
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    DeleteGroupFromPackRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let deleteGroupFromPackRequest: DeleteGroupFromPackRequest; //The user pack data to unlink
+
+const { status, data } = await apiInstance.deleteUserFromPack(
+    userId,
+    deleteGroupFromPackRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **deleteGroupFromPackRequest** | **DeleteGroupFromPackRequest**| The user pack data to unlink | |
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**Notification**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plain success message |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**412** | Resource is not attached |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listUserGroups**
+> ListUserGroups200Response listUserGroups()
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+let sort: string; //Sorting column (optional) (default to undefined)
+let order: 'asc' | 'desc'; //Sorting order (optional) (default to 'asc')
+let limit: number; //Paging limit (optional) (default to 100)
+let offset: number; //Paging offset (optional) (default to 0)
+
+const { status, data } = await apiInstance.listUserGroups(
+    userId,
+    search,
+    sort,
+    order,
+    limit,
+    offset
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+| **sort** | [**string**] | Sorting column | (optional) defaults to undefined|
+| **order** | [**&#39;asc&#39; | &#39;desc&#39;**]**Array<&#39;asc&#39; &#124; &#39;desc&#39;>** | Sorting order | (optional) defaults to 'asc'|
+| **limit** | [**number**] | Paging limit | (optional) defaults to 100|
+| **offset** | [**number**] | Paging offset | (optional) defaults to 0|
+
+
+### Return type
+
+**ListUserGroups200Response**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A collection of user groups |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listUserMods**
+> ListUserMods200Response listUserMods()
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+let sort: string; //Sorting column (optional) (default to undefined)
+let order: 'asc' | 'desc'; //Sorting order (optional) (default to 'asc')
+let limit: number; //Paging limit (optional) (default to 100)
+let offset: number; //Paging offset (optional) (default to 0)
+
+const { status, data } = await apiInstance.listUserMods(
+    userId,
+    search,
+    sort,
+    order,
+    limit,
+    offset
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+| **sort** | [**string**] | Sorting column | (optional) defaults to undefined|
+| **order** | [**&#39;asc&#39; | &#39;desc&#39;**]**Array<&#39;asc&#39; &#124; &#39;desc&#39;>** | Sorting order | (optional) defaults to 'asc'|
+| **limit** | [**number**] | Paging limit | (optional) defaults to 100|
+| **offset** | [**number**] | Paging offset | (optional) defaults to 0|
+
+
+### Return type
+
+**ListUserMods200Response**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A collection of user mods |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listUserPacks**
+> ListUserPacks200Response listUserPacks()
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+let sort: string; //Sorting column (optional) (default to undefined)
+let order: 'asc' | 'desc'; //Sorting order (optional) (default to 'asc')
+let limit: number; //Paging limit (optional) (default to 100)
+let offset: number; //Paging offset (optional) (default to 0)
+
+const { status, data } = await apiInstance.listUserPacks(
+    userId,
+    search,
+    sort,
+    order,
+    limit,
+    offset
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+| **sort** | [**string**] | Sorting column | (optional) defaults to undefined|
+| **order** | [**&#39;asc&#39; | &#39;desc&#39;**]**Array<&#39;asc&#39; &#124; &#39;desc&#39;>** | Sorting order | (optional) defaults to 'asc'|
+| **limit** | [**number**] | Paging limit | (optional) defaults to 100|
+| **offset** | [**number**] | Paging offset | (optional) defaults to 0|
+
+
+### Return type
+
+**ListUserPacks200Response**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A collection of user packs |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listUsers**
+> ListUsers200Response listUsers()
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let search: string; //Search query (optional) (default to undefined)
+let sort: string; //Sorting column (optional) (default to undefined)
+let order: 'asc' | 'desc'; //Sorting order (optional) (default to 'asc')
+let limit: number; //Paging limit (optional) (default to 100)
+let offset: number; //Paging offset (optional) (default to 0)
+
+const { status, data } = await apiInstance.listUsers(
+    search,
+    sort,
+    order,
+    limit,
+    offset
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+| **sort** | [**string**] | Sorting column | (optional) defaults to undefined|
+| **order** | [**&#39;asc&#39; | &#39;desc&#39;**]**Array<&#39;asc&#39; &#124; &#39;desc&#39;>** | Sorting order | (optional) defaults to 'asc'|
+| **limit** | [**number**] | Paging limit | (optional) defaults to 100|
+| **offset** | [**number**] | Paging offset | (optional) defaults to 0|
+
+
+### Return type
+
+**ListUsers200Response**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A collection of users |  -  |
+|**403** | User is not authorized |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **permitUserGroup**
+> Notification permitUserGroup(permitPackGroupRequest)
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    PermitPackGroupRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let permitPackGroupRequest: PermitPackGroupRequest; //The user group data to permit
+
+const { status, data } = await apiInstance.permitUserGroup(
+    userId,
+    permitPackGroupRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **permitPackGroupRequest** | **PermitPackGroupRequest**| The user group data to permit | |
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**Notification**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plain success message |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**412** | Resource is not attached |  -  |
+|**422** | Failed to validate request |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **permitUserMod**
+> Notification permitUserMod(permitGroupModRequest)
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    PermitGroupModRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let permitGroupModRequest: PermitGroupModRequest; //The user mod data to permit
+
+const { status, data } = await apiInstance.permitUserMod(
+    userId,
+    permitGroupModRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **permitGroupModRequest** | **PermitGroupModRequest**| The user mod data to permit | |
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**Notification**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plain success message |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**412** | Resource is not attached |  -  |
+|**422** | Failed to validate request |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **permitUserPack**
+> Notification permitUserPack(permitGroupPackRequest)
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    PermitGroupPackRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let permitGroupPackRequest: PermitGroupPackRequest; //The user pack data to permit
+
+const { status, data } = await apiInstance.permitUserPack(
+    userId,
+    permitGroupPackRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **permitGroupPackRequest** | **PermitGroupPackRequest**| The user pack data to permit | |
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**Notification**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plain success message |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**412** | Resource is not attached |  -  |
+|**422** | Failed to validate request |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **showUser**
+> User showUser()
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+
+const { status, data } = await apiInstance.showUser(
+    userId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**User**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | The details for an user |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateUser**
+> User updateUser(updateUserRequest)
+
+
+### Example
+
+```typescript
+import {
+    UserApi,
+    Configuration,
+    UpdateUserRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let userId: string; //A user identifier or slug (default to undefined)
+let updateUserRequest: UpdateUserRequest; //The user data to update
+
+const { status, data } = await apiInstance.updateUser(
+    userId,
+    updateUserRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateUserRequest** | **UpdateUserRequest**| The user data to update | |
+| **userId** | [**string**] | A user identifier or slug | defaults to undefined|
+
+
+### Return type
+
+**User**
+
+### Authorization
+
+[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | The details for an user |  -  |
+|**400** | Failed to parse request |  -  |
+|**403** | User is not authorized |  -  |
+|**404** | Resource not found |  -  |
+|**422** | Failed to validate request |  -  |
+|**500** | Some internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+