kleisterjs 2.7.0 → 2.9.0

package/docs/ListQuiltBuilds200Response.md

@@ -0,0 +1,28 @@
+# ListQuiltBuilds200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [default to undefined]
+**limit** | **number** |  | [default to undefined]
+**offset** | **number** |  | [default to undefined]
+**quilt** | [**Quilt**](Quilt.md) |  | [optional] [default to undefined]
+**builds** | [**Array<Build>**](Build.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListQuiltBuilds200Response } from 'kleisterjs';
+
+const instance: ListQuiltBuilds200Response = {
+    total,
+    limit,
+    offset,
+    quilt,
+    builds,
+};
+```
+
+[[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/ListQuilts200Response.md

@@ -0,0 +1,26 @@
+# ListQuilts200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [default to undefined]
+**limit** | **number** |  | [default to undefined]
+**offset** | **number** |  | [default to undefined]
+**versions** | [**Array<Quilt>**](Quilt.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListQuilts200Response } from 'kleisterjs';
+
+const instance: ListQuilts200Response = {
+    total,
+    limit,
+    offset,
+    versions,
+};
+```
+
+[[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/ListUserGroups200Response.md

@@ -0,0 +1,28 @@
+# ListUserGroups200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [default to undefined]
+**limit** | **number** |  | [default to undefined]
+**offset** | **number** |  | [default to undefined]
+**user** | [**User**](User.md) |  | [optional] [default to undefined]
+**groups** | [**Array<UserGroup>**](UserGroup.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListUserGroups200Response } from 'kleisterjs';
+
+const instance: ListUserGroups200Response = {
+    total,
+    limit,
+    offset,
+    user,
+    groups,
+};
+```
+
+[[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/ListUserMods200Response.md

@@ -0,0 +1,28 @@
+# ListUserMods200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [default to undefined]
+**limit** | **number** |  | [default to undefined]
+**offset** | **number** |  | [default to undefined]
+**user** | [**User**](User.md) |  | [optional] [default to undefined]
+**mods** | [**Array<UserMod>**](UserMod.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListUserMods200Response } from 'kleisterjs';
+
+const instance: ListUserMods200Response = {
+    total,
+    limit,
+    offset,
+    user,
+    mods,
+};
+```
+
+[[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/ListUserPacks200Response.md

@@ -0,0 +1,28 @@
+# ListUserPacks200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [default to undefined]
+**limit** | **number** |  | [default to undefined]
+**offset** | **number** |  | [default to undefined]
+**user** | [**User**](User.md) |  | [optional] [default to undefined]
+**packs** | [**Array<UserPack>**](UserPack.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListUserPacks200Response } from 'kleisterjs';
+
+const instance: ListUserPacks200Response = {
+    total,
+    limit,
+    offset,
+    user,
+    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/ListUsers200Response.md

@@ -0,0 +1,26 @@
+# ListUsers200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [default to undefined]
+**limit** | **number** |  | [default to undefined]
+**offset** | **number** |  | [default to undefined]
+**users** | [**Array<User>**](User.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListUsers200Response } from 'kleisterjs';
+
+const instance: ListUsers200Response = {
+    total,
+    limit,
+    offset,
+    users,
+};
+```
+
+[[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/ListVersionBuilds200Response.md

@@ -0,0 +1,30 @@
+# ListVersionBuilds200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [default to undefined]
+**limit** | **number** |  | [default to undefined]
+**offset** | **number** |  | [default to undefined]
+**mod** | [**Mod**](Mod.md) |  | [optional] [default to undefined]
+**version** | [**Version**](Version.md) |  | [optional] [default to undefined]
+**builds** | [**Array<BuildVersion>**](BuildVersion.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListVersionBuilds200Response } from 'kleisterjs';
+
+const instance: ListVersionBuilds200Response = {
+    total,
+    limit,
+    offset,
+    mod,
+    version,
+    builds,
+};
+```
+
+[[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/ListVersions200Response.md

@@ -0,0 +1,28 @@
+# ListVersions200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [default to undefined]
+**limit** | **number** |  | [default to undefined]
+**offset** | **number** |  | [default to undefined]
+**mod** | [**Mod**](Mod.md) |  | [optional] [default to undefined]
+**versions** | [**Array<Version>**](Version.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListVersions200Response } from 'kleisterjs';
+
+const instance: ListVersions200Response = {
+    total,
+    limit,
+    offset,
+    mod,
+    versions,
+};
+```
+
+[[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/LoginAuthRequest.md

@@ -0,0 +1,22 @@
+# LoginAuthRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** |  | [default to undefined]
+**password** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { LoginAuthRequest } from 'kleisterjs';
+
+const instance: LoginAuthRequest = {
+    username,
+    password,
+};
+```
+
+[[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/Minecraft.md

@@ -0,0 +1,29 @@
+# Minecraft
+
+Model to represent minecraft
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [readonly] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [readonly] [default to undefined]
+**updated_at** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Minecraft } from 'kleisterjs';
+
+const instance: Minecraft = {
+    id,
+    name,
+    type,
+    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/MinecraftApi.md

@@ -0,0 +1,297 @@
+# MinecraftApi
+
+All URIs are relative to *https://try.kleister.eu/api/v1*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**attachMinecraftToBuild**](#attachminecrafttobuild) | **POST** /minecraft/{minecraft_id}/builds | Attach a build to a Minecraft version|
+|[**deleteMinecraftFromBuild**](#deleteminecraftfrombuild) | **DELETE** /minecraft/{minecraft_id}/builds | Unlink a build from a Minecraft version|
+|[**listMinecraftBuilds**](#listminecraftbuilds) | **GET** /minecraft/{minecraft_id}/builds | Fetch the builds attached to a Minecraft version|
+|[**listMinecrafts**](#listminecrafts) | **GET** /minecraft | Fetch the available Minecraft versions|
+|[**updateMinecraft**](#updateminecraft) | **PUT** /minecraft | Update the available Minecraft versions|
+
+# **attachMinecraftToBuild**
+> Notification attachMinecraftToBuild(attachMinecraftToBuildRequest)
+
+
+### Example
+
+```typescript
+import {
+    MinecraftApi,
+    Configuration,
+    AttachMinecraftToBuildRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new MinecraftApi(configuration);
+
+let minecraftId: string; //A minecraft identifier or slug (default to undefined)
+let attachMinecraftToBuildRequest: AttachMinecraftToBuildRequest; //The minecraft build data to create or update
+
+const { status, data } = await apiInstance.attachMinecraftToBuild(
+    minecraftId,
+    attachMinecraftToBuildRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **attachMinecraftToBuildRequest** | **AttachMinecraftToBuildRequest**| The minecraft build data to create or update | |
+| **minecraftId** | [**string**] | A minecraft 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)
+
+# **deleteMinecraftFromBuild**
+> Notification deleteMinecraftFromBuild(attachMinecraftToBuildRequest)
+
+
+### Example
+
+```typescript
+import {
+    MinecraftApi,
+    Configuration,
+    AttachMinecraftToBuildRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new MinecraftApi(configuration);
+
+let minecraftId: string; //A minecraft identifier or slug (default to undefined)
+let attachMinecraftToBuildRequest: AttachMinecraftToBuildRequest; //The minecraft build data to create or update
+
+const { status, data } = await apiInstance.deleteMinecraftFromBuild(
+    minecraftId,
+    attachMinecraftToBuildRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **attachMinecraftToBuildRequest** | **AttachMinecraftToBuildRequest**| The minecraft build data to create or update | |
+| **minecraftId** | [**string**] | A minecraft 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)
+
+# **listMinecraftBuilds**
+> ListMinecraftBuilds200Response listMinecraftBuilds()
+
+
+### Example
+
+```typescript
+import {
+    MinecraftApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new MinecraftApi(configuration);
+
+let minecraftId: string; //A minecraft 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.listMinecraftBuilds(
+    minecraftId,
+    search,
+    sort,
+    order,
+    limit,
+    offset
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **minecraftId** | [**string**] | A minecraft 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
+
+**ListMinecraftBuilds200Response**
+
+### 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 minecraft 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)
+
+# **listMinecrafts**
+> ListMinecrafts200Response listMinecrafts()
+
+
+### Example
+
+```typescript
+import {
+    MinecraftApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new MinecraftApi(configuration);
+
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listMinecrafts(
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**ListMinecrafts200Response**
+
+### 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 minecrafts |  -  |
+|**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)
+
+# **updateMinecraft**
+> Notification updateMinecraft()
+
+
+### Example
+
+```typescript
+import {
+    MinecraftApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new MinecraftApi(configuration);
+
+const { status, data } = await apiInstance.updateMinecraft();
+```
+
+### 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/Mod.md

@@ -0,0 +1,43 @@
+# Mod
+
+Model to represent mod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [readonly] [default to undefined]
+**avatar** | [**ModAvatar**](ModAvatar.md) |  | [optional] [default to undefined]
+**slug** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**side** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**author** | **string** |  | [optional] [default to undefined]
+**website** | **string** |  | [optional] [default to undefined]
+**donate** | **string** |  | [optional] [default to undefined]
+**_public** | **boolean** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [readonly] [default to undefined]
+**updated_at** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Mod } from 'kleisterjs';
+
+const instance: Mod = {
+    id,
+    avatar,
+    slug,
+    name,
+    side,
+    description,
+    author,
+    website,
+    donate,
+    _public,
+    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)