Class: ApiClient

Constructor

new ApiClient() → {ApiClient}

Source: source/api/ApiClient.bs, line 21

Returns:

Type:: ApiClient

Methods

AuthenticateByName(username, password) → {dynamic}

Authenticate user by username and password

Parameters:

Name	Type	Description
`username`	string	User's username
`password`	string	User's password

Source: source/api/ApiClient.bs, line 347

Returns:

API response with auth token or invalid on error

Type:: dynamic

AuthenticateWithQuickConnect(secret) → {dynamic}

Authenticate via Quick Connect

Parameters:

Name	Type	Description
`secret`	string	The Quick Connect secret

Source: source/api/ApiClient.bs, line 370

Returns:

API response or invalid on error

Type:: dynamic

ConnectQuickConnect(secret) → {dynamic}

Connect via Quick Connect

Parameters:

Name	Type	Description
`secret`	string	The Quick Connect secret

Source: source/api/ApiClient.bs, line 385

Returns:

API response or invalid on error

Type:: dynamic

DeleteItem(itemId) → {dynamic}

Delete an item

Parameters:

Name	Type	Description
`itemId`	string	The item ID to delete

Source: source/api/ApiClient.bs, line 282

Returns:

API response or invalid on error

Type:: dynamic

DeleteRating(itemId) → {dynamic}

Delete user rating

Parameters:

Name	Type	Description
`itemId`	string	The item ID

Source: source/api/ApiClient.bs, line 274

Returns:

API response or invalid on error

Type:: dynamic

GetAdditionalParts(itemId) → {dynamic}

Get additional parts for a video

Parameters:

Name	Type	Description
`itemId`	string	The video item ID

Source: source/api/ApiClient.bs, line 425

Returns:

API response or invalid on error

Type:: dynamic

GetAlbumArtists(paramsopt) → {dynamic}

Get all album artists with automatic image injection

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 146

Returns:

API response or invalid on error

Type:: dynamic

GetAlbumInstantMix(id, paramsopt) → {dynamic}

Get album instant mix

Parameters:

Name	Type	Attributes	Default	Description
`id`	string			Album ID
`params`	object	<optional>	{}	Optional query parameters

Source: source/api/ApiClient.bs, line 208

Returns:

API response or invalid on error

Type:: dynamic

GetArtistByName(name, paramsopt) → {dynamic}

Get artist by name

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			Artist name
`params`	object	<optional>	{}	Optional query parameters

Source: source/api/ApiClient.bs, line 130

Returns:

API response or invalid on error

Type:: dynamic

GetArtists(paramsopt) → {dynamic}

Get all artists with automatic image injection

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 138

Returns:

API response or invalid on error

Type:: dynamic

GetBrandingConfiguration() → {dynamic}

Get branding configuration

Source: source/api/ApiClient.bs, line 329

Returns:

API response or invalid on error

Type:: dynamic

GetByQuery(paramsopt) → {dynamic}

Get items by query (alternative endpoint)

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 441

Returns:

API response or invalid on error

Type:: dynamic

GetConfigurationByName(name) → {dynamic}

Get configuration by name

Parameters:

Name	Type	Description
`name`	string	Configuration name

Source: source/api/ApiClient.bs, line 322

Returns:

API response or invalid on error

Type:: dynamic

GetDisplayPreferences(id, paramsopt) → {dynamic}

Get display preferences

Parameters:

Name	Type	Attributes	Default	Description
`id`	string			Preference ID
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 338

Returns:

API response or invalid on error

Type:: dynamic

GetEpisodes(seriesId, paramsopt) → {dynamic}

Get episodes for a TV season with automatic image injection

Parameters:

Name	Type	Attributes	Default	Description
`seriesId`	string			The series ID
`params`	object	<optional>	{}	Optional query parameters (season number, etc.)

Source: source/api/ApiClient.bs, line 121

Returns:

API response or invalid on error

Type:: dynamic

GetFilters(paramsopt) → {dynamic}

Get filters

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 433

Returns:

API response or invalid on error

Type:: dynamic

GetGenres(paramsopt) → {dynamic}

Get genres

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 498

Returns:

API response or invalid on error

Type:: dynamic

GetImageURL(id, imageType, imageIndexopt, paramsopt) → {dynamic}

Get image URL

Parameters:

Name	Type	Attributes	Default	Description
`id`	string			Item ID
`imageType`	string			Type of image
`imageIndex`	integer	<optional>	0	Image index
`params`	object	<optional>	{}	Optional parameters

Source: source/api/ApiClient.bs, line 463

Returns:

API response or invalid on error

Type:: dynamic

GetInstantMix(itemId, paramsopt) → {dynamic}

Get instant mix based on item

Parameters:

Name	Type	Attributes	Default	Description
`itemId`	string			The item ID
`params`	object	<optional>	{}	Optional query parameters

