@jellyfin/sdk 0.8.2 → 0.10.0

package/lib/generated-client/models/play-queue-update.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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 { GroupRepeatMode } from './group-repeat-mode';
+import { GroupShuffleMode } from './group-shuffle-mode';
+import { PlayQueueUpdateReason } from './play-queue-update-reason';
+import { SyncPlayQueueItem } from './sync-play-queue-item';
+/**
+ * Class PlayQueueUpdate.
+ * @export
+ * @interface PlayQueueUpdate
+ */
+export interface PlayQueueUpdate {
+    /**
+     *
+     * @type {PlayQueueUpdateReason}
+     * @memberof PlayQueueUpdate
+     */
+    'Reason'?: PlayQueueUpdateReason;
+    /**
+     * Gets the UTC time of the last change to the playing queue.
+     * @type {string}
+     * @memberof PlayQueueUpdate
+     */
+    'LastUpdate'?: string;
+    /**
+     * Gets the playlist.
+     * @type {Array<SyncPlayQueueItem>}
+     * @memberof PlayQueueUpdate
+     */
+    'Playlist'?: Array<SyncPlayQueueItem>;
+    /**
+     * Gets the playing item index in the playlist.
+     * @type {number}
+     * @memberof PlayQueueUpdate
+     */
+    'PlayingItemIndex'?: number;
+    /**
+     * Gets the start position ticks.
+     * @type {number}
+     * @memberof PlayQueueUpdate
+     */
+    'StartPositionTicks'?: number;
+    /**
+     * Gets a value indicating whether the current item is playing.
+     * @type {boolean}
+     * @memberof PlayQueueUpdate
+     */
+    'IsPlaying'?: boolean;
+    /**
+     *
+     * @type {GroupShuffleMode}
+     * @memberof PlayQueueUpdate
+     */
+    'ShuffleMode'?: GroupShuffleMode;
+    /**
+     *
+     * @type {GroupRepeatMode}
+     * @memberof PlayQueueUpdate
+     */
+    'RepeatMode'?: GroupRepeatMode;
+}

package/lib/generated-client/models/playback-order.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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/.
+ */
+/**
+ * Enum PlaybackOrder.
+ * @export
+ * @enum {string}
+ */
+export declare const PlaybackOrder: {
+    readonly Default: "Default";
+    readonly Shuffle: "Shuffle";
+};
+export type PlaybackOrder = typeof PlaybackOrder[keyof typeof PlaybackOrder];

package/lib/generated-client/models/{send-to-user-type.js → playback-order.js}

@@ -11,14 +11,13 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 /**
- *
+ * Enum PlaybackOrder.
  * @export
  * @enum {string}
  */
