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.11

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 AttributeModelDTO1 attributeModelDTO1 = ; // AttributeModelDTO1 | 

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AttributeApi	addAttribute	POST /attribute	Add a new attribute
AttributeApi	deleteAllAttributes	DELETE /attribute/delete/all	Delete all attributes
AttributeApi	deleteAttributeById	DELETE /attribute/delete/{id}	Delete an attribute by ID
AttributeApi	getAllAttributes	GET /attribute/all	Get all attributes
AttributeApi	updateAttribute	POST /attribute/update	Update an attribute
FontApi	addFont	POST /font	Add a new font
FontApi	deleteAllFonts	DELETE /font/delete/all	Delete all fonts
FontApi	deleteFont	DELETE /font/delete/{id}	Remove a font by ID
FontApi	getAllFonts	GET /font/all	Get all fonts
FontApi	getCharsById	GET /font/chars/{id}	Get characters by font ID
FontApi	getFontById	GET /font/{id}	Get a font by ID
FontApi	updateFont	POST /font/update	Update a font
ItemApi	addItem	POST /item	Add a new item
ItemApi	deleteAll	DELETE /item/deleteAll	Delete all items
ItemApi	getAllItems	GET /item/all	Get all items
ItemApi	getEnchantmentsById	GET /item/enchantments/{id}	Get enchantments of an item
ItemApi	getFlagsById	GET /item/flags/{id}	Get all flags of an item
ItemApi	getItemById	GET /item/{id}	Get an item by ID
ItemApi	getLoreById	GET /item/lore/{id}	Get all lore of an item
ItemApi	removeItemById	DELETE /item/delete/{id}	Remove an item by ID
ItemApi	update	POST /item/update	Update an item
NotificationApi	addNotification	POST /notification	Add a new notification
NotificationApi	deleteAllNotifications	DELETE /notification/delete/all	Delete all notifications
NotificationApi	getAllNotifications	GET /notification/all	Get all notifications
NotificationApi	getNotificationById	GET /notification/{id}	Get a notification by ID
NotificationApi	removeNotificationById	DELETE /notification/delete/{id}	Remove a notification by ID
NotificationApi	updateNotification	POST /notification/update	Update a notification
SoundApi	addSoundEvent	POST /sound	Add a new sound event
SoundApi	deleteAllSoundEvents	DELETE /sound/delete/all	Delete all sound events
SoundApi	getAllSoundEvents	GET /sound/all	Get all sound events
SoundApi	getSoundById	GET /sound/{id}	Get a sound by its ID
SoundApi	getSoundSourcesById	GET /sound/{id}/sources	Get all sound file sources by an id
SoundApi	removeSoundEventById	DELETE /sound/delete/{id}	Remove a sound event by ID
SoundApi	updateSoundEvent	POST /sound/update	Update a sound event

Documentation For Models

• AttributeModelDTO
• AttributeModelDTO1
• AttributeModelDTO2
• AttributeModelErrorDTO
• FontModelCharsDTO
• FontModelDTO
• FontModelDTO1
• FontModelDTO2
• FontModelErrorDTO
• ItemModelDTO
• ItemModelDTO1
• ItemModelDTO2
• ItemModelDTO3
• ItemModelDTO4
• ItemModelDTO5
• ItemModelEnchantmentDTO
• ItemModelFlagDTO
• ItemModelLoreDTO
• ItemModelResponseDTOItemModelErrorDTO
• NotificationModelDTO
• NotificationModelDTO1
• NotificationModelDTO2
• NotificationModelResponseDTONotificationModelErrorDTO
• Pageable
• PageableMode
• Sort
• SortOrder
• SortOrderDirection
• SoundErrorDTO
• SoundEventDTO
• SoundModelDTO

Documentation For Authorization

Endpoints do not require authorization.

Author