@jellyfin/sdk 0.7.0

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

@@ -0,0 +1,310 @@
+/**
+ * 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 { ImageSavingConvention } from './image-saving-convention';
+import { MetadataOptions } from './metadata-options';
+import { NameValuePair } from './name-value-pair';
+import { PathSubstitution } from './path-substitution';
+import { RepositoryInfo } from './repository-info';
+/**
+ * Represents the server configuration.
+ * @export
+ * @interface ServerConfiguration
+ */
+export interface ServerConfiguration {
+    /**
+     * Gets or sets the number of days we should retain log files.
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    LogFileRetentionDays?: number;
+    /**
+     * Gets or sets a value indicating whether this instance is first run.
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    IsStartupWizardCompleted?: boolean;
+    /**
+     * Gets or sets the cache path.
+     * @type {string}
+     * @memberof ServerConfiguration
+     */
+    CachePath?: string | null;
+    /**
+     * Gets or sets the last known version that was ran using the configuration.
+     * @type {string}
+     * @memberof ServerConfiguration
+     */
+    PreviousVersion?: string | null;
+    /**
+     * Gets or sets the stringified PreviousVersion to be stored/loaded,  because System.Version itself isn\'t xml-serializable.
+     * @type {string}
+     * @memberof ServerConfiguration
+     */
+    PreviousVersionStr?: string | null;
+    /**
+     * Gets or sets a value indicating whether to enable prometheus metrics exporting.
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    EnableMetrics?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    EnableNormalizedItemByNameIds?: boolean;
+    /**
+     * Gets or sets a value indicating whether this instance is port authorized.
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    IsPortAuthorized?: boolean;
+    /**
+     * Gets or sets a value indicating whether quick connect is available for use on this server.
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    QuickConnectAvailable?: boolean;
+    /**
+     * Gets or sets a value indicating whether [enable case sensitive item ids].
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    EnableCaseSensitiveItemIds?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    DisableLiveTvChannelUserDataName?: boolean;
+    /**
+     * Gets or sets the metadata path.
+     * @type {string}
+     * @memberof ServerConfiguration
+     */
+    MetadataPath?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ServerConfiguration
+     */
+    MetadataNetworkPath?: string;
+    /**
+     * Gets or sets the preferred metadata language.
+     * @type {string}
+     * @memberof ServerConfiguration
+     */
+    PreferredMetadataLanguage?: string;
+    /**
+     * Gets or sets the metadata country code.
+     * @type {string}
+     * @memberof ServerConfiguration
+     */
+    MetadataCountryCode?: string;
+    /**
+     * Gets or sets characters to be replaced with a \' \' in strings to create a sort name.
+     * @type {Array<string>}
+     * @memberof ServerConfiguration
+     */
+    SortReplaceCharacters?: Array<string>;
+    /**
+     * Gets or sets characters to be removed from strings to create a sort name.
+     * @type {Array<string>}
+     * @memberof ServerConfiguration
+     */
+    SortRemoveCharacters?: Array<string>;
+    /**
+     * Gets or sets words to be removed from strings to create a sort name.
+     * @type {Array<string>}
+     * @memberof ServerConfiguration
+     */
+    SortRemoveWords?: Array<string>;
+    /**
+     * Gets or sets the minimum percentage of an item that must be played in order for playstate to be updated.
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    MinResumePct?: number;
+    /**
+     * Gets or sets the maximum percentage of an item that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched.
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    MaxResumePct?: number;
+    /**
+     * Gets or sets the minimum duration that an item must have in order to be eligible for playstate updates..
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    MinResumeDurationSeconds?: number;
+    /**
+     * Gets or sets the minimum minutes of a book that must be played in order for playstate to be updated.
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    MinAudiobookResume?: number;
+    /**
+     * Gets or sets the remaining minutes of a book that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched.
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    MaxAudiobookResume?: number;
+    /**
+     * Gets or sets the delay in seconds that we will wait after a file system change to try and discover what has been added/removed  Some delay is necessary with some items because their creation is not atomic.  It involves the creation of several  different directories and files.
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    LibraryMonitorDelay?: number;
+    /**
+     *
+     * @type {ImageSavingConvention}
+     * @memberof ServerConfiguration
+     */
+    ImageSavingConvention?: ImageSavingConvention;
+    /**
+     *
+     * @type {Array<MetadataOptions>}
+     * @memberof ServerConfiguration
+     */
+    MetadataOptions?: Array<MetadataOptions>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    SkipDeserializationForBasicTypes?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ServerConfiguration
+     */
+    ServerName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ServerConfiguration
+     */
+    UICulture?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    SaveMetadataHidden?: boolean;
+    /**
+     *
+     * @type {Array<NameValuePair>}
+     * @memberof ServerConfiguration
+     */
+    ContentTypes?: Array<NameValuePair>;
+    /**
+     *
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    RemoteClientBitrateLimit?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    EnableFolderView?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    EnableGroupingIntoCollections?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    DisplaySpecialsWithinSeasons?: boolean;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ServerConfiguration
+     */
+    CodecsUsed?: Array<string>;
+    /**
+     *
+     * @type {Array<RepositoryInfo>}
+     * @memberof ServerConfiguration
+     */
+    PluginRepositories?: Array<RepositoryInfo>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    EnableExternalContentInSuggestions?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    ImageExtractionTimeoutMs?: number;
+    /**
+     *
+     * @type {Array<PathSubstitution>}
+     * @memberof ServerConfiguration
+     */
+    PathSubstitutions?: Array<PathSubstitution>;
+    /**
+     * Gets or sets a value indicating whether slow server responses should be logged as a warning.
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    EnableSlowResponseWarning?: boolean;
+    /**
+     * Gets or sets the threshold for the slow response time warning in ms.
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    SlowResponseThresholdMs?: number;
+    /**
+     * Gets or sets the cors hosts.
+     * @type {Array<string>}
+     * @memberof ServerConfiguration
+     */
+    CorsHosts?: Array<string>;
+    /**
+     * Gets or sets the number of days we should retain activity logs.
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    ActivityLogRetentionDays?: number | null;
+    /**
+     * Gets or sets the how the library scan fans out.
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    LibraryScanFanoutConcurrency?: number;
+    /**
+     * Gets or sets the how many metadata refreshes can run concurrently.
+     * @type {number}
+     * @memberof ServerConfiguration
+     */
+    LibraryMetadataRefreshConcurrency?: number;
+    /**
+     * Gets or sets a value indicating whether older plugins should automatically be deleted from the plugin folder.
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    RemoveOldPlugins?: boolean;
+    /**
+     * Gets or sets a value indicating whether clients should be allowed to upload logs.
+     * @type {boolean}
+     * @memberof ServerConfiguration
+     */
+    AllowClientLogUpload?: boolean;
+}