-const SendToUserType = {
-    All: 'All',
-    Admins: 'Admins',
-    Custom: 'Custom'
+const PlaybackOrder = {
+    Default: 'Default',
+    Shuffle: 'Shuffle'
 };
 
-export { SendToUserType };
+export { PlaybackOrder };

package/lib/generated-client/models/playback-progress-info.d.ts

@@ -10,6 +10,7 @@
  */
 import { BaseItemDto } from './base-item-dto';
 import { PlayMethod } from './play-method';
+import { PlaybackOrder } from './playback-order';
 import { QueueItem } from './queue-item';
 import { RepeatMode } from './repeat-mode';
 /**
@@ -126,6 +127,12 @@ export interface PlaybackProgressInfo {
      * @memberof PlaybackProgressInfo
      */
     'RepeatMode'?: RepeatMode;
+    /**
+     *
+     * @type {PlaybackOrder}
+     * @memberof PlaybackProgressInfo
+     */
+    'PlaybackOrder'?: PlaybackOrder;
     /**
      *
      * @type {Array<QueueItem>}

package/lib/generated-client/models/playback-request-type.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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/.
+ */
+/**
+ * Enum PlaybackRequestType.
+ * @export
+ * @enum {string}
+ */
+export declare const PlaybackRequestType: {
+    readonly Play: "Play";
+    readonly SetPlaylistItem: "SetPlaylistItem";
+    readonly RemoveFromPlaylist: "RemoveFromPlaylist";
+    readonly MovePlaylistItem: "MovePlaylistItem";
+    readonly Queue: "Queue";
+    readonly Unpause: "Unpause";
+    readonly Pause: "Pause";
+    readonly Stop: "Stop";
+    readonly Seek: "Seek";
+    readonly Buffer: "Buffer";
+    readonly Ready: "Ready";
+    readonly NextItem: "NextItem";
+    readonly PreviousItem: "PreviousItem";
+    readonly SetRepeatMode: "SetRepeatMode";
+    readonly SetShuffleMode: "SetShuffleMode";
+    readonly Ping: "Ping";
+    readonly IgnoreWait: "IgnoreWait";
+};
+export type PlaybackRequestType = typeof PlaybackRequestType[keyof typeof PlaybackRequestType];

package/lib/generated-client/models/playback-request-type.js

@@ -0,0 +1,38 @@
+/* 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/.
+ */
+/**
+ * Enum PlaybackRequestType.
+ * @export
+ * @enum {string}
+ */
+const PlaybackRequestType = {
+    Play: 'Play',
+    SetPlaylistItem: 'SetPlaylistItem',
+    RemoveFromPlaylist: 'RemoveFromPlaylist',
+    MovePlaylistItem: 'MovePlaylistItem',
+    Queue: 'Queue',
+    Unpause: 'Unpause',
+    Pause: 'Pause',
+    Stop: 'Stop',
+    Seek: 'Seek',
+    Buffer: 'Buffer',
+    Ready: 'Ready',
+    NextItem: 'NextItem',
+    PreviousItem: 'PreviousItem',
+    SetRepeatMode: 'SetRepeatMode',
+    SetShuffleMode: 'SetShuffleMode',
+    Ping: 'Ping',
+    IgnoreWait: 'IgnoreWait'
+};
+
+export { PlaybackRequestType };

package/lib/generated-client/models/playback-start-info.d.ts

@@ -10,6 +10,7 @@
  */
 import { BaseItemDto } from './base-item-dto';
 import { PlayMethod } from './play-method';
+import { PlaybackOrder } from './playback-order';
 import { QueueItem } from './queue-item';
 import { RepeatMode } from './repeat-mode';
 /**
@@ -126,6 +127,12 @@ export interface PlaybackStartInfo {
      * @memberof PlaybackStartInfo
      */
     'RepeatMode'?: RepeatMode;
+    /**
+     *
+     * @type {PlaybackOrder}
+     * @memberof PlaybackStartInfo
+     */
+    'PlaybackOrder'?: PlaybackOrder;
     /**
      *
      * @type {Array<QueueItem>}

package/lib/generated-client/models/player-state-info.d.ts

@@ -9,6 +9,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 import { PlayMethod } from './play-method';
+import { PlaybackOrder } from './playback-order';
 import { RepeatMode } from './repeat-mode';
 /**
  *
@@ -76,6 +77,12 @@ export interface PlayerStateInfo {
      * @memberof PlayerStateInfo
      */
     'RepeatMode'?: RepeatMode;
+    /**
+     *
+     * @type {PlaybackOrder}
+     * @memberof PlayerStateInfo
+     */
+    'PlaybackOrder'?: PlaybackOrder;
     /**
      * Gets or sets the now playing live stream identifier.
      * @type {string}

package/lib/generated-client/models/playlist-user-permissions.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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/.
+ */
+/**
+ * Class to hold data on user permissions for playlists.
+ * @export
+ * @interface PlaylistUserPermissions
+ */
+export interface PlaylistUserPermissions {
+    /**
+     * Gets or sets the user id.
+     * @type {string}
+     * @memberof PlaylistUserPermissions
+     */
+    'UserId'?: string;
+    /**
+     * Gets or sets a value indicating whether the user has edit permissions.
+     * @type {boolean}
+     * @memberof PlaylistUserPermissions
+     */
+    'CanEdit'?: boolean;
+}

package/lib/generated-client/models/playstate-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 { PlaystateRequest } from './playstate-request';
+import { SessionMessageType } from './session-message-type';
+/**
+ * Playstate message.
+ * @export
+ * @interface PlaystateMessage
+ */
+export interface PlaystateMessage {
+    /**
+     *
+     * @type {PlaystateRequest}
+     * @memberof PlaystateMessage
+     */
+    'Data'?: PlaystateRequest;
+    /**
+     * Gets or sets the message id.
+     * @type {string}
+     * @memberof PlaystateMessage
+     */
+    'MessageId'?: string;
+    /**
+     *
+     * @type {SessionMessageType}
+     * @memberof PlaystateMessage
+     */
+    'MessageType'?: SessionMessageType;
+}

package/lib/generated-client/models/plugin-installation-cancelled-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 { InstallationInfo } from './installation-info';
+import { SessionMessageType } from './session-message-type';
+/**
+ * Plugin installation cancelled message.
+ * @export
+ * @interface PluginInstallationCancelledMessage
+ */
+export interface PluginInstallationCancelledMessage {
+    /**
+     *
+     * @type {InstallationInfo}
+     * @memberof PluginInstallationCancelledMessage
+     */
+    'Data'?: InstallationInfo;
+    /**
+     * Gets or sets the message id.
+     * @type {string}
+     * @memberof PluginInstallationCancelledMessage
+     */
+    'MessageId'?: string;
+    /**
+     *
+     * @type {SessionMessageType}
+     * @memberof PluginInstallationCancelledMessage
+     */
+    'MessageType'?: SessionMessageType;
+}

package/lib/generated-client/models/plugin-installation-completed-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 { InstallationInfo } from './installation-info';
+import { SessionMessageType } from './session-message-type';
+/**
+ * Plugin installation completed message.
+ * @export
+ * @interface PluginInstallationCompletedMessage
+ */
+export interface PluginInstallationCompletedMessage {
+    /**
+     *
+     * @type {InstallationInfo}
+     * @memberof PluginInstallationCompletedMessage
+     */
+    'Data'?: InstallationInfo;
+    /**
+     * Gets or sets the message id.
+     * @type {string}
+     * @memberof PluginInstallationCompletedMessage
+     */
+    'MessageId'?: string;
+    /**
+     *
+     * @type {SessionMessageType}
+     * @memberof PluginInstallationCompletedMessage
+     */
+    'MessageType'?: SessionMessageType;
+}

package/lib/generated-client/models/plugin-installation-failed-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 { InstallationInfo } from './installation-info';
+import { SessionMessageType } from './session-message-type';
+/**
+ * Plugin installation failed message.
+ * @export
+ * @interface PluginInstallationFailedMessage
+ */
+export interface PluginInstallationFailedMessage {
+    /**
+     *
+     * @type {InstallationInfo}
+     * @memberof PluginInstallationFailedMessage
+     */
+    'Data'?: InstallationInfo;
+    /**
+     * Gets or sets the message id.
+     * @type {string}
+     * @memberof PluginInstallationFailedMessage
+     */
+    'MessageId'?: string;
+    /**
+     *
+     * @type {SessionMessageType}
+     * @memberof PluginInstallationFailedMessage
+     */
+    'MessageType'?: SessionMessageType;
+}

package/lib/generated-client/models/plugin-installing-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 { InstallationInfo } from './installation-info';
+import { SessionMessageType } from './session-message-type';
+/**
+ * Package installing message.
+ * @export
+ * @interface PluginInstallingMessage
+ */
+export interface PluginInstallingMessage {
+    /**
+     *
+     * @type {InstallationInfo}
+     * @memberof PluginInstallingMessage
+     */
+    'Data'?: InstallationInfo;
+    /**
+     * Gets or sets the message id.
+     * @type {string}
+     * @memberof PluginInstallingMessage
+     */
+    'MessageId'?: string;
+    /**
+     *
+     * @type {SessionMessageType}
+     * @memberof PluginInstallingMessage
+     */
+    'MessageType'?: SessionMessageType;
+}

package/lib/generated-client/models/plugin-uninstalled-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 { PluginInfo } from './plugin-info';
+import { SessionMessageType } from './session-message-type';
+/**
+ * Plugin uninstalled message.
+ * @export
+ * @interface PluginUninstalledMessage
+ */
+export interface PluginUninstalledMessage {
+    /**
+     *
+     * @type {PluginInfo}
+     * @memberof PluginUninstalledMessage
+     */
+    'Data'?: PluginInfo;
+    /**
+     * Gets or sets the message id.
+     * @type {string}
+     * @memberof PluginUninstalledMessage
+     */
+    'MessageId'?: string;
+    /**
+     *
+     * @type {SessionMessageType}
+     * @memberof PluginUninstalledMessage
+     */
+    'MessageType'?: SessionMessageType;
+}

package/lib/generated-client/models/process-priority-class.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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/.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const ProcessPriorityClass: {
+    readonly Normal: "Normal";
+    readonly Idle: "Idle";
+    readonly High: "High";
+    readonly RealTime: "RealTime";
+    readonly BelowNormal: "BelowNormal";
+    readonly AboveNormal: "AboveNormal";
+};
+export type ProcessPriorityClass = typeof ProcessPriorityClass[keyof typeof ProcessPriorityClass];

package/lib/generated-client/models/process-priority-class.js

@@ -0,0 +1,27 @@
+/* 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/.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+const ProcessPriorityClass = {
+    Normal: 'Normal',
+    Idle: 'Idle',
+    High: 'High',
+    RealTime: 'RealTime',
+    BelowNormal: 'BelowNormal',
+    AboveNormal: 'AboveNormal'
+};
+
+export { ProcessPriorityClass };

package/lib/generated-client/models/public-system-info.d.ts

@@ -42,6 +42,7 @@ export interface PublicSystemInfo {
      * Gets or sets the operating system.
      * @type {string}
      * @memberof PublicSystemInfo
+     * @deprecated
      */
     'OperatingSystem'?: string | null;
     /**

package/lib/generated-client/models/refresh-progress-message.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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';
+/**
+ * Refresh progress message.
+ * @export
+ * @interface RefreshProgressMessage
+ */
+export interface RefreshProgressMessage {
+    /**
+     * Gets or sets the data.
+     * @type {{ [key: string]: string; }}
+     * @memberof RefreshProgressMessage
+     */
+    'Data'?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Gets or sets the message id.
+     * @type {string}
+     * @memberof RefreshProgressMessage
+     */
+    'MessageId'?: string;
+    /**
+     *
+     * @type {SessionMessageType}
+     * @memberof RefreshProgressMessage
+     */
+    'MessageType'?: SessionMessageType;
+}

package/lib/generated-client/models/remote-lyric-info-dto.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 { LyricDto } from './lyric-dto';
+/**
+ * The remote lyric info dto.
+ * @export
+ * @interface RemoteLyricInfoDto
+ */
+export interface RemoteLyricInfoDto {
+    /**
+     * Gets or sets the id for the lyric.
+     * @type {string}
+     * @memberof RemoteLyricInfoDto
+     */
+    'Id'?: string;
+    /**
+     * Gets the provider name.
+     * @type {string}
+     * @memberof RemoteLyricInfoDto
+     */
+    'ProviderName'?: string;
+    /**
+     *
+     * @type {LyricDto}
+     * @memberof RemoteLyricInfoDto
+     */
+    'Lyrics'?: LyricDto;
+}