This version/update is titled v2.0.0, considering the amount of changes that were made to support the latest version of the API (6.0.1). A lot of new classes and functions were added, but there were also quite a few functions that were either removed entirely or altered, which will likely break any code that used this client previously.

Summary

• Updated schema for Artifacts API version 6.0.1.
• Created/modified API classes to accommodate API changes.
• Replaced deprecated packages.
• Updated eslint to 9.x.
• Updated package version to 2.0.0 to signify major breaking changes since the last version.

Client Changes

This will only be about changes that impact the use of this client.

Accounts

• Added accounts.forgotPassword() method.
• Added accounts.resetPassword() method.
• Added accounts.getAchievements() method.
• Added accounts.getCharacters() method.
• Added accounts.get() method.

Achievements (NEW!)

• Added achievements.getAll() method.
• Added achievements.get() method.

Badges (NEW!)

• Added badges.getAll() method.
• Added badges.get() method.

Characters

• Replaced characters.getAll() with characters.getActive() method.

Effects (NEW!)

• Added effects.getAll() method.
• Added effects.get() method.

Events

• Added events.getAllActive() method.
• Added events.spawn() method.

Grand Exchange

• Added grandExchange.getHistory() method.
• Changed grandExchange.getAll() method to get sell orders.
• Changed grandExchange.get() method to get a sell order based on its order ID.

Leaderboard

• Removed leaderboard.getAll() method.
• Added leaderboard.getCharacters() method.
• Added leaderboard.getAccounts() method.

Maps

• Removed maps.get() method.
• Added maps.getLayerMaps() method.
• Added maps.getByPosition() method.
• Added maps.getById() method.

My Account

• Added myAccount.getGrandExchangeSellOrders() method.
• Added myAccount.getGrandExchangeSellHistory() method.

My Characters

• Added myCharacters.transition() method.
• Added myCharacters.rest() method.
• Added myCharacters.useItem() method.
• Added optional body parameter to myCharacters.fight() method.
• Replaced myCharacters.depositBank() with myCharacters.depositBankItem() method.
• Replaced myCharacters.withdrawBank() with myCharacters.withdrawBankItem() method.
• Added myCharacters.buyNpcItem() method.
• Added myCharacters.sellNpcItem() method.
• Added myCharacters.createGrandExchangeSellOrder() method.
• Added myCharacters.cancelGrandExchangeSellOrder() method.
• Removed myCharacters.sellGrandExchangeItem() method.
• Added myCharacters.tradeTaskItem() method.
• Added myCharacters.giveGold() method.
• Added myCharacters.giveItems() method.
• Added myCharacters.changeSkin() method.
• Added myCharacters.getAllLogs() method.

NPCs (NEW!)

• Added npcs.getAll() method.
• Added npcs.get() method.
• Added npcs.getItems() method.
• Added npcs.getAllItems() method.

Simulation (NEW!)

• Added simulation.simulate() method.

Tasks (NEW!)

• Added tasks.getAll() method.
• Added tasks.get() method.
• Added tasks.getAllRewards() method.
• Added tasks.getReward() method.

Providing support for API Update 02/09/24
Supported version: 2.1

Changelog:

• Syncronized openapi schema.

Providing support for API Update 08/25/24 (season 2)
Supported version: 2.0

Changelog:

• Added leaderboard.getAll method.
• Replaced myAccount.getBankGold with myAccount.getBank method.
• Added myCharacters.cancelTask method.
• Added myCharacters.buyBankExpansion method.
• Syncronized openapi schema.

Providing support for API Update 08/08/24
Supported version: 1.6

Changelog:

• Syncronized openapi schema.

Providing support for API Update 08/05/24
Supported version: 1.5

Changelog:

• Added new method characters.delete().
• Syncronized openapi schema.

Providing support for API Update 08/04/24
Supported version: 1.4

Changelog:

• Syncronized openapi schema.

Changelog:

• Provided type bindings over generated openapi types. Refer to docs.
• Fixed maps.get() method structure.

Providing support for API Update 08/03/24

Changelog:

• Removed myCharacters.getCharacterLogs() method.
• Syncronized openapi schema.
  • Added started_at to cooldown schema.
  • Minor updates.

Changelog

• Fixed myCharacters.crafting() method. Missing body added

Supported API version: 1.3