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

Show more of this group Show more artifacts with this name
Show all versions of jellyfin-api-jvm Show documentation

Official Kotlin/Java SDK for Jellyfin. org.jellyfin.sdk:jellyfin-api-jvm

There is a newer version: 1.5.5

// !!        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 kotlin.Any
import kotlin.Boolean
import kotlin.String
import kotlin.collections.Collection
import kotlin.collections.List
import kotlin.collections.buildMap
import kotlin.collections.emptyList
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.UUID
import org.jellyfin.sdk.model.api.BaseItemDtoQueryResult
import org.jellyfin.sdk.model.api.CollectionType
import org.jellyfin.sdk.model.api.SpecialViewOptionDto

public class UserViewsApi(
	private val api: ApiClient,
) : Api {
	/**
	 * Get user view grouping options.
	 *
	 * @param userId User id.
	 */
	public suspend fun getGroupingOptions(userId: UUID? = null): Response> {
		val pathParameters = emptyMap()
		val queryParameters = buildMap(1) {
			put("userId", userId)
		}
		val data = null
		val response = api.`get`>("/UserViews/GroupingOptions", pathParameters,
				queryParameters, data)
		return response
	}

	/**
	 * Get user views.
	 *
	 * @param userId User id.
	 * @param includeExternalContent Whether or not to include external views such as channels or live
	 * tv.
	 * @param presetViews Preset views.
	 * @param includeHidden Whether or not to include hidden content.
	 */
	public suspend fun getUserViews(
		userId: UUID? = null,
		includeExternalContent: Boolean? = null,
		presetViews: Collection? = emptyList(),
		includeHidden: Boolean? = false,
	): Response {
		val pathParameters = emptyMap()
		val queryParameters = buildMap(4) {
			put("userId", userId)
			put("includeExternalContent", includeExternalContent)
			put("presetViews", presetViews)
			put("includeHidden", includeHidden)
		}
		val data = null
		val response = api.`get`("/UserViews", pathParameters, queryParameters,
				data)
		return response
	}
}