Kraken/duckpond.buriedincode/Metron

Metron

class Metron @JvmOverloads constructor(baseUrl: String = "https://metron.cloud/api", username: String, password: String, userAgent: String = "Kraken/", timeout: Duration = 30.seconds, maxRetries: Int = 5, cache: SQLiteCache, policy: CachePolicy? = CachePolicy(percent = 0.1, expiry = 14.days))

A client for interacting with the Metron API.

Parameters

baseUrl

The base url of the Metron API.

username

The username for authentication with the Metron API.

password

The password for authentication with the Metron API.

userAgent

The HTTP User-Agent sent with every request.

timeout

The maximum duration to wait for a HTTP request to complete before timing out.

maxRetries

The maximum number of retry attempts for requests that fail due to RateLimiting errors.

cache

A SQLiteCache instance for caching API responses.

policy

An optional CachePolicy that determines how long cached responses remain valid and when they should be refreshed. If null, cached responses are never marked stale.

Constructors

constructor(baseUrl: String = "https://metron.cloud/api", username: String, password: String, userAgent: String = "Kraken/", timeout: Duration = 30.seconds, maxRetries: Int = 5, cache: SQLiteCache, policy: CachePolicy? = CachePolicy(percent = 0.1, expiry = 14.days))

Types

object Companion

Functions

fun getArc(id: Long): Arc

Retrieves details of a specific Arc by its ID.

fun getCharacter(id: Long): Character

Retrieves details of a specific Character by its ID.

fun getCreator(id: Long): Creator

Retrieves details of a specific Creator by its ID.

fun getImprint(id: Long): Imprint

Retrieves details of a specific Imprint by its ID.

fun getIssue(id: Long): Issue

Retrieves details of a specific Issue by its ID.

fun getPublisher(id: Long): Publisher

Retrieves details of a specific Publisher by its ID.

fun getSeries(id: Long): Series

Retrieves details of a specific Series by its ID.

fun getTeam(id: Long): Team

Retrieves details of a specific Team by its ID.

fun getUniverse(id: Long): Universe

Retrieves details of a specific Universe by its ID.

fun listArcs(params: Map<String, String> = emptyMap()): List<BaseResource>

Retrieves a list of Arcs from the Metron API.

fun listCharacters(params: Map<String, String> = emptyMap()): List<BaseResource>

Retrieves a list of Characters from the Metron API.

fun listCreators(params: Map<String, String> = emptyMap()): List<BaseResource>

Retrieves a list of Creators from the Metron API.

fun listImprints(params: Map<String, String> = emptyMap()): List<BaseResource>

Retrieves a list of Imprints from the Metron API.

fun listIssues(params: Map<String, String> = emptyMap()): List<BasicIssue>

Retrieves a list of Issues from the Metron API.

fun listPublishers(params: Map<String, String> = emptyMap()): List<BaseResource>

Retrieves a list of Publishers from the Metron API.

fun listRoles(params: Map<String, String> = emptyMap()): List<GenericItem>

Retrieves a list of Roles from the Metron API.

fun listSeries(params: Map<String, String> = emptyMap()): List<BasicSeries>

Retrieves a list of Series from the Metron API.

listSeriesTypes

fun listSeriesTypes(params: Map<String, String> = emptyMap()): List<GenericItem>

Retrieves a list of SeriesTypes from the Metron API.

fun listTeams(params: Map<String, String> = emptyMap()): List<BaseResource>

Retrieves a list of Teams from the Metron API.

fun listUniverses(params: Map<String, String> = emptyMap()): List<BaseResource>

Retrieves a list of Universes from the Metron API.