@jellyfin/sdk 0.8.2 → 0.10.0

package/lib/generated-client/models/update-user-item-data-dto.d.ts

@@ -0,0 +1,83 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+/**
+ * This is used by the api to get information about a item user data.
+ * @export
+ * @interface UpdateUserItemDataDto
+ */
+export interface UpdateUserItemDataDto {
+    /**
+     * Gets or sets the rating.
+     * @type {number}
+     * @memberof UpdateUserItemDataDto
+     */
+    'Rating'?: number | null;
+    /**
+     * Gets or sets the played percentage.
+     * @type {number}
+     * @memberof UpdateUserItemDataDto
+     */
+    'PlayedPercentage'?: number | null;
+    /**
+     * Gets or sets the unplayed item count.
+     * @type {number}
+     * @memberof UpdateUserItemDataDto
+     */
+    'UnplayedItemCount'?: number | null;
+    /**
+     * Gets or sets the playback position ticks.
+     * @type {number}
+     * @memberof UpdateUserItemDataDto
+     */
+    'PlaybackPositionTicks'?: number | null;
+    /**
+     * Gets or sets the play count.
+     * @type {number}
+     * @memberof UpdateUserItemDataDto
+     */
+    'PlayCount'?: number | null;
+    /**
+     * Gets or sets a value indicating whether this instance is favorite.
+     * @type {boolean}
+     * @memberof UpdateUserItemDataDto
+     */
+    'IsFavorite'?: boolean | null;
+    /**
+     * Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UpdateUserItemDataDto is likes.
+     * @type {boolean}
+     * @memberof UpdateUserItemDataDto
+     */
+    'Likes'?: boolean | null;
+    /**
+     * Gets or sets the last played date.
+     * @type {string}
+     * @memberof UpdateUserItemDataDto
+     */
+    'LastPlayedDate'?: string | null;
+    /**
+     * Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is played.
+     * @type {boolean}
+     * @memberof UpdateUserItemDataDto
+     */
+    'Played'?: boolean | null;
+    /**
+     * Gets or sets the key.
+     * @type {string}
+     * @memberof UpdateUserItemDataDto
+     */
+    'Key'?: string | null;
+    /**
+     * Gets or sets the item identifier.
+     * @type {string}
+     * @memberof UpdateUserItemDataDto
+     */
+    'ItemId'?: string | null;
+}

package/lib/generated-client/models/upload-subtitle-dto.d.ts

@@ -32,6 +32,12 @@ export interface UploadSubtitleDto {
      * @memberof UploadSubtitleDto
      */
     'IsForced': boolean;
+    /**
+     * Gets or sets a value indicating whether the subtitle is for hearing impaired.
+     * @type {boolean}
+     * @memberof UploadSubtitleDto
+     */
+    'IsHearingImpaired': boolean;
     /**
      * Gets or sets the subtitle data.
      * @type {string}

package/lib/generated-client/models/user-configuration.d.ts

@@ -105,4 +105,10 @@ export interface UserConfiguration {
      * @memberof UserConfiguration
      */
     'EnableNextEpisodeAutoPlay'?: boolean;
+    /**
+     * Gets or sets the id of the selected cast receiver.
+     * @type {string}
+     * @memberof UserConfiguration
+     */
+    'CastReceiverId'?: string | null;
 }

package/lib/generated-client/models/user-data-change-info.d.ts

@@ -0,0 +1,30 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+import { UserItemDataDto } from './user-item-data-dto';
+/**
+ * Class UserDataChangeInfo.
+ * @export
+ * @interface UserDataChangeInfo
+ */
+export interface UserDataChangeInfo {
+    /**
+     * Gets or sets the user id.
+     * @type {string}
+     * @memberof UserDataChangeInfo
+     */
+    'UserId'?: string | null;
+    /**
+     * Gets or sets the user data list.
+     * @type {Array<UserItemDataDto>}
+     * @memberof UserDataChangeInfo
+     */
+    'UserDataList'?: Array<UserItemDataDto> | null;
+}