package/lib/generated-client/models/server-configuration.js

@@ -0,0 +1,14 @@
+"use strict";
+/* 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/.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/generated-client/models/server-discovery-info.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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/.
+ */
+/**
+ * The server discovery info model.
+ * @export
+ * @interface ServerDiscoveryInfo
+ */
+export interface ServerDiscoveryInfo {
+    /**
+     * Gets the address.
+     * @type {string}
+     * @memberof ServerDiscoveryInfo
+     */
+    Address?: string;
+    /**
+     * Gets the server identifier.
+     * @type {string}
+     * @memberof ServerDiscoveryInfo
+     */
+    Id?: string;
+    /**
+     * Gets the name.
+     * @type {string}
+     * @memberof ServerDiscoveryInfo
+     */
+    Name?: string;
+    /**
+     * Gets the endpoint address.
+     * @type {string}
+     * @memberof ServerDiscoveryInfo
+     */
+    EndpointAddress?: string | null;
+}

package/lib/generated-client/models/server-discovery-info.js

@@ -0,0 +1,14 @@
+"use strict";
+/* 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/.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/generated-client/models/session-info.d.ts

@@ -0,0 +1,199 @@
+/**
+ * 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 { BaseItem } from './base-item';
+import { BaseItemDto } from './base-item-dto';
+import { ClientCapabilities } from './client-capabilities';
+import { GeneralCommandType } from './general-command-type';
+import { PlayerStateInfo } from './player-state-info';
+import { QueueItem } from './queue-item';
+import { SessionUserInfo } from './session-user-info';
+import { TranscodingInfo } from './transcoding-info';
+/**
+ * Class SessionInfo.
+ * @export
+ * @interface SessionInfo
+ */
+export interface SessionInfo {
+    /**
+     *
+     * @type {PlayerStateInfo}
+     * @memberof SessionInfo
+     */
+    PlayState?: PlayerStateInfo;
+    /**
+     *
+     * @type {Array<SessionUserInfo>}
+     * @memberof SessionInfo
+     */
+    AdditionalUsers?: Array<SessionUserInfo> | null;
+    /**
+     *
+     * @type {ClientCapabilities}
+     * @memberof SessionInfo
+     */
+    Capabilities?: ClientCapabilities;
+    /**
+     * Gets or sets the remote end point.
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    RemoteEndPoint?: string | null;
+    /**
+     * Gets the playable media types.
+     * @type {Array<string>}
+     * @memberof SessionInfo
+     */
+    PlayableMediaTypes?: Array<string> | null;
+    /**
+     * Gets or sets the id.
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    Id?: string | null;
+    /**
+     * Gets or sets the user id.
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    UserId?: string;
+    /**
+     * Gets or sets the username.
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    UserName?: string | null;
+    /**
+     * Gets or sets the type of the client.
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    Client?: string | null;
+    /**
+     * Gets or sets the last activity date.
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    LastActivityDate?: string;
+    /**
+     * Gets or sets the last playback check in.
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    LastPlaybackCheckIn?: string;
+    /**
+     * Gets or sets the name of the device.
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    DeviceName?: string | null;
+    /**
+     * Gets or sets the type of the device.
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    DeviceType?: string | null;
+    /**
+     *
+     * @type {BaseItemDto}
+     * @memberof SessionInfo
+     */
+    NowPlayingItem?: BaseItemDto;
+    /**
+     *
+     * @type {BaseItem}
+     * @memberof SessionInfo
+     */
+    FullNowPlayingItem?: BaseItem;
+    /**
+     *
+     * @type {BaseItemDto}
+     * @memberof SessionInfo
+     */
+    NowViewingItem?: BaseItemDto;
+    /**
+     * Gets or sets the device id.
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    DeviceId?: string | null;
+    /**
+     * Gets or sets the application version.
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    ApplicationVersion?: string | null;
+    /**
+     *
+     * @type {TranscodingInfo}
+     * @memberof SessionInfo
+     */
+    TranscodingInfo?: TranscodingInfo;
+    /**
+     * Gets a value indicating whether this instance is active.
+     * @type {boolean}
+     * @memberof SessionInfo
+     */
+    IsActive?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SessionInfo
+     */
+    SupportsMediaControl?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SessionInfo
+     */
+    SupportsRemoteControl?: boolean;
+    /**
+     *
+     * @type {Array<QueueItem>}
+     * @memberof SessionInfo
+     */
+    NowPlayingQueue?: Array<QueueItem> | null;
+    /**
+     *
+     * @type {Array<BaseItemDto>}
+     * @memberof SessionInfo
+     */
+    NowPlayingQueueFullItems?: Array<BaseItemDto> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SessionInfo
+     */
+    HasCustomDeviceName?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    PlaylistItemId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    ServerId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SessionInfo
+     */
+    UserPrimaryImageTag?: string | null;
+    /**
+     * Gets the supported commands.
+     * @type {Array<GeneralCommandType>}
+     * @memberof SessionInfo
+     */
+    SupportedCommands?: Array<GeneralCommandType> | null;
+}

