README

This is automatically generated API client for Artifacts MMO. The code is completely based on OpenAPI Generator project and is thus untested.

Version numbering should reflect version of the API.

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

Requirements

PHP 8.1 and later.

Installation

You can install the package via composer:

composer require kehet/artifactsmmo-client

Getting Started

<?php

\Kehet\ArtifactsMMO\Configuration::getDefaultConfiguration()
    ->setHost('https://api.artifactsmmo.com')
    ->setAccessToken('XXXXXXXXXXXXXX');

$apiInstance = new \Kehet\ArtifactsMMO\Api\MyCharactersApi(
    new \GuzzleHttp\Client()
);

try {
    $response = $apiInstance->actionMoveMyNameActionMovePost(
        'Kehetus',
        new \Kehet\ArtifactsMMO\Model\DestinationSchema([
            'x' => 1,
            'y' => 1,
        ])
    );
    
    print_r($result);
} catch (\Kehet\ArtifactsMMO\ApiException $e) {
    echo 'Exception when calling AccountsApi->createAccountAccountsCreatePost: ', $e->getMessage(), PHP_EOL;
}

Unpaginate helper class

<?php

$config = new \Kehet\ArtifactsMMO\Configuration()
    ->setHost('https://api.artifactsmmo.com')
    ->setAccessToken('XXXXXXXXXXXXXX');

$api = new \Kehet\ArtifactsMMO\Api\ItemsApi(new GuzzleHttp\Client(), $config);

$items = iterator_to_array(\Kehet\ArtifactsMMO\Util\Unpaginate::iterate(
    fn(int $page) => $api->getAllItemsItemsGet(page: $page, size: 100),
    sleepSeconds: 1
));

var_dump($items);
var_dump(count($items));

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AccountsApi	createAccountAccountsCreatePost	POST /accounts/create	Create Account
AccountsApi	forgotPasswordAccountsForgotPasswordPost	POST /accounts/forgot_password	Forgot Password
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
AccountsApi	resetPasswordAccountsResetPasswordPost	POST /accounts/reset_password	Reset Password
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	getActiveCharactersCharactersActiveGet	GET /characters/active	Get Active Characters
CharactersApi	getCharacterCharactersNameGet	GET /characters/{name}	Get Character
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
EventsApi	spawnEventEventsSpawnPost	POST /events/spawn	Spawn Event
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	getLayerMapsMapsLayerGet	GET /maps/{layer}	Get Layer Maps
MapsApi	getMapByIdMapsIdMapIdGet	GET /maps/id/{map_id}	Get Map By Id
MapsApi	getMapByPositionMapsLayerXYGet	GET /maps/{layer}/{x}/{y}	Get Map By Position
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	actionChangeSkinMyNameActionChangeSkinPost	POST /my/{name}/action/change_skin	Action Change Skin
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	actionDepositBankItemMyNameActionBankDepositItemPost	POST /my/{name}/action/bank/deposit/item	Action Deposit Bank Item
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	actionGiveGoldMyNameActionGiveGoldPost	POST /my/{name}/action/give/gold	Action Give Gold
MyCharactersApi	actionGiveItemsMyNameActionGiveItemPost	POST /my/{name}/action/give/item	Action Give Items
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	actionTransitionMyNameActionTransitionPost	POST /my/{name}/action/transition	Action Transition
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	actionWithdrawBankItemMyNameActionBankWithdrawItemPost	POST /my/{name}/action/bank/withdraw/item	Action Withdraw Bank Item
MyCharactersApi	getAllCharactersLogsMyLogsGet	GET /my/logs	Get All Characters Logs
MyCharactersApi	getCharacterLogsMyLogsNameGet	GET /my/logs/{name}	Get Character Logs
MyCharactersApi	getMyCharactersMyCharactersGet	GET /my/characters	Get My Characters
NPCsApi	getAllNpcsItemsNpcsItemsGet	GET /npcs/items	Get All Npcs Items
NPCsApi	getAllNpcsNpcsDetailsGet	GET /npcs/details	Get All Npcs
NPCsApi	getNpcItemsNpcsItemsCodeGet	GET /npcs/items/{code}	Get Npc Items
NPCsApi	getNpcNpcsDetailsCodeGet	GET /npcs/details/{code}	Get Npc
ResourcesApi	getAllResourcesResourcesGet	GET /resources	Get All Resources
ResourcesApi	getResourceResourcesCodeGet	GET /resources/{code}	Get Resource
ServerDetailsApi	getServerDetailsGet	GET /	Get Server Details
SimulationApi	fightSimulationSimulationFightSimulationPost	POST /simulation/fight_simulation	Fight Simulation
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

Models

Authorization

JWTBearer

Type: Bearer authentication

HTTPBasic

Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

About this package

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

API version: 6.1.0
- Generator version: 7.18.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen

kehet / artifactsmmo-client

Maintainers

Details