Source: source/api/ApiClient.bs, line 164

Returns:

API response or invalid on error

Type:: dynamic

GetIntros(itemId) → {dynamic}

Get intros for an item

Parameters:

Name	Type	Description
`itemId`	string	The item ID

Source: source/api/ApiClient.bs, line 172

Returns:

API response or invalid on error

Type:: dynamic

GetItem(itemId, paramsopt) → {dynamic}

Get a single item by ID with automatic image and version field injection

Parameters:

Name	Type	Attributes	Default	Description
`itemId`	string			The Jellyfin item ID
`params`	object	<optional>	{}	Optional query parameters (fields, etc.)

Source: source/api/ApiClient.bs, line 54

Returns:

API response or invalid on error

Type:: dynamic

GetItemRaw(itemId, paramsopt) → {dynamic}

Get item without image parameters - use for playback info only

Parameters:

Name	Type	Attributes	Default	Description
`itemId`	string			The Jellyfin item ID
`params`	object	<optional>	{}	Query parameters (passed through as-is)

Source: source/api/ApiClient.bs, line 95

Returns:

API response or invalid on error

Type:: dynamic

GetItemsByQuery(paramsopt) → {dynamic}

Get items by query with automatic image and version field injection

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters (limit, sortBy, filters, etc.)

Source: source/api/ApiClient.bs, line 62

Returns:

API response or invalid on error

Type:: dynamic

GetItemsByQueryRaw(paramsopt) → {dynamic}

Get items by query without image parameters

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters (passed through as-is)

Source: source/api/ApiClient.bs, line 103

Returns:

API response or invalid on error

Type:: dynamic

GetLatestMedia(paramsopt) → {dynamic}

Get latest media with automatic image injection

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Optional query parameters

Source: source/api/ApiClient.bs, line 86

Returns:

API response or invalid on error

Type:: dynamic

GetLiveTVChannels(paramsopt) → {dynamic}

Get Live TV channels

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 482

Returns:

API response or invalid on error

Type:: dynamic

GetLocalTrailers(itemId) → {dynamic}

Get local trailers for an item

Parameters:

Name	Type	Description
`itemId`	string	The item ID

Source: source/api/ApiClient.bs, line 216

Returns:

API response or invalid on error

Type:: dynamic

GetNextUp(paramsopt) → {dynamic}

Get next up episodes with automatic image injection

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 400

Returns:

API response or invalid on error

Type:: dynamic

GetPlaylistItems(playlistId, paramsopt) → {dynamic}

Get playlist items

Parameters:

Name	Type	Attributes	Default	Description
`playlistId`	string			The playlist ID
`params`	object	<optional>	{}	Optional query parameters

Source: source/api/ApiClient.bs, line 155

Returns:

API response or invalid on error

Type:: dynamic

GetPublicUsers() → {dynamic}

Get public users

Source: source/api/ApiClient.bs, line 362

Returns:

API response or invalid on error

Type:: dynamic

GetResumeItems(paramsopt) → {dynamic}

Get resume items (Continue Watching) with automatic image injection

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Optional query parameters

Source: source/api/ApiClient.bs, line 70

Returns:

API response or invalid on error

Type:: dynamic

GetSeasons(seriesId, paramsopt) → {dynamic}

Get seasons for a TV series with automatic image injection

Parameters:

Name	Type	Attributes	Default	Description
`seriesId`	string			The series ID
`params`	object	<optional>	{}	Optional query parameters

Source: source/api/ApiClient.bs, line 112

Returns:

API response or invalid on error

Type:: dynamic

GetSessions(paramsopt) → {dynamic}

Get active sessions

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 314

Returns:

API response or invalid on error

Type:: dynamic

GetSimilarAlbums(id, paramsopt) → {dynamic}

Get similar albums

Parameters:

Name	Type	Attributes	Default	Description
`id`	string			Album ID
`params`	object	<optional>	{}	Optional query parameters

Source: source/api/ApiClient.bs, line 199

Returns:

API response or invalid on error

Type:: dynamic

GetSimilarArtists(id, paramsopt) → {dynamic}

Get similar artists

Parameters:

Name	Type	Attributes	Default	Description
`id`	string			Artist ID
`params`	object	<optional>	{}	Optional query parameters

Source: source/api/ApiClient.bs, line 190

Returns:

API response or invalid on error

Type:: dynamic

GetSimilarShows(id, paramsopt) → {dynamic}

Get similar shows with automatic image injection

Parameters:

Name	Type	Attributes	Default	Description
`id`	string			Show ID
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 417

Returns:

API response or invalid on error

Type:: dynamic

GetSpecialFeatures(itemId) → {dynamic}

Get special features for an item

Parameters:

Name	Type	Description
`itemId`	string	The item ID