package/lib/generated-client/models/session-info.js

@@ -0,0 +1,14 @@
+"use strict";
+/* 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/.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/generated-client/models/session-message-type.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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/.
+ */
+/**
+ * The different kinds of messages that are used in the WebSocket api.
+ * @export
+ * @enum {string}
+ */
+export declare enum SessionMessageType {
+    ForceKeepAlive = "ForceKeepAlive",
+    GeneralCommand = "GeneralCommand",
+    UserDataChanged = "UserDataChanged",
+    Sessions = "Sessions",
+    Play = "Play",
+    SyncPlayCommand = "SyncPlayCommand",
+    SyncPlayGroupUpdate = "SyncPlayGroupUpdate",
+    Playstate = "Playstate",
+    RestartRequired = "RestartRequired",
+    ServerShuttingDown = "ServerShuttingDown",
+    ServerRestarting = "ServerRestarting",
+    LibraryChanged = "LibraryChanged",
+    UserDeleted = "UserDeleted",
+    UserUpdated = "UserUpdated",
+    SeriesTimerCreated = "SeriesTimerCreated",
+    TimerCreated = "TimerCreated",
+    SeriesTimerCancelled = "SeriesTimerCancelled",
+    TimerCancelled = "TimerCancelled",
+    RefreshProgress = "RefreshProgress",
+    ScheduledTaskEnded = "ScheduledTaskEnded",
+    PackageInstallationCancelled = "PackageInstallationCancelled",
+    PackageInstallationFailed = "PackageInstallationFailed",
+    PackageInstallationCompleted = "PackageInstallationCompleted",
+    PackageInstalling = "PackageInstalling",
+    PackageUninstalled = "PackageUninstalled",
+    ActivityLogEntry = "ActivityLogEntry",
+    ScheduledTasksInfo = "ScheduledTasksInfo",
+    ActivityLogEntryStart = "ActivityLogEntryStart",
+    ActivityLogEntryStop = "ActivityLogEntryStop",
+    SessionsStart = "SessionsStart",
+    SessionsStop = "SessionsStop",
+    ScheduledTasksInfoStart = "ScheduledTasksInfoStart",
+    ScheduledTasksInfoStop = "ScheduledTasksInfoStop",
+    KeepAlive = "KeepAlive"
+}

