kleisterjs 2.7.0 → 2.9.0

package/docs/BuildVersion.md

@@ -0,0 +1,31 @@
+# BuildVersion
+
+Model to represent build version
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**build_id** | **string** |  | [default to undefined]
+**build** | [**Build**](Build.md) |  | [optional] [default to undefined]
+**version_id** | **string** |  | [default to undefined]
+**version** | [**Version**](Version.md) |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [readonly] [default to undefined]
+**updated_at** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { BuildVersion } from 'kleisterjs';
+
+const instance: BuildVersion = {
+    build_id,
+    build,
+    version_id,
+    version,
+    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/CreateBuildRequest.md

@@ -0,0 +1,40 @@
+# CreateBuildRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**minecraft_id** | **string** |  | [optional] [default to undefined]
+**forge_id** | **string** |  | [optional] [default to undefined]
+**neoforge_id** | **string** |  | [optional] [default to undefined]
+**quilt_id** | **string** |  | [optional] [default to undefined]
+**fabric_id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**java** | **string** |  | [optional] [default to undefined]
+**memory** | **string** |  | [optional] [default to undefined]
+**latest** | **boolean** |  | [optional] [default to undefined]
+**recommended** | **boolean** |  | [optional] [default to undefined]
+**_public** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateBuildRequest } from 'kleisterjs';
+
+const instance: CreateBuildRequest = {
+    minecraft_id,
+    forge_id,
+    neoforge_id,
+    quilt_id,
+    fabric_id,
+    name,
+    java,
+    memory,
+    latest,
+    recommended,
+    _public,
+};
+```
+
+[[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/CreateGroupRequest.md

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

@@ -0,0 +1,34 @@
+# CreateModRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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]
+
+## Example
+
+```typescript
+import { CreateModRequest } from 'kleisterjs';
+
+const instance: CreateModRequest = {
+    slug,
+    name,
+    side,
+    description,
+    author,
+    website,
+    donate,
+    _public,
+};
+```
+
+[[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/CreatePackRequest.md

@@ -0,0 +1,26 @@
+# CreatePackRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**slug** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**website** | **string** |  | [optional] [default to undefined]
+**_public** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreatePackRequest } from 'kleisterjs';
+
+const instance: CreatePackRequest = {
+    slug,
+    name,
+    website,
+    _public,
+};
+```
+
+[[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/CreateUserRequest.md

@@ -0,0 +1,30 @@
+# CreateUserRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**fullname** | **string** |  | [optional] [default to undefined]
+**admin** | **boolean** |  | [optional] [default to false]
+**active** | **boolean** |  | [optional] [default to true]
+
+## Example
+
+```typescript
+import { CreateUserRequest } from 'kleisterjs';
+
+const instance: CreateUserRequest = {
+    username,
+    password,
+    email,
+    fullname,
+    admin,
+    active,
+};
+```
+
+[[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/CreateVersionRequest.md

@@ -0,0 +1,24 @@
+# CreateVersionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**_public** | **boolean** |  | [optional] [default to undefined]
+**upload** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateVersionRequest } from 'kleisterjs';
+
+const instance: CreateVersionRequest = {
+    name,
+    _public,
+    upload,
+};
+```
+
+[[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/DeleteGroupFromModRequest.md

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

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

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

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

@@ -0,0 +1,27 @@
+# Fabric
+
+Model to represent fabric
+
+## 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 { Fabric } from 'kleisterjs';
+
+const instance: Fabric = {
+    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/FabricApi.md

@@ -0,0 +1,297 @@
+# FabricApi
+
+All URIs are relative to *https://try.kleister.eu/api/v1*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**attachFabricToBuild**](#attachfabrictobuild) | **POST** /fabric/{fabric_id}/builds | Attach a build to a Fabric version|
+|[**deleteFabricFromBuild**](#deletefabricfrombuild) | **DELETE** /fabric/{fabric_id}/builds | Unlink a build from a Fabric version|
+|[**listFabricBuilds**](#listfabricbuilds) | **GET** /fabric/{fabric_id}/builds | Fetch the builds attached to a Fabric version|
+|[**listFabrics**](#listfabrics) | **GET** /fabric | Fetch the available Fabric versions|
+|[**updateFabric**](#updatefabric) | **PUT** /fabric | Update the available Fabric versions|
+
+# **attachFabricToBuild**
+> Notification attachFabricToBuild(attachMinecraftToBuildRequest)
+
+
+### Example
+
+```typescript
+import {
+    FabricApi,
+    Configuration,
+    AttachMinecraftToBuildRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new FabricApi(configuration);
+
+let fabricId: string; //A fabric identifier or slug (default to undefined)
+let attachMinecraftToBuildRequest: AttachMinecraftToBuildRequest; //The fabric build data to create or update
+
+const { status, data } = await apiInstance.attachFabricToBuild(
+    fabricId,
+    attachMinecraftToBuildRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **attachMinecraftToBuildRequest** | **AttachMinecraftToBuildRequest**| The fabric build data to create or update | |
+| **fabricId** | [**string**] | A fabric 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)
+
+# **deleteFabricFromBuild**
+> Notification deleteFabricFromBuild(attachMinecraftToBuildRequest)
+
+
+### Example
+
+```typescript
+import {
+    FabricApi,
+    Configuration,
+    AttachMinecraftToBuildRequest
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new FabricApi(configuration);
+
+let fabricId: string; //A fabric identifier or slug (default to undefined)
+let attachMinecraftToBuildRequest: AttachMinecraftToBuildRequest; //The fabric build data to create or update
+
+const { status, data } = await apiInstance.deleteFabricFromBuild(
+    fabricId,
+    attachMinecraftToBuildRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **attachMinecraftToBuildRequest** | **AttachMinecraftToBuildRequest**| The fabric build data to create or update | |
+| **fabricId** | [**string**] | A fabric 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)
+
+# **listFabricBuilds**
+> ListFabricBuilds200Response listFabricBuilds()
+
+
+### Example
+
+```typescript
+import {
+    FabricApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new FabricApi(configuration);
+
+let fabricId: string; //A fabric 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.listFabricBuilds(
+    fabricId,
+    search,
+    sort,
+    order,
+    limit,
+    offset
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **fabricId** | [**string**] | A fabric 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
+
+**ListFabricBuilds200Response**
+
+### 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 fabric 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)
+
+# **listFabrics**
+> ListFabrics200Response listFabrics()
+
+
+### Example
+
+```typescript
+import {
+    FabricApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new FabricApi(configuration);
+
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listFabrics(
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**ListFabrics200Response**
+
+### 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 fabrics |  -  |
+|**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)
+
+# **updateFabric**
+> Notification updateFabric()
+
+
+### Example
+
+```typescript
+import {
+    FabricApi,
+    Configuration
+} from 'kleisterjs';
+
+const configuration = new Configuration();
+const apiInstance = new FabricApi(configuration);
+
+const { status, data } = await apiInstance.updateFabric();
+```
+
+### 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/Forge.md

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