io.github.kryszak.gwatlin.api.homeinstance.GWHomeInstanceClient.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gwatlin Show documentation

Guild Wars 2 API client

The newest version!

package io.github.kryszak.gwatlin.api.homeinstance

import io.github.kryszak.gwatlin.api.homeinstance.model.Cat
import io.github.kryszak.gwatlin.clients.homeinstance.HomeInstanceClient

/**
 * Client for home instance endpoints.
 * @see io.github.kryszak.gwatlin.api.exception.ApiRequestException for errors
 */
class GWHomeInstanceClient {

    private val homeInstanceClient: HomeInstanceClient = HomeInstanceClient()

    /**
     * Retrieves list of all cat ids
     * Documentation can be found in the [GW2 Wiki](https://wiki.guildwars2.com/wiki/API:2/home/cats)
     * @return list of cat ids
     */
    fun getCatIds(): List {
        return homeInstanceClient.getCatIds()
    }

    /**
     * Retrieves specific cat
     * Documentation can be found in the [GW2 Wiki](https://wiki.guildwars2.com/wiki/API:2/home/cats)
     * @param id of cat
     * @return Cat
     * @see io.github.kryszak.gwatlin.api.homeinstance.model.Cat
     */
    fun getCat(id: Int): Cat {
        return homeInstanceClient.getCat(id)
    }

    /**
     * Retrieves list of cats
     * Documentation can be found in the [GW2 Wiki](https://wiki.guildwars2.com/wiki/API:2/home/cats)
     * @param ids of cats
     * @return List of cats
     * @see io.github.kryszak.gwatlin.api.homeinstance.model.Cat
     */
    fun getCats(ids: List): List {
        return homeInstanceClient.getCats(ids)
    }

    /**
     * Retrieves list of all available home node instances
     * Documentation can be found in the [GW2 Wiki](https://wiki.guildwars2.com/wiki/API:2/home/nodes)
     * @return List of nodes
     */
    fun getNodeIds(): List {
        return homeInstanceClient.getNodesIds()
    }
}