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.17.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)
• timemachine option currently DOES NOT support sound null-safety and may not work

Installation & Usage

pub.dev

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

dependencies:
  vulpes_backend_client: 1.0.0

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.addAttribute(attributeModelDTO);
    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	Delete all attributes
AttributeApi	deleteAttributeById	DELETE /attribute/delete/{id}	Delete an attribute by ID
AttributeApi	getAllAttributes	GET /attribute	Get all attributes
AttributeApi	updateAttribute	POST /attribute/update	Update an attribute
FontApi	addFont	POST /font	Add a new font
FontApi	createChar	PUT /font/chars/{id}	Create character of a font
FontApi	deleteAllFonts	DELETE /font/delete	Delete all fonts
FontApi	deleteChar	DELETE /font/chars/{fontId}	Delete character of a font
FontApi	deleteChar1	DELETE /font/chars/{fontId}/{charId}	Delete character of a font
FontApi	deleteFont	DELETE /font/delete/{id}	Remove a font by ID
FontApi	getAllFonts	GET /font	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	updateChar	POST /font/chars/{id}	Update character of a font
FontApi	updateFont	POST /font/update	Update a font
ItemApi	addItem	POST /item	Create a new item
ItemApi	createEnchantment	PUT /item/enchantment/{itemId}	Create an enchantment for an item
ItemApi	createEnchantment1	PUT /item/{itemId}/enchantment	Create an enchantment for an item
ItemApi	createFlag	PUT /item/flag/{itemId}	Create flag of an item
ItemApi	createFlag1	PUT /item/{itemId}/flag	Create flag of an item
ItemApi	createLore	PUT /item/lore/{itemId}	Create lore of an item
ItemApi	createLore1	PUT /item/{itemId}/lore	Create lore of an item
ItemApi	deleteAll	DELETE /item/deleteAll	Delete all items
ItemApi	deleteAllLore	DELETE /item/lore/{itemId}	Delete all lore of an item
ItemApi	deleteAllLore1	DELETE /item/{itemId}/lore	Delete all lore of an item
ItemApi	deleteEnchantment	DELETE /item/enchantment/{itemId}/{enchantmentId}	Delete an enchantment of an item
ItemApi	deleteEnchantment1	DELETE /item/{itemId}/enchantment/{enchantmentId}	Delete an enchantment of an item
ItemApi	deleteEnchantments	DELETE /item/enchantment/{itemId}	Delete all enchantments of an item
ItemApi	deleteEnchantments1	DELETE /item/{itemId}/enchantment	Delete all enchantments of an item
ItemApi	deleteFlag	DELETE /item/flag/{itemId}/{flagId}	Delete flag of an item
ItemApi	deleteFlag1	DELETE /item/{itemId}/flag/{flagId}	Delete flag of an item
ItemApi	deleteFlags	DELETE /item/flag/{itemId}	Delete all flags of an item
ItemApi	deleteFlags1	DELETE /item/{itemId}/flag	Delete all flags of an item
ItemApi	deleteLore	DELETE /item/lore/{itemId}/{loreId}	Delete lore of an item
ItemApi	deleteLore1	DELETE /item/{itemId}/lore/{loreId}	Delete lore of an item
ItemApi	getAllItems	GET /item	Get all items
ItemApi	getEnchantments	GET /item/enchantments/{itemId}	Get enchantments of an item
ItemApi	getEnchantments1	GET /item/{itemId}/enchantments	Get enchantments of an item
ItemApi	getFlags	GET /item/flags/{itemId}	Get all flags of an item
ItemApi	getFlags1	GET /item/{itemId}/flags	Get all flags of an item
ItemApi	getItemById	GET /item/{itemId}	Get an item by ID
ItemApi	getLore	GET /item/lore/{itemId}	Get all lore of an item
ItemApi	getLore1	GET /item/{itemId}/lore	Get all lore of an item
ItemApi	removeItemById	DELETE /item/delete/{itemId}	Remove an item by ID
ItemApi	updateEnchantment	POST /item/enchantment/{itemId}	Update an enchantment of an item
ItemApi	updateEnchantment1	POST /item/{itemId}/enchantment	Update an enchantment of an item
ItemApi	updateFlag	POST /item/flag/{itemId}	Update flag of an item
ItemApi	updateFlag1	POST /item/{itemId}/flag	Update flag of an item
ItemApi	updateItem	POST /item/update	Update an item
ItemApi	updateLore	POST /item/lore/{itemId}	Update lore of an item
ItemApi	updateLore1	POST /item/{itemId}/lore	Update lore of an item
NotificationApi	addNotification	POST /notification	Add a new notification
NotificationApi	deleteAllNotifications	DELETE /notification/delete	Delete all notifications
NotificationApi	getAllNotifications	GET /notification	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	createAndLinkSoundFileSource	POST /sound/{id}/sources	Create and link a SoundFileSource
SoundApi	deleteAllSoundEvents	DELETE /sound/delete	Delete all sound events
SoundApi	deleteLinkedSoundFileSource	DELETE /sound/{id}/sources/delete/{soundId}	Delete a linked SoundFileSource
SoundApi	getAllSoundEvents	GET /sound	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	updateLinkedSoundFileSource	POST /sound/{id}/sources/update	Update a linked SoundFileSource
SoundApi	updateSoundEvent	POST /sound/update	Update a sound event

Documentation For Models

• AttributeModelDTO
• AttributeModelErrorDTO
• FontModelDTO
• FontStringDTO
• ItemEnchantmentDTO
• ItemFlagDTO
• ItemLoreDTO
• ItemModelDTO
• ItemModelErrorDTO
• NotificationModelDTO
• NotificationModelErrorDTO
• Pageable
• PageableMode
• ResponseAttributeModelDTO
• ResponseFontModelDTO
• ResponseFontModelErrorDTO
• ResponseFontStringDTO
• ResponseFontStringErrorDTO
• ResponseItemEnchantmentDTO
• ResponseItemEnchantmentErrorDTO
• ResponseItemFlagDTO
• ResponseItemFlagErrorDTO
• ResponseItemLoreDTO
• ResponseItemLoreErrorDTO
• ResponseItemModelDTO
• ResponseNotificationModelDTO
• ResponseSoundErrorDTO
• ResponseSoundFileSourceDTO
• ResponseSoundModelDTO
• Sort
• SortOrder
• SortOrderDirection
• SoundEventDTO
• SoundFileSourceDTO

Documentation For Authorization

Endpoints do not require authorization.

Author