HyWrapper/com.joshy.hywrapper

Package-level declarations

Types

class DataNotPopulatedException(message: String) : HypixelException

Thrown when the requested data has not been populated yet (e.g bazaar, auctions) This does not seem to happen any more and is only a thing for new endpoints

HypixelClient

class HypixelClient(apiKey: String, httpClient: OkHttpClient = OkHttpClient(), baseUrl: String = "https://api.hypixel.net/v2", defaultCacheDurationMinutes: Int = 1, autoRetry: Boolean = false, maxRetries: Int = 3)

A client for interacting with the Hypixel API.

HypixelException

open class HypixelException(message: String, val code: Int? = null) : Exception

Base exception for all Hypixel API related errors.

InvalidApiKeyException

class InvalidApiKeyException(message: String) : HypixelException

Thrown when the provided API key is invalid

InvalidDataException

class InvalidDataException(message: String) : HypixelException

Thrown when the provided data is invalid.

MissingFieldException

class MissingFieldException(message: String) : HypixelException

Thrown when a required field is missing from the request.

RateLimitException

class RateLimitException(message: String, val isGlobal: Boolean = false, val retryAfter: Long? = null) : HypixelException

Thrown when the API rate limit has been exceeded.

ResourceNotFoundException

class ResourceNotFoundException(message: String) : HypixelException

Thrown when the requested resource was not found.