package/lib/generated-client/models/user-data-changed-message.d.ts

@@ -0,0 +1,37 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+import { SessionMessageType } from './session-message-type';
+import { UserDataChangeInfo } from './user-data-change-info';
+/**
+ * User data changed message.
+ * @export
+ * @interface UserDataChangedMessage
+ */
+export interface UserDataChangedMessage {
+    /**
+     *
+     * @type {UserDataChangeInfo}
+     * @memberof UserDataChangedMessage
+     */
+    'Data'?: UserDataChangeInfo;
+    /**
+     * Gets or sets the message id.
+     * @type {string}
+     * @memberof UserDataChangedMessage
+     */
+    'MessageId'?: string;
+    /**
+     *
+     * @type {SessionMessageType}
+     * @memberof UserDataChangedMessage
+     */
+    'MessageType'?: SessionMessageType;
+}

package/lib/generated-client/models/user-deleted-message.d.ts

@@ -0,0 +1,36 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+import { SessionMessageType } from './session-message-type';
+/**
+ * User deleted message.
+ * @export
+ * @interface UserDeletedMessage
+ */
+export interface UserDeletedMessage {
+    /**
+     * Gets or sets the data.
+     * @type {string}
+     * @memberof UserDeletedMessage
+     */
+    'Data'?: string;
+    /**
+     * Gets or sets the message id.
+     * @type {string}
+     * @memberof UserDeletedMessage
+     */
+    'MessageId'?: string;
+    /**
+     *
+     * @type {SessionMessageType}
+     * @memberof UserDeletedMessage
+     */
+    'MessageType'?: SessionMessageType;
+}

package/lib/generated-client/models/user-dto.d.ts

