This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
To build and compile the typescript sources to javascript use:
npm install
npm run build
First build the package then run npm publish
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install [email protected] --save
unPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --save
All URIs are relative to https://api.dofusdu.de
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AlmanaxApi | getAlmanaxDate | GET /dofus3/v1/{language}/almanax/{date} | Single Almanax Date |
| AlmanaxApi | getAlmanaxRange | GET /dofus3/v1/{language}/almanax | Almanax Range |
| ConsumablesApi | getAllItemsConsumablesList | GET /{game}/v1/{language}/items/consumables/all | List All Consumables |
| ConsumablesApi | getItemsConsumablesList | GET /{game}/v1/{language}/items/consumables | List Consumables |
| ConsumablesApi | getItemsConsumablesSearch | GET /{game}/v1/{language}/items/consumables/search | Search Consumables |
| ConsumablesApi | getItemsConsumablesSingle | GET /{game}/v1/{language}/items/consumables/{ankama_id} | Single Consumables |
| CosmeticsApi | getAllCosmeticsList | GET /{game}/v1/{language}/items/cosmetics/all | List All Cosmetics |
| CosmeticsApi | getCosmeticsList | GET /{game}/v1/{language}/items/cosmetics | List Cosmetics |
| CosmeticsApi | getCosmeticsSearch | GET /{game}/v1/{language}/items/cosmetics/search | Search Cosmetics |
| CosmeticsApi | getCosmeticsSingle | GET /{game}/v1/{language}/items/cosmetics/{ankama_id} | Single Cosmetics |
| EquipmentApi | getAllItemsEquipmentList | GET /{game}/v1/{language}/items/equipment/all | List All Equipment |
| EquipmentApi | getItemsEquipmentList | GET /{game}/v1/{language}/items/equipment | List Equipment |
| EquipmentApi | getItemsEquipmentSearch | GET /{game}/v1/{language}/items/equipment/search | Search Equipment |
| EquipmentApi | getItemsEquipmentSingle | GET /{game}/v1/{language}/items/equipment/{ankama_id} | Single Equipment |
| GameApi | getGameSearch | GET /{game}/v1/{language}/search | Game Search |
| GameApi | getItemsAllSearch | GET /{game}/v1/{language}/items/search | Search All Items |
| MetaApi | getGameSearchTypes | GET /{game}/v1/meta/search/types | Available Game Search Types |
| MetaApi | getItemTypes | GET /{game}/v1/meta/items/types | Available Item Types |
| MetaApi | getMetaAlmanaxBonuses | GET /dofus3/v1/meta/{language}/almanax/bonuses | Available Almanax Bonuses |
| MetaApi | getMetaAlmanaxBonusesSearch | GET /dofus3/v1/meta/{language}/almanax/bonuses/search | Search Available Almanax Bonuses |
| MetaApi | getMetaElements | GET /{game}/v1/meta/elements | Effects and Condition Elements |
| MetaApi | getMetaVersion | GET /{game}/v1/meta/version | Game Version |
| MountsApi | getAllMountsList | GET /{game}/v1/{language}/mounts/all | List All Mounts |
| MountsApi | getMountsList | GET /{game}/v1/{language}/mounts | List Mounts |
| MountsApi | getMountsSearch | GET /{game}/v1/{language}/mounts/search | Search Mounts |
| MountsApi | getMountsSingle | GET /{game}/v1/{language}/mounts/{ankama_id} | Single Mounts |
| QuestItemsApi | getAllItemsQuestList | GET /{game}/v1/{language}/items/quest/all | List All Quest Items |
| QuestItemsApi | getItemQuestSingle | GET /{game}/v1/{language}/items/quest/{ankama_id} | Single Quest Items |
| QuestItemsApi | getItemsQuestList | GET /{game}/v1/{language}/items/quest | List Quest Items |
| QuestItemsApi | getItemsQuestSearch | GET /{game}/v1/{language}/items/quest/search | Search Quest Items |
| ResourcesApi | getAllItemsResourcesList | GET /{game}/v1/{language}/items/resources/all | List All Resources |
| ResourcesApi | getItemsResourceSearch | GET /{game}/v1/{language}/items/resources/search | Search Resources |
| ResourcesApi | getItemsResourcesList | GET /{game}/v1/{language}/items/resources | List Resources |
| ResourcesApi | getItemsResourcesSingle | GET /{game}/v1/{language}/items/resources/{ankama_id} | Single Resources |
| SetsApi | getAllSetsList | GET /{game}/v1/{language}/sets/all | List All Sets |
| SetsApi | getSetsList | GET /{game}/v1/{language}/sets | List Sets |
| SetsApi | getSetsSearch | GET /{game}/v1/{language}/sets/search | Search Sets |
| SetsApi | getSetsSingle | GET /{game}/v1/{language}/sets/{ankama_id} | Single Sets |
| WebhooksApi | deleteWebhooksAlmanaxId | DELETE /webhooks/almanax/{id} | Unregister Almanax Hook |
| WebhooksApi | deleteWebhooksRssId | DELETE /webhooks/rss/{id} | Unregister RSS Hook |
| WebhooksApi | deleteWebhooksTwitterId | DELETE /webhooks/twitter/{id} | Unregister Twitter Hook |
| WebhooksApi | getMetaWebhooksAlmanax | GET /meta/webhooks/almanax | Get Almanax Hook Metainfo |
| WebhooksApi | getMetaWebhooksRss | GET /meta/webhooks/rss | Get RSS Hook Metainfo |
| WebhooksApi | getMetaWebhooksTwitter | GET /meta/webhooks/twitter | Get Twitter Hook Metainfo |
| WebhooksApi | getWebhooksAlmanaxId | GET /webhooks/almanax/{id} | Get Almanax Hook |
| WebhooksApi | getWebhooksRssId | GET /webhooks/rss/{id} | Get RSS Hook |
| WebhooksApi | getWebhooksTwitterId | GET /webhooks/twitter/{id} | Get Twitter Hook |
| WebhooksApi | postWebhooksAlmanax | POST /webhooks/almanax | Register Almanax Hook |
| WebhooksApi | postWebhooksRss | POST /webhooks/rss | Register RSS Hook |
| WebhooksApi | postWebhooksTwitter | POST /webhooks/twitter | Register Twitter Hook |
| WebhooksApi | putWebhooksAlmanaxId | PUT /webhooks/almanax/{id} | Update Almanax Hook |
| WebhooksApi | putWebhooksRssId | PUT /webhooks/rss/{id} | Update RSS Hook |
| WebhooksApi | putWebhooksTwitterId | PUT /webhooks/twitter/{id} | Update Twitter Hook |
- Almanax
- AlmanaxBonus
- AlmanaxTribute
- AlmanaxTributeItem
- AlmanaxWebhook
- AlmanaxWebhookDailySettings
- Condition
- ConditionLeaf
- ConditionNode
- ConditionRelation
- CreateAlmanaxWebhook
- CreateAlmanaxWebhookDailySettings
- CreateAlmanaxWebhookMentionsValueInner
- CreateRSSWebhook
- CreateTwitterWebhook
- Effect
- EffectType
- Equipment
- EquipmentSet
- GameSearch
- GameSearchItem
- GameSearchType
- GetMetaAlmanaxBonuses200ResponseInner
- GetMetaWebhooksTwitter200Response
- Images
- ItemSubtype
- ListEquipmentSet
- ListEquipmentSets
- ListItem
- ListItemGeneral
- ListItems
- ListMounts
- ModelError
- Mount
- MountFamily
- PagedLinks
- PutAlmanaxWebhook
- PutRSSWebhook
- PutTwitterWebhook
- Range
- Recipe
- Resource
- RssWebhook
- TranslatedId
- TwitterWebhook
- Version
- Weapon
Endpoints do not require authorization.