vulpes_backend_client (EXPERIMENTAL)

Vulpes Backend API handles the custom attributes, fonts, items and notifications API for Dungeon Project. It provides endpoints to manage custom attributes, fonts, items, and notifications. The API is designed to be used by the Vulpes Generator to generate dependencies for Minestom Server

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

• Dart 2.15.0+ or Flutter 2.8.0+
• Dio 5.0.0+ (https://pub.dev/packages/dio)

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  vulpes_backend_client: 1.2.0-beta.1

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  vulpes_backend_client:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  vulpes_backend_client:
    path: /path/to/vulpes_backend_client

Getting Started

Please follow the installation procedure and then run the following:

import 'package:vulpes_backend_client/vulpes_backend_client.dart';


final api = VulpesBackendClient().getAttributeApi();
final AttributeModelDTO attributeModelDTO = ; // AttributeModelDTO | 

try {
    final response = await api.add(attributeModelDTO);
    print(response);
} catch on DioException (e) {
    print("Exception when calling AttributeApi->add: $e\n");
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AttributeApi	add	POST /attribute	Add a new attribute
AttributeApi	delete	DELETE /attribute/delete/{id}	Delete an attribute by ID
AttributeApi	deleteAll	DELETE /attribute/deleteAll	Delete all attributes
AttributeApi	getAll	GET /attribute/all	Get all attributes
AttributeApi	getAll1	GET /attribute/getAll	Get all attributes
AttributeApi	update	POST /attribute/update	Get an attribute by ID
FontApi	add1	POST /font	Add a new font
FontApi	deleteAll1	DELETE /font/deleteAll	Delete all fonts
FontApi	getAll2	GET /font/all	Get all fonts
FontApi	getAll3	GET /font/getAll	Get all fonts
FontApi	getById	GET /font/{id}	Get a font by ID
FontApi	getCharsById	GET /font/chars/{id}	Get characters by font ID
FontApi	remove	DELETE /font/remove/{id}	Remove a font by ID
FontApi	update1	POST /font/update	Update a font
ItemApi	add2	POST /item	Add a new item
ItemApi	deleteAll2	DELETE /item/deleteAll	Delete all items
ItemApi	getAll4	GET /item/all	Get all items
ItemApi	getAll5	GET /item/getAll	Get all items
ItemApi	getById1	GET /item/{id}	Get an item by ID
ItemApi	getEnchantmentsById	GET /item/enchantments/{id}	Get enchantments of an item
ItemApi	getFlagsById	GET /item/flags/{id}	Get all flags of an item
ItemApi	getLoreById	GET /item/lore/{id}	Get all lore of an item
ItemApi	remove1	DELETE /item/remove/{id}	Remove an item by ID
ItemApi	update2	POST /item/update	Update an item
NotificationApi	add3	POST /notification	Add a new notification
NotificationApi	deleteAll3	DELETE /notification/deleteAll	Delete all notifications
NotificationApi	getAll6	GET /notification/all	Get all notifications
NotificationApi	getAll7	GET /notification/getAll	Get all notifications
NotificationApi	getById2	GET /notification/{id}	Get a notification by ID
NotificationApi	remove2	DELETE /notification/remove/{id}	Remove a notification by ID
NotificationApi	update3	POST /notification/update	Update a notification
SoundApi	add4	POST /sound	Add a new sound event
SoundApi	callGet	GET /sound/{id}/sources	Get all sound file sources by an id
SoundApi	deleteAll4	DELETE /sound/deleteAll	Delete all sound events
SoundApi	getAll8	GET /sound/getAll	Get all sound events
SoundApi	getById3	GET /sound/{id}	Get a sound by its ID
SoundApi	remove3	DELETE /sound/remove/{id}	Remove a sound event by ID
SoundApi	update4	POST /sound/update	Update a sound event

Documentation For Models

• AttributeModelDTO
• AttributeModelResponseDTOAttributeModelDTO
• AttributeModelResponseDTOAttributeModelErrorDTO
• FontModelDTO
• FontModelResponseDTOFontModelCharsResponseDTO
• FontModelResponseDTOFontModelDTO
• FontModelResponseDTOFontModelErrorDTO
• ItemModelDTO
• ItemModelResponseDTOItemModelDTO
• ItemModelResponseDTOItemModelEnchantmentResponseDTO
• ItemModelResponseDTOItemModelErrorDTO
• ItemModelResponseDTOItemModelFlagResponseDTO
• ItemModelResponseDTOItemModelLoreResponseDTO
• NotificationModelDTO
• NotificationModelResponseDTONotificationModelDTO
• NotificationModelResponseDTONotificationModelErrorDTO
• Pageable
• PageableMode
• Sort
• SortOrder
• SortOrderDirection
• SoundEventDTO
• SoundResponseDTOSoundErrorDTO
• SoundResponseDTOSoundModelDTO

Documentation For Authorization

Endpoints do not require authorization.

Author