@@ -62,6 +62,7 @@ export interface UserDto {
      * Gets or sets a value indicating whether this instance has configured easy password.
      * @type {boolean}
      * @memberof UserDto
+     * @deprecated
      */
     'HasConfiguredEasyPassword'?: boolean;
     /**

package/lib/generated-client/models/user-policy.d.ts

@@ -29,6 +29,24 @@ export interface UserPolicy {
      * @memberof UserPolicy
      */
     'IsHidden'?: boolean;
+    /**
+     * Gets or sets a value indicating whether this instance can manage collections.
+     * @type {boolean}
+     * @memberof UserPolicy
+     */
+    'EnableCollectionManagement'?: boolean;
+    /**
+     * Gets or sets a value indicating whether this instance can manage subtitles.
+     * @type {boolean}
+     * @memberof UserPolicy
+     */
+    'EnableSubtitleManagement'?: boolean;
+    /**
+     * Gets or sets a value indicating whether this user can manage lyrics.
+     * @type {boolean}
+     * @memberof UserPolicy
+     */
+    'EnableLyricManagement'?: boolean;
     /**
      * Gets or sets a value indicating whether this instance is disabled.
      * @type {boolean}
@@ -47,6 +65,12 @@ export interface UserPolicy {
      * @memberof UserPolicy
      */
     'BlockedTags'?: Array<string> | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof UserPolicy
+     */
+    'AllowedTags'?: Array<string> | null;
     /**
      *
      * @type {boolean}
@@ -238,13 +262,13 @@ export interface UserPolicy {
      * @type {string}
      * @memberof UserPolicy
      */
-    'AuthenticationProviderId'?: string | null;
+    'AuthenticationProviderId': string;
     /**
      *
      * @type {string}
      * @memberof UserPolicy
      */
-    'PasswordResetProviderId'?: string | null;
+    'PasswordResetProviderId': string;
     /**
      *
      * @type {SyncPlayUserAccessType}

package/lib/generated-client/models/user-updated-message.d.ts

@@ -0,0 +1,37 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+import { SessionMessageType } from './session-message-type';
+import { UserDto } from './user-dto';
+/**
+ * User updated message.
+ * @export
+ * @interface UserUpdatedMessage
+ */
+export interface UserUpdatedMessage {
+    /**
+     *
+     * @type {UserDto}
+     * @memberof UserUpdatedMessage
+     */
+    'Data'?: UserDto;
+    /**
+     * Gets or sets the message id.
+     * @type {string}
+     * @memberof UserUpdatedMessage
+     */
+    'MessageId'?: string;
+    /**
+     *
+     * @type {SessionMessageType}
+     * @memberof UserUpdatedMessage
+     */
+    'MessageType'?: SessionMessageType;
+}

package/lib/generated-client/models/video-range-type.d.ts

@@ -0,0 +1,27 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+/**
+ * An enum representing types of video ranges.
+ * @export
+ * @enum {string}
+ */
+export declare const VideoRangeType: {
+    readonly Unknown: "Unknown";
+    readonly Sdr: "SDR";
+    readonly Hdr10: "HDR10";
+    readonly Hlg: "HLG";
+    readonly Dovi: "DOVI";
+    readonly DoviWithHdr10: "DOVIWithHDR10";
+    readonly DoviWithHlg: "DOVIWithHLG";
+    readonly DoviWithSdr: "DOVIWithSDR";
+    readonly Hdr10Plus: "HDR10Plus";
+};
+export type VideoRangeType = typeof VideoRangeType[keyof typeof VideoRangeType];

package/lib/generated-client/models/video-range-type.js

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+/**
+ * An enum representing types of video ranges.
+ * @export
+ * @enum {string}
+ */
+const VideoRangeType = {
+    Unknown: 'Unknown',
+    Sdr: 'SDR',
+    Hdr10: 'HDR10',
+    Hlg: 'HLG',
+    Dovi: 'DOVI',
+    DoviWithHdr10: 'DOVIWithHDR10',
+    DoviWithHlg: 'DOVIWithHLG',
+    DoviWithSdr: 'DOVIWithSDR',
+    Hdr10Plus: 'HDR10Plus'
+};
+
+export { VideoRangeType };

package/lib/generated-client/models/video-range.d.ts

@@ -0,0 +1,21 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+/**
+ * An enum representing video ranges.
+ * @export
+ * @enum {string}
+ */
+export declare const VideoRange: {
+    readonly Unknown: "Unknown";
+    readonly Sdr: "SDR";
+    readonly Hdr: "HDR";
+};
+export type VideoRange = typeof VideoRange[keyof typeof VideoRange];

package/lib/generated-client/models/{device-profile-type.js → video-range.js}

@@ -11,13 +11,14 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 /**
- *
+ * An enum representing video ranges.
  * @export
  * @enum {string}
  */
-const DeviceProfileType = {
-    System: 'System',
-    User: 'User'
+const VideoRange = {
+    Unknown: 'Unknown',
+    Sdr: 'SDR',
+    Hdr: 'HDR'
 };
 
-export { DeviceProfileType };
+export { VideoRange };

package/lib/generated-client/models/web-socket-message.d.ts

@@ -0,0 +1,18 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+import { InboundWebSocketMessage } from './inbound-web-socket-message';
+import { OutboundWebSocketMessage } from './outbound-web-socket-message';
+/**
+ * @type WebSocketMessage
+ * Represents the possible websocket types
+ * @export
+ */
+export type WebSocketMessage = InboundWebSocketMessage | OutboundWebSocketMessage;

package/lib/utils/api/image-api.d.ts

@@ -4,5 +4,5 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 import type { Api } from '../../api';
-import { ImageApi } from '../../generated-client/api/image-api';
-export declare function getImageApi(api: Api): ImageApi;
+import { ImageUrlsApi } from './image-urls-api';
+export declare function getImageApi(api: Api): ImageUrlsApi;

package/lib/utils/api/image-api.js

@@ -1,4 +1,4 @@
-import { ImageApi } from '../../generated-client/api/image-api.js';
+import { ImageUrlsApi } from './image-urls-api.js';
 
 /**
  * This Source Code Form is subject to the terms of the Mozilla Public
@@ -6,7 +6,7 @@ import { ImageApi } from '../../generated-client/api/image-api.js';
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 function getImageApi(api) {
-    return new ImageApi(api.configuration, undefined, api.axiosInstance);
+    return new ImageUrlsApi(api.configuration, undefined, api.axiosInstance);
 }
 
 export { getImageApi };

package/lib/utils/api/image-urls-api.d.ts

@@ -0,0 +1,55 @@
+/**
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+import type { ImageApiGetSplashscreenRequest } from '../../generated-client/api/image-api';
+import { ImageApi } from '../../generated-client/api/image-api';
+import type { BaseItemDto } from '../../generated-client/models/base-item-dto';
+import { ImageType } from '../../generated-client/models/image-type';
+import type { UserDto } from '../../generated-client/models/user-dto';
+import type { ImageRequestParameters } from '../../models/api/image-request-parameters';
+/**
+ * ImageUrlsApi - ImageApi with URL utility methods
+ * @export
+ * @class ImageUrlsApi
+ * @extends {ImageApi}
+ */
+export declare class ImageUrlsApi extends ImageApi {
+    /**
+     * Get an Item image URL for a given Item ID.
+     * @param itemId The Item ID.
+     * @param [imageType=ImageType.Primary] An optional Image Type.
+     * @param [params={}] Additional request parameters.
+     * @returns The image URL.
+     */
+    getItemImageUrlById(itemId: string, imageType?: ImageType, params?: ImageRequestParameters): string;
+    /**
+     * Get an Item image URL with automatic `tag` param handling.
+     * @param item The Item.
+     * @param [imageType] An optional Image Type (Primary by default).
+     * @param [params={}] Additional request parameters.
+     * @returns The Item image URL.
+     */
+    getItemImageUrl(item?: BaseItemDto, imageType?: ImageType, params?: ImageRequestParameters): string | undefined;
+    /**
+     * Get an Item's backdrop image URLs.
+     * @param item The Item.
+     * @param [params={}] Additional request parameters.
+     * @returns An array of backdrop image URLs.
+     */
+    getItemBackdropImageUrls(item?: BaseItemDto, params?: ImageRequestParameters): string[];
+    /**
+     * Get the splash screen image URL.
+     * @param [params={}] Additional request parameters.
+     * @returns The splash screen image URL.
+     */
+    getSplashscreenImageUrl(params?: ImageApiGetSplashscreenRequest): string;
+    /**
+     * Get a User's primary image URL.
+     * @param user The User.
+     * @param [params={}] Additional request parameters.
+     * @returns The User's primary image URL.
+     */
+    getUserImageUrl(user?: UserDto, params?: ImageRequestParameters): string | undefined;
+}

package/lib/utils/api/image-urls-api.js

@@ -0,0 +1,115 @@
+import { ImageApi } from '../../generated-client/api/image-api.js';
+import { ImageType } from '../../generated-client/models/image-type.js';
+
+/**
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+/**
+ * ImageUrlsApi - ImageApi with URL utility methods
+ * @export
+ * @class ImageUrlsApi
+ * @extends {ImageApi}
+ */
+class ImageUrlsApi extends ImageApi {
+    /**
+     * Get an Item image URL for a given Item ID.
+     * @param itemId The Item ID.
+     * @param [imageType=ImageType.Primary] An optional Image Type.
+     * @param [params={}] Additional request parameters.
+     * @returns The image URL.
+     */
+    getItemImageUrlById(itemId, imageType = ImageType.Primary, params = {}) {
+        var _a;
+        // TODO: We could probably use ImageApiAxiosParamCreator to make this more robust
+        return this.axios.getUri({
+            baseURL: (_a = this.configuration) === null || _a === void 0 ? void 0 : _a.basePath,
+            url: `/Items/${itemId}/Images/${imageType}`,
+            params
+        });
+    }
+    /**
+     * Get an Item image URL with automatic `tag` param handling.
+     * @param item The Item.
+     * @param [imageType] An optional Image Type (Primary by default).
+     * @param [params={}] Additional request parameters.
+     * @returns The Item image URL.
+     */
+    getItemImageUrl(item, imageType = ImageType.Primary, params = {}) {
+        var _a, _b;
+        if (!(item === null || item === void 0 ? void 0 : item.Id))
+            return;
+        return this.getItemImageUrlById(item.Id, imageType, {
+            ...params,
+            tag: (_a = params.tag) !== null && _a !== void 0 ? _a : (_b = item.ImageTags) === null || _b === void 0 ? void 0 : _b[imageType]
+        });
+    }
+    /**
+     * Get an Item's backdrop image URLs.
+     * @param item The Item.
+     * @param [params={}] Additional request parameters.
+     * @returns An array of backdrop image URLs.
+     */
+    getItemBackdropImageUrls(item, params = {}) {
+        var _a, _b;
+        const urls = [];
+        const id = item === null || item === void 0 ? void 0 : item.Id;
+        if (!id)
+            return urls;
+        (_a = item.BackdropImageTags) === null || _a === void 0 ? void 0 : _a.forEach(tag => {
+            const url = this.getItemImageUrlById(id, ImageType.Backdrop, {
+                ...params,
+                tag
+            });
+            urls.push(url);
+        });
+        if (urls.length > 0)
+            return urls;
+        const parentId = item.ParentBackdropItemId;
+        if (parentId) {
+            (_b = item.ParentBackdropImageTags) === null || _b === void 0 ? void 0 : _b.forEach(tag => {
+                const url = this.getItemImageUrlById(parentId, ImageType.Backdrop, {
+                    ...params,
+                    tag
+                });
+                urls.push(url);
+            });
+        }
+        return urls;
+    }
+    /**
+     * Get the splash screen image URL.
+     * @param [params={}] Additional request parameters.
+     * @returns The splash screen image URL.
+     */
+    getSplashscreenImageUrl(params = {}) {
+        var _a;
+        return this.axios.getUri({
+            baseURL: (_a = this.configuration) === null || _a === void 0 ? void 0 : _a.basePath,
+            url: '/Branding/Splashscreen',
+            params
+        });
+    }
+    /**
+     * Get a User's primary image URL.
+     * @param user The User.
+     * @param [params={}] Additional request parameters.
+     * @returns The User's primary image URL.
+     */
+    getUserImageUrl(user, params = {}) {
+        var _a;
+        if (!(user === null || user === void 0 ? void 0 : user.Id))
+            return;
+        return this.axios.getUri({
+            baseURL: (_a = this.configuration) === null || _a === void 0 ? void 0 : _a.basePath,
+            url: `/Users/${user.Id}/Images/Primary`,
+            params: {
+                ...params,
+                tag: user.PrimaryImageTag
+            }
+        });
+    }
+}
+
+export { ImageUrlsApi };

package/lib/utils/api/index.d.ts

@@ -15,15 +15,12 @@ export * from './configuration-api';
 export * from './dashboard-api';
 export * from './devices-api';
 export * from './display-preferences-api';
-export * from './dlna-api';
-export * from './dlna-server-api';
 export * from './dynamic-hls-api';
 export * from './environment-api';
 export * from './filter-api';
 export * from './genres-api';
 export * from './hls-segment-api';
 export * from './image-api';
-export * from './image-by-name-api';
 export * from './instant-mix-api';
 export * from './item-lookup-api';
 export * from './item-refresh-api';
@@ -33,10 +30,10 @@ export * from './library-api';
 export * from './library-structure-api';
 export * from './live-tv-api';
 export * from './localization-api';
+export * from './lyrics-api';
 export * from './media-info-api';
 export * from './movies-api';
 export * from './music-genres-api';
-export * from './notifications-api';
 export * from './package-api';
 export * from './persons-api';
 export * from './playlists-api';
@@ -56,6 +53,7 @@ export * from './system-api';
 export * from './time-sync-api';
 export * from './tmdb-api';
 export * from './trailers-api';
+export * from './trickplay-api';
 export * from './tv-shows-api';
 export * from './universal-audio-api';
 export * from './user-api';