commonMain.org.jellyfin.sdk.api.operations.EnvironmentApi.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.Deprecated
import kotlin.String
import kotlin.Unit
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.api.client.extensions.post
import org.jellyfin.sdk.model.api.DefaultDirectoryBrowserInfoDto
import org.jellyfin.sdk.model.api.FileSystemEntryInfo
import org.jellyfin.sdk.model.api.ValidatePathDto

public class EnvironmentApi(
	private val api: ApiClient,
) : Api {
	/**
	 * Get Default directory browser.
	 */
	public suspend fun getDefaultDirectoryBrowser(): Response {
		val pathParameters = emptyMap()
		val queryParameters = emptyMap()
		val data = null
		val response = api.`get`("/Environment/DefaultDirectoryBrowser",
				pathParameters, queryParameters, data)
		return response
	}

	/**
	 * Gets the contents of a given directory in the file system.
	 *
	 * @param path The path.
	 * @param includeFiles An optional filter to include or exclude files from the results. true/false.
	 * @param includeDirectories An optional filter to include or exclude folders from the results.
	 * true/false.
	 */
	public suspend fun getDirectoryContents(
		path: String,
		includeFiles: Boolean? = false,
		includeDirectories: Boolean? = false,
	): Response> {
		val pathParameters = emptyMap()
		val queryParameters = buildMap(3) {
			put("path", path)
			put("includeFiles", includeFiles)
			put("includeDirectories", includeDirectories)
		}
		val data = null
		val response = api.`get`>("/Environment/DirectoryContents",
				pathParameters, queryParameters, data)
		return response
	}

	/**
	 * Gets available drives from the server's file system.
	 */
	public suspend fun getDrives(): Response> {
		val pathParameters = emptyMap()
		val queryParameters = emptyMap()
		val data = null
		val response = api.`get`>("/Environment/Drives", pathParameters,
				queryParameters, data)
		return response
	}

	/**
	 * Gets network paths.
	 */
	@Deprecated("This member is deprecated and may be removed in the future")
	public suspend fun getNetworkShares(): Response> {
		val pathParameters = emptyMap()
		val queryParameters = emptyMap()
		val data = null
		val response = api.`get`>("/Environment/NetworkShares", pathParameters,
				queryParameters, data)
		return response
	}

	/**
	 * Gets the parent path of a given path.
	 *
	 * @param path The path.
	 */
	public suspend fun getParentPath(path: String): Response {
		val pathParameters = emptyMap()
		val queryParameters = buildMap(1) {
			put("path", path)
		}
		val data = null
		val response = api.`get`("/Environment/ParentPath", pathParameters, queryParameters, data)
		return response
	}

	/**
	 * Validates path.
	 */
	public suspend fun validatePath(`data`: ValidatePathDto): Response {
		val pathParameters = emptyMap()
		val queryParameters = emptyMap()
		val response = api.post("/Environment/ValidatePath", pathParameters, queryParameters, data)
		return response
	}
}