package/lib/generated-client/models/session-message-type.js

@@ -0,0 +1,57 @@
+"use strict";
+/* 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/.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionMessageType = void 0;
+/**
+ * The different kinds of messages that are used in the WebSocket api.
+ * @export
+ * @enum {string}
+ */
+var SessionMessageType;
+(function (SessionMessageType) {
+    SessionMessageType["ForceKeepAlive"] = "ForceKeepAlive";
+    SessionMessageType["GeneralCommand"] = "GeneralCommand";
+    SessionMessageType["UserDataChanged"] = "UserDataChanged";
+    SessionMessageType["Sessions"] = "Sessions";
+    SessionMessageType["Play"] = "Play";
+    SessionMessageType["SyncPlayCommand"] = "SyncPlayCommand";
+    SessionMessageType["SyncPlayGroupUpdate"] = "SyncPlayGroupUpdate";
+    SessionMessageType["Playstate"] = "Playstate";
+    SessionMessageType["RestartRequired"] = "RestartRequired";
+    SessionMessageType["ServerShuttingDown"] = "ServerShuttingDown";
+    SessionMessageType["ServerRestarting"] = "ServerRestarting";
+    SessionMessageType["LibraryChanged"] = "LibraryChanged";
+    SessionMessageType["UserDeleted"] = "UserDeleted";
+    SessionMessageType["UserUpdated"] = "UserUpdated";
+    SessionMessageType["SeriesTimerCreated"] = "SeriesTimerCreated";
+    SessionMessageType["TimerCreated"] = "TimerCreated";
+    SessionMessageType["SeriesTimerCancelled"] = "SeriesTimerCancelled";
+    SessionMessageType["TimerCancelled"] = "TimerCancelled";
+    SessionMessageType["RefreshProgress"] = "RefreshProgress";
+    SessionMessageType["ScheduledTaskEnded"] = "ScheduledTaskEnded";
+    SessionMessageType["PackageInstallationCancelled"] = "PackageInstallationCancelled";
+    SessionMessageType["PackageInstallationFailed"] = "PackageInstallationFailed";
+    SessionMessageType["PackageInstallationCompleted"] = "PackageInstallationCompleted";
+    SessionMessageType["PackageInstalling"] = "PackageInstalling";
+    SessionMessageType["PackageUninstalled"] = "PackageUninstalled";
+    SessionMessageType["ActivityLogEntry"] = "ActivityLogEntry";
+    SessionMessageType["ScheduledTasksInfo"] = "ScheduledTasksInfo";
+    SessionMessageType["ActivityLogEntryStart"] = "ActivityLogEntryStart";
+    SessionMessageType["ActivityLogEntryStop"] = "ActivityLogEntryStop";
+    SessionMessageType["SessionsStart"] = "SessionsStart";
+    SessionMessageType["SessionsStop"] = "SessionsStop";
+    SessionMessageType["ScheduledTasksInfoStart"] = "ScheduledTasksInfoStart";
+    SessionMessageType["ScheduledTasksInfoStop"] = "ScheduledTasksInfoStop";
+    SessionMessageType["KeepAlive"] = "KeepAlive";
+})(SessionMessageType = exports.SessionMessageType || (exports.SessionMessageType = {}));