artifacts_mmo_openapi 4.1.0
artifacts_mmo_openapi: ^4.1.0 copied to clipboard
An OpenApi generated client for ArtifactsMMO: https://artifactsmmo.com/
artifacts_mmo_openapi #
Artifacts is an API-based MMO game where you can manage 5 characters to explore, fight, gather resources, craft items and much more.
Website: https://artifactsmmo.com/
Documentation: https://docs.artifactsmmo.com/
OpenAPI Spec: https://api.artifactsmmo.com/openapi.json
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 4.1
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.DartClientCodegen
Requirements #
Dart 2.12 or later
Installation & Usage #
pub #
The recommended way to consume this package is by consuming the publicly published pub package.
Add the following to your library's pubspec.yaml:
artifacts_mmo_openapi: ^4.1.0
Github #
This library can also be consumed from Github by adding the following dependency to your pubspec.yaml
dependencies:
artifacts_mmo_openapi:
git:
url: https://github.com/regenvanwalbeek/artifacts_mmo_openapi.git
ref: some-branch
Local #
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
artifacts_mmo_openapi:
path: /path/to/artifacts_mmo_openapi
Getting Started #
Please follow the installation procedure.
In your dart library, use import 'package:artifacts_mmo_openapi/api.dart';
Initialize your client with:
const token = 'MY_TOKEN_HERE';
defaultApiClient = ApiClient(
basePath: 'https://api.artifactsmmo.com',
authentication: HttpBearerAuth()..accessToken = token,
);
Then you can make a request. Example:
final destination = DestinationSchema(x: x, y: y);
await MyCharactersApi().actionMoveMyNameActionMovePost('MY_CHARACTER_NAME', destination);
See example.
Documentation for API Endpoints #
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountsApi | createAccountAccountsCreatePost | POST /accounts/create | Create Account |
| AccountsApi | getAccountAccountsAccountGet | GET /accounts/{account} | Get Account |
| AccountsApi | getAccountAchievementsAccountsAccountAchievementsGet | GET /accounts/{account}/achievements | Get Account Achievements |
| AccountsApi | getAccountCharactersAccountsAccountCharactersGet | GET /accounts/{account}/characters | Get Account Characters |
| AchievementsApi | getAchievementAchievementsCodeGet | GET /achievements/{code} | Get Achievement |
| AchievementsApi | getAllAchievementsAchievementsGet | GET /achievements | Get All Achievements |
| BadgesApi | getAllBadgesBadgesGet | GET /badges | Get All Badges |
| BadgesApi | getBadgeBadgesCodeGet | GET /badges/{code} | Get Badge |
| CharactersApi | createCharacterCharactersCreatePost | POST /characters/create | Create Character |
| CharactersApi | deleteCharacterCharactersDeletePost | POST /characters/delete | Delete Character |
| CharactersApi | getCharacterCharactersNameGet | GET /characters/{name} | Get Character |
| DefaultApi | getStatusGet | GET / | Get Status |
| EffectsApi | getAllEffectsEffectsGet | GET /effects | Get All Effects |
| EffectsApi | getEffectEffectsCodeGet | GET /effects/{code} | Get Effect |
| EventsApi | getAllActiveEventsEventsActiveGet | GET /events/active | Get All Active Events |
| EventsApi | getAllEventsEventsGet | GET /events | Get All Events |
| GrandExchangeApi | getGeSellHistoryGrandexchangeHistoryCodeGet | GET /grandexchange/history/{code} | Get Ge Sell History |
| GrandExchangeApi | getGeSellOrderGrandexchangeOrdersIdGet | GET /grandexchange/orders/{id} | Get Ge Sell Order |
| GrandExchangeApi | getGeSellOrdersGrandexchangeOrdersGet | GET /grandexchange/orders | Get Ge Sell Orders |
| ItemsApi | getAllItemsItemsGet | GET /items | Get All Items |
| ItemsApi | getItemItemsCodeGet | GET /items/{code} | Get Item |
| LeaderboardApi | getAccountsLeaderboardLeaderboardAccountsGet | GET /leaderboard/accounts | Get Accounts Leaderboard |
| LeaderboardApi | getCharactersLeaderboardLeaderboardCharactersGet | GET /leaderboard/characters | Get Characters Leaderboard |
| MapsApi | getAllMapsMapsGet | GET /maps | Get All Maps |
| MapsApi | getMapMapsXYGet | GET /maps/{x}/{y} | Get Map |
| MonstersApi | getAllMonstersMonstersGet | GET /monsters | Get All Monsters |
| MonstersApi | getMonsterMonstersCodeGet | GET /monsters/{code} | Get Monster |
| MyAccountApi | changePasswordMyChangePasswordPost | POST /my/change_password | Change Password |
| MyAccountApi | getAccountDetailsMyDetailsGet | GET /my/details | Get Account Details |
| MyAccountApi | getBankDetailsMyBankGet | GET /my/bank | Get Bank Details |
| MyAccountApi | getBankItemsMyBankItemsGet | GET /my/bank/items | Get Bank Items |
| MyAccountApi | getGeSellHistoryMyGrandexchangeHistoryGet | GET /my/grandexchange/history | Get Ge Sell History |
| MyAccountApi | getGeSellOrdersMyGrandexchangeOrdersGet | GET /my/grandexchange/orders | Get Ge Sell Orders |
| MyCharactersApi | actionAcceptNewTaskMyNameActionTaskNewPost | POST /my/{name}/action/task/new | Action Accept New Task |
| MyCharactersApi | actionBuyBankExpansionMyNameActionBankBuyExpansionPost | POST /my/{name}/action/bank/buy_expansion | Action Buy Bank Expansion |
| MyCharactersApi | actionCompleteTaskMyNameActionTaskCompletePost | POST /my/{name}/action/task/complete | Action Complete Task |
| MyCharactersApi | actionCraftingMyNameActionCraftingPost | POST /my/{name}/action/crafting | Action Crafting |
| MyCharactersApi | actionDeleteItemMyNameActionDeletePost | POST /my/{name}/action/delete | Action Delete Item |
| MyCharactersApi | actionDepositBankGoldMyNameActionBankDepositGoldPost | POST /my/{name}/action/bank/deposit/gold | Action Deposit Bank Gold |
| MyCharactersApi | actionDepositBankMyNameActionBankDepositPost | POST /my/{name}/action/bank/deposit | Action Deposit Bank |
| MyCharactersApi | actionEquipItemMyNameActionEquipPost | POST /my/{name}/action/equip | Action Equip Item |
| MyCharactersApi | actionFightMyNameActionFightPost | POST /my/{name}/action/fight | Action Fight |
| MyCharactersApi | actionGatheringMyNameActionGatheringPost | POST /my/{name}/action/gathering | Action Gathering |
| MyCharactersApi | actionGeBuyItemMyNameActionGrandexchangeBuyPost | POST /my/{name}/action/grandexchange/buy | Action Ge Buy Item |
| MyCharactersApi | actionGeCancelSellOrderMyNameActionGrandexchangeCancelPost | POST /my/{name}/action/grandexchange/cancel | Action Ge Cancel Sell Order |
| MyCharactersApi | actionGeCreateSellOrderMyNameActionGrandexchangeSellPost | POST /my/{name}/action/grandexchange/sell | Action Ge Create Sell Order |
| MyCharactersApi | actionMoveMyNameActionMovePost | POST /my/{name}/action/move | Action Move |
| MyCharactersApi | actionNpcBuyItemMyNameActionNpcBuyPost | POST /my/{name}/action/npc/buy | Action Npc Buy Item |
| MyCharactersApi | actionNpcSellItemMyNameActionNpcSellPost | POST /my/{name}/action/npc/sell | Action Npc Sell Item |
| MyCharactersApi | actionRecyclingMyNameActionRecyclingPost | POST /my/{name}/action/recycling | Action Recycling |
| MyCharactersApi | actionRestMyNameActionRestPost | POST /my/{name}/action/rest | Action Rest |
| MyCharactersApi | actionTaskCancelMyNameActionTaskCancelPost | POST /my/{name}/action/task/cancel | Action Task Cancel |
| MyCharactersApi | actionTaskExchangeMyNameActionTaskExchangePost | POST /my/{name}/action/task/exchange | Action Task Exchange |
| MyCharactersApi | actionTaskTradeMyNameActionTaskTradePost | POST /my/{name}/action/task/trade | Action Task Trade |
| MyCharactersApi | actionUnequipItemMyNameActionUnequipPost | POST /my/{name}/action/unequip | Action Unequip Item |
| MyCharactersApi | actionUseItemMyNameActionUsePost | POST /my/{name}/action/use | Action Use Item |
| MyCharactersApi | actionWithdrawBankGoldMyNameActionBankWithdrawGoldPost | POST /my/{name}/action/bank/withdraw/gold | Action Withdraw Bank Gold |
| MyCharactersApi | actionWithdrawBankMyNameActionBankWithdrawPost | POST /my/{name}/action/bank/withdraw | Action Withdraw Bank |
| MyCharactersApi | getAllCharactersLogsMyLogsGet | GET /my/logs | Get All Characters Logs |
| MyCharactersApi | getMyCharactersMyCharactersGet | GET /my/characters | Get My Characters |
| NPCsApi | getAllNpcsNpcsGet | GET /npcs | Get All Npcs |
| NPCsApi | getNpcItemsNpcsCodeItemsGet | GET /npcs/{code}/items | Get Npc Items |
| NPCsApi | getNpcNpcsCodeGet | GET /npcs/{code} | Get Npc |
| ResourcesApi | getAllResourcesResourcesGet | GET /resources | Get All Resources |
| ResourcesApi | getResourceResourcesCodeGet | GET /resources/{code} | Get Resource |
| TasksApi | getAllTasksRewardsTasksRewardsGet | GET /tasks/rewards | Get All Tasks Rewards |
| TasksApi | getAllTasksTasksListGet | GET /tasks/list | Get All Tasks |
| TasksApi | getTaskTasksListCodeGet | GET /tasks/list/{code} | Get Task |
| TasksApi | getTasksRewardTasksRewardsCodeGet | GET /tasks/rewards/{code} | Get Tasks Reward |
| TokenApi | generateTokenTokenPost | POST /token | Generate Token |
Documentation For Models #
- AccountAchievementSchema
- AccountDetails
- AccountDetailsSchema
- AccountLeaderboardSchema
- AccountLeaderboardType
- AccountStatus
- AchievementResponseSchema
- AchievementRewardsSchema
- AchievementSchema
- AchievementType
- ActionType
- ActiveEventSchema
- AddAccountSchema
- AddCharacterSchema
- AnnouncementSchema
- BadgeConditionSchema
- BadgeResponseSchema
- BadgeSchema
- BankExtensionSchema
- BankExtensionTransactionResponseSchema
- BankExtensionTransactionSchema
- BankGoldTransactionResponseSchema
- BankGoldTransactionSchema
- BankItemTransactionResponseSchema
- BankItemTransactionSchema
- BankResponseSchema
- BankSchema
- BlockedHitsSchema
- ChangePassword
- CharacterFightDataSchema
- CharacterFightResponseSchema
- CharacterLeaderboardSchema
- CharacterLeaderboardType
- CharacterMovementDataSchema
- CharacterMovementResponseSchema
- CharacterResponseSchema
- CharacterRestDataSchema
- CharacterRestResponseSchema
- CharacterSchema
- CharacterSkin
- CharactersListSchema
- CooldownSchema
- CraftSchema
- CraftSkill
- CraftingSchema
- DataPageAccountAchievementSchema
- DataPageAccountLeaderboardSchema
- DataPageAchievementSchema
- DataPageActiveEventSchema
- DataPageBadgeSchema
- DataPageCharacterLeaderboardSchema
- DataPageDropRateSchema
- DataPageEffectSchema
- DataPageEventSchema
- DataPageGEOrderSchema
- DataPageGeOrderHistorySchema
- DataPageItemSchema
- DataPageLogSchema
- DataPageMapSchema
- DataPageMonsterSchema
- DataPageNPCItem
- DataPageNPCSchema
- DataPageResourceSchema
- DataPageSimpleItemSchema
- DataPageTaskFullSchema
- DeleteCharacterSchema
- DeleteItemResponseSchema
- DeleteItemSchema
- DepositWithdrawGoldSchema
- DestinationSchema
- DropRateSchema
- DropSchema
- EffectResponseSchema
- EffectSchema
- EffectSubtype
- EffectType
- EquipRequestSchema
- EquipSchema
- EquipmentResponseSchema
- EventContentSchema
- EventMapSchema
- EventSchema
- FightResult
- FightSchema
- GEBuyOrderSchema
- GECancelOrderSchema
- GECreateOrderTransactionResponseSchema
- GEOrderCreatedSchema
- GEOrderCreationrSchema
- GEOrderReponseSchema
- GEOrderSchema
- GEOrderTransactionSchema
- GETransactionListSchema
- GETransactionResponseSchema
- GETransactionSchema
- GatheringSkill
- GeOrderHistorySchema
- GoldSchema
- HTTPValidationError
- InventorySlot
- ItemResponseSchema
- ItemSchema
- ItemSlot
- ItemType
- LogSchema
- LogType
- MapContentSchema
- MapContentType
- MapResponseSchema
- MapSchema
- MonsterResponseSchema
- MonsterSchema
- MyAccountDetails
- MyAccountDetailsSchema
- MyCharactersListSchema
- NPCItem
- NPCResponseSchema
- NPCSchema
- NPCType
- NpcItemTransactionSchema
- NpcMerchantBuySchema
- NpcMerchantTransactionResponseSchema
- NpcMerchantTransactionSchema
- RecyclingDataSchema
- RecyclingItemsSchema
- RecyclingResponseSchema
- RecyclingSchema
- ResourceResponseSchema
- ResourceSchema
- ResponseSchema
- RewardDataResponseSchema
- RewardDataSchema
- RewardResponseSchema
- RewardsSchema
- SimpleEffectSchema
- SimpleItemSchema
- Skill
- SkillDataSchema
- SkillInfoSchema
- SkillResponseSchema
- StatusResponseSchema
- StatusSchema
- TaskCancelledResponseSchema
- TaskCancelledSchema
- TaskDataSchema
- TaskFullResponseSchema
- TaskFullSchema
- TaskResponseSchema
- TaskSchema
- TaskTradeDataSchema
- TaskTradeResponseSchema
- TaskTradeSchema
- TaskType
- TokenResponseSchema
- UnequipSchema
- UseItemResponseSchema
- UseItemSchema
- ValidationError
- ValidationErrorLocInner