commonMain.org.jellyfin.sdk.api.operations.ScheduledTasksApi.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.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.delete
import org.jellyfin.sdk.api.client.extensions.post
import org.jellyfin.sdk.model.api.TaskInfo
import org.jellyfin.sdk.model.api.TaskTriggerInfo

public class ScheduledTasksApi(
	private val api: ApiClient,
) : Api {
	/**
	 * Get task by id.
	 *
	 * @param taskId Task Id.
	 */
	public suspend fun getTask(taskId: String): Response {
		val pathParameters = buildMap(1) {
			put("taskId", taskId)
		}
		val queryParameters = emptyMap()
		val data = null
		val response = api.`get`("/ScheduledTasks/{taskId}", pathParameters, queryParameters,
				data)
		return response
	}

	/**
	 * Get tasks.
	 *
	 * @param isHidden Optional filter tasks that are hidden, or not.
	 * @param isEnabled Optional filter tasks that are enabled, or not.
	 */
	public suspend fun getTasks(isHidden: Boolean? = null, isEnabled: Boolean? = null):
			Response> {
		val pathParameters = emptyMap()
		val queryParameters = buildMap(2) {
			put("isHidden", isHidden)
			put("isEnabled", isEnabled)
		}
		val data = null
		val response = api.`get`>("/ScheduledTasks", pathParameters, queryParameters, data)
		return response
	}

	/**
	 * Start specified task.
	 *
	 * @param taskId Task Id.
	 */
	public suspend fun startTask(taskId: String): Response {
		val pathParameters = buildMap(1) {
			put("taskId", taskId)
		}
		val queryParameters = emptyMap()
		val data = null
		val response = api.post("/ScheduledTasks/Running/{taskId}", pathParameters, queryParameters,
				data)
		return response
	}

	/**
	 * Stop specified task.
	 *
	 * @param taskId Task Id.
	 */
	public suspend fun stopTask(taskId: String): Response {
		val pathParameters = buildMap(1) {
			put("taskId", taskId)
		}
		val queryParameters = emptyMap()
		val data = null
		val response = api.delete("/ScheduledTasks/Running/{taskId}", pathParameters,
				queryParameters, data)
		return response
	}

	/**
	 * Update specified task triggers.
	 *
	 * @param taskId Task Id.
	 */
	public suspend fun updateTask(taskId: String, `data`: List): Response {
		val pathParameters = buildMap(1) {
			put("taskId", taskId)
		}
		val queryParameters = emptyMap()
		val response = api.post("/ScheduledTasks/{taskId}/Triggers", pathParameters,
				queryParameters, data)
		return response
	}
}