umami-api/dev.appoutlet.umami.api/Links

Links

class Links(umami: Umami)

Provides functionalities for interacting with Links in the Umami API.

Parameters

umami

The Umami instance used for making HTTP requests.

Constructors

constructor(umami: Umami)

Types

@Serializable

data class LinkRequest(val name: String? = null, val url: String? = null, val slug: String? = null)

Functions

suspend fun createLink(name: String, url: String, slug: String): Link

Creates a new link.

suspend fun deleteLink(linkId: String)

Deletes a link from the Umami API.

suspend fun getLink(linkId: String): Link

Retrieves a single link from the Umami API by its ID.

suspend fun getLinks(search: String? = null, page: Int? = null, pageSize: Int? = null): SearchResponse<Link>

Retrieves a paginated list of links from the Umami API.

suspend fun updateLink(linkId: String, name: String? = null, url: String? = null, slug: String? = null): Link

Updates an existing link.