Source: source/api/ApiClient.bs, line 224

Returns:

API response or invalid on error

Type:: dynamic

GetStudios(paramsopt) → {dynamic}

Get studios

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 490

Returns:

API response or invalid on error

Type:: dynamic

GetSuggestions(paramsopt) → {dynamic}

Get suggestions with automatic image injection

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Optional query parameters

Source: source/api/ApiClient.bs, line 78

Returns:

API response or invalid on error

Type:: dynamic

GetUpcoming(paramsopt) → {dynamic}

Get upcoming episodes with automatic image injection

Parameters:

Name	Type	Attributes	Default	Description
`params`	object	<optional>	{}	Query parameters

Source: source/api/ApiClient.bs, line 408

Returns:

API response or invalid on error

Type:: dynamic

GetUser(userId) → {dynamic}

Get user by ID

Parameters:

Name	Type	Description
`userId`	string	The user ID

Source: source/api/ApiClient.bs, line 355

Returns:

API response or invalid on error

Type:: dynamic

GetUserImageURL(id, imageType, imageIndexopt, paramsopt) → {dynamic}

Get user image URL

Parameters:

Name	Type	Attributes	Default	Description
`id`	string			User ID
`imageType`	string			Type of image
`imageIndex`	integer	<optional>	0	Image index
`params`	object	<optional>	{}	Optional parameters

Source: source/api/ApiClient.bs, line 474

Returns:

API response or invalid on error

Type:: dynamic

GetViews() → {dynamic}

Get user views

Source: source/api/ApiClient.bs, line 392

Returns:

API response or invalid on error

Type:: dynamic

HeadImageURLByName(id, imageType, imageIndexopt, paramsopt) → {dynamic}

Get image URL for an item by ID (HEAD request helper)

Parameters:

Name	Type	Attributes	Default	Description
`id`	string			Item ID
`imageType`	string			Type of image
`imageIndex`	integer	<optional>	0	Image index (default 0)
`params`	object	<optional>	{}	Optional parameters

Source: source/api/ApiClient.bs, line 452

Returns:

API response or invalid on error

Type:: dynamic

InitiateQuickConnect() → {dynamic}

Initiate Quick Connect

Source: source/api/ApiClient.bs, line 377

Returns:

API response with secret or invalid on error

Type:: dynamic

MarkFavorite(itemId) → {dynamic}

Mark item as favorite

Parameters:

Name	Type	Description
`itemId`	string	The item ID

Source: source/api/ApiClient.bs, line 232

Returns:

API response or invalid on error

Type:: dynamic

MarkPlayed(itemId, paramsopt) → {dynamic}

Mark item as played

Parameters:

Name	Type	Attributes	Default	Description
`itemId`	string			The item ID
`params`	object	<optional>	{}	Optional parameters (DatePlayed, etc.)

Source: source/api/ApiClient.bs, line 249

Returns:

API response or invalid on error

Type:: dynamic

Playing(params) → {dynamic}

Report playback started

Parameters:

Name	Type	Description
`params`	object	Playback parameters

Source: source/api/ApiClient.bs, line 290

Returns:

API response or invalid on error

Type:: dynamic

PostPlaybackInfo(itemId, postData) → {dynamic}

Post playback info (used for starting playback)

Parameters:

Name	Type	Description
`itemId`	string	The item ID
`postData`	object	Request body data

Source: source/api/ApiClient.bs, line 181

Returns:

API response or invalid on error

Type:: dynamic

PostProgress(params) → {dynamic}

Report playback progress

Parameters:

Name	Type	Description
`params`	object	Playback parameters

Source: source/api/ApiClient.bs, line 306

Returns:

API response or invalid on error

Type:: dynamic

PostStopped(params) → {dynamic}

Report playback stopped

Parameters:

Name	Type	Description
`params`	object	Playback parameters

Source: source/api/ApiClient.bs, line 298

Returns:

API response or invalid on error

Type:: dynamic

UnmarkFavorite(itemId) → {dynamic}

Unmark item as favorite

Parameters:

Name	Type	Description
`itemId`	string	The item ID

Source: source/api/ApiClient.bs, line 240

Returns:

API response or invalid on error

Type:: dynamic

UnmarkPlayed(itemId) → {dynamic}

Mark item as unplayed

Parameters:

Name	Type	Description
`itemId`	string	The item ID

Source: source/api/ApiClient.bs, line 257

Returns:

API response or invalid on error

Type:: dynamic

UpdateRating(itemId, paramsopt) → {dynamic}

Update user rating

Parameters:

Name	Type	Attributes	Default	Description
`itemId`	string			The item ID
`params`	object	<optional>	{}	Rating parameters

Source: source/api/ApiClient.bs, line 266

Returns:

API response or invalid on error

Type:: dynamic