kleisterjs 2.7.0 → 2.9.0

package/docs/PackAvatar.md

@@ -0,0 +1,27 @@
+# PackAvatar
+
+Model to represent pack avatar
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**slug** | **string** |  | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [readonly] [default to undefined]
+**updated_at** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PackAvatar } from 'kleisterjs';
+
+const instance: PackAvatar = {
+    slug,
+    url,
+    created_at,
+    updated_at,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PermitGroupModRequest.md

@@ -0,0 +1,22 @@
+# PermitGroupModRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mod** | **string** |  | [default to undefined]
+**perm** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PermitGroupModRequest } from 'kleisterjs';
+
+const instance: PermitGroupModRequest = {
+    mod,
+    perm,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PermitGroupPackRequest.md

@@ -0,0 +1,22 @@
+# PermitGroupPackRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pack** | **string** |  | [default to undefined]
+**perm** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PermitGroupPackRequest } from 'kleisterjs';
+
+const instance: PermitGroupPackRequest = {
+    pack,
+    perm,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PermitPackGroupRequest.md

@@ -0,0 +1,22 @@
+# PermitPackGroupRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**group** | **string** |  | [default to undefined]
+**perm** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PermitPackGroupRequest } from 'kleisterjs';
+
+const instance: PermitPackGroupRequest = {
+    group,
+    perm,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PermitPackUserRequest.md

@@ -0,0 +1,22 @@
+# PermitPackUserRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **string** |  | [default to undefined]
+**perm** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PermitPackUserRequest } from 'kleisterjs';
+
+const instance: PermitPackUserRequest = {
+    user,
+    perm,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Profile.md

@@ -0,0 +1,47 @@
+# Profile
+
+Model to represent profile
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**username** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**fullname** | **string** |  | [optional] [default to undefined]
+**profile** | **string** |  | [optional] [default to undefined]
+**admin** | **boolean** |  | [optional] [readonly] [default to undefined]
+**active** | **boolean** |  | [optional] [readonly] [default to undefined]
+**created_at** | **string** |  | [optional] [readonly] [default to undefined]
+**updated_at** | **string** |  | [optional] [readonly] [default to undefined]
+**auths** | [**Array<UserAuth>**](UserAuth.md) |  | [optional] [readonly] [default to undefined]
+**groups** | [**Array<UserGroup>**](UserGroup.md) |  | [optional] [readonly] [default to undefined]
+**mods** | [**Array<UserMod>**](UserMod.md) |  | [optional] [readonly] [default to undefined]
+**packs** | [**Array<UserPack>**](UserPack.md) |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Profile } from 'kleisterjs';
+
+const instance: Profile = {
+    id,
+    username,
+    password,
+    email,
+    fullname,
+    profile,
+    admin,
+    active,
+    created_at,
+    updated_at,
+    auths,
+    groups,
+    mods,
+    packs,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ProfileApi.md

@@ -0,0 +1,155 @@
+# ProfileApi
+
+All URIs are relative to *https://try.kleister.eu/api/v1*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**showProfile**](#showprofile) | **GET** /profile/self | Fetch profile details of the personal account|
+|[**tokenProfile**](#tokenprofile) | **GET** /profile/token | Retrieve an unlimited auth token|
+|[**updateProfile**](#updateprofile) | **PUT** /profile/self | Update your own profile information|
+
+# **showProfile**
+> Profile showProfile()
+
+
+### Example
+
+```typescript
+import {
+    ProfileApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new ProfileApi(configuration);
+
+const { status, data } = await apiInstance.showProfile();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Profile**
+
+### 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 current profile details |  -  |
+|**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)
+
+# **tokenProfile**
+> AuthToken tokenProfile()
+
+
+### Example
+
+```typescript
+import {
+    ProfileApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new ProfileApi(configuration);
+
+const { status, data } = await apiInstance.tokenProfile();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AuthToken**
+
+### 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** | Generated token never expiring |  -  |
+|**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)
+
+# **updateProfile**
+> Profile updateProfile(updateProfileRequest)
+
+
+### Example
+
+```typescript
+import {
+    ProfileApi,
+    Configuration,
+    UpdateProfileRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new ProfileApi(configuration);
+
+let updateProfileRequest: UpdateProfileRequest; //The profile data to update
+
+const { status, data } = await apiInstance.updateProfile(
+    updateProfileRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateProfileRequest** | **UpdateProfileRequest**| The profile data to update | |
+
+
+### Return type
+
+**Profile**
+
+### 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 current profile details |  -  |
+|**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)
+

package/docs/Provider.md

@@ -0,0 +1,27 @@
+# Provider
+
+Model to represent auth provider
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [readonly] [default to undefined]
+**driver** | **string** |  | [optional] [readonly] [default to undefined]
+**display** | **string** |  | [optional] [readonly] [default to undefined]
+**icon** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Provider } from 'kleisterjs';
+
+const instance: Provider = {
+    name,
+    driver,
+    display,
+    icon,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Quilt.md

@@ -0,0 +1,27 @@
+# Quilt
+
+Model to represent quilt
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [readonly] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [readonly] [default to undefined]
+**updated_at** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Quilt } from 'kleisterjs';
+
+const instance: Quilt = {
+    id,
+    name,
+    created_at,
+    updated_at,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/QuiltApi.md

@@ -0,0 +1,297 @@
+# QuiltApi
+
+All URIs are relative to *https://try.kleister.eu/api/v1*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**attachQuiltToBuild**](#attachquilttobuild) | **POST** /quilt/{quilt_id}/builds | Attach a build to a Quilt version|
+|[**deleteQuiltFromBuild**](#deletequiltfrombuild) | **DELETE** /quilt/{quilt_id}/builds | Unlink a build from a Quilt version|
+|[**listQuiltBuilds**](#listquiltbuilds) | **GET** /quilt/{quilt_id}/builds | Fetch the builds attached to a Quilt version|
+|[**listQuilts**](#listquilts) | **GET** /quilt | Fetch the available Quilt versions|
+|[**updateQuilt**](#updatequilt) | **PUT** /quilt | Update the available Quilt versions|
+
+# **attachQuiltToBuild**
+> Notification attachQuiltToBuild(attachMinecraftToBuildRequest)
+
+
+### Example
+
+```typescript
+import {
+    QuiltApi,
+    Configuration,
+    AttachMinecraftToBuildRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new QuiltApi(configuration);
+
+let quiltId: string; //A quilt identifier or slug (default to undefined)
+let attachMinecraftToBuildRequest: AttachMinecraftToBuildRequest; //The quilt build data to create or update
+
+const { status, data } = await apiInstance.attachQuiltToBuild(
+    quiltId,
+    attachMinecraftToBuildRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **attachMinecraftToBuildRequest** | **AttachMinecraftToBuildRequest**| The quilt build data to create or update | |
+| **quiltId** | [**string**] | A quilt 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)
+
+# **deleteQuiltFromBuild**
+> Notification deleteQuiltFromBuild(attachMinecraftToBuildRequest)
+
+
+### Example
+
+```typescript
+import {
+    QuiltApi,
+    Configuration,
+    AttachMinecraftToBuildRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new QuiltApi(configuration);
+
+let quiltId: string; //A quilt identifier or slug (default to undefined)
+let attachMinecraftToBuildRequest: AttachMinecraftToBuildRequest; //The quilt build data to create or update
+
+const { status, data } = await apiInstance.deleteQuiltFromBuild(
+    quiltId,
+    attachMinecraftToBuildRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **attachMinecraftToBuildRequest** | **AttachMinecraftToBuildRequest**| The quilt build data to create or update | |
+| **quiltId** | [**string**] | A quilt 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)
+
+# **listQuiltBuilds**
+> ListQuiltBuilds200Response listQuiltBuilds()
+
+
+### Example
+
+```typescript
+import {
+    QuiltApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new QuiltApi(configuration);
+
+let quiltId: string; //A quilt 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.listQuiltBuilds(
+    quiltId,
+    search,
+    sort,
+    order,
+    limit,
+    offset
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **quiltId** | [**string**] | A quilt 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
+
+**ListQuiltBuilds200Response**
+
+### 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 quilt builds |  -  |
+|**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)
+
+# **listQuilts**
+> ListQuilts200Response listQuilts()
+
+
+### Example
+
+```typescript
+import {
+    QuiltApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new QuiltApi(configuration);
+
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listQuilts(
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**ListQuilts200Response**
+
+### 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 quilts |  -  |
+|**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)
+
+# **updateQuilt**
+> Notification updateQuilt()
+
+
+### Example
+
+```typescript
+import {
+    QuiltApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new QuiltApi(configuration);
+
+const { status, data } = await apiInstance.updateQuilt();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### 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 |  -  |
+|**503** | Remote source is nit available |  -  |
+|**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)
+

package/docs/RedirectAuthRequest.md

@@ -0,0 +1,20 @@
+# RedirectAuthRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RedirectAuthRequest } from 'kleisterjs';
+
+const instance: RedirectAuthRequest = {
+    token,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)