commonMain.org.jellyfin.sdk.api.operations.ImageByNameApi.kt Maven / Gradle / Ivy

Go to download
// !!        WARNING
// !! DO NOT EDIT THIS FILE
//
// This file is generated by the openapi-generator module and is not meant for manual changes.
// Please read the README.md file in the openapi-generator module for additional information.
package org.jellyfin.sdk.api.operations

import io.ktor.utils.io.ByteReadChannel
import kotlin.Any
import kotlin.Boolean
import kotlin.String
import kotlin.collections.List
import kotlin.collections.buildMap
import kotlin.collections.emptyMap
import org.jellyfin.sdk.api.client.ApiClient
import org.jellyfin.sdk.api.client.Response
import org.jellyfin.sdk.api.client.extensions.`get`
import org.jellyfin.sdk.model.api.ImageByNameInfo

public class ImageByNameApi(
	private val api: ApiClient,
) : Api {
	/**
	 * Get General Image.
	 *
	 * @param name The name of the image.
	 * @param type Image Type (primary, backdrop, logo, etc).
	 */
	public suspend fun getGeneralImage(name: String, type: String): Response {
		val pathParameters = buildMap(2) {
			put("name", name)
			put("type", type)
		}
		val queryParameters = emptyMap()
		val data = null
		val response = api.`get`("/Images/General/{name}/{type}", pathParameters,
				queryParameters, data)
		return response
	}

	/**
	 * Get General Image.
	 *
	 * @param name The name of the image.
	 * @param type Image Type (primary, backdrop, logo, etc).
	 * @param includeCredentials Add the access token to the url to make an authenticated request.
	 */
	public fun getGeneralImageUrl(
		name: String,
		type: String,
		includeCredentials: Boolean = false,
	): String {
		val pathParameters = buildMap(2) {
			put("name", name)
			put("type", type)
		}
		val queryParameters = emptyMap()
		return api.createUrl("/Images/General/{name}/{type}", pathParameters, queryParameters,
				includeCredentials)
	}

	/**
	 * Get all general images.
	 */
	public suspend fun getGeneralImages(): Response> {
		val pathParameters = emptyMap()
		val queryParameters = emptyMap()
		val data = null
		val response = api.`get`>("/Images/General", pathParameters,
				queryParameters, data)
		return response
	}

	/**
	 * Get media info image.
	 *
	 * @param theme The theme to get the image from.
	 * @param name The name of the image.
	 */
	public suspend fun getMediaInfoImage(theme: String, name: String): Response {
		val pathParameters = buildMap(2) {
			put("theme", theme)
			put("name", name)
		}
		val queryParameters = emptyMap()
		val data = null
		val response = api.`get`("/Images/MediaInfo/{theme}/{name}", pathParameters,
				queryParameters, data)
		return response
	}

	/**
	 * Get media info image.
	 *
	 * @param theme The theme to get the image from.
	 * @param name The name of the image.
	 * @param includeCredentials Add the access token to the url to make an authenticated request.
	 */
	public fun getMediaInfoImageUrl(
		theme: String,
		name: String,
		includeCredentials: Boolean = false,
	): String {
		val pathParameters = buildMap(2) {
			put("theme", theme)
			put("name", name)
		}
		val queryParameters = emptyMap()
		return api.createUrl("/Images/MediaInfo/{theme}/{name}", pathParameters, queryParameters,
				includeCredentials)
	}

	/**
	 * Get all media info images.
	 */
	public suspend fun getMediaInfoImages(): Response> {
		val pathParameters = emptyMap()
		val queryParameters = emptyMap()
		val data = null
		val response = api.`get`>("/Images/MediaInfo", pathParameters,
				queryParameters, data)
		return response
	}

	/**
	 * Get rating image.
	 *
	 * @param theme The theme to get the image from.
	 * @param name The name of the image.
	 */
	public suspend fun getRatingImage(theme: String, name: String): Response {
		val pathParameters = buildMap(2) {
			put("theme", theme)
			put("name", name)
		}
		val queryParameters = emptyMap()
		val data = null
		val response = api.`get`("/Images/Ratings/{theme}/{name}", pathParameters,
				queryParameters, data)
		return response
	}

	/**
	 * Get rating image.
	 *
	 * @param theme The theme to get the image from.
	 * @param name The name of the image.
	 * @param includeCredentials Add the access token to the url to make an authenticated request.
	 */
	public fun getRatingImageUrl(
		theme: String,
		name: String,
		includeCredentials: Boolean = false,
	): String {
		val pathParameters = buildMap(2) {
			put("theme", theme)
			put("name", name)
		}
		val queryParameters = emptyMap()
		return api.createUrl("/Images/Ratings/{theme}/{name}", pathParameters, queryParameters,
				includeCredentials)
	}

	/**
	 * Get all general images.
	 */
	public suspend fun getRatingImages(): Response> {
		val pathParameters = emptyMap()
		val queryParameters = emptyMap()
		val data = null
		val response = api.`get`>("/Images/Ratings", pathParameters,
				queryParameters, data)
		return response